StackExchange.Redis 官方文档(二) Configuration

2022-10-04 10:23:12

配置

有多种方式可以配置redis，StackExchange.Redis提供了一个丰富的配置模型，在执行Connect (or ConnectAsync) 时被调用：

var conn = ConnectionMultiplexer.Connect(configuration);

这里的 configuration 可以是一下类型当中的任意一项：

一个ConfigurationOptions 实例
一个包含配置数据的字符串

后者基本上是前者的字符串形式

基本的配置字符串

最简单 的例子就是只包含主机的名称：

var conn = ConnectionMultiplexer.Connect("localhost");

这样就会链接到部署在本地机器上使用默认端口(6379)的单服务器。其余的配置选项只需要拼接在后面(要用逗号分隔).端口之前通常使用分号(:)分隔。配置选项在名称后边有一个=。示例：

var conn = ConnectionMultiplexer.Connect("redis0:6380,redis1:6380,allowAdmin=true");

string和ConfigurationOptions之间的映射在下面有详细的概述,你可以通过如下的方式对两者进行互相转换:

ConfigurationOptions options = ConfigurationOptions.Parse(configString);

or:

string configString = options.ToString();

常用的方式将基本的配置保存在字符串当中，但运行的时候应用特殊的配置：

string configString = GetRedisConfiguration();

var options = ConfigurationOptions.Parse(configString);

options.ClientName = GetAppName(); // 只能在运行状态下才能获取到

options.AllowAdmin = true;

conn = ConnectionMultiplexer.Connect(options);

带有密码的 Microsoft Azure Redis 实例：

var conn = ConnectionMultiplexer.Connect("contoso5.redis.cache.windows.net,ssl=true,password=...");

配置选项

ConfigurationOptions对象有很多属性，转换时会自动判断。下面是一些常用的配置：

Configuration string	`ConfigurationOptions`	Meaning
abortConnect={bool}	`AbortOnConnectFail`	如果是true，`Connect`方法在链接不到有效的服务器的时候不会创建一个链接实例
allowAdmin={bool}	`AllowAdmin`	启用被认定为是有风险的一些命令
channelPrefix={string}	`ChannelPrefix`	所有的发布订阅频道的前缀
connectRetry={int}	`ConnectRetry`	在初始化 `Connect` 失败的时候重新尝试进行链接的次数
connectTimeout={int}	`ConnectTimeout`	链接超时时间(ms)
configChannel={string}	`ConfigurationChannel`	用于传递配置改变信息的广播频道
defaultDatabase={int}	`DefaultDatabase`	默认的数据库序数,从1到-1
keepAlive={int}	`KeepAlive`	发送信息以保持sockets在线的间隔时间
name={string}	`ClientName`	在redis内用于判别不同链接客户端
password={string}	`Password`	密码
proxy={proxy type}	`Proxy`	代理类型(如果有的话); 如 "twemproxy"
resolveDns={bool}	`ResolveDns`	指定DNS解析服务器，推荐明确指出，而不是采用默认的
serviceName={string}	`ServiceName`	当前没有实现（用于sentinel模式）
ssl={bool}	`Ssl`	使用SSL加密
sslHost={string}	`SslHost`	在服务器证书上注册SSL主机身份标识
syncTimeout={int}	`SyncTimeout`	同步操作的超时时间(ms)
tiebreaker={string}	`TieBreaker`	多主机服务器部署情形下中用于选择出master服务的Key
version={string}	`DefaultVersion`	Redis版本(用于从服务器获取不到此信息时)
writeBuffer={int}	`WriteBuffer`	输出缓存大小

配置字符串的Token是用逗号分隔开的；任何没有 = 符号的Token都会被认为是一个服务器节点。节点信息如果没有指出端口号在没有使用ssl的情况下会默认为6379，启用了ssl则默认使用6380。

Token当中如果是以$开头则表示是命令映射信息，例如：$config=cfg。

自动配置和手动配置

在通常的方案当中，StackExchange.Redis 会自动配置很多设置，包括服务器类型和版本，链接超时时间，以及主从关系。但是，有时候这些命令会被redis服务器无效化，这种情况下，提供这些信息是很有必要的：

ConfigurationOptions config = new ConfigurationOptions

{

    EndPoints =

    {

        { "redis0", 6379 },

        { "redis1", 6380 }

    },

    CommandMap = CommandMap.Create(new HashSet<string>

    { // EXCLUDE a few commands

        "INFO", "CONFIG", "CLUSTER",

        "PING", "ECHO", "CLIENT"

    }, available: false),

    KeepAlive = 180,

    DefaultVersion = new Version(2, 8, 8),

    Password = "changeme"

};

或者使用下面字符串的方式：

redis0:6379,redis1:6380,keepAlive=180,version=2.8.8,$CLIENT=,$CLUSTER=,$CONFIG=,$ECHO=,$INFO=,$PING=

命令重命名

redis里有一个不常用的功能，就是禁用或者重命名个别的命令。在这之前的每一个例子，这个功能是通过CommandMap操作的，但是它并没有采用传参数HashSet<string>或者 Create()的形式(去明确指出哪些命令可用哪些命令不可用)，而是采用 Dictionary<string,string>的形式。这个字典当中包含的所有的命令都被假定为启用，而且并没有被重命名。 null或者空字符串则表示命令被禁用了，例如：

var commands = new Dictionary<string,string> {

        { "info", null }, // disabled

        { "select", "use" }, // renamed to SQL equivalent for some reason

};

var options = new ConfigurationOptions {

    // ...

    CommandMap = CommandMap.Create(commands),

    // ...

}

字符串形式：

$INFO=,$SELECT=use

Twemproxy

Twemproxy是一个可以把多个服务器当成一个服务器的工具，带有分享和容错能力(这和redis cluster很相似，但是实现方式不同)。Twemproxy可以使用的功能是简化过的。为了避免手动配置，可以使用Proxy配置项：

var options = new ConfigurationOptions

{

    EndPoints = { "my-server" },

    Proxy = Proxy.Twemproxy

};

Tiebreakers和配置更改公告

正常情况下StackExchange.Redis会自动判别主从节点。但是,如果你没有使用类似于redis-sentinel或者redis cluster的管理工具，你可能会碰到有多个master节点的情况（例如，维护时重置了节点，在网络中在就表现为是一个master）。为了解决这种情况，StackExchange.Redis使用了tie-breaker的概念 - 他只有在检测到多个master的时候才会用到。（不包括redis cluster的情况下，因为redis cluster是正是需要多个master的）。为了兼容BookSleeve，默认的key是"__Booksleeve_TieBreak"（只存在于0号数据库）。他是一种原始的投票机制去判断更适用的master。(so that work is routed correctly.)

类似的，当配置发生改变时（特别是master/slave配置），让已经链接的实例知道新的环境（通过INFO, CONFIG等可以使用的命令）是很重要的。StackExchagnge.Redist通过自动订阅一个pub/sub频道，这个频道是用来发送这些通知的。为了兼容BookSleeve，频道名名称默认是 "__Booksleeve_MasterChanged"。

这两个选项都是可以通过.ConfigurationChannel和.TieBreaker配置属性自定义或者禁用的（设置为""）。

这些设置也可以被IServer.MakeMaster()方法使用，来设置数据库里的tie-breaker以及广播配置更改消息。对于master/slave变化的配置信息也可以通过 ConnectionMultiplexer.PublishReconfigure 方法来请求所有节点刷新配置。

原文地址：StackExchange.Redis

大部分为意译，如有不当还请指正

码农公寓

配置