在.NET?Core中使用CSRedis的詳細(xì)過程

更新時間：2022年06月21日 14:53:12 作者：XSCAPE'

這篇文章主要介紹了在.NET?Core中使用CSRedis的相關(guān)知識，本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下

CSRedis

為什么選擇CSRedis

ServiceStack.Redis 是商業(yè)版，免費版有限制；

StackExchange.Redis 是免費版，但是內(nèi)核在 .NETCore 運行有問題經(jīng)常 Timeout，暫無法解決；

CSRedis于2016年開始支持.NETCore一直迭代至今，實現(xiàn)了低門檻、高性能，和分區(qū)高級玩法的.NETCore redis-cli SDK；

在v3.0版本更新中，CSRedis中的所有方法名稱進行了調(diào)整，使其和redis-cli保持一致，如果你熟悉redis-cli的命令的話，CSRedis可以直接上手，這樣學(xué)習(xí)成本就降低很多。

安裝CSRedis

直接使用Visual Studio中的Nuget包管理器搜索安裝

開始之前

使用連接字符串創(chuàng)建redis實例，執(zhí)行RedisHelper.Initialization()進行初始化。

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

如果你沒有給redis設(shè)置密碼，那么直接寫上ip就行，否則的話要把password寫進連接字符串中。

var csredis = new CSRedisClient("127.0.0.1:6379");
RedisHelper.Initialization(csredis);

然后就可以進行redis操作了。

字符串(string)

關(guān)于字符串的value：

value可以用來存儲任意格式的數(shù)據(jù)，如json、jpg甚至是視頻文件；
value的最大容量是512M；
value可以存儲3種類型的值：字節(jié)串（byte string）、整數(shù)（int）、浮點數(shù)（double）；

其中，整數(shù)的取值范圍和系統(tǒng)的長整數(shù)取值范圍相同，在32位的操作系統(tǒng)上，整數(shù)就是32位的；在64位操作系統(tǒng)上，整數(shù)就是64位有符號整數(shù)。浮點數(shù)的取值范圍和IEEE 754標(biāo)準(zhǔn)的雙精度浮點數(shù)相同。

使用CSRedis進行簡單操作

// 添加字符串鍵-值對
csredis.Set("hello", "1");
csredis.Set("world", "2");
csredis.Set("hello", "3");
// 根據(jù)鍵獲取對應(yīng)的值
csredis.Get("hello");
// 移除元素
csredis.Del("world");

在對同一個鍵多次賦值時，該鍵的值是最后一次賦值時的值，實例中hello對應(yīng)的值最終為3。

由于redis可以對字符串的類型進行“識別”，所以除了對字符串進行增、刪、查、之外，我們還可以對整數(shù)類型進行自增、自減操作，對字節(jié)串的一部分進行讀取或者寫入。

/*    數(shù)值操作    */
csredis.Set("num-key", "24");
// value += 5
csredis.IncrBy("num-key",5); 
// output -> 29
// value -= 10
csredis.IncrBy("num-key", -10); 
// output -> 19

/*    字節(jié)串操作    */
csredis.Set("string-key", "hello ");
// 在指定key的value末尾追加字符串
csredis.Append("string-key", "world"); 
// output -> "hello world"
// 獲取從指定范圍所有字符構(gòu)成的子串（start:3,end:7）
csredis.GetRange("string-key",3,7)  
// output ->  "lo wo"
// 用新字符串從指定位置覆寫原value（index:4）
csredis.SetRange("string-key", 4, "aa"); 
// output -> "hellaaword"

非正常情況

對字節(jié)串進行自增、自減操作時，redis會報錯。
使用Append、SetRange方法對value進行寫入時，字節(jié)串的長度可能不夠用，這時redis會使用空字符(null)將value擴充到指定長度，然后再進行寫入操作。

列表(list)

列表可以有序的存儲多個字符串（字符串可以重復(fù)）等操作；
列表是通過鏈表來實現(xiàn)的，所以它添加新元素的速度非常快。

// 從右端推入元素
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);
}
// 按索引值獲取元素（當(dāng)索引值大于鏈表長度，返回空值，不會報錯）
Console.WriteLine($"{csredis.LIndex("my-list", 1)}"); 

// 修剪指定范圍內(nèi)的元素（start:4,end:10）
csredis.LTrim("my-list", 4, 10);

除了對列表中的元素進行以上簡單的處理之外，還可以將一個列表中的元素復(fù)制到另一個列表中。在語義上，列表的左端默認(rèn)為“頭部”，列表的右端為“尾部”。

// 將my-list最后一個元素彈出并壓入another-list的頭部
csredis.RPopLPush("my-list", "another-list");

集合(set)

集合以無序的方式存儲各不相同的元素，也就是說在集合中的每個元素的Key都不重復(fù)。在redis中可以快速地對集合執(zhí)行添加、移除等操作。

// 實際上只插入了兩個元素("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");

以上是對一個集合中的元素進行操作，除此之外還可以對兩個集合進行交、并、差操作

csredis.SAdd("set-a", "item1", "item2", "item3","item4","item5");
csredis.SAdd("set-b", "item2", "item5", "item6", "item7");

// 差集
csredis.SDiff("set-a", "set-b"); 
// output -> "item1", "item3","item4"

// 交集
csredis.SInter("set-a", "set-b"); 
// output -> "item2","item5"

// 并集
csredis.SUnion("set-a", "set-b");
// output -> "item1","item2","item3","item4","item5","item6","item7"

另外還可以用SDiffStore,SInterStore,SUnionStore將操作后的結(jié)果存儲在新的集合中。

散列(hashmap)

在redis中我們可以使用散列將多個鍵-值對存儲在一個redis鍵上，從而達到將一系列相關(guān)數(shù)據(jù)存放在一起的目的。例如添加一個redis鍵Article:1001,然后在這個鍵中存放ID為1001的文章的標(biāo)題、作者、鏈接、點贊數(shù)等信息。我們可以把這樣數(shù)據(jù)集看作是關(guān)系數(shù)據(jù)庫中的行。

// 向散列添加元素
csredis.HSet("ArticleID:10001", "Title", "在.NET Core中使用CSRedis");
csredis.HSet("ArticleID:10001", "Author", "xscape");
csredis.HSet("ArticleID:10001", "PublishTime", "2019-01-01");
csredis.HSet("ArticleID:10001", "Link","https://www.cnblogs.com/xscape/p/10208638.html");

// 根據(jù)Key獲取散列中的元素
csredis.HGet("ArticleID:10001", "Title");

// 獲取散列中的所有元素
foreach (var item in csredis.HGetAll("ArticleID:10001"))
{
    Console.WriteLine(item.Value);
}

HGet和HSet方法執(zhí)行一次只能處理一個鍵值對，而HMGet和HMSet是他們的多參數(shù)版本，一次可以處理多個鍵值對。

var keys = new string[] { "Title","Author","publishTime"};
csredis.HMGet("ID:10001", keys);

雖然使用HGetAll可以取出所有的value，但是有時候散列包含的值可能非常大，容易造成服務(wù)器的堵塞，為了避免這種情況，我們可以使用HKeys取到散列的所有鍵(HVals可以取出所有值)，然后再使用HGet方法一個一個地取出鍵對應(yīng)的值。

foreach (var item in csredis.HKeys("ID:10001"))
{
	Console.WriteLine($"{item} - {csredis.HGet("ID:10001", item)}");
}

和處理字符串一樣，我們也可以對散列中的值進行自增、自減操作，原理同字符串是一樣的。

csredis.HSet("ArticleID:10001", "votes", "257");
csredis.HIncrBy("ID:10001", "votes", 40);
// output -> 297

有序集合

有序集合可以看作是可排序的散列，不過有序集合的val成為score分值，集合內(nèi)的元素就是基于score進行排序的，score以雙精度浮點數(shù)的格式存儲。

// 向有序集合添加元素
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"));

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

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

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

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

事務(wù)

基本事務(wù)

事務(wù)可以保證一個客戶端在執(zhí)行多條命令時，不被其他客戶端打斷，這跟關(guān)系型數(shù)據(jù)庫的事務(wù)是不一樣的。事務(wù)需要使用MULTI和EXEC命令，redis會將被MULTI和EXEC所包圍的代碼依次執(zhí)行，當(dāng)該事務(wù)結(jié)束之后，redis才會處理其他客戶端的命令。

管道(pipeline)

redis的事務(wù)是通過pipeline實現(xiàn)的，使用pipeline時，客戶端會自動調(diào)用MULTI和EXEX命令，將多條命令打包并一次性地發(fā)送給redis，然后redis再將命令的執(zhí)行結(jié)果全部打包并一次性返回給客戶端，這樣有效的減少了redis與客戶端的通信次數(shù)，提升執(zhí)行多次命令時的性能。

var pipe = csredis.StartPipe();
for (int i = 0; i < COUNT; i++)
{
    pipe.IncrBy("key-one"); // 將key-one中的值自增COUNT次，產(chǎn)生了COUNT條IncrBy命令
}
pipe.EndPipe(); // 在管道結(jié)束的位置，將COUNT條命令一次性發(fā)送給redis
Console.WriteLine($"{csredis.Get("key-one")}");
Console.ReadKey();

Key的過期

redis還允許我們?yōu)閗ey設(shè)置有效期，當(dāng)key過期之后，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 -> ""