注意
這不是本文的最新版本。 如需目前發行版本,請參閱本文的 .NET 11 版本。
快取可藉由減少產生內容所需的工作,大幅改善應用程式的效能和延展性。 快取最適合不常變更 且 產生成本高昂的數據。 快取讓資料副本的返回速度比直接從來源取得快得多。 應用程式應該撰寫並測試, 永遠不會 相依於快取的數據。
ASP.NET Core 支援數個不同的快取。 最簡單的快取是基於介面 IMemoryCache 。
IMemoryCache 表示儲存在網頁伺服器記憶體中的快取。 在伺服器農場(多部伺服器)上執行的應用程式應該在使用記憶體內部快取時確保會話持續連線。 黏性會話可確保來自用戶端的要求全都移至相同的伺服器。 例如,Azure 網頁應用程式使用 Microsoft Application Request Routing (ARR) 將所有請求路由至同一伺服器。
網路農場中的非黏性會話需要分散式 快取 以避免快取一致性問題。 對於某些應用程式,分散式快取可以支援比記憶體內部快取更高的向外延展。 使用分散式快取會將快取記憶體卸除至外部進程。
記憶體內部快取可以儲存任何物件。 分散式快取介面限制為 byte[]。 記憶體內部和分散式快取會將快取項目儲存為鍵值對。
使用 System.Runtime.Caching/MemoryCache
System.Runtime.Caching / MemoryCache (NuGet 套件)可用於:
- .NET 標準 2.0 或更新版本
- 任何 .NET 實作 針對 .NET Standard 2.0 或更高版本(例如 ASP.NET Core 3.1 或更高版本)
- .NET Framework 4.5 或更新版本
Microsoft.Extensions.Caching.Memory/System.Runtime.Caching(本文所述)比 MemoryCache/IMemoryCache 更受推薦,因為它與 ASP.NET Core 的整合更佳。 例如, IMemoryCache 以原生方式搭配 ASP.NET Core 依賴注入運作。
將程式代碼從 ASP.NET 4.x 移植到 ASP.NET Core 時,使用 System.Runtime.Caching/MemoryCache 作為相容性網橋。
主記憶體快取檢討指引
以下指引適用於記憶體內快取:
程式碼應該永遠有備援選項來擷取資料, 而非 依賴快取值的可用性。
快取使用記憶體,而記憶體是稀缺資源。 限制快取成長:
不要 把外部輸入插入快取。 舉例來說,不建議使用任意使用者提供的輸入作為快取金鑰,因為該輸入可能會佔用不可預測的記憶體量。
使用到期日來限制快取成長。
使用 SetSize、Size 和 SizeLimit 來限制快取大小。 ASP.NET Core執行時不會根據記憶體壓力限制快取大小。 開發者負責限制快取大小。
建立一個 IMemoryCache 實例
記憶體內快取是一種應用程式透過依賴注入來引用的服務。
Warning
如果同一個快取被多個框架或函式庫使用,那就是 共享 快取。 如果你使用依賴 注入 的共享記憶體快取,並且使用 SetSize、 Size,以及 SizeLimit 為了限制快取大小,應用程式可能會失敗。
當快取設定大小限制時,所有條目在新增時必須指定大小。 這種做法可能會帶來問題,因為開發者可能無法完全控制使用共享快取的內容。
為了限制快取大小,可以使用SetSize方法,Size屬性,或SizeLimit屬性,並且建立一個快取單例來進行快取。 欲了解更多資訊與範例,請參閱 「使用 SetSize、Size 及 SizeLimit 限制快取大小」。
在建構函式中請求 IMemoryCache 實例:
public class IndexModel : PageModel
{
private readonly IMemoryCache _memoryCache;
public IndexModel(IMemoryCache memoryCache) =>
_memoryCache = memoryCache;
// ...
以下程式碼使用該 TryGetValue 方法來檢查快取中是否有時間。 如果某個時間未被快取,便會建立一個新項目,並使用 Set 方法將其加入快取中:
public void OnGet()
{
CurrentDateTime = DateTime.Now;
if (!_memoryCache.TryGetValue(CacheKeys.Entry, out DateTime cacheValue))
{
cacheValue = CurrentDateTime;
var cacheEntryOptions = new MemoryCacheEntryOptions()
.SetSlidingExpiration(TimeSpan.FromSeconds(3));
_memoryCache.Set(CacheKeys.Entry, cacheValue, cacheEntryOptions);
}
CacheCurrentDateTime = cacheValue;
}
在前述程式碼中,快取條目設定為滑動有效期 3 秒。 如果快取條目未被存取超過 3 秒,該條目將被逐出快取。 每次存取快取條目時,它將在快取中額外保留 3 秒。 類別 CacheKeys 是下載範例的一部分。
目前的時間和快取時間會顯示:
<ul>
<li>Current Time: @Model.CurrentDateTime</li>
<li>Cached Time: @Model.CacheCurrentDateTime</li>
</ul>
下列程式碼使用Set擴充方法快取相對時間的數據,而不使用MemoryCacheEntryOptions。
_memoryCache.Set(CacheKeys.Entry, DateTime.Now, TimeSpan.FromDays(1));
在上述程式代碼中,快取項目會設定為一天的相對到期日。 即使該快取條目在逾時期間被存取,也會在一天後從快取中移除。
以下程式碼使用 and GetOrCreateGetOrCreateAsync 方法來快取資料。
public void OnGetCacheGetOrCreate()
{
var cachedValue = _memoryCache.GetOrCreate(
CacheKeys.Entry,
cacheEntry =>
{
cacheEntry.SlidingExpiration = TimeSpan.FromSeconds(3);
return DateTime.Now;
});
// ...
}
public async Task OnGetCacheGetOrCreateAsync()
{
var cachedValue = await _memoryCache.GetOrCreateAsync(
CacheKeys.Entry,
cacheEntry =>
{
cacheEntry.SlidingExpiration = TimeSpan.FromSeconds(3);
return Task.FromResult(DateTime.Now);
});
// ...
}
以下程式碼呼叫 Get 方法以取得快取時間:
var cacheEntry = _memoryCache.Get<DateTime?>(CacheKeys.Entry);
下列程式代碼會取得或建立具有絕對有效期限的快取項目:
var cachedValue = _memoryCache.GetOrCreate(
CacheKeys.Entry,
cacheEntry =>
{
cacheEntry.AbsoluteExpirationRelativeToNow = TimeSpan.FromSeconds(20);
return DateTime.Now;
});
只有滑動到期的快取專案集有永不過期的風險。 如果在滑動到期間隔內重複存取快取的項目,該項目將永遠不會過期。 將滑動有效期與絕對有效期結合,保證物品會過期。 絕對有效期設定了該項目可快取的上限。 即使物品沒有在滑動到期期限內申請,仍允許物品提前過期。 如果滑動過期時間間隔 或 絕對到期時間過後,該項目將從快取中移除。
下列程式代碼會取得或建立同時具有滑動到期 和 絕對到期的快取專案:
var cachedValue = _memoryCache.GetOrCreate(
CacheKeys.CallbackEntry,
cacheEntry =>
{
cacheEntry.SlidingExpiration = TimeSpan.FromSeconds(3);
cacheEntry.AbsoluteExpirationRelativeToNow = TimeSpan.FromSeconds(20);
return DateTime.Now;
});
前述程式碼保證資料的快取時間不會超過絕對時間。
GetOrCreate、GetOrCreateAsync 和 Get 是 CacheExtensions 類別中的擴充方法。 這些方法會擴充 IMemoryCache 的功能。
為一個條目建立 MemoryCacheEntryOptions
以下範例示範如何為條目創建 MemoryCacheEntryOptions 。 程式代碼會完成下列工作:
將快取優先權設定為 CacheItemPriority.NeverRemove。
在條目從快取中被驅逐後,設定 a PostEvictionDelegate 呼叫。 回調執行在與移除快取項目的程式碼不同的執行緒上。
public void OnGetCacheRegisterPostEvictionCallback()
{
var memoryCacheEntryOptions = new MemoryCacheEntryOptions()
.SetPriority(CacheItemPriority.NeverRemove)
.RegisterPostEvictionCallback(PostEvictionCallback, _memoryCache);
_memoryCache.Set(CacheKeys.CallbackEntry, DateTime.Now, memoryCacheEntryOptions);
}
private static void PostEvictionCallback(
object cacheKey, object? cacheValue, EvictionReason evictionReason, object? state)
{
if (state is IMemoryCache memoryCache)
{
memoryCache.Set(
CacheKeys.CallbackMessage,
$"Entry {cacheKey} was evicted: {evictionReason}.");
}
}
以 SetSize、Size 和 SizeLimit 限制快取大小
實 MemoryCache 例可選擇性地指定並強制執行大小限制。 快取大小限制沒有定義的測量單位,因為快取沒有測量專案大小的機制。 如果已設定快取大小限制,所有項目都必須指定大小。 ASP.NET Core 執行時間不會根據記憶體壓力限制快取大小。 由開發人員決定限制快取大小。 指定的大小是以開發人員選擇的單位來指定。
例如:
- 如果網頁應用程式主要快取字串,每個快取條目大小可能是字串長度。
- 應用程式可以將所有條目的大小指定為 1,大小限制則是條目的數量。
如果SizeLimit屬性未被設定,快取會無限成長。 ASP.NET Core 執行時不會在系統記憶體不足時清理快取。 應用程式必須架構為:
以下程式碼建立一個無單位固定大小 MemoryCache 的實例,可透過 依賴注入存取:
public class MyMemoryCache
{
public MemoryCache Cache { get; } = new MemoryCache(
new MemoryCacheOptions
{
SizeLimit = 1024
});
}
這個 SizeLimit 屬性沒有單位。 快取項目必須在設定快取大小限制時,以他們認為最合適的單位來指定大小。 快取實例的所有用戶都應該使用相同的單位系統。 如果快取的項目大小總和超過由 SizeLimit所指定的值,則該條目不算快取。 如果未設定任何快取大小限制,則會忽略項目上設定的快取大小。
以下程式碼將 MyMemoryCache 實例註冊到相依注入容器:
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
builder.Services.AddSingleton<MyMemoryCache>();
MyMemoryCache 作為獨立的記憶體快取,供已知此大小限制快取並知道如何適當設定快取條目大小的元件使用。
快取項目的大小可透過延伸 SetSize 方法或 Size 屬性來設定。
if (!_myMemoryCache.Cache.TryGetValue(CacheKeys.Entry, out DateTime cacheValue))
{
var cacheEntryOptions = new MemoryCacheEntryOptions()
.SetSize(1);
// cacheEntryOptions.Size = 1;
_myMemoryCache.Cache.Set(CacheKeys.Entry, cacheValue, cacheEntryOptions);
}
在上述程式代碼中,兩行醒目提示的代碼達成了相同的效果,設定快取項目的大小。
SetSize此方法的提供是為了方便地將呼叫串接到new MemoryCacheOptions()。
使用 MemoryCache.Compact 移除快取項目
此 MemoryCache.Compact 方法嘗試依以下順序移除指定百分比的快取:
- 所有過期商品
- 依優先順序分類項目,優先移除優先權最低的項目
- 最近最少使用的物件
- 最早絕對有效期的項目
- 最早滑動到期的項目
具有優先權 NeverRemove 的釘選項目 永遠不會移除。 以下程式碼移除快取項目,並呼叫 Compact 移除 25% 快取條目的方法:
_myMemoryCache.Cache.Remove(CacheKeys.Entry);
_myMemoryCache.Cache.Compact(.25);
如需詳細資訊,請參閱 GitHub 上的 Compact 來源。
移除依賴過期的快取項目
為了在連結快取條目間繼承到期令牌及基於時間的到期設定,註冊快取Program.cs時將設定TrackLinkedCacheEntries為true。 從 .NET 7 開始,此選項的預設值為 false:
builder.Services.AddMemoryCache(options =>
{
options.TrackLinkedCacheEntries = true;
});
下列範例示範如果相依專案到期,如何讓快取專案過期。 一個 CancellationChangeToken 被加入至快取的專案。 當在 Cancel 物件上呼叫 CancellationTokenSource 方法時,兩個快取項目都會被逐出:
public void OnGetCacheCreateDependent()
{
var cancellationTokenSource = new CancellationTokenSource();
_memoryCache.Set(
CacheKeys.DependentCancellationTokenSource,
cancellationTokenSource);
using var parentCacheEntry = _memoryCache.CreateEntry(CacheKeys.Parent);
parentCacheEntry.Value = DateTime.Now;
_memoryCache.Set(
CacheKeys.Child,
DateTime.Now,
new CancellationChangeToken(cancellationTokenSource.Token));
}
public void OnGetCacheRemoveDependent()
{
var cancellationTokenSource = _memoryCache.Get<CancellationTokenSource>(
CacheKeys.DependentCancellationTokenSource);
cancellationTokenSource?.Cancel();
}
當你使用一個 CancellationTokenSource 物件時,可以作為一個群組逐出多個快取項目。 啟用連結條目追蹤後,父條目會繼承在其 using 範圍內建立的子條目所具有的過期權杖。
關於記憶體緩存的檢閱備忘錄
以下說明適用於記憶體內快取:
到期不會在背景發生。
沒有定時器會主動掃描快取中的過期項目。 快取上的任何活動(透過
Get、TryGetValue、Set或Remove)都可能觸發背景掃描以尋找過期的物品。 在CancellationTokenSource物件上(使用 CancelAfter 方法)設定的計時器,也會移除該條目並觸發對過期物品的掃描。以下範例使用 CancellationTokenSource(TimeSpan) 了註冊標記的超載建構子。 當此令牌激活時,它會立即移除項目,並觸發驅逐回調函數。
if (!_memoryCache.TryGetValue(CacheKeys.Entry, out DateTime cacheValue)) { cacheValue = DateTime.Now; var cancellationTokenSource = new CancellationTokenSource( TimeSpan.FromSeconds(10)); var cacheEntryOptions = new MemoryCacheEntryOptions() .AddExpirationToken( new CancellationChangeToken(cancellationTokenSource.Token)) .RegisterPostEvictionCallback((key, value, reason, state) => { (state as CancellationTokenSource)?.Dispose(); }, cancellationTokenSource); _memoryCache.Set(CacheKeys.Entry, cacheValue, cacheEntryOptions); }當你使用回調來重新填入快取項目時:
- 多次請求可能會發現快取的金鑰值為空,因為回呼尚未完成。
- 這種做法可能導致多個執行緒重新填充快取項目。
當啟用連結條目追蹤,且一個快取條目(父項)建立另一個條目(子項)時,父項繼承該子節點的到期標記與基於時間的到期設定。 手動移除或更新該子項目,不會使父項目過期。
使用PostEvictionCallbacks 屬性來指定在快取項目被移除後應該執行哪些回調。
針對大部分的應用程式,
IMemoryCache會啟用 。 例如,呼叫AddMvc、AddControllersWithViews、AddRazorPages、AddMvcCore().AddRazorViewEngine以及Add{Service}檔案中許多其他方法可啟用IMemoryCache。對於沒有呼叫上述
Add{Service}方法的應用程式,你可能需要在 AddMemoryCache 檔案中呼叫該方法。MemoryCache 是執行緒安全的,且可同時在多個執行緒間使用。
在高並發情況下存取該 Count 屬性計算成本高,因為需要在內部分割區彙整項目。 避免在對效能敏感的請求路徑中頻繁存取
Count。GetOrCreate 和 GetOrCreateAsync 並非原子操作。 當多個請求同時未命中相同鍵時,每個請求都會執行工廠,最後寫入的值會保留在快取中。 對於昂貴的資料來源來說,這可能導致大量重複呼叫。 如果要讓 factory 對每個金鑰只執行一次,請使用
HybridCache,這能提供快取擊穿保護。快取儲存的是物件的參考,而非副本。 如果程式碼在讀取快取物件後改變了該物件,所有讀取該項目的呼叫者都會看到該變更。 快取不可變物件,或在更改物件前先複製物件。
使用背景快取更新
使用 背景服務 如介面 IHostedService 來更新快取。 背景服務只能在項目準備好後重新計算並指派到快取。