技術文章 » .NET 6 基於IDistributedCache實現Redis與MemoryCache的快取幫助類

.NET 6 基於IDistributedCache實現Redis與MemoryCache的快取幫助類

2022-12-05 21:00:31

本文通過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);
	}
}

總結

暫無，下次再會！

歡迎大家關注我的微信公眾號，一起進步，一起成長