Asp.Net Core 輕鬆學-在.Net Core 使用快取和配置依賴策略
前言
幾乎在所有的應用程式中，快取都是一個永恆的話題，恰當的使用快取可以有效提高應用程式的效能；在某些業務場景下，使用快取依賴會有很好的體驗；在 Asp.Net Core 中，支援了多種快取元件，這其中最基礎也最易用的當屬 IMemoryCache，該介面表示其儲存依賴於託管程式伺服器的記憶體，下面要介紹的內容就是基於 IMemoryCache 的快取依賴。
1. IMemoryCache 的實現
Asp.Net Core 內部實現了一個繼承自 IMemoryCache 介面的類 MemoryCache
這幾乎已成慣例，一旦某個介面被列入 SDK 中，其必然包含了一個預設實現
1.1 使用 IMemoryCache
在 Asp.Net Core 中要使用 IMemoryCache 非常簡單，只需要在 Startup 的 ConfigureServices 方法加入一句程式碼 services.AddMemoryCache() 即可
public void ConfigureServices(IServiceCollection services)
{
services.AddMemoryCache();
...
}1.2 在控制器中使用 IMemoryCache
[Route("api/[controller]")] [ApiController] public class HomeController : ControllerBase { private IMemoryCache cache; public HomeController(IMemoryCache cache) { this.cache = cache; } [HttpGet] public ActionResult<IEnumerable<string>> Get() { cache.Set("userId", "0001"); return new string[] { "value1", "value2" }; } [HttpGet("{id}")] public ActionResult<string> Get(int id) { return cache.Get<string>("userId"); } }
上面的程式碼表示在 HomeController 控制器的構造方法中使用注入的方式獲得了一個 IMemoryCache 物件，在 Get() 方法中增加了一條快取記錄 "userId=0001"，然後在 Get(int id) 介面中提取該快取記錄
執行程式，分別呼叫 Get() 和 Get(int id) 介面，獲得下面的輸出資訊
- 呼叫 Get() 介面
- 呼叫 Get(int id) 介面
這看起來非常容易，幾乎不用什麼思考，你就學會了在 Asp.Net Core 中使用快取，容易使用，這非常重要，這也是一門語言廣泛推廣的根本態度
2. 應用快取策略
IMemoryCache 還包含了一個帶引數的構造方法，讓我們可以對快取進行靈活的配置，該配置由類 MemoryCacheOptions 決定
2.1 MemoryCacheOptions 配置，MemoryCacheOptions的配置專案不多，看下面的程式碼
public class MemoryCacheOptions : IOptions<MemoryCacheOptions>
{
public MemoryCacheOptions();
public ISystemClock Clock { get; set; }
[Obsolete("This is obsolete and will be removed in a future version.")]
public bool CompactOnMemoryPressure { get; set; }
public TimeSpan ExpirationScanFrequency { get; set; }
public long? SizeLimit { get; set; }
public double CompactionPercentage { get; set; }
}- ISystemClock：系統時鐘，預設值為 null，官方文件對此屬性沒有說明，我也不知道是幹什麼用的，哪位大神求告知其作用和原理
- ExpirationScanFrequency：對過期快取的掃描間隔時間
- SizeLimit：快取區可儲存記錄條目數量
- CompactionPercentage：在快取過期策略生效的時候，對快取進行壓縮的百分比
上面的這個配置非常簡單，在系統中應用類似下面的程式碼這樣
public void ConfigureServices(IServiceCollection services)
{
services.AddMemoryCache(options =>
{
options.CompactionPercentage = 0.02d;
options.ExpirationScanFrequency = TimeSpan.FromMinutes(5);
options.SizeLimit = 1024;
});
services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}上面的快取策略設定為快取壓縮比為 2%，每 5 分鐘進行一次過期快取的掃描，最大快取空間大小限制為 1024
使用方法不變
2.1 單個鍵快取策略
由於快取的所有鍵其快取過期優先順序都是預設的 Normal，可能我們需要在某些業務場景下，讓某些快取值設定一個較高的優先順序，比如設定永遠都不過期，這樣即使快取達到最大限制條數以後也不會對其進行清理
- 快取優先順序，該值為一個列舉型別，分別是 低、普通、高、永不移除，開發者可以根據不同的業務場景靈活設定
public enum CacheItemPriority
{
Low = 0,
Normal = 1,
High = 2,
NeverRemove = 3
}- 設定策略，下面就使用 MemoryCacheEntryOptions 對單個鍵值進行應用策略
[HttpGet]
public ActionResult<IEnumerable<string>> Get()
{
MemoryCacheEntryOptions entry = new MemoryCacheEntryOptions
{
Priority = CacheItemPriority.NeverRemove
};
cache.Set("userId", "0001", entry);
return new string[] { "value1", "value2" };
}上面的程式碼表示，我們對快取鍵 "userId" 應用了一個 “永不移除” 的策略，當然，還可以對單個值做非常多的策略，比如現在 "userId" 的值大小等等，有興趣的同學可以深入瞭解 MemoryCacheEntryOptions 類
3. 使用快取依賴策略
快取依賴的意思是表示，一個或者多個快取依賴於某個快取，當某個快取過期的時候，對其有依賴條件的其它快取也會過期，在某些應用場景下，快取依賴非常有用
3.1 建立 TokenController 並登入後註冊依賴、獲取快取、移除快取介面
以下示例使用一個模擬使用者登入/登出的業務場景
[Route("api/[controller]")]
[ApiController]
public class TokenController : ControllerBase
{
private IMemoryCache cache;
public TokenController(IMemoryCache cache)
{
this.cache = cache;
}
// 建立註冊依賴
[HttpGet("login")]
public ActionResult<string> Login()
{
var cts = new CancellationTokenSource();
cache.Set(CacheKeys.DependentCTS, cts);
using (var entry = cache.CreateEntry(CacheKeys.UserSession))
{
entry.Value = "_x0123456789";
entry.RegisterPostEvictionCallback(DependentEvictionCallback, this);
cache.Set(CacheKeys.UserShareData, "這裡是共享的資料", new CancellationChangeToken(cts.Token));
cache.Set(CacheKeys.UserCart, "這裡是購物車", new CancellationChangeToken(cts.Token));
}
return "設定依賴完成";
}
// 獲取快取
[HttpPost("getkeys")]
public IActionResult GetKeys()
{
var userInfo = new
{
UserSession = cache.Get<string>(CacheKeys.UserSession),
UserShareData = cache.Get<string>(CacheKeys.UserShareData),
UserCart = cache.Get<string>(CacheKeys.UserCart)
};
return new JsonResult(userInfo);
}
// 移除快取
[HttpPost("logout")]
public ActionResult<string> LogOut()
{
cache.Get<CancellationTokenSource>(CacheKeys.DependentCTS).Cancel();
var userInfo = new
{
UserSession = cache.Get<string>(CacheKeys.UserSession),
UserShareData = cache.Get<string>(CacheKeys.UserShareData),
UserCart = cache.Get<string>(CacheKeys.UserCart)
};
return new JsonResult(userInfo);
}
// 過期通知
private static void DependentEvictionCallback(object key, object value, EvictionReason reason, object state)
{
Console.ForegroundColor = ConsoleColor.Yellow;
Console.WriteLine("Key:{0} 已過期，依賴於該 Key 的所有快取都將過期而處於不可用狀態", key);
Console.ForegroundColor = ConsoleColor.Gray;
}
}上面的程式碼使用 CancellationTokenSource 用作事件通知源，當移除 CacheKeys.DependentCTS 並觸發 CancellationTokenSource.Cancel() 方法後，將非同步觸發 DependentEvictionCallback(object key, object value, EvictionReason reason, object state)委託；此時，託管程式收到一個通知，使用者已登出，已移除使用者相關快取，任何移除介面嘗試再次讀取 CacheKeys 項，此時，返回值為空
3.2 執行程式，分別呼叫 login/getkeys/logout 介面，分別得到以下輸出結果
- login 登入後註冊依賴
- getkeys 獲取快取
- logout 移除快取，嘗試再次讀取 CacheKeys 項，此時，返回值為空
- 控制檯輸出移除通知（黃色字型部分資訊）
可以看到，在使用者登入登出這個業務場景下，使用快取依賴項對其相關快取進行管理，還是非常方便的，當用戶退出登入後，即清空其所有相關快取
結束語
- 本文通過例項介紹了 IMemoryCache 的簡單使用方法
- 針對單個快取鍵，也可以對其進行應用策略
- 通過使用快取依賴策略，可以在某些業務場景中有非常好的應用體驗
- 注意：當使用全域性快取策略 SizeLimit 時，每個鍵都需要設定一個大小
- IMemoryCache 依賴於託管伺服器等記憶體，一旦重啟，快取資料將立即被釋放
示例程式碼下載
https://files.cnblogs.com/files/viter/Ron.MemoryCacheDemo.zip