C#利用ServiceStack.Redis訪問Redis

概述

Redis【REmote DIctionary Server】作為當前比較流行的NoSql數據庫，以其高性能，高可用的的特點，應用越來越廣泛，深得各大企業和開發人員的青睞。 本文主要以一個簡單的小例子，簡述ServiceStack.Redis動態庫在Redis方面的相關應用，僅供學習分享使用，如有不足之處，還請指正。

開發環境

相關開發環境，如下所示：

• Microsoft Visual Studio Community 2019
• ServiceStack.Redis 動態庫
• Redis 6.0.9 服務器端環境搭建

ServiceStack.Redis的安裝

在C#開發中，主要通過NuGet包管理器，來安裝ServiceStack.Redis動態庫，目前版本為5.10.4，如下所示：

 

示例截圖

關於C#調用Redis相關示例截圖，如下所示：

核心代碼

關於Redis操作的核心代碼，主要分兩部分：Redis客戶端管理類，Redis客戶端操作類。

Redis客戶端管理類，主要通過Redis客戶端連接池【PooledRedisClientManager】創建客戶端對象【IRedisClient】，如下所示：

using ServiceStack.Redis;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace DemoRedis
{
    /// <summary>
    /// Redis客戶端管理類
    /// </summary>
    public static class RedisManager
    {
        private static PooledRedisClientManager clientManager;

        /// <summary>
        /// 初始化信息
        /// </summary>
        private static void initInfo()
        {
            string ipaddr = System.Configuration.ConfigurationManager.AppSettings["ipaddr"];
            string port = System.Configuration.ConfigurationManager.AppSettings["port"];
            string host = string.Format("{0}:{1}", ipaddr, port);
            initInfo(new string[] { host }, new string[] { host });
        }

        /// <summary>
        /// 初始化Redis客戶端管理
        /// </summary>
        /// <param name="readWriteHosts"></param>
        /// <param name="readOnlyHosts"></param>
        private static void initInfo(string[] readWriteHosts, string[] readOnlyHosts)
        {
            clientManager = new PooledRedisClientManager(readWriteHosts, readOnlyHosts, new RedisClientManagerConfig
            {
                MaxWritePoolSize = 5, // “寫”鏈接池鏈接數 
                MaxReadPoolSize = 5, // “讀”鏈接池鏈接數 
                AutoStart = true,
            });
        }

        public static IRedisClient getRedisClient()
        {
            if (clientManager == null)
            {
                initInfo();
            }
            return clientManager.GetClient();
        }

    }


}

Redis客戶端操作類，主要包括字符串（String），列表（List），哈希結構（Hash）,集合（Set），有序集合（Sorted Set）等相關操作功能的封裝，如下所示：

using ServiceStack.Redis;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace DemoRedis
{
    public class RedisHelper:IDisposable
    {
        private IRedisClient client;

        public RedisHelper()
        {

        }

        public RedisHelper(IRedisClient client ) {
            this.client = client;
        }

        #region 字符串

        public List<string> getAllKeys()
        {
            return this.client.GetAllKeys();
        }

        /// <summary>
        /// 設置值
        /// </summary>
        /// <param name="key"></param>
        /// <param name="value"></param>
        public void setString(string key,string value)
        {
            this.client.Set(key, value);
        }

        /// <summary>
        /// 設置值，帶過期時間
        /// </summary>
        /// <param name="key"></param>
        /// <param name="value"></param>
        /// <param name="expiresIn"></param>
        public void setString(string key, string value,TimeSpan expiresIn)
        {
            this.client.Set(key, value, expiresIn);
        }

        /// <summary>
        /// 是否存在
        /// </summary>
        /// <param name="key"></param>
        /// <returns></returns>
        public bool containsKey(string key)
        {
            return this.client.ContainsKey(key);
        }

        /// <summary>
        /// 設置字典
        /// </summary>
        /// <param name="dic"></param>
        public void setAll(Dictionary<string,string> dic)
        {
            this.client.SetAll(dic);
        }

        /// <summary>
        /// 返回舊值，設置新值
        /// </summary>
        /// <param name="key"></param>
        /// <param name="value"></param>
        /// <returns></returns>
        public string getAndSetValue(string key,string value) {
           return this.client.GetAndSetValue(key, value);
        }

        /// <summary>
        /// 獲取對應的值
        /// </summary>
        /// <param name="key"></param>
        /// <returns></returns>
        public string getValue(string key) {
            return this.client.GetValue(key);
        }

        public string getRandomKey()
        {
            return this.client.GetRandomKey();
        }

        /// <summary>
        /// 追加值到現有key中
        /// </summary>
        /// <param name="key"></param>
        /// <param name="value"></param>
        public void appendToValue(string key, string value) {
            this.client.AppendToValue(key, value);
        }

        #endregion

        #region List

        /// <summary>
        /// （隊列操作）增加一個值到列表
        /// </summary>
        /// <param name="listId"></param>
        /// <param name="value"></param>
        public void enqueueItemOnList(string listId ,string value)
        {
            this.client.EnqueueItemOnList(listId, value);
        }

        /// <summary>
        /// 從隊列中出一個
        /// </summary>
        /// <param name="listId"></param>
        /// <returns></returns>
        public string dequeueItemFromList(string listId)
        {
            return this.client.DequeueItemFromList(listId);
        }

        /// <summary>
        /// 棧，增加一個值到列表
        /// </summary>
        /// <param name="listId"></param>
        /// <param name="value"></param>
        public void pushItemToList(string listId, string value) {
            this.client.PushItemToList(listId, value);
        }

        /// <summary>
        /// 棧，從當前列表中出一個值，並返回
        /// </summary>
        /// <param name="listId"></param>
        /// <returns></returns>
        public string popItemFromList(string listId)
        {
            return this.client.PopItemFromList(listId);
        }


        /// <summary>
        /// 獲取某一個位置的值
        /// </summary>
        /// <param name="listId"></param>
        /// <param name="index"></param>
        /// <returns></returns>
        public string getItemFromList(string listId, int index)
        {
            return this.client.GetItemFromList(listId, index);
        }

        /// <summary>
        /// 設置並修改指定位置的值
        /// </summary>
        /// <param name="listId"></param>
        /// <param name="index"></param>
        /// <param name="value"></param>
        public void setItemInList(string listId, int index,string value)
        {
            this.client.SetItemInList(listId, index, value);
        }


        /// <summary>
        /// 獲取列表所有的值
        /// </summary>
        /// <param name="listId"></param>
        /// <returns></returns>
        public List<string> getAllItemsFromList(string listId) {
            return this.client.GetAllItemsFromList(listId);
        }

        /// <summary>
        /// 刪除所有內容
        /// </summary>
        /// <param name="listId"></param>
        public void removeAllFromList(string listId) {
            this.client.RemoveAllFromList(listId);
        }

        /// <summary>
        /// 刪除列表指定元素
        /// </summary>
        /// <param name="listId"></param>
        /// <param name="attr"></param>
        public void removeItemFromList(string listId, string value) {
            this.client.RemoveItemFromList(listId, value);
        }

        /// <summary>
        /// 獲取指定列表的長度
        /// </summary>
        /// <param name="listId"></param>
        /// <returns></returns>
        public long getListCount(string listId) {
            return this.client.GetListCount(listId);
        }

        #endregion

        #region Hash

        /// <summary>
        /// 設置Hash的值
        /// </summary>
        /// <param name="hashId"></param>
        /// <param name="key"></param>
        /// <param name="value"></param>
        /// <returns></returns>
        public bool setEntryInHash(string hashId, string key, string value)
        {
            return this.client.SetEntryInHash(hashId, key, value);
        }

        /// <summary>
        /// 獲取Hash中的值
        /// </summary>
        /// <param name="hashId"></param>
        /// <param name="key"></param>
        /// <returns></returns>
        public string getValueFromHash(string hashId, string key)
        {
            return this.client.GetValueFromHash(hashId, key);
        }

        /// <summary>
        /// 獲取Hash列表中的所有內容
        /// </summary>
        /// <param name="hashId"></param>
        public Dictionary<string,string> getAllEntriesFromHash(string hashId)
        {
            return this.client.GetAllEntriesFromHash(hashId);
        }

        /// <summary>
        /// 判斷Hash是否存在指定的鍵
        /// </summary>
        /// <param name="hashId"></param>
        /// <param name="key"></param>
        /// <returns></returns>
        public bool hashContainsEntry(string hashId, string key)
        {
            return this.client.HashContainsEntry(hashId, key);
        }

        /// <summary>
        /// 設置多個值到Hash
        /// </summary>
        /// <param name="hashId"></param>
        /// <param name="keyValuePairs"></param>
        public void setRangeInHash(string hashId,Dictionary<string,string> keyValuePairs) {
            this.client.SetRangeInHash(hashId, keyValuePairs);
        }

        /// <summary>
        /// 獲取Hash列表的長度
        /// </summary>
        /// <param name="hashId"></param>
        /// <returns></returns>
        public long getHashCount(string hashId) {
            return this.client.GetHashCount(hashId);
        }

        /// <summary>
        /// 刪除某一個值
        /// </summary>
        /// <param name="hashId"></param>
        /// <param name="key"></param>
        /// <returns></returns>
        public bool removeEntryFromHash(string hashId,string key) {
            return this.client.RemoveEntryFromHash(hashId, key);
        }
      
        #endregion

        #region Set

        /// <summary>
        /// 從Set中獲取隨機值
        /// </summary>
        /// <param name="setId"></param>
        /// <returns></returns>
        public string getRandomItemFromSet(string setId)
        {
            return this.client.GetRandomItemFromSet(setId);
        }

        /// <summary>
        /// 獲取所有的值
        /// </summary>
        /// <param name="setId"></param>
        /// <returns></returns>
        public HashSet<string> getAllItemsFromSet(string setId)
        {
           return this.client.GetAllItemsFromSet(setId);
        }

        /// <summary>
        /// 獲取set的長度
        /// </summary>
        /// <param name="setId"></param>
        /// <returns></returns>
        public long getSetCount(string setId)
        {
            return this.client.GetSetCount(setId);
        }

        /// <summary>
        /// 刪除某一項
        /// </summary>
        /// <param name="setId"></param>
        /// <param name="item"></param>
        public void removeItemFromSet(string setId,string item) {
            this.client.RemoveItemFromSet(setId, item);
        }

        /// <summary>
        /// 新增內容
        /// </summary>
        /// <param name="setId"></param>
        /// <param name="item"></param>
        public void addItemToSet(string setId, string item) {
            this.client.AddItemToSet(setId, item);
        }

        /// <summary>
        /// 增加列表到Set
        /// </summary>
        /// <param name="setId"></param>
        /// <param name="items"></param>
        public void addRangeToSet(string setId,List<string> items) {
            this.client.AddRangeToSet(setId, items);
        }

        #endregion

        #region zset

        /// <summary>
        /// 添加元素到排序集合
        /// </summary>
        /// <param name="setId"></param>
        /// <param name="value"></param>
        /// <returns></returns>
        public bool addItemToSortedSet(string setId,string value) {
            return this.client.AddItemToSortedSet(setId, value);
        }

        /// <summary>
        /// 添加元素到排序集合
        /// </summary>
        /// <param name="setId"></param>
        /// <param name="value"></param>
        /// <param name="score"></param>
        /// <returns></returns>
        public bool addItemToSortedSet(string setId, string value,double score)
        {
            return this.client.AddItemToSortedSet(setId, value,score);
        }

        /// <summary>
        /// 增加列表到排序集合
        /// </summary>
        /// <param name="setId"></param>
        /// <param name="values"></param>
        /// <param name="score"></param>
        /// <returns></returns>
        public bool addRangeToSortedSet(string setId,List<string> values, double score) {
           return  this.client.AddRangeToSortedSet(setId, values, score);
        }

        /// <summary>
        /// 增加列表到排序集合
        /// </summary>
        /// <param name="setId"></param>
        /// <param name="values"></param>
        /// <param name="score"></param>
        /// <returns></returns>
        public bool addRangeToSortedSet(string setId, List<string> values, long score)
        {
            return this.client.AddRangeToSortedSet(setId, values, score);
        }

        /// <summary>
        /// 獲取所有的集合內容
        /// </summary>
        /// <param name="setId"></param>
        /// <returns></returns>
        public List<string> getAllItemsFromSortedSet(string setId) {
            return this.client.GetAllItemsFromSortedSet(setId);
        }

        /// <summary>
        /// 倒序獲取所有的內容
        /// </summary>
        /// <param name="setId"></param>
        /// <returns></returns>
        public List<string> getAllItemsFromSortedSetDesc(string setId) {
            return this.client.GetAllItemsFromSortedSetDesc(setId);
        }

        /// <summary>
        /// 帶分數一起取出
        /// </summary>
        /// <param name="setId"></param>
        /// <returns></returns>
        public IDictionary<string, double> getAllWithScoresFromSortedSet(string setId)
        {
            return this.client.GetAllWithScoresFromSortedSet(setId);
        }

        /// <summary>
        /// 獲取對應值的位置
        /// </summary>
        /// <param name="setId"></param>
        /// <param name="value"></param>
        /// <returns></returns>
        public long getItemIndexInSortedSet(string setId,string value)
        {
            return this.client.GetItemIndexInSortedSet(setId, value);
        }

        /// <summary>
        /// 倒序的位置
        /// </summary>
        /// <param name="setId"></param>
        /// <param name="value"></param>
        /// <returns></returns>
        public long getItemIndexInSortedSetDesc(string setId, string value) {
           return this.client.GetItemIndexInSortedSetDesc(setId, value);
        }

        /// <summary>
        /// 獲取對應元素的分數
        /// </summary>
        /// <param name="setId"></param>
        /// <param name="value"></param>
        /// <returns></returns>
        public double getItemScoreInSortedSet(string setId, string value) {
            return this.client.GetItemScoreInSortedSet(setId, value);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="setId"></param>
        /// <param name="fromRank"></param>
        /// <param name="toRank"></param>
        /// <returns></returns>
        public List<string> getRangeFromSortedSet(string setId, int fromRank, int toRank) {
           return  this.client.GetRangeFromSortedSet(setId, fromRank, toRank);
        }

        public IDictionary<string, double> getRangeWithScoresFromSortedSet(string setId, int fromRank, int toRank) {
            return this.client.GetRangeWithScoresFromSortedSet(setId, fromRank, toRank);
        }

        public void Dispose()
        {
            if(this.client != null)
            {
                this.client.Dispose();
            }
        }
        #endregion
    }
}

關於前端調用功能，主要是各個按鈕對應的事件，如下所示：

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace DemoRedis
{
    public partial class FrmMain : Form
    {

        private RedisHelper redisHelper;

        public FrmMain()
        {
            InitializeComponent();
        }

        /// <summary>
        /// 加載
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void FrmMain_Load(object sender, EventArgs e)
        {
            this.redisHelper = new RedisHelper(RedisManager.getRedisClient());
        }

        /// <summary>
        /// 獲取所有的Key
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void btnAllKey_Click(object sender, EventArgs e)
        {
            List<string> keys = this.redisHelper.getAllKeys();
            this.combKeys.Items.AddRange(keys.ToArray());
            this.combKeys.SelectedIndex = 0;
        }

        private void btnSetString_Click(object sender, EventArgs e)
        {
            string key = this.txtKey1.Text;
            string value = this.txtValue1.Text;
            if (string.IsNullOrEmpty(key) || string.IsNullOrEmpty(value))
            {
                return;
            }
            this.redisHelper.setString(key, value);
            MessageBox.Show("設置成功");
        }

        private void btnGetString_Click(object sender, EventArgs e)
        {
            string key = this.txtKey2.Text;
            if (string.IsNullOrEmpty(key))
            {
                return;
            }
            string value = this.redisHelper.getValue(key);
            if (string.IsNullOrEmpty(value)) {
                MessageBox.Show("讀取失敗，值為空");
            }
            else
            {
                this.txtValue2.Text = value;
            }
        }

        private void btnAppend_Click(object sender, EventArgs e)
        {
            string key = this.txtKey3.Text;
            string value = this.txtValue3.Text;
            if (string.IsNullOrEmpty(key) || string.IsNullOrEmpty(value)) {
                return;
            }
            this.redisHelper.appendToValue(key, value);
            MessageBox.Show("追加成功");
        }

        private void btnAddItemToHash_Click(object sender, EventArgs e)
        {
            string hashId = this.txtHashId1.Text;
            string attr = this.txtHashAttr1.Text;
            string value = this.txtHashVal1.Text;
            if (string.IsNullOrEmpty(hashId) || string.IsNullOrEmpty(attr) || string.IsNullOrEmpty(value))
            {
                return;
            }
            if (this.redisHelper.setEntryInHash(hashId, attr, value))
            {
                MessageBox.Show("設置成功");
            }
            else {
                MessageBox.Show("設置失敗");
            }
        }

        private void btnGetItemFromHash_Click(object sender, EventArgs e)
        {
            string hashId = this.txtHashId2.Text;
            string attr = this.txtHashAttr2.Text;
            if (string.IsNullOrEmpty(hashId) || string.IsNullOrEmpty(attr) )
            {
                return;
            }
            string value = this.redisHelper.getValueFromHash(hashId, attr);
            if (string.IsNullOrEmpty(value))
            {
                MessageBox.Show("獲取失敗");
            }
            else
            {
                this.txtHashVal2.Text = value;
            }
        }

        private void btnGetHashCount_Click(object sender, EventArgs e)
        {
            string hashId = this.txtHashId3.Text;
            if (string.IsNullOrEmpty(hashId))
            {
                return;
            }
            long count = this.redisHelper.getHashCount(hashId);
            if (count > 0)
            {
                MessageBox.Show("長度為：" + count);
            }
            else {
                MessageBox.Show("獲取失敗");
            }
        }

        private void btnHashContainsEntry_Click(object sender, EventArgs e)
        {
            string hashId = this.txtHashId3.Text;
            string attr = this.txtHashAttr3.Text;
            if (string.IsNullOrEmpty(hashId) || string.IsNullOrEmpty(attr))
            {
                return;
            }
            bool flag =  this.redisHelper.hashContainsEntry(hashId, attr);
            if (flag) {
                MessageBox.Show("存在");
            }
            else
            {
                MessageBox.Show("不存在");
            }
        }

        private void btnRemoveEntryFromHash_Click(object sender, EventArgs e)
        {
            string hashId = this.txtHashId3.Text;
            string attr = this.txtHashAttr3.Text;
            if (string.IsNullOrEmpty(hashId) || string.IsNullOrEmpty(attr))
            {
                return;
            }
            bool flag = this.redisHelper.removeEntryFromHash(hashId, attr);
            if (flag)
            {
                MessageBox.Show("刪除成功");
            }
            else
            {
                MessageBox.Show("刪除失敗");
            }
        }

        private void btnEnqueueItemToList_Click(object sender, EventArgs e)
        {
            string listId = this.txtListId1.Text;
            string item = this.txtListItem1.Text;
            if (string.IsNullOrEmpty(listId) || string.IsNullOrEmpty(item))
            {
                return;
            }
            this.redisHelper.enqueueItemOnList(listId, item);
            MessageBox.Show("入隊成功");
        }

        private void btnPushItemToList_Click(object sender, EventArgs e)
        {
            string listId = this.txtListId2.Text;
            string item = this.txtListItem2.Text;
            if (string.IsNullOrEmpty(listId) || string.IsNullOrEmpty(item))
            {
                return;
            }
            this.redisHelper.pushItemToList(listId, item);
            MessageBox.Show("入棧成功");
        }

        private void btnGetItemFromList_Click(object sender, EventArgs e)
        {
            string listId = this.txtListId3.Text;
            string index =  this.txtListIndex3.Text;
            if (string.IsNullOrEmpty(listId) || string.IsNullOrEmpty(index))
            {
                return;
            }
            string value = this.redisHelper.getItemFromList(listId, int.Parse(index));
            if (string.IsNullOrEmpty(value))
            {
                MessageBox.Show("值為：" + value);
            }
            else
            {
                MessageBox.Show("獲取失敗");
            }
        }

        private void btnRemoveItemFromList_Click(object sender, EventArgs e)
        {
            string listId = this.txtListId4.Text;
            string item = this.txtListItem4.Text;
            if (string.IsNullOrEmpty(listId) || string.IsNullOrEmpty(item))
            {
                return;
            }
            this.redisHelper.removeItemFromList(listId, item);
            MessageBox.Show("刪除成功");
        }

        private void btnAddItemToSet_Click(object sender, EventArgs e)
        {
            string setId = this.txtSetId1.Text;
            string item = this.txtSetItem1.Text;
            if (string.IsNullOrEmpty(setId) || string.IsNullOrEmpty(item))
            {
                return;
            }
            this.redisHelper.addItemToSet(setId, item);
            MessageBox.Show("添加成功");
        }

        private void btnGetSetCount_Click(object sender, EventArgs e)
        {
            string setId = this.txtSetId1.Text;
            if (string.IsNullOrEmpty(setId))
            {
                return;
            }
            long count = this.redisHelper.getSetCount(setId);
            if (count > 0)
            {
                MessageBox.Show("長度為：" + count);
            }
            else
            {
                MessageBox.Show("獲取失敗");
            }
        }

        private void btnAddItemToSortSet_Click(object sender, EventArgs e)
        {
            string setId = this.txtZsetId1.Text;
            string item = this.txtZsetItem1.Text;
            if (string.IsNullOrEmpty(setId) || string.IsNullOrEmpty(item))
            {
                return;
            }
            bool flag = this.redisHelper.addItemToSortedSet(setId, item);
            if (flag)
            {
                MessageBox.Show("添加成功");
            }
            else
            {
                MessageBox.Show("添加失敗");
            }
        }

        private void btnGetScoreByValue_Click(object sender, EventArgs e)
        {
            string setId = this.txtZsetId2.Text;
            string item = this.txtZsetItem2.Text;
            if (string.IsNullOrEmpty(setId) || string.IsNullOrEmpty(item))
            {
                return;
            }
            double score = this.redisHelper.getItemScoreInSortedSet(setId, item);
            MessageBox.Show("分數為：" + score);
        }

        private void btnAddItemWithScoreToZset_Click(object sender, EventArgs e)
        {
            string setId = this.txtZsetId2.Text;
            string item = this.txtZsetItem2.Text;
            string score = this.txtZsetScore2.Text;
            if (string.IsNullOrEmpty(setId) || string.IsNullOrEmpty(item) || string.IsNullOrEmpty(score))
            {
                return;
            }
            bool flag = this.redisHelper.addItemToSortedSet(setId, item,double.Parse(score));
            if (flag)
            {
                MessageBox.Show("添加成功");
            }
            else
            {
                MessageBox.Show("添加失敗");
            }
        }
    }
}

 

注意事項

如果在Redis服務端和客戶端不在同一個電腦上，可能會出現無法訪問的情況，前端報連接超時錯誤。則可能是服務端防火牆限制。需要執行如下命令即可：

[root@localhost bin]# /sbin/iptables -I INPUT -p tcp --dport 6379 -j ACCEPT

另外Redis.conf配置文件中，關於bind配置，默認bind為127.0.0.1只允許本機訪問，需要修改，如下所示：

# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
bind 127.0.0.1 192.168.127.131

其中：192.168.127.131 為服務器IP地址。

備注

使至塞上

朝代：唐代 | 作者：王維

單車欲問邊，屬國過居延。
征蓬出漢塞，歸雁入胡天。
大漠孤煙直，長河落日圓。
蕭關逢候騎，都護在燕然。