配置
这里的 configuration
可以是下面的任意一个:
- 一个
ConfigurationOptions
实例 - 一个代表配置的
string
后者是 基本上 是前者的标记化形式。
基本配置字符串
-
最简单的 配置示例只需要一个主机名:
var conn = ConnectionMultiplexer.Connect("localhost");
这将使用默认的redis端口(6379)连接到本地计算机上的单个服务器。
附加选项只是简单地附加(逗号分隔)。 端口通常用冒号(:
)表示。 配置选项在名称后面包含一个=
。 例如:
var conn = ConnectionMultiplexer.Connect("redis0:6380,redis1:6380,allowAdmin=true");
下面显示了 string
和 ConfigurationOptions
表示之间的映射概述,但您可以轻松地在它们之间切换:
ConfigurationOptions options = ConfigurationOptions.Parse(configString);
或者:
常见的用法是将 基础配置 细节存储在一个字符串中,然后在运行时应用特定的详细信息:
string configString = GetRedisConfiguration();
var options = ConfigurationOptions.Parse(configString);
options.ClientName = GetAppName(); // only known at runtime
options.AllowAdmin = true;
带密码的 Microsoft Azure Redis 示例
var conn = ConnectionMultiplexer.Connect("contoso5.redis.cache.windows.net,ssl=true,password=...");
一些更常用的选项包括:
补充的只有代码才支持的选项:
- 重连重试策略(
IReconnectRetryPolicy
)。默认设置:ReconnectRetryPolicy = LinearRetry(ConnectTimeout);
配置字符串中的令牌是逗号分隔的;任何没有=
符号的都假定为redis服务器端点。
没有显式端口的端点将在未启用ssl的情况下使用6379,如果启用了ssl则使用6380。
以$
开头的令牌被用来表示命令映射,例如:$ config = cfg
。
自动和手动配置
在许多常见的情况下,StackExchange.Redis将自动配置很多设置,包括服务器类型和版本,连接超时和主/从关系。
有时,在redis服务器上禁用了这些命令。 在这种情况下,可以提供更多的信息:
ConfigurationOptions config = new ConfigurationOptions
{
EndPoints =
{
{ "redis0", 6379 },
{ "redis1", 6380 }
},
{ // EXCLUDE a few commands
"INFO", "CONFIG", "CLUSTER",
"PING", "ECHO", "CLIENT"
}, available: false),
KeepAlive = 180,
DefaultVersion = new Version(2, 8, 8),
};
它相当于命令字符串:
redis的一个很不寻常的功能是可以禁用或重命名或禁用并重命名单个命令。
根据前面的例子,这是通过CommandMap
来实现的,但不是传递一个HashSet <string>
到Create()
(表示可用或不可用的命令),而是传递一个Dictionary < string>
。
字典中未提及的所有命令都默认已启用且未重命名。
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
是允许使用多个 redis 实例就像它是一个单个服务器,具有内置分片和容错(很像 redis 集群,但单独实现)的工具。
Twemproxy可用的功能集减少。
为了避免手动配置,可以使用 Proxy
选项:
var options = new ConfigurationOptions
{
EndPoints = { "my-server" },
Proxy = Proxy.Twemproxy
};
通常 StackExchange.Redis 都会自动解析 主/从节点。然而,如果你不使用诸如 redis-sentinel 或 redis 集群之类的管理工具,有时你会有多个主节点(例如,在重置节点以进行维护时,它可能会作为主节点重新显示在网络上)。
为了帮助解决这个问题,StackExchange.Redis 可以使用 tie-breaker 的概念 - 这仅在检测到多个主节点时使用(不包括需要多个主节点的redis集群)。
为了与 BookSleeve 兼容,tiebreaker 使用默认的key为 "__Booksleeve_TieBreak"
(总是在数据库0中)。
这用作粗略的投票机制,以帮助确定首选 主机,以便能够按正确的路由工作。
同样,当配置改变时(特别是主/从配置),连接的实例使得他们意识到新的情况(在可用的地方通过 INFO
,CONFIG
等进行通知 )是很重要的。
StackExchange.Redis 通过自动订阅可以在其上发送这样的通知的发布/订阅通道来实现。
由于类似的原因,这默认为"__Booksleeve_MasterChanged"
。
这两个选项都可以通过 .ConfigurationChannel
和 .TieBreaker
配置属性来定制或禁用(设置为""
)。
These settings are also used by the IServer.MakeMaster()
method, which can set the tie-breaker in the database and broadcast the configuration change message.
The configuration message can also be used separately to master/slave changes simply to request all nodes to refresh their configurations, via the ConnectionMultiplexer.PublishReconfigure
method.
这些设置也由 IServer.MakeMaster()
方法使用,它可以设置数据库中的 tie-breaker 并广播配置更改消息。
配置消息也可以单独用于主/从变化,只需通过调用 方法请求所有节点刷新其配置。
重新连接重试策略
当连接由于任何原因丢失时,StackExchange.Redis会自动尝试在后台重新连接。
它将继续重试,直到连接恢复。 它将使用 ReconnectRetryPolicy 来决定在重试之间应该等待多长时间。
ReconnectRetryPolicy可以是线性的(默认),指数的或者是一个自定义的重试策略。
举个例子: