.NET 6 基於IDistributedCache實現Redis與MemoryCache的緩存幫助類

来源:https://www.cnblogs.com/gmval/archive/2022/12/05/16953063.html
-Advertisement-
Play Games

C# 簡介 C#是微軟公司發佈的一種由C和C++衍生出來的面向對象的編程語言，它不僅去掉了 C++ 和 Java 語言中的一些複雜特性，還提供了可視化工具，能夠高效地編寫程式。 C#是由C和C++衍生出來的一種安全的、穩定的、簡單的、優雅的面向對象編程語言。它在繼承C和C++強大功能的同時去掉了一些 ...


本文通過IDistributedCache的介面方法，實現Redis與MemoryCache統一幫助類。只需要在配置文件中簡單的配置一下，就可以實現Redis與MemoryCache的切換。

目錄

IDistributedCache

IDistributedCache 方法：

方法 說明
Get(String) 獲取具有給定鍵的值。
GetAsync(String, CancellationToken) 獲取具有給定鍵的值。
Refresh(String) 基於緩存中某個值的鍵刷新該值，並重置其可調到期超時（如果有）。
RefreshAsync(String, CancellationToken) 基於緩存中某個值的鍵刷新該值，並重置其可調到期超時（如果有）。
Remove(String) 刪除具有給定鍵的值。
RemoveAsync(String, CancellationToken) 刪除具有給定鍵的值。
Set(String, Byte[], DistributedCacheEntryOptions) 設置具有給定鍵的值。
SetAsync(String, Byte[], DistributedCacheEntryOptions, CancellationToken) 設置具有給定鍵的值。

IDistributedCache 還提供了一些擴展方法，本文的幫助類就是通過擴展方法完成的。

IDistributedCache 擴展方法：

方法 說明
GetString(IDistributedCache, String) 使用指定的鍵從指定的緩存中獲取字元串。
GetStringAsync(IDistributedCache, String, CancellationToken) 使用指定的鍵從指定的緩存非同步獲取字元串。
Set(IDistributedCache, String, Byte[]) 使用指定的鍵設置指定緩存中的位元組序列。
SetAsync(IDistributedCache, String, Byte[], CancellationToken) 使用指定的鍵非同步設置指定緩存中的位元組序列。
SetString(IDistributedCache, String, String) 使用指定的鍵在指定的緩存中設置字元串。
SetString(IDistributedCache, String, String, DistributedCacheEntryOptions) 使用指定的鍵在指定的緩存中設置字元串。
SetStringAsync(IDistributedCache, String, String, DistributedCacheEntryOptions, CancellationToken) 使用指定的鍵在指定的緩存中非同步設置字元串。
SetStringAsync(IDistributedCache, String, String, CancellationToken) 使用指定的鍵在指定的緩存中非同步設置字元串。

ICache 介面

ICache介面提供了設置緩存、獲取緩存、刪除緩存和刷新緩存的介面方法。



namespace CacheHelper
{
    public interface ICache
    {
        #region 設置緩存 
        /// <summary>
        /// 設置緩存
        /// </summary>
        /// <param name="key">緩存Key</param>
        /// <param name="value">值</param>
        void SetCache(string key, object value);
        /// <summary>
        /// 設置緩存
        /// </summary>
        /// <param name="key">緩存Key</param>
        /// <param name="value">值</param>
        Task SetCacheAsync(string key, object value);

        /// <summary>
        /// 設置緩存
        /// 註：預設過期類型為絕對過期
        /// </summary>
        /// <param name="key">緩存Key</param>
        /// <param name="value">值</param>
        /// <param name="timeout">過期時間間隔</param>
        void SetCache(string key, object value, TimeSpan timeout);

        /// <summary>
        /// 設置緩存
        /// 註：預設過期類型為絕對過期
        /// </summary>
        /// <param name="key">緩存Key</param>
        /// <param name="value">值</param>
        /// <param name="timeout">過期時間間隔</param>
        Task SetCacheAsync(string key, object value, TimeSpan timeout);

        /// <summary>
        /// 設置緩存
        /// 註：預設過期類型為絕對過期
        /// </summary>
        /// <param name="key">緩存Key</param>
        /// <param name="value">值</param>
        /// <param name="timeout">過期時間間隔</param>
        /// <param name="expireType">過期類型</param>  
        void SetCache(string key, object value, TimeSpan timeout, ExpireType expireType);

        /// <summary>
        /// 設置緩存
        /// 註：預設過期類型為絕對過期
        /// </summary>
        /// <param name="key">緩存Key</param>
        /// <param name="value">值</param>
        /// <param name="timeout">過期時間間隔</param>
        /// <param name="expireType">過期類型</param>  
        Task SetCacheAsync(string key, object value, TimeSpan timeout, ExpireType expireType);
        #endregion

        #region 獲取緩存

        /// <summary>
        /// 獲取緩存
        /// </summary>
        /// <param name="key">緩存Key</param>
        string GetCache(string key);

        /// <summary>
        /// 獲取緩存
        /// </summary>
        /// <param name="key">緩存Key</param>
        Task<string> GetCacheAsync(string key);
        /// <summary>
        /// 獲取緩存
        /// </summary>
        /// <param name="key">緩存Key</param>
        T GetCache<T>(string key);
        /// <summary>
        /// 獲取緩存
        /// </summary>
        /// <param name="key">緩存Key</param>
        Task<T> GetCacheAsync<T>(string key);

        #endregion

        #region 刪除緩存

        /// <summary>
        /// 清除緩存
        /// </summary>
        /// <param name="key">緩存Key</param>
        void RemoveCache(string key);

        /// <summary>
        /// 清除緩存
        /// </summary>
        /// <param name="key">緩存Key</param>
        Task RemoveCacheAsync(string key);

        #endregion

        #region 刷新緩存
        /// <summary>
        /// 刷新緩存
        /// </summary>
        /// <param name="key">緩存Key</param>
        void RefreshCache(string key);
        /// <summary>
        /// 刷新緩存
        /// </summary>
        /// <param name="key">緩存Key</param>
        Task RefreshCacheAsync(string key);
        #endregion
    }
}

ExpireType枚舉

ExpireType枚舉標識緩存的過期類型，分為絕對過期與相對過期兩個類型。
絕對過期：即自創建一段時間後就過期
相對過期：即該鍵未被訪問後一段時間後過期，若此鍵一直被訪問則過期時間自動延長。

namespace CacheHelper
{
    public enum ExpireType
    {
        /// <summary>
        /// 絕對過期
        /// 註：即自創建一段時間後就過期
        /// </summary>
        Absolute,

        /// <summary>
        /// 相對過期
        /// 註：即該鍵未被訪問後一段時間後過期，若此鍵一直被訪問則過期時間自動延長
        /// </summary>
        Relative,
    }
}

CacheType 枚舉

是使用MemoryCache，還是Redis，MemoryCache不支持分散式，Redis支持分散式。

namespace CacheHelper
{
    public enum CacheType
    {
        /// <summary>
        /// 使用記憶體緩存(不支持分散式)
        /// </summary>
        Memory,

        /// <summary>
        /// 使用Redis緩存(支持分散式)
        /// </summary>
        Redis
    }
}

CacheHelper 緩存幫助類

namespace CacheHelper
{
    public class CacheHelper : ICache
    {
        readonly IDistributedCache _cache;

        public CacheHelper(IDistributedCache cache)
        {
            _cache = cache;
        }

        protected string BuildKey(string idKey)
        {
            return $"Cache_{GetType().FullName}_{idKey}";
        }
        public void SetCache(string key, object value)
        {
            string cacheKey = BuildKey(key);
            _cache.SetString(cacheKey, value.ToJson());
        }

        public async Task SetCacheAsync(string key, object value)
        {
            string cacheKey = BuildKey(key);
            await _cache.SetStringAsync(cacheKey, value.ToJson());
        }

        public void SetCache(string key, object value, TimeSpan timeout)
        {
            string cacheKey = BuildKey(key);
            _cache.SetString(cacheKey, value.ToJson(), new DistributedCacheEntryOptions
            {
                AbsoluteExpiration = new DateTimeOffset(DateTime.Now + timeout)
            });
        }

        public async Task SetCacheAsync(string key, object value, TimeSpan timeout)
        {
            string cacheKey = BuildKey(key);
            await _cache.SetStringAsync(cacheKey, value.ToJson(), new DistributedCacheEntryOptions
            {
                AbsoluteExpiration = new DateTimeOffset(DateTime.Now + timeout)
            });
        }

        public void SetCache(string key, object value, TimeSpan timeout, ExpireType expireType)
        {
            string cacheKey = BuildKey(key);
            if (expireType == ExpireType.Absolute)
            {
                //這裡沒轉換標準時間，Linux時區會有問題？
                _cache.SetString(cacheKey, value.ToJson(), new DistributedCacheEntryOptions
                {
                    AbsoluteExpiration = new DateTimeOffset(DateTime.Now + timeout)
                });
            }
            else
            {
                _cache.SetString(cacheKey, value.ToJson(), new DistributedCacheEntryOptions
                {
                    AbsoluteExpirationRelativeToNow = timeout
                });
            }
        }

        public async Task SetCacheAsync(string key, object value, TimeSpan timeout, ExpireType expireType)
        {
            string cacheKey = BuildKey(key);
            if (expireType == ExpireType.Absolute)
            {
                //這裡沒轉換標準時間，Linux時區會有問題？
                await _cache.SetStringAsync(cacheKey, value.ToJson(), new DistributedCacheEntryOptions
                {
                    AbsoluteExpiration = new DateTimeOffset(DateTime.Now + timeout)
                });
            }
            else
            {
                await _cache.SetStringAsync(cacheKey, value.ToJson(), new DistributedCacheEntryOptions
                {
                    AbsoluteExpirationRelativeToNow = timeout
                });
            }
        }

        public string GetCache(string idKey)
        {
            if (idKey.IsNullOrEmpty())
            {
                return null;
            }
            string cacheKey = BuildKey(idKey);
            var cache = _cache.GetString(cacheKey);
            return cache;
        }
        public async Task<string> GetCacheAsync(string key)
        {
            if (key.IsNullOrEmpty())
            {
                return null;
            }
            string cacheKey = BuildKey(key);
            var cache = await _cache.GetStringAsync(cacheKey);
            return cache;
        }

        public T GetCache<T>(string key)
        {
            var cache = GetCache(key);
            if (!cache.IsNullOrEmpty())
            {
                return cache.ToObject<T>();
            }
            return default(T);
        }

        public async Task<T> GetCacheAsync<T>(string key)
        {
            var cache = await GetCacheAsync(key);
            if (!string.IsNullOrEmpty(cache))
            {
                return cache.ToObject<T>();
            }
            return default(T);
        }

        public void RemoveCache(string key)
        {
            _cache.Remove(BuildKey(key));
        }

        public async Task RemoveCacheAsync(string key)
        {
            await _cache.RemoveAsync(BuildKey(key));
        }

        public void RefreshCache(string key)
        {
            _cache.Refresh(BuildKey(key));
        }

        public async Task RefreshCacheAsync(string key)
        {
            await _cache.RefreshAsync(BuildKey(key));
        }

    }
}

CacheHelper 中，自定義了一個string的擴展方法ToObject<T>()。ToObject<T>()擴展方法使用了 Newtonsoft.Json。

/// <summary>
/// 將Json字元串反序列化為對象
/// </summary>
/// <typeparam name="T">對象類型</typeparam>
/// <param name="jsonStr">Json字元串</param>
/// <returns></returns>
public static T ToObject<T>(this string jsonStr)
{
    return JsonConvert.DeserializeObject<T>(jsonStr);
}

CacheHelper 的使用方法

安裝Redis依賴

Redis依賴我使用的是Caching.CSRedis，安裝依賴：

PM> Install-Package Caching.CSRedis -Version 3.6.90

配置appsettings.json

在appsettings.json中，對緩存進行配置：

 "Cache": {
    "CacheType": "Memory", // "Memory OR Redis"
    "RedisEndpoint": "127.0.0.1:6379" //Redis節點地址,定義詳見 https://github.com/2881099/csredis
  },

如果要使用MemoryCache，CacheType就設置為Memory，如果要使用Redis，CacheType就設置為Redis。如果設置為Redis的話，還需要配置RedisEndpoint，保證Redis節點可用。

CacheOptions配置

編寫一個名為CacheOptions的類。用於獲取配置文件的配置節內容

namespace CacheHelper
{
    public class CacheOptions
    {
        public CacheType CacheType { get; set; }
        public string RedisEndpoint { get; set; }
    }
}

IHostBuilder擴展方法UseCache

編寫一個IHostBuilder的擴展方法UseCache，用於註入MemoryCache或是Redis

public static IHostBuilder UseCache(this IHostBuilder hostBuilder)
{
    hostBuilder.ConfigureServices((buidlerContext, services) =>
    {
        var cacheOption = buidlerContext.Configuration.GetSection("Cache").Get<CacheOptions>();
        switch (cacheOption.CacheType)
        {
            case CacheType.Memory: services.AddDistributedMemoryCache(); break;
            case CacheType.Redis:
                {
                    var csredis = new CSRedisClient(cacheOption.RedisEndpoint);
                    RedisHelper.Initialization(csredis);
                    services.AddSingleton(csredis);
                    services.AddSingleton<IDistributedCache>(new CSRedisCache(RedisHelper.Instance));
                }; break;
            default: throw new Exception("緩存類型無效");
        }
    });

    return hostBuilder;
}

Program.cs中引用

var builder = WebApplication.CreateBuilder(args);
builder.Host.UseCache();

CacheHelper的使用。

public class HomeController
{
	readonly ICache _cache;
	public HomeController
	(
		ICache cache,
	)
	{
		_cache = cache;
	}
	
	public async Task CacheTest(string key)
	{
		string cache_value = "hello cache";
		//同步方法
		_cache.SetCache(key,cache_value );
		string v = _cache.GetCache<string>(key);
		_cache.RemoveCache(key);
		//非同步方法
		await _cache.SetCacheAsync(key,cache_value );
		string val = await _cache.GetCacheAsync<string>(key);
		await _cache.RemoveCacheAsync(key);
	}
}

總結

暫無，下次再會！

歡迎大家關註我的微信公眾號，一起進步，一起成長
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 自從用了 OkHttp，別的都完全不想用了！
    Java封裝OkHttp3工具類，適用於Java後端開發者。 說實在話，用過挺多網路請求工具，有過java原生的，HttpClient3和4，但是個人感覺用了OkHttp3之後，之前的那些完全不想再用了。 怎麼說呢，代碼輕便，使用起來很很很靈活，響應快，比起HttpClient好用許多。當然，這些是 ...
  • Android ViewPager2 + TabLayout + BottomNavigationView
    Android ViewPager2 + TabLayout + BottomNavigationView 實際案例 本篇主要介紹一下 ViewPager2 + TabLayout + BottomNavigationView 的結合操作 概述 相信大家都看過今日頭條的的樣式 如下: 頂部有這種ta ...
  • 如何理性看待國內大熱的HuTool工具包
    一、序言 關於HuTool工具包，相信很多技術朋友都聽說甚至使用過。在HuTool之前，已經有比較成熟的工具包比如Apache Common包，谷歌推出的Guava包，他們已經在全世界大範圍使用了。 究竟是什麼原因導致HuTool有後來居上的趨勢，傳統的工具包對於國內開發者來講劣勢在哪裡呢，不妨來扒 ...
  • TinyShell（CSAPP實驗）
    簡介 CSAPP實驗介紹 學生實現他們自己的帶有作業控制的Unix Shell程式，包括Ctrl + C和Ctrl + Z按鍵，fg，bg，和 jobs命令。這是學生第一次接觸併發，並且讓他們對Unix的進程式控制制、信號和信號處理有清晰的瞭解。 什麼是Shell？ ​ Shell就是用戶與操作系統內核 ...
  • 每日演算法之二叉搜索樹的後序遍歷序列
    JZ33 二叉搜索樹的後序遍歷序列 描述 輸入一個整數數組，判斷該數組是不是某二叉搜索樹的後序遍歷的結果。如果是則返回 true ,否則返回 false 。假設輸入的數組的任意兩個數字都互不相同。 提示： 1.二叉搜索樹是指父親節點大於左子樹中的全部節點，但是小於右子樹中的全部節點的樹。 2.該題我 ...
  • 源碼解析：Dubbo3 的 Spring 適配原理與初始化流程
    前言 在使用mybatis框架進行開發時，編寫sql少不了<=，>=，>，<，<>等比較符號，但是直接在mapper文件中，直接使用這些符號是不行的，此時就需要對類似於這種的符號進行轉換。 正文 直接符號轉義 以下羅列出sql中的比較符合和對應的轉義符號： 大於 > ==> &gt; 大於等於 >= ...
  • Java8新特性之方法引用
    本文主要介紹方法引用的5種形式：對象的非靜態方法引用、類的靜態方法引用、類的非靜態方法引用、構造器的引用、數組的引用。 ...
  • 有來實驗室|第一篇：Seata1.5.2版本部署和開源全棧商城訂單支付業務實戰
    有來實驗室結合正式的商城訂單支付業務場景將 Seata 分散式事務可視化，通過現象去看本質(原理和源碼)，告別被動式輸入的短期記憶學習。 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類