1. 程式人生 > >StackExchange.Redis 官方文檔(二) Configuration

StackExchange.Redis 官方文檔(二) Configuration

其余 socket lse base 關系 make resolved async 自定義

原文:StackExchange.Redis 官方文檔(二) Configuration

配置

有多種方式可以配置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");

stringConfigurationOptions之間的映射在下面有詳細的概述,你可以通過如下的方式對兩者進行互相轉換:

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
大部分為意譯,如有不當還請指正

StackExchange.Redis 官方文檔(二) Configuration