Features

• CSRedisClient and RedisHelper Keep all method names consistent with redis-cli

• Support geo type commands (redis-server 3.2 or above is required)

• Support Redis Cluster redis-trib.rb

• Support Redis Sentinel and master-slave

• Supports stream type commands (requires redis-server 5.0 and above)

Package Name	NuGet	Downloads
CSRedisCore
Caching.CSRedis			IDistributedCache

dotnet add package CSRedisCore

Single machine redis

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

Parameter	Default	Explain
user	<Empty>	Redis server user (redis 6.0+)
password	<Empty>	Redis server password
defaultDatabase	0	Redis server database
asyncPipeline	false	The asynchronous method automatically uses pipeline, and the 10W concurrent time is 450ms (welcome to feedback)
poolsize	50	Connection pool size
idleTimeout	20000	Idle time of elements in the connection pool (MS), suitable for connecting to remote redis server
connectTimeout	5000	Connection timeout (MS)
syncTimeout	10000	Send / receive timeout (MS)
preheat	5	Preheat connections, receive values such as preheat = 5 preheat 5 connections
autoDispose	true	Follow system exit event to release automatically
ssl	false	Enable encrypted transmission
testcluster	true	是否尝试集群模式，阿里云、腾讯云集群需要设置此选项为 false
tryit	0	Execution error, retry attempts
name	<Empty>	Connection name, use client list command to view
prefix	<Empty>	key前辍，所有方法都会附带此前辍，csredis.Set(prefix + "key", 111);

IPv6: [fe80::b164:55b3:4b4f:7ce6%15]:6379

Redis Sentinel

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

Read only: new CSRedisClient("mymaster,password=123", new [] { Sentinels }, false)

Redis Cluster

假设你已经配置好 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（脚本）等众多杀手级功能。

IDistributedCache

dotnet add package Caching.CSRedis

RedisHelper.Initialization(csredis);
services.AddSingleton<IDistributedCache>(new Microsoft.Extensions.Caching.Redis.CSRedisCache(RedisHelper.Instance));

Note: CSRedisClient is singleton, RedisHelper static class is recommended

RedisHelper.Set("test1", "123123", 60);
RedisHelper.Get("test1");
//The method name is the same as the command of redis cli

Operate on multiple databases

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

redis[1].Get("test1");

Multiple RedisHelper

public abstract class MyHelper1 : RedisHelper<MyHelper1> {}
public abstract class MyHelper2 : RedisHelper<MyHelper2> {}

MyHelper1.Initialization(new CSRedisClient("...."));
MyHelper2.Initialization(new CSRedisClient("...."));

Subscribe/Publish

//Native subscribe
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");

参考资料：【由浅至深】redis 实现发布订阅的几种方式

CacheShell

//不加缓存的时候，要从数据库查询
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(p => p.Set("a", "1").Get("a"));

Benchmark

100,000 operations

StackExchange.Redis StringSet：7882ms
CSRedisCore Set：6101ms
-------------------
StackExchange.Redis StringGet：7729ms
CSRedisCore Get：5762ms
-------------------
StackExchange.Redis StringSetAsync：8094ms
CSRedisCore SetAsync：6315ms
-------------------
StackExchange.Redis StringGetAsync：7986ms
CSRedisClient GetAsync：4931ms
CSRedisCore GetAsync：5960ms
-------------------
CSRedisCore SetAsync(Task.WaitAll)：559ms
StackExchange.Redis StringSetAsync (concurrent Task.WaitAll)：172ms
-------------------
CSRedisCore GetAsync(Task.WaitAll)：435ms
StackExchange.Redis StringGetAsync (concurrent Task.WaitAll)：176ms

💕 Donation (捐赠)

感谢你的打赏

• Alipay

• WeChat

Thank

Original open source project: https://github.com/ctstone/csredis