StackExchange.Redis幫助類解決方案RedisRepository封裝（字符串類型數據操做）

時間 2019-11-13

標籤 stackexchange.redis stackexchange redis 幫助解決方案 redisrepository 封裝字符串類型數據欄目 Redis 简体版

原文原文鏈接

本文版權歸博客園和做者本人共同全部，轉載和爬蟲請註明原文連接 http://www.cnblogs.com/tdws/tag/NoSql/html

1、基礎配置封裝git

2、String字符串類型數據操做封裝github

3、Hash散列類型數據操做封裝web

4、List列表類型數據操做封裝(建議自行封裝)redis

5、Set集合類型數據操做封裝(建議自行封裝)安全

6、Sort Set集合數據類型操做封裝(建議自行封裝)服務器

7、發佈訂閱（Pub/Sub）模式在StackExchange.Redis中的使用app

8、主從配置，哨兵相關配置函數

2、String字符串類型數據操做封裝

下面這段畫若是看一遍沒看懂，請看過代碼後再次來閱讀：this

咱們有必要先提到ConnectionMultiplexer類，它是StackExchange提供給咱們的一個類，它將多服務器的詳細信息隱藏，由於這個類爲咱們作了不少事情，它的設計目的是爲了在調用者間共享和重用。你不用每次操做都建立這樣一個ConnectionMultiplexer，它是徹底線程安全的。它擁有ConnectionMultiplexer.Connect和onnectionMultiplexer.ConnectAsync來連接Redis。連接參數是一個字符串或者一個ConfigurationOptions對象。這個類實現了IDisposable接口，你能夠在你不須要的時候釋放對象，經過using或者dispose。可是你不用常常來釋放它，由於咱們要常常複用。你有三種需求時，須要使用ConnectionMultiplexer，連接Redis,發佈訂閱模式，訪問一個單獨的服務器或者監控的目的。除了基本使用，更多的請看github文檔，https://github.com/StackExchange/StackExchange.Redis/blob/master/Docs/Basics.md

咱們在IRedisClient中定義以下String數據類型方法：

若是你以爲代碼太多，當VS按下快捷鍵ctrl+M+O吧

  1 #region 程序集 RedisRepository, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null
  2 // Author：吳雙  2016.8.28   聯繫郵箱 wscoder@outlook.com
  3 #endregion
  4 using System;
  5 using System.Collections.Generic;
  6 using StackExchange.Redis;
  7 
  8 namespace RedisRepository
  9 {
 10     public interface IRedisClient
 11     {
 12         #region Redis String類型操做
 13         /// <summary>
 14         /// Redis String類型 新增一條記錄
 15         /// </summary>
 16         /// <typeparam name="T">generic refrence type</typeparam>
 17         /// <param name="key">unique key of value</param>
 18         /// <param name="value">value of key of type object</param>
 19         /// <param name="expiresAt">time span of expiration</param>
 20         /// <param name= "when">枚舉類型</param>
 21         /// <param name="commandFlags"></param>
 22         /// <returns>true or false</returns>
 23         bool StringSet<T>(string key, object value, TimeSpan? expiry = default(TimeSpan?), When when = When.Always, CommandFlags commandFlags = CommandFlags.None) where T : class;
 24 
 25         /// <summary>
 26         /// Redis String類型 新增一條記錄
 27         /// </summary>
 28         /// <typeparam name="T">generic refrence type</typeparam>
 29         /// <param name="key">unique key of value</param>
 30         /// <param name="value">value of key of type object</param>
 31         /// <param name="expiresAt">time span of expiration</param>
 32         /// <param name= "when">枚舉類型</param>
 33         /// <param name="commandFlags"></param>
 34         /// <returns>true or false</returns>
 35         bool StringSet<T>(string key, T value, TimeSpan? expiry = default(TimeSpan?), When when = When.Always, CommandFlags commandFlags = CommandFlags.None) where T : class;
 36 
 37         /// <summary>
 38         /// 更新時應使用此方法，代碼更可讀。
 39         /// </summary>
 40         /// <typeparam name="T"></typeparam>
 41         /// <param name="key"></param>
 42         /// <param name="value"></param>
 43         /// <param name="expiresAt"></param>
 44         /// <param name="when"></param>
 45         /// <param name="commandFlags"></param>
 46         /// <returns></returns>
 47         bool StringUpdate<T>(string key, T value, TimeSpan expiresAt, When when = When.Always, CommandFlags commandFlags = CommandFlags.None) where T : class;
 48 
 49         /// <summary>
 50         /// Redis String類型  Get
 51         /// </summary>
 52         /// <typeparam name="T"></typeparam>
 53         /// <param name="key"></param>
 54         /// <param name="commandFlags"></param>
 55         /// <returns>T</returns>
 56         T StringGet<T>(string key, CommandFlags commandFlags = CommandFlags.None) where T : class;
 57 
 58         /// <summary>
 59         /// Redis String數據類型 獲取指定key中字符串長度
 60         /// </summary>
 61         /// <param name="key"></param>
 62         /// <param name="commandFlags"></param>
 63         /// <returns></returns>
 64         long StringLength(string key, CommandFlags commandFlags = CommandFlags.None);
 65 
 66         /// <summary>
 67         ///  Redis String數據類型  返回拼接後總長度
 68         /// </summary>
 69         /// <param name="key"></param>
 70         /// <param name="appendVal"></param>
 71         /// <param name="commandFlags"></param>
 72         /// <returns>總長度</returns>
 73         long StringAppend(string key, string appendVal, CommandFlags commandFlags = CommandFlags.None);
 74 
 75         /// <summary>
 76         /// 設置新值而且返回舊值
 77         /// </summary>
 78         /// <param name="key"></param>
 79         /// <param name="newVal"></param>
 80         /// <param name="commandFlags"></param>
 81         /// <returns>OldVal</returns>
 82         string StringGetAndSet(string key, string newVal, CommandFlags commandFlags = CommandFlags.None);
 83 
 84         /// <summary>
 85         /// 爲數字增加val
 86         /// </summary>
 87         /// <param name="key"></param>
 88         /// <param name="val"></param>
 89         /// <param name="commandFlags"></param>
 90         /// <returns>增加後的值</returns>
 91         double StringIncrement(string key, double val, CommandFlags commandFlags = CommandFlags.None);
 92 
 93         /// <summary>
 94         /// Redis String數據類型
 95         /// 相似於模糊查詢  key* 查出全部key開頭的鍵
 96         /// </summary>
 97         /// <typeparam name="T"></typeparam>
 98         /// <param name="key"></param>
 99         /// <param name="pageSize"></param>
100         /// <param name="commandFlags"></param>
101         /// <returns>返回List<T></returns>
102         List<T> StringGetList<T>(string key, int pageSize = 1000, CommandFlags commandFlags = CommandFlags.None) where T : class;
103         #endregion
104 
105 
106         #region Redis各數據類型公用
107 
108         /// <summary>
109         /// Redis中是否存在指定Key
110         /// </summary>
111         /// <param name="key"></param>
112         /// <param name="commandFlags"></param>
113         /// <returns></returns>
114         bool KeyExists(string key, CommandFlags commandFlags = CommandFlags.None);
115 
116         /// <summary>
117         /// 從Redis中移除鍵
118         /// </summary>
119         /// <param name="key"></param>
120         /// <param name="commandFlags"></param>
121         /// <returns></returns>
122         bool KeyRemove(string key, CommandFlags commandFlags = CommandFlags.None);
123 
124         /// <summary>
125         /// 從Redis中移除多個鍵
126         /// </summary>
127         /// <param name="keys"></param>
128         /// <param name="commandFlags"></param>
129         /// <returns></returns>
130         void KeyRemove(RedisKey[] keys, CommandFlags commandFlags = CommandFlags.None);
131 
132         /// <summary>
133         /// Dispose DB connection 釋放DB相關連接
134         /// </summary>
135         void DbConnectionStop();
136         #endregion
137     }
138 }

在RedisClient.cs中實現以下：

using System;
using System.Collections.Generic;
using System.Linq;
using Newtonsoft.Json;
using StackExchange.Redis;

namespace RedisRepository
{
    public class RedisClient : IRedisClient
    {


        #region 初始化

        private static readonly IDatabase _db;
        private static readonly ConnectionMultiplexer _redis;

        /// <summary>
        /// 構造函數，在其中註冊Redis事件
        /// </summary>
        static RedisClient()
        {
            const string configuration = "{0},abortConnect=false,defaultDatabase={1},ssl=false,ConnectTimeout={2},allowAdmin=true,connectRetry={3}";
            _redis = ConnectionMultiplexer
                .Connect(string.Format(configuration, RedisClientConfigurations.Url,
                    RedisClientConfigurations.DefaultDatabase, RedisClientConfigurations.ConnectTimeout,
                    RedisClientConfigurations.ConnectRetry));
            _redis.PreserveAsyncOrder = RedisClientConfigurations.PreserveAsyncOrder;
            //_redis.ConnectionFailed;
            _db = _redis.GetDatabase();
        }

        #endregion

        #region Redis String數據類型操做

        /// <summary>
        /// Redis String類型 新增一條記錄
        /// </summary>
        /// <typeparam name="T">generic refrence type</typeparam>
        /// <param name="key">unique key of value</param>
        /// <param name="value">value of key of type T</param>
        /// <param name="expiresAt">time span of expiration</param>
        /// <returns>true or false</returns>
        public bool StringSet<T>(string key, T value, TimeSpan? expiresAt = default(TimeSpan?), When when = When.Always, CommandFlags commandFlags = CommandFlags.None) where T : class
        {
            var stringContent = SerializeContent(value);
            return _db.StringSet(key, stringContent, expiresAt, when, commandFlags);
        }

        /// <summary>
        /// Redis String類型 新增一條記錄
        /// </summary>
        /// <typeparam name="T">generic refrence type</typeparam>
        /// <param name="key">unique key of value</param>
        /// <param name="value">value of key of type object</param>
        /// <param name="expiresAt">time span of expiration</param>
        /// <returns>true or false</returns>
        public bool StringSet<T>(string key, object value, TimeSpan? expiresAt = default(TimeSpan?), When when = When.Always, CommandFlags commandFlags = CommandFlags.None) where T : class
        {
            var stringContent = SerializeContent(value);

            return _db.StringSet(key, stringContent, expiresAt, when, commandFlags);
        }

        /// <summary>
        /// Redis String數據類型 獲取指定key中字符串長度
        /// </summary>
        /// <param name="key"></param>
        /// <returns></returns>
        public long StringLength(string key, CommandFlags commandFlags = CommandFlags.None)
        {
            return _db.StringLength(key, commandFlags);
        }

        /// <summary>
        ///  Redis String數據類型  返回拼接後總長度
        /// </summary>
        /// <param name="key"></param>
        /// <param name="appendVal"></param>
        /// <returns>總長度</returns>
        public long StringAppend(string key, string appendVal, CommandFlags commandFlags = CommandFlags.None)
        {
            return _db.StringAppend(key, appendVal, commandFlags);
        }

        /// <summary>
        /// 設置新值而且返回舊值
        /// </summary>
        /// <param name="key"></param>
        /// <param name="newVal"></param>
        /// <param name="commandFlags"></param>
        /// <returns>OldVal</returns>
        public string StringGetAndSet(string key, string newVal, CommandFlags commandFlags = CommandFlags.None)
        {
            return DeserializeContent<string>(_db.StringGetSet(key, newVal, commandFlags));
        }

        /// <summary>
        /// 更新時應使用此方法，代碼更可讀。
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="key"></param>
        /// <param name="value"></param>
        /// <param name="expiresAt"></param>
        /// <param name="when"></param>
        /// <param name="commandFlags"></param>
        /// <returns></returns>
        public bool StringUpdate<T>(string key, T value, TimeSpan expiresAt, When when = When.Always, CommandFlags commandFlags = CommandFlags.None) where T : class
        {
            var stringContent = SerializeContent(value);
            return _db.StringSet(key, stringContent, expiresAt, when, commandFlags);
        }

        /// <summary>
        /// 爲數字增加val
        /// </summary>
        /// <param name="key"></param>
        /// <param name="val">能夠爲負</param>
        /// <param name="commandFlags"></param>
        /// <returns>增加後的值</returns>
        public double StringIncrement(string key, double val, CommandFlags commandFlags = CommandFlags.None)
        {
            return _db.StringIncrement(key, val, commandFlags);
        }

        /// <summary>
        /// Redis String類型  Get
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="key"></param>
        /// <returns>T</returns>
        public T StringGet<T>(string key, CommandFlags commandFlags = CommandFlags.None) where T : class
        {
            try
            {
                RedisValue myString = _db.StringGet(key, commandFlags);
                if (myString.HasValue && !myString.IsNullOrEmpty)
                {
                    return DeserializeContent<T>(myString);
                }
                else
                {
                    return null;
                }
            }
            catch (Exception)
            {
                // Log Exception
                return null;
            }
        }

        /// <summary>
        ///  Redis String類型
        /// 相似於模糊查詢  key* 查出全部key開頭的鍵
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="key"></param>
        /// <param name="pageSize"></param>
        /// <param name="commandFlags"></param>
        /// <returns>List<T></returns>
        public List<T> StringGetList<T>(string key, int pageSize = 1000, CommandFlags commandFlags = CommandFlags.None) where T : class
        {
            try
            {
                var server = _redis.GetServer(host: RedisClientConfigurations.Url,
                                              port: RedisClientConfigurations.Port);
                var keys = server.Keys(_db.Database, key, pageSize, commandFlags);
                var keyValues = _db.StringGet(keys.ToArray(), commandFlags);

                var result = new List<T>();
                foreach (var redisValue in keyValues)
                {
                    if (redisValue.HasValue && !redisValue.IsNullOrEmpty)
                    {
                        var item = DeserializeContent<T>(redisValue);
                        result.Add(item);
                    }
                }

                return result;
            }
            catch (Exception)
            {
                // Log Exception
                return null;
            }
        }

        #endregion

        #region Redis Hash散列數據類型操做

        #endregion

        #region Redis List列表數據類型操做

        #endregion

        #region Redis Set集合數據類型操做

        #endregion

        #region Redis Sort Set有序集合數據類型操做

        #endregion

        #region Redis各數據類型公用

        /// <summary>
        /// Redis中是否存在指定Key
        /// </summary>
        /// <param name="key"></param>
        /// <returns></returns>
        public bool KeyExists(string key, CommandFlags commandFlags = CommandFlags.None)
        {
            return _db.KeyExists(key, commandFlags);
        }

        /// <summary>
        /// Dispose DB connection 釋放DB相關連接
        /// </summary>
        public void DbConnectionStop()
        {
            _redis.Dispose();
        }

        /// <summary>
        /// 從Redis中移除鍵
        /// </summary>
        /// <param name="key"></param>
        /// <returns></returns>
        public bool KeyRemove(string key, CommandFlags commandFlags = CommandFlags.None)
        {
            return _db.KeyDelete(key, commandFlags);
        }
        /// <summary>
        /// 從Redis中移除多個鍵
        /// </summary>
        /// <param name="keys"></param>
        public void KeyRemove(RedisKey[] keys, CommandFlags commandFlags = CommandFlags.None)
        {
            _db.KeyDelete(keys, commandFlags);
        }
        #endregion

        #region 私有公用方法

        // serialize and Deserialize content in separate functions as redis can save value as array of binary. 
        // so, any time you need to change the way of handling value, do it here.

        private string SerializeContent(object value)
        {
            return JsonConvert.SerializeObject(value);
        }

        private T DeserializeContent<T>(RedisValue myString)
        {
            return JsonConvert.DeserializeObject<T>(myString);
        }


        #endregion
    }
}

下面簡單介紹一下本文中的方法細節之處。

首先在RedisClient類的構造方法中初始化Redis數據操做對象_db。每一個方法更多的詳盡信息請注意方法註釋。若是關於Redis命令還不瞭解，請看前期Redis命令拾遺系列文章 http://www.cnblogs.com/tdws/tag/NoSql/

有園友指出問題說

Because the ConnectionMultiplexer does a lot, it is designed to be shared and reused between callers. You should not create a ConnectionMultiplexer per operation. It is fully thread-safe and ready for this usage.
這是官方文檔的原話，ConnectionMultiplexer比較「重」，建議共用，不要每次操做就建立一個

因此暫時將構造函數改成靜態構造。若是有問題，歡迎提之處

30日，反思了一下，仍是加鎖的單例更爲合適。