redis for .net core -- csredis

github:  https://github.com/2881099/csredis

ServiceStack.Redis是商業版，免費版有限制；

StackExchange.Redis是免費版，早期有Timeout Bug，當前版本使用需要全部使用異步方法方可解決；

CSRedis於2016年開始支持.NETCore一直迭代至今（解決上述Bug），實現了低門檻、高性能，和分區高級玩法的redis-cli SDK；

 

v3.0 更新功能

1、CSRedisClient、RedisHelper 方法名調整，所有方法名與redis-cli保持一持；

java,python,go,nodejs,php SDK 方法名基本都與 redis-cli 一致，反對二次命名的庫

2、CSRedisClient 增加反序列對象獲取，如：Get<byte[]>、HGet<byte[]>，所以獲取方法都重載了，默認獲取仍然是string；

3、增加 geo 命令支持（需要 redis-server 3.2 以上支持）；

4、增加官方集羣 redis-trib.rb 支持；

5、增加哨兵模式，和讀寫分離；

6、增加 stream 命令支持（需要 redis-server 5.0 以上支持）；

Package Name	NuGet	Downloads
CSRedisCore
Caching.CSRedis			IDistributedCache

功能介紹

1、實現分區與連接池管理類CSRedisClient，靜態類RedisHelper快速上手，方法名與redis-cli保持一致。

dotnet add package CSRedisCore

普通模式

var csredis = new CSRedis.CSRedisClient("127.0.0.1:6379,password=123,defaultDatabase=13,prefix=key前輟");

參數名	默認值	說明
password	<空>	密碼
defaultDatabase	0	默認數據庫
poolsize	50	連接池大小
connectTimeout	5000	連接超時設置(毫秒)
syncTimeout	10000	發送/接收超時設置(毫秒)
idleTimeout	0	連接池內元素空閒時間(毫秒)，適用連接遠程redis-server
preheat	true	預熱連接，接收數值如 preheat=5 預熱5個連接
ssl	false	是否開啓加密傳輸
testcluster	true	是否嘗試集羣模式，阿里雲、騰訊雲集羣需要設置此選項爲 false
writeBuffer	10240	異步方法寫入緩衝區大小(字節)
tryit	0	執行命令出錯，嘗試重試的次數
name	<空>	連接名稱，可以使用 Client List 命令查看
prefix	<空>	key前輟，所有方法都會附帶此前輟，csredis.Set(prefix + "key", 111);

哨兵模式

var csredis = new CSRedis.CSRedisClient(
    "mymaster,password=123,prefix=key前輟", 
    new [] { "192.169.1.10:26379", "192.169.1.11:26379", "192.169.1.12:26379" });

連接字符串中的 mymaster 是哨兵監聽的名稱，其他配置參數與普通模式一致

只讀模式：new CSRedisClient("mymaster,password=123", new []{哨兵}, false)

官方集羣

假設你已經配置好 redis-trib 集羣，定義一個【普通模式】的 CSRedisClient 對象，它會根據 redis-server 返回的 MOVED | ASK 錯誤記錄slot，自動增加節點 Nodes 屬性。

127.0.0.1:6379,password=123,defaultDatabase=0,poolsize=50,prefix=

其他節點在運行過程中自動增加，確保每個節點密碼一致。

警告：本模式與【分區模式】同時使用時，切記不可設置“prefix=key前輟”（或者全部設置成一樣），否則會導致 keySlot 計算結果與服務端不匹配，無法記錄 slotCache。

注意：官方集羣不支持多 keys 的命令、【管道】、Eval（腳本）等衆多殺手級功能。

分區模式

本功能現實多個服務節點分擔存儲，與官方的分區、集羣、高可用方案不同。

例如：緩存數據達到500G，如果使用一臺redis-server服務器光靠內存存儲將非常喫力，使用硬盤又影響性能。 可以使用此功能自動管理N臺redis-server服務器分擔存儲，每臺服務器只需約 (500/N)G 內存，且每臺服務器勻可以配置官方高可用架構。

var csredis = new CSRedis.CSRedisClient(null,
  "127.0.0.1:6371,password=123,defaultDatabase=11,poolsize=10", 
  "127.0.0.1:6372,password=123,defaultDatabase=12,poolsize=11",
  "127.0.0.1:6373,password=123,defaultDatabase=13,poolsize=12",
  "127.0.0.1:6374,password=123,defaultDatabase=14,poolsize=13");
//實現思路：根據CRC16(key) % 節點總數量，確定連向的節點
//也可以自定義規則(第一個參數設置)

mvc分佈式緩存注入 dotnet add package Caching.CSRedis

//初始化 RedisHelper
RedisHelper.Initialization(csredis);
//註冊mvc分佈式緩存
services.AddSingleton<IDistributedCache>(new Microsoft.Extensions.Caching.Redis.CSRedisCache(RedisHelper.Instance));

提示：CSRedis.CSRedisClient 單例模式夠用了，強烈建議使用 RedisHelper 靜態類

RedisHelper.Set("test1", "123123", 60);
RedisHelper.Get("test1");
//...函數名與 redis-cli 的命令相同

如果確定一定以及肯定非要有切換數據庫的需求，請看以下代碼：

var connectionString = "127.0.0.1:6379,password=123,poolsize=10";
var redis = new CSRedisClient[14]; //定義成單例
for (var a = 0; a< redis.Length; a++) redis[a] = new CSRedisClient(connectionString + ",defaultDatabase=" + a);

//訪問數據庫1的數據
redis[1].Get("test1");

操作多個庫時，一個 RedisHelper 不夠用怎麼辦？

public abstract class Rds1 : RedisHelper<Rds1> {}
public abstract class Rds2 : RedisHelper<Rds2> {}

Rds1.Initialization(new CSRedisClient("...."));
Rds2.Initialization(new CSRedisClient("...."));

2、訂閱與發佈

//普通訂閱
RedisHelper.Subscribe(
  ("chan1", msg => Console.WriteLine(msg.Body)),
  ("chan2", msg => Console.WriteLine(msg.Body)));

//模式訂閱（通配符）
RedisHelper.PSubscribe(new[] { "test*", "*test001", "test*002" }, msg => {
  Console.WriteLine($"PSUB   {msg.MessageId}:{msg.Body}    {msg.Pattern}: chan:{msg.Channel}");
});
//模式訂閱已經解決的難題：
//1、分區的節點匹配規則，導致通配符最大可能匹配全部節點，所以全部節點都要訂閱
//2、本組 "test*", "*test001", "test*002" 訂閱全部節點時，需要解決同一條消息不可執行多次

//發佈
RedisHelper.Publish("chan1", "123123123");
//無論是分區或普通模式，RedisHelper.Publish 都可以正常通信

參考資料：【由淺至深】redis 實現發佈訂閱的幾種方式

3、緩存殼

//不加緩存的時候，要從數據庫查詢
var t1 = Test.Select.WhereId(1).ToOne();

//一般的緩存代碼，如不封裝還挺繁瑣的
var cacheValue = RedisHelper.Get("test1");
if (!string.IsNullOrEmpty(cacheValue)) {
	try {
		return JsonConvert.DeserializeObject(cacheValue);
	} catch {
		//出錯時刪除key
		RedisHelper.Remove("test1");
		throw;
	}
}
var t1 = Test.Select.WhereId(1).ToOne();
RedisHelper.Set("test1", JsonConvert.SerializeObject(t1), 10); //緩存10秒

//使用緩存殼效果同上，以下示例使用 string 和 hash 緩存數據
var t1 = RedisHelper.CacheShell("test1", 10, () => Test.Select.WhereId(1).ToOne());
var t2 = RedisHelper.CacheShell("test", "1", 10, () => Test.Select.WhereId(1).ToOne());
var t3 = RedisHelper.CacheShell("test", new [] { "1", "2" }, 10, notCacheFields => new [] {
  ("1", Test.Select.WhereId(1).ToOne()),
  ("2", Test.Select.WhereId(2).ToOne())
});

Pipeline

使用管道模式，打包多條命令一起執行，從而提高性能。

var ret1 = RedisHelper.StartPipe().Set("a", "1").Get("a").EndPipe();
var ret2 = RedisHelper.StartPipe(p => p.Set("a", "1").Get("a"));

var ret3 = RedisHelper.StartPipe().Get("b").Get("a").Get("a").EndPipe();
//與 RedisHelper.MGet("b", "a", "a") 性能相比，經測試差之毫釐

Benchmark