NetCore的緩存使用詳例

關於我

做者博客|文章首發html

緩存基礎知識

緩存能夠減小生成內容所需的工做,從而顯著提升應用程序的性能和可伸縮性。 緩存最適用於不常常更改的 數據,生成 成本很高。 經過緩存,能夠比從數據源返回的數據的副本速度快得多。 應該對應用進行編寫和測試,使其 永不 依賴於緩存的數據。程序員

ASP.NET Core 支持多個不一樣的緩存。 最簡單的緩存基於 IMemoryCache。 IMemoryCache 表示存儲在 web 服務器的內存中的緩存。 在服務器場上運行的應用 (多臺服務器) 應確保會話在使用內存中緩存時處於粘滯狀態。 粘滯會話確保來自客戶端的後續請求都將發送到相同的服務器。web

內存中緩存能夠存儲任何對象。 分佈式緩存接口僅限 byte[] 。 內存中和分佈式緩存將緩存項做爲鍵值對。緩存

緩存指南

  • 代碼應始終具備回退選項,以獲取數據,而 是依賴於可用的緩存值。
  • 緩存使用稀有資源內存,限制緩存增加:
    • 不要 使用外部 輸入做爲緩存鍵。
    • 使用過時限制緩存增加。
    • 使用 SetSize、Size 和 SizeLimit 限制緩存大小]。 ASP.NET Core 運行時不會根據內存 壓力限制緩存 大小。 開發人員須要限制緩存大小。

使用

DI注入

建立一個NetCore控制檯項目,進行緩存的項目演示。服務器

控制檯項目只有一個初始化的Program.cs文件。基於NetCore進行項目編碼,每一步就是建立一個基礎模板,使用依賴注入的方式。async

nuget install Microsoft.Extensions.Hosting
public static class Program
    {
        static async void Main(string[] args)
        {
           var builder = new HostBuilder().ConfigureServices((context, service) =>
            {

            });

           await builder.RunConsoleAsync();
        }
    }

注入緩存服務,控制檯須要下載庫 Microsoft.Extensions.Caching.Memory分佈式

nuget install Microsoft.Extensions.Caching.Memory
public static class Program
    {
        static async void Main(string[] args)
        {
           var builder = new HostBuilder().ConfigureServices((context, service) =>
            {
      		  service.AddMemoryCache();
      		  
              service.AddScoped<CacheService>();//實際測試服務

              service.AddHostedService<BackgroundJob>();//後臺執行方法
            });

           await builder.RunConsoleAsync();
        }
    }

後臺服務函數

public class BackgroundJob : IHostedService
    {
        private readonly CacheService _cacheService;

        public BackgroundJob(CacheService cacheService)
        {
            _cacheService = cacheService;
        }

        public Task StartAsync(CancellationToken cancellationToken)
        {
            _cacheService.Action();

            return Task.CompletedTask;
        }

        public Task StopAsync(CancellationToken cancellationToken)
        {
            return Task.CompletedTask;
        }
    }

MemoryCache使用總結

經過構造函數自動注入IMemoryCache工具

public class CacheService
{
    private readonly IMemoryCache _memoryCache;

    public CacheService(IMemoryCache memoryCache)
    {
   		 _memoryCache = memoryCache;
    }
}

最基本的使用

Set方法根據Key設置緩存,默認緩存不過時性能

Get方法根據Key取出緩存

/// <summary>
/// 緩存設置
/// </summary>
public void BaseCache()
{
    string cacheKey = "timestamp";
    //set cache
    _memoryCache.Set(cacheKey, DateTime.Now.ToString());

    //get cache
    Console.WriteLine(_memoryCache.Get(cacheKey));
}

IMemoryCache提供一些好的語法糖供開發者使用,具體內容看下方文檔

/// <summary>
/// 特殊方法的使用
/// </summary>
public void ActionUse()
{
    //場景-若是緩存存在,取出。若是緩存不存在,寫入
    //原始寫法
    string cacheKey = "timestamp";
    if (_memoryCache.Get(cacheKey) != null)
    {
        _memoryCache.Set(cacheKey, DateTime.Now.ToString());
    }
    else
    {
        Console.WriteLine(_memoryCache.Get(cacheKey));
    }

    //新寫法
    var dataCacheValue = _memoryCache.GetOrCreate(cacheKey, entry =>
     {
         return DateTime.Now.ToString();
     });
    Console.WriteLine(dataCacheValue);

    //刪除緩存
    _memoryCache.Remove(cacheKey);

    //場景 判斷緩存是否存在的同時取出緩存數據
    _memoryCache.TryGetValue(cacheKey, out string cacheValue);
    Console.WriteLine(cacheValue);

}

緩存過時策略

設置緩存經常使用的方式主要是如下二種

  1. 絕對到期(指定在一個固定的時間點到期)
  2. 滑動到期(在一個時間長度內沒有被命中則過時)
  3. 組合過時 (絕對過時+滑動過時)

絕對到期

過時策略 5秒後過時

//set absolute cache
string cacheKey = "absoluteKey";
_memoryCache.Set(cacheKey, DateTime.Now.ToString(), TimeSpan.FromSeconds(5));

//get absolute cache
for (int i = 0; i < 6; i++)
{
    Console.WriteLine(_memoryCache.Get(cacheKey));
    Thread.Sleep(1000);
}

滑動到期

過時策略 2秒的滑動過時時間,若是2秒內有訪問,過時時間延後。當2秒的區間內沒有訪問,緩存過時

//set slibing cache
string cacheSlibingKey = "slibingKey";
MemoryCacheEntryOptions options = new MemoryCacheEntryOptions();
options.SlidingExpiration = TimeSpan.FromSeconds(2);

_memoryCache.Set(cacheSlibingKey, DateTime.Now.ToString(), options);

//get slibing cache
for (int i = 0; i < 2; i++)
{
    Console.WriteLine(_memoryCache.Get(cacheSlibingKey));
    Thread.Sleep(1000);
}
for (int i = 0; i < 2; i++)
{
    Thread.Sleep(2000);
    Console.WriteLine(_memoryCache.Get(cacheSlibingKey));
}

組合過時

過時策略

6秒絕對過時+2秒滑動過時

知足任意一個緩存都將失效

string cacheCombineKey = "combineKey";
MemoryCacheEntryOptions combineOptions = new MemoryCacheEntryOptions();
combineOptions.SlidingExpiration = TimeSpan.FromSeconds(2);
combineOptions.AbsoluteExpiration = DateTime.Now.AddSeconds(6);

_memoryCache.Set(cacheCombineKey, DateTime.Now.ToString(), combineOptions);

//get slibing cache
for (int i = 0; i < 2; i++)
{
    Console.WriteLine(_memoryCache.Get(cacheCombineKey));
    Thread.Sleep(1000);
}

for (int i = 0; i < 6; i++)
{
    Thread.Sleep(2000);
    Console.WriteLine(i+"|" + _memoryCache.Get(cacheCombineKey));
}

Console.WriteLine("------------combineKey End----------------");

緩存狀態變化事件

當緩存更新、刪除時觸發一個回調事件,記錄緩存變化的內容。

/// <summary>
/// cache狀態變化回調
/// </summary>
public void CacheStateCallback()
{
    MemoryCacheEntryOptions options = new MemoryCacheEntryOptions();
    options.AbsoluteExpiration = DateTime.Now.AddSeconds(3
        );
    options.RegisterPostEvictionCallback(MyCallback, this);

    //show callback console
    string cacheKey = "absoluteKey";
    _memoryCache.Set(cacheKey, DateTime.Now.ToString(), options);

    Thread.Sleep(500);
    _memoryCache.Set(cacheKey, DateTime.Now.ToString(), options);

    _memoryCache.Remove(cacheKey);

}

private static void MyCallback(object key, object value, EvictionReason reason, object state)
{
    var message = $"Cache entry state change:{key} {value} {reason} {state}";
    ((CacheService)state)._memoryCache.Set("callbackMessage", message);

    Console.WriteLine(message);
}

緩存依賴策略

設置一個緩存A 設置一個緩存B,依賴於緩存A 若是緩存A失效,緩存B也失效

/// <summary>
/// 緩存依賴策略
/// </summary>
public void CacheDependencyPolicy()
{
    string DependentCTS = "DependentCTS";
    string cacheKeyParent = "CacheKeys.Parent";
    string cacheKeyChild = "CacheKeys.Child";

    var cts = new CancellationTokenSource();
    _memoryCache.Set(DependentCTS, cts);

    //建立一個cache策略
    using (var entry = _memoryCache.CreateEntry(cacheKeyParent))
    {
        //當前key對應的值
        entry.Value = "parent" + DateTime.Now;

        //當前key對應的回調事件
        entry.RegisterPostEvictionCallback(MyCallback, this);

        //基於些key建立一個依賴緩存
        _memoryCache.Set(cacheKeyChild, "child" + DateTime.Now, new CancellationChangeToken(cts.Token));
    }

    string ParentCachedTime = _memoryCache.Get<string>(cacheKeyParent);
    string ChildCachedTime = _memoryCache.Get<string>(cacheKeyChild);
    string callBackMsg = _memoryCache.Get<string>("callbackMessage");
    Console.WriteLine("第一次獲取");
    Console.WriteLine(ParentCachedTime + "|" + ChildCachedTime + "|" + callBackMsg);

    //移除parentKey
    _memoryCache.Get<CancellationTokenSource>(DependentCTS).Cancel();
    Thread.Sleep(1000);

    ParentCachedTime = _memoryCache.Get<string>(cacheKeyParent);
    ChildCachedTime = _memoryCache.Get<string>(cacheKeyChild);
    callBackMsg = _memoryCache.Get<string>("callbackMessage");
    Console.WriteLine("第二次獲取");
    Console.WriteLine(ParentCachedTime + "|" + ChildCachedTime + "|" + callBackMsg);
}

參考資料

AspNetCore中的緩存內存

.NetCore緩存篇之MemoryCache

Asp.Net Core 輕鬆學-在.Net Core 使用緩存和配置依賴策略

擁抱.NET Core系列:MemoryCache 緩存過時

推薦閱讀

Redis工具收費後新的開源已出現

GitHub上Star最高的工程師技能圖譜

中國程序員最容易發錯的單詞

推薦!!! Markdown圖標索引網站

最後

本文到此結束,但願對你有幫助 😃

若是還有什麼疑問或者建議,能夠多多交流,原創文章,文筆有限,才疏學淺,文中如有不正之處,萬望告知。

更多精彩技術文章彙總在個人 公衆號【程序員工具集】,持續更新,歡迎關注訂閱收藏。

wechat.png

相關文章
相關標籤/搜索