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

来源:http://www.cnblogs.com/tdws/archive/2016/08/28/5815880.html
-Advertisement-
Play Games

本文版權歸博客園和作者本人共同所有，轉載和爬蟲請註明原文鏈接 http://www.cnblogs.com/tdws/tag/NoSql/ 目錄 一、基礎配置封裝 二、String字元串類型數據操作封裝 三、Hash散列類型數據操作封裝 四、List列表類型數據操作封裝 五、Set集合類型數據操作封 ...


本文版權歸博客園和作者本人共同所有，轉載和爬蟲請註明原文鏈接 http://www.cnblogs.com/tdws/tag/NoSql/

目錄

一、基礎配置封裝

二、String字元串類型數據操作封裝

三、Hash散列類型數據操作封裝

四、List列表類型數據操作封裝

五、Set集合類型數據操作封裝

六、Sort Set集合數據類型操作封裝

七、主從配置，哨兵相關配置

二、String字元串類型數據操作封裝

下麵這段畫如果看一遍沒看懂，請看過代碼後再次來閱讀：

我們有必要先提到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   聯繫郵箱 [email protected]
  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 readonly IDatabase _db;
        private readonly ConnectionMultiplexer _redis;

        /// <summary>
        /// 構造函數，在其中註冊Redis事件
        /// </summary>
        public 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 _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/

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 基於系統的UIMenuController的使用及自定義UIMenuItem
    UIMenuController的使用及自定義UIMenuItem ...
  • Android ORM -- Litepal(1)
    ORM，即Object Relation Mapping，對象關係映射，實現了程式裡面的類和資料庫裡面的數據之間的對應關係，對資料庫的操作可以通過對類的操作去實現，不用再寫SQL語句，從而提高了開發效率，節省了開發時間。 在Java Web開發中，有很多的ORM框架，如Hibernate等。在And ...
  • Android學習之ProgressBar
    ProgressBar用於向用戶顯示某個耗時操作完成的百分比，避免長時間執行某個耗時操作時讓用戶感覺程式失去了響應，從而提高用戶界面的友好性。 請看下麵的界面佈局： <LinearLayout xmlns:android="http://schemas.android.com/apk/res/and ...
  • 關於自定義tabBar時修改系統自帶tabBarItem屬性造成的按鈕順序錯亂的問題相關探究
    /Users/chenjiajiang/Desktop/截圖/大神班/Snip20160827_1.png ...
  • 蘋果系統開發中的混合編程(2):Swift和C的相互調用
    在進行Swift和C之間的相互調用時，有必要先瞭解一下兩種語言之間的類型轉換關係： 下在還是先演示一下如何在Swift里對C的方法進行調用，創建一個Swift的項目： 在項目里創建C代碼文件： 這個時候會提示你是否要生成Bridging Header，選擇創建。 文件創建完成後的代碼結構如下，可以看 ...
  • Xamarin.Android 入門之：Xamarin+vs2015 環境搭建
    一、前言 此篇博客主要寫瞭如何使用搭建xamarin開發的環境，防止我自己萬一哪天電腦重裝系統了，可以直接看這篇博客。 二、準備工作 在安裝之前需要下載好xamarin所需要的軟體並一個個安裝他們： 1.visual studio 2015：http://news.mydrivers.com/1/4 ...
  • Android快樂貪吃蛇游戲實戰項目開發教程-06虛擬方向鍵（五）繪製方向鍵箭頭
    本系列教程概述與目錄：http://www.cnblogs.com/chengyujia/p/5787111.html本系列教程項目源碼GitHub地址：https://github.com/jackchengyujia/HappySnake 一、本文概述 在上篇教程中，我們畫了4個背景三角形，並且 ...
  • Android學習之Handler消息傳遞機制
    Android只允許UI線程修改Activity里的UI組件。當Android程式第一次啟動時，Android會同時啟動一條主線程（Main Thread），主線程主要負責處理與UI相關的事件，如用戶的按鍵事件、屏幕繪圖事件，並把相關的事件分發到對應的組件進行處理。所以，主線程通常又被稱為UI線程。 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類