在.NET Core中使用CSRedis

CSRedis

爲何選擇CSRedis

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

StackExchange.Redis 是免費版，可是內核在 .NETCore 運行有問題常常 Timeout，暫沒法解決；

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

在v3.0版本更新中，CSRedis中的全部方法名稱進行了調整，使其和redis-cli保持一致，若是你熟悉redis-cli的命令的話，CSRedis能夠直接上手，這樣學習成本就下降不少。

安裝CSRedis

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

開始以前

使用鏈接字符串建立redis實例，執行RedisHelper.Initialization()進行初始化。

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

若是你沒有給redis設置密碼，那麼直接寫上ip就行，不然的話要把password寫進鏈接字符串中。

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

而後就能夠進行redis操做了。

字符串(string)

since Redis keys are strings, when we use the string type as a value too, we are mapping a string to another string.

關於字符串的value：

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

其中，整數的取值範圍和系統的長整數取值範圍相同，在32位的操做系統上，整數就是32位的；在64位操做系統上，整數就是64位有符號整數。浮點數的取值範圍和IEEE 754標準的雙精度浮點數相同。

使用CSRedis進行簡單操做

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

// 根據鍵獲取對應的值
csredis.Get("hello");

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

在對同一個鍵屢次賦值時，該鍵的值是最後一次賦值時的值，實例中hello對應的值最終爲3。

因爲redis能夠對字符串的類型進行「識別」，因此除了對字符串進行增、刪、查、以外，咱們還能夠對整數類型進行自增、自減操做，對字節串的一部分進行讀取或者寫入。

/*    數值操做    */
csredis.Set("num-key", "24");

// value += 5
csredis.IncrBy("num-key",5); 
// output -> 29

// value -= 10
csredis.IncrBy("num-key", -10); 
// output -> 19

/*    字節串操做    */
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"

非正常狀況

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

列表(list)

The speed of adding a new element with the LPUSH command to the head of a list with ten elements is the same as adding an element to the head of list with 10 million elements.

使用LPUSH命令，向包含10個元素的列表添加新元素的速度等於向包含一千萬個元素的列表添加新元素的速度。

• 列表能夠有序的存儲多個字符串（字符串能夠重複）等操做；
• 列表是經過鏈表來實現的，因此它添加新元素的速度很是快。

// 從右端推入元素
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);

除了對列表中的元素進行以上簡單的處理以外，還能夠將一個列表中的元素複製到另外一個列表中。在語義上，列表的左端默認爲「頭部」，列表的右端爲「尾部」。

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

集合(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");

以上是對一個集合中的元素進行操做，除此以外還能夠對兩個集合進行交、並、差操做

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將操做後的結果存儲在新的集合中。

散列(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);
}

HGet和HSet方法執行一次只能處理一個鍵值對，而HMGet和HMSet是他們的多參數版本，一次能夠處理多個鍵值對。

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

雖然使用HGetAll能夠取出全部的value，可是有時候散列包含的值可能很是大，容易形成服務器的堵塞，爲了不這種狀況，咱們可使用HKeys取到散列的全部鍵(HVals能夠取出全部值)，而後再使用HGet方法一個一個地取出鍵對應的值。

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分值，集合內的元素就是基於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還容許咱們爲key設置有效期，當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 -> ""

引用

• Redis命令參考
• Redis實戰
• An introduction to Redis data types and abstractions
• Redis管道
• .NET Core簡單且高級的庫
• Github:CSRedis