.NETCORE CSRedis分布式缓存

Redis包选择

ServiceStack.Redis 是商业版，免费版有限制；

StackExchange.Redis 是免费版，但是内核在 .NETCore 运行有问题经常 Timeout，暂无法解决；

CSRedis于2016年开始支持.NETCore一直迭代至今，实现了低门槛、高性能，和分区高级玩法的.NETCore redis-cli SDK；

初始化

var csredis = new CSRedis.CSRedisClient("127.0.0.1:6379,password=xxxx");
RedisHelper.Initialization(csredis);

支持的数据类型

1、字符串

• value可以用来存储任意格式的数据，如json、jpg甚至是视频文件；
• value的最大容量是512M；
• value可以存储3种类型的值：字节串（byte string）、整数（int）、浮点数（double）；

// 添加字符串键-值对
csredis.Set("hello", "1");
csredis.Set("world", "2");
csredis.Set("hello", "3");

// 根据键获取对应的值
csredis.Get("hello");

// 移除元素
csredis.Del("world");

/*    字节串操作    */
csredis.Set("string-key", "hello ");

// 在指定key的value末尾追加字符串
csredis.Append("string-key", "world"); 
// output -> "hello world"

// 获取从指定范围所有字符构成的子串（start:3,end:7）
csredis.GetRange("string-key",3,7)  
// output ->  "lo wo"
    
// 用新字符串从指定位置覆写原value（index:4）
csredis.SetRange("string-key", 4, "aa"); 
// output -> "hellaaword"

2、列表list

• 列表可以有序的存储多个字符串（字符串可以重复）等操作；
• 列表是通过链表来实现的，所以它添加新元素的速度非常快。

// 从右端推入元素
csredis.RPush("my-list", "item1", "item2", "item3", "item4"); 
// 从右端弹出元素
csredis.RPop("my-list");
// 从左端推入元素
csredis.LPush("my-list","LeftPushItem");
// 从左端弹出元素
csredis.LPop("my-list");

// 遍历链表元素（start:0,end:-1即可返回所有元素）
foreach (var item in csredis.LRange("my-list", 0, -1))
{
    Console.WriteLine(item);
}
// 按索引值获取元素（当索引值大于链表长度，返回空值，不会报错）
Console.WriteLine($"{csredis.LIndex("my-list", 1)}"); 

// 修剪指定范围内的元素（start:4,end:10）
csredis.LTrim("my-list", 4, 10);

3、集合set

集合以无序的方式存储各不相同的元素，也就是说在集合中的每个元素的Key都不重复。在redis中可以快速地对集合执行添加、移除等操作。

// 实际上只插入了两个元素("item1","item2")
csredis.SAdd("my-set", "item1", "item1", "item2"); 

// 集合的遍历
foreach (var member in csredis.SMembers("my-set"))
{
    Console.WriteLine($"集合成员：{member.ToString()}");
}

// 判断元素是否存在
string member = "item1";
Console.WriteLine($"{member}是否存在:{csredis.SIsMember("my-set", member)}"); 
// output -> True

// 移除元素
csredis.SRem("my-set", member);
Console.WriteLine($"{member}是否存在:{csredis.SIsMember("my-set", member)}"); 
// output ->  False

// 随机移除一个元素
csredis.SPop("my-set");

4、散列表hashmap

在redis中我们可以使用散列将多个键-值对存储在一个redis键上，从而达到将一系列相关数据存放在一起的目的。例如添加一个redis键Article:1001,然后在这个键中存放ID为1001的文章的标题、作者、链接、点赞数等信息。我们可以把这样数据集看作是关系数据库中的行。

// 向散列添加元素
csredis.HSet("ArticleID:10001", "Title", "了解简单的Redis数据结构");
csredis.HSet("ArticleID:10001", "Author", "xscape");
csredis.HSet("ArticleID:10001", "PublishTime", "2019-01-01");

// 根据Key获取散列中的元素
csredis.HGet("ArticleID:10001", "Title");

// 获取散列中的所有元素
foreach (var item in csredis.HGetAll("ArticleID:10001"))
{
    Console.WriteLine(item.Value);
}
//效率高
foreach (var item in csredis.HKeys("ID:10001"))
{
    Console.WriteLine($"{item} - {csredis.HGet("ID:10001", item)}");
}

5、有序集合

有序集合可以看作是可排序的散列，不过有序集合的val成为score分值，集合内的元素就是基于score进行排序的，score以双精度浮点数的格式存储。

// 向有序集合添加元素
csredis.ZAdd("Quiz", (79, "Math"));
csredis.ZAdd("Quiz", (98, "English"));
csredis.ZAdd("Quiz", (87, "Algorithm"));
csredis.ZAdd("Quiz", (84, "Database"));
csredis.ZAdd("Quiz", (59, "Operation System"));

//返回集合中的元素数量
csredis.ZCard("Quiz");

// 获取集合中指定范围(90~100)的元素集合
csredis.ZRangeByScore("Quiz",90,100);

// 获取集合所有元素并升序排序
csredis.ZRangeWithScores("Quiz", 0, -1);

// 移除集合中的元素
csredis.ZRem("Quiz", "Math");

事务

基本事务

事务可以保证一个客户端在执行多条命令时，不被其他客户端打断，这跟关系型数据库的事务是不一样的。事务需要使用MULTI和EXEC命令，redis会将被MULTI和EXEC所包围的代码依次执行，当该事务结束之后，redis才会处理其他客户端的命令。

管道(pipeline)

redis的事务是通过pipeline实现的，使用pipeline时，客户端会自动调用MULTI和EXEX命令，将多条命令打包并一次性地发送给redis，然后redis再将命令的执行结果全部打包并一次性返回给客户端，这样有效的减少了redis与客户端的通信次数，提升执行多次命令时的性能。

var pl = csredis.StartPipe();
for (int i = 0; i < COUNT; i++)
{
    csredis.IncrBy("key-one");
}
pl.EndPipe();
Console.WriteLine($"{csredis.Get("key-one")}");
Console.ReadKey();

Key时间设置

redis.Set("MyKey", "hello,world");
Console.WriteLine(redis.Get("MyKey")); 
// output -> "hello,world"

redis.Expire("MyKey", 5); // key在5秒后过期，也可以使用ExpireAt方法让它在指定时间自动过期

Thread.Sleep(6000); // 线程暂停6秒
Console.WriteLine(redis.Get("MyKey"));
// output -> ""

---

分布式锁命令

► Setnx

命令：SETNX key value
说明：将 key 的值设为 value ，当且仅当 key 不存在。若给定的 key 已经存在，则 SETNX 不做任何动作。SETNX 是『SET if Not eXists』(如果不存在，则 SET)的简写。
时间复杂度：O(1)
返回值：设置成功，返回1 ； 设置失败，返回 0

► Getset

命令：GETSET key value
说明：将给定 key 的值设为 value ，并返回 key 的旧值(old value)。当 key 存在但不是字符串类型时，返回一个错误。
时间复杂度：O(1)
返回值：返回给定 key 的旧值; 当 key 没有旧值时，也即是， key 不存在时，返回 nil 。

► Expire

命令：EXPIRE key seconds
说明：为给定 key 设置生存时间，当 key 过期时(生存时间为 0 )，它会被自动删除。
时间复杂度：O(1)
返回值：设置成功返回 1 ；当 key 不存在或者不能为 key 设置生存时间时(比如在低于 2.1.3 版本的 Redis 中你尝试更新 key 的生存时间)，返回 0 。

► Del

命令：DEL key [key ...]
说明：删除给定的一个或多个 key 。不存在的 key 会被忽略。
时间复杂度：O(N); N 为被删除的 key 的数量。
删除单个字符串类型的 key ，时间复杂度为O(1)。
删除单个列表、集合、有序集合或哈希表类型的 key ，时间复杂度为O(M)， M 为以上数据结构内的元素数量。

返回值：被删除 key 的数量。

好了，命令熟悉之后，下面我们就开始一步一步实现分布式锁。

 

1、分布式锁结合时间戳

       static void Main(string[] args)
        {
            var lockTimeout = 5000;//单位是毫秒
            var currentTime = DateTime.Now.ToUnixTime(true);
            if (SetNx("lockkey", currentTime+ lockTimeout,lockTimeout))
            {
                //TODO:一些业务逻辑代码
                //.....
                //.....
                //最后释放锁
                Remove("lockkey");
            }
            else
            {
                Console.WriteLine("没有获得分布式锁");
            }
            Console.ReadKey();
        }

        public static bool SetNx(string key,long time ,double expireMS)
        {
            if (redisClient.SetNx(key, time))
            {
                if (expireMS > 0)
                    redisClient.Expire(key, TimeSpan.FromMilliseconds(expireMS));
                return true;
            }
            return false;
        }

        public static bool Remove(string key)
        {
            return redisClient.Del(key) > 0;
        }

Redis是单线程的并且setnx、expire是原子操作，但是先setnx再expire就不是原子操作，我们要考虑多线程环境和容器部署时多实例环境

2、分布式锁结合时间戳，考虑死锁

        public static void RedisLockV2()
        {
            var lockTimeout = 5000;//单位是毫秒
            var currentTime = DateTime.Now.ToUnixTime(true);

            if (SetNxV2("lockkey",DateTime.Now.ToUnixTime(true)+lockTimeout))
            {
                //设置过期时间
                redisClient.Expire("lockkey", TimeSpan.FromMilliseconds(5000));
                //TODO:一些业务逻辑代码
                
                Console.WriteLine("处理业务ing");
                Thread.Sleep(100000);

                Console.WriteLine("处理业务ed");
                //最后释放锁
                Remove("lockkey");
            }
            else
            {
                //未获取到锁，继续判断，判断时间戳看看是否可以重置并获取锁
                var lockValue = redisClient.Get("lockkey");
                var time = DateTime.Now.ToUnixTime(true);

                if (!string.IsNullOrEmpty(lockValue) &&  time> lockValue.ToInt64())
                {
                    //再次用当前时间戳getset
                    //返回固定key的旧值，旧值判断是否可以获取锁
                    var getsetResult = redisClient.GetSet("lockkey", time);
                    if (getsetResult == null || (getsetResult != null && getsetResult ==             lockValue))
                    {
                        Console.WriteLine("获取到Redis锁了");
                        //真正获取到锁
                        redisClient.Expire("lockkey", TimeSpan.FromMilliseconds(5000));
                        //TODO:一些业务逻辑代码
                        //.....
                        //.....
                        Console.WriteLine("处理业务");
                        //最后释放锁
                        Remove("lockkey");
                    }
                    else
                    {
                        Console.WriteLine("没有获取到锁");
                    }

                }
                else
                {
                    Console.WriteLine("没有获取到锁");
                }
            }
            
        }

过期时间设置为多少要结合你的具体业务处理时间来计算出一个合理的值