ASP.NET Core - 快取之記憶體快取(上)

啊晚發表於2023-04-03

1. 快取

快取指的是在軟體應用執行過程中,將一些資料生成副本直接進行存取,而不是從原始源(資料庫,業務邏輯計算等)讀取資料,減少生成內容所需的工作,從而顯著提高應用的效能和可伸縮性,使用好快取技術,有利於提高我們提升使用者體驗性。

對於快取的使用有以下一些注意點:

  • 快取最適用於不常更改且生成成本很高的資料。
  • 程式碼應始終具有回退選項,以提取資料,而不依賴於可用的快取值。
    我們應該以從不依賴於快取資料的方式編寫和測試應用。快取是會失效的,我們在進行應用開發時應該考慮到快取失效的情況,提供快取失效時按照正常邏輯獲取相關資料的方式。
  • 快取使用短缺資源:記憶體。 我們應該限制快取增長:
    • 不要將外部輸入插入到快取中。 例如,不建議使用使用者提供的任意輸入作為快取鍵,因為輸入可能會消耗不可預測的記憶體量。
    • 使用過期限制快取增長。
    • 應當限制快取的大小,避免快取過度增長

軟體開發中對快取的使用一般有兩種情況,一種是記憶體快取,一種是分散式快取。

2. NET Core 的記憶體快取

記憶體快取是最簡單的一種快取方式,就是使用應用所在的伺服器的記憶體來儲存一些資料副本,利用記憶體讀寫比磁碟、網路請求快的特點來提供應用效能。記憶體快取一般應用於單機應用,一旦應用重啟,記憶體快取中的資料就會丟失。

如果是在伺服器場(多個伺服器)中執行的應用使用記憶體快取,應確保在使用記憶體中快取時會話是粘滯的。 粘滯會話可確保來自客戶端的請求都轉到同一伺服器。

2. 1 記憶體快取啟用

.NET Core 框架下對於記憶體快取的使用是透過 IMemoryCache ,可以透過將其註冊到容器中,之後在需要的地方注入使用。對於大多數應用,在 Program.cs 中呼叫許多其他 Add{Service} 方法可以啟用 IMemoryCache,例如 AddMvc、AddControllersWithViews、AddRazorPages、AddMvcCore().AddRazorViewEngine 等 。

如果應用中沒有使用到上述的這些方法,我們也可以自行引入 Microsoft.Extensions.Caching.Memory Nuget 包,透過 AddMemoryCache 方法啟動記憶體快取。為了方便演示,以下示例使用 .NET 6 控制檯應用。

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

Host.CreateDefaultBuilder(args)
	.ConfigureServices(services =>
	{
		services.AddMemoryCache();
	})
	.Build().Run();

2. 2 記憶體快取基本用法

記憶體快取的使用,只需要將 IMemoryCache 服務注入到類中進行使用即可。我們可以透過 TryGetValue 方法嘗試從快取中獲取資料,透過 Set 方法向快取中新增資料。

public interface ICacheService
{
	public void PrintDateTimeNow();
}

public class CacheService : ICacheService
{
	public const string CacheKey = "CacheTime";
	private readonly IMemoryCache _cache;
	public CacheService(IMemoryCache memoryCache)
	{
		_cache = memoryCache;
	}

	public void PrintDateTimeNow()
	{
		var time = DateTime.Now;
		if(!_cache.TryGetValue(CacheKey, out DateTime cacheValue))
		{
			cacheValue = time;
			_cache.Set(CacheKey, cacheValue);
		}
		time = cacheValue;

		Console.WriteLine("快取時間:" + time.ToString("yyyy-MM-dd HH:mm:ss"));
		Console.WriteLine("當前時間:" + DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"));
	}
}

using CacheSample;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

var host = Host.CreateDefaultBuilder(args)
	.ConfigureServices(services =>
	{
		services.AddMemoryCache();
		services.AddTransient<ICacheService, CacheService>();
	})
	.Build();

var service = host.Services.GetRequiredService<ICacheService>();
service.PrintDateTimeNow();

Task.Delay(TimeSpan.FromSeconds(2)).Wait();

service.PrintDateTimeNow();

host.Run();

透過控制檯列印結果,可以看到,當前時間已經改變,但是快取的時間是之前的資料。

image

快取系統將快取項儲存為鍵值對,記憶體快取中鍵和值都可以是任意型別,不過一般情況下我們會將字串作為鍵。之後會講到的分散式快取中,則要求值必須是 byte[] 型別。

除此之外,還可以透過 GetOrCreate 或 GetOrCreateAsync 將獲取和新增的操作結合。

public class CacheService : ICacheService
{
	public const string CacheKey = "CacheTime";
	private readonly IMemoryCache _cache;
	public CacheService(IMemoryCache memoryCache)
	{
		_cache = memoryCache;
	}

	public void PrintDateTimeNow()
	{
		//var time = DateTime.Now;
		//if(!_cache.TryGetValue(CacheKey, out DateTime cacheValue))
		//{
		//    cacheValue = time;
		//    _cache.Set(CacheKey, cacheValue);
		//}
		//time = cacheValue;

		var time = _cache.GetOrCreate(CacheKey, cacheEntry =>
		{
			return DateTime.Now;
		});

		Console.WriteLine("快取時間:" + time.ToString("yyyy-MM-dd HH:mm:ss"));
		Console.WriteLine("當前時間:" + DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"));
	}
}

image

除了 TryGetValue 方法外,如果你確定快取中一定存在相應的資料,還可以透過 Get 方法獲取資料,Get 方法支援泛型,可以直接進行型別轉換,但是如果快取中不存在該快取項,則會返回對應型別的預設值。

var timeCache = _cache.Get<DateTime>(CacheKey);![image]

2.3 快取過期設定

一般情況下,我們會對快取資料設定過期時間,一個是為將一些長期未被訪問的快取條目移除,避免快取過度增長,一方面是為了更新資料,避免長時間的資料副本和源資料不一致。

.NET Core 下記憶體快取的過期時間設定可以透過以下的方式:

(1) 透過 Set 方法設定

var time = DateTime.Now;
if (!_cache.TryGetValue(CacheKey, out DateTime cacheValue))
{
	cacheValue = time;
	// 設定絕對過期時間
	// 兩種實現的功能是一樣的,只是時間設定的方式不同而已
	// 傳入的是 AbsoluteExpirationRelativeToNow, 相對當前的絕對過期時間,傳入時間差,會根據當前時間算出絕對過期時間
	_cache.Set(CacheKey, cacheValue, TimeSpan.FromSeconds(2));
	// 傳入的是 AbsoluteExpiration,絕對過期時間,傳入一個DateTimeOffset物件,需要明確的指定具體的時間
	// _cache.Set(CacheKey, cacheValue, DateTimeOffset.Now.AddSeconds(2));
}
time = cacheValue;

調整一下入口檔案的程式碼,如下:

var service = host.Services.GetRequiredService<ICacheService>();
service.PrintDateTimeNow();

Task.Delay(TimeSpan.FromSeconds(1)).Wait();
service.PrintDateTimeNow();

Task.Delay(TimeSpan.FromSeconds(2)).Wait();
service.PrintDateTimeNow();

可以看到,在第二次輸出的時候,快取沒過期,時間是不變的,第三次的時候快取過期了,時間改變了。

image

對於快取過期時間的設定,除了絕對過期時間,還有緩動過期時間。滑動過期時間是指,如果在規定的過期時間內快取有被再一次呼叫,過期時間就會重新更新,從頭開始計算,每次被呼叫都會重新開始。

Set 方法沒有直接的引數設定滑動過期時間,只能透過 MemoryCacheEntryOptions 物件設定,當然相對過期時間等其他配置也可以透過該物件設定。

var memoryCacheEntryOption = new MemoryCacheEntryOptions();
// 滑動過期時間是一個相對時間
memoryCacheEntryOption.SlidingExpiration = TimeSpan.FromSeconds(3);
_cache.Set(CacheKey, cacheValue, memoryCacheEntryOption);

image

可以看到,快取時間一直沒有變,因為雖然三次輸出時間加起來超過了三秒,但是三次輸出之間的間隔都沒有超過3秒,而每呼叫一次快取都會重新整理超時時間,所以快取一直沒有過期。

(2) 透過 CreateEntry 方法設定

var time = DateTime.Now;
if (!_cache.TryGetValue(CacheKey, out DateTime cacheValue))
{
	cacheValue = time;
	var entry = _cache.CreateEntry(CacheKey);
	// 設定絕對過期時間
	// 兩種實現的功能是一樣的,只是時間設定的方式不同而已
	// 傳入的是 AbsoluteExpirationRelativeToNow, 相對當前的絕對過期時間,傳入時間差,會根據當前時間算出絕對過期時間
	entry.AbsoluteExpirationRelativeToNow = TimeSpan.FromSeconds(2);
	// 傳入的是 AbsoluteExpiration,絕對過期時間,傳入一個DateTimeOffset物件,需要明確的指定具體的時間
	entry.AbsoluteExpiration = DateTimeOffset.Now.AddSeconds(2);
	entry.Value = cacheValue;
}
time = cacheValue;

(3) 透過 GetOrCreate 或 GetOrCreateAsync 方法設定

var time = _cache.GetOrCreate(CacheKey, cacheEntry =>
{
	// 兩種實現的功能是一樣的,只是時間設定的方式不同而已
	// 相對當前的絕對過期時間,傳入時間差,會根據當前時間算出絕對過期時間
	cacheEntry.AbsoluteExpirationRelativeToNow = TimeSpan.FromSeconds(3);
	// 絕對過期時間,傳入一個DateTimeOffset物件,需要明確的指定具體的時間
	// cacheEntry.AbsoluteExpiration = DateTimeOffset.Now.AddSeconds(2);
	// 滑動過期時間是一個相對時間
	cacheEntry.SlidingExpiration = TimeSpan.FromSeconds(3);
	return DateTime.Now;
});

GetOrCreateGetOrCreateAsync 方法的回撥引數其實就是實現了 ICacheEntry 介面的物件。

這裡同時設定了絕對過期時間和滑動過期時間,對於一個快取項,僅具有滑動過期時間的快取項集有永不過期的風險。 如果在滑動過期間隔內重複訪問快取項,則該項永遠不會過期。 將滑動過期與絕對過期相結合,以確保專案過期。 絕對過期時間設定一個上限,即在滑動過期間隔內未請求該項時,仍允許該項提前過期的時間。 如果經過了可調到期間隔或絕對到期時間,則會從快取中逐出項。

可以看到輸出結果如下:

image

第三次呼叫的時候,時間改變了,這是因為輸入滑動過期時間一直在更新,但是絕對過期時間超過了,所以快取失效了。

這一篇就先到這裡,後面還有內容,但是考慮到如果全塞在一篇裡面的話,這篇文章就太長了,大家的閱讀體驗會不大好,所以就拆成兩篇了。



參考文章:
ASP.NET Core 中的記憶體中快取



ASP.NET Core 系列:

目錄:ASP.NET Core 系列總結
上一篇:ASP.NET Core - 選項系統之原始碼介紹

相關文章