The Will Will Web

記載著 Will 在網路世界的學習心得與技術分享

ASP.NET 如何將目前的 Cache 物件全部清空

最近在測試一個大量做 Cache 的網站,測試的過程中想說要先將 Cache 物件中的資料全部清空,才發現原來 ASP.NET 中內建的 Cache 物件 ( System.Web.Caching.Cache ) 並沒有支援 Clear() 方法,無法用一行把所有的 Cache 物件清空,然而我也嘗試看有沒有 Cache.Keys 物件,好讓我用 foreach 取得所有 Cache 的 Keys 進而一個一個刪除,結果也是沒有!原來要用以下這段程式碼才能將所有 Cache 中的 Keys 全部取出並逐一刪除:

IDictionaryEnumerator cacheEnum = Cache.GetEnumerator();

while (cacheEnum.MoveNext())
{
    Cache.Remove(cacheEnum.Key.ToString());
}

因為 Enumerator 正在一個一個取出每一個 Cache 元素的同時,在迴圈中卻一個一個的刪除,那麼 Enumerator 不會發生 Exception 嗎?查了一下 MSDN 針對 IDictionaryEnumerator 介面 的說明,上面有一段是這樣寫的:

只要集合保持不變,列舉值就會保持有效。如果已對集合做變更,例如加入、修改或刪除元素,則列舉值將永遠無效,而再次呼叫 MoveNextReset 會擲回 InvalidOperationException。如果在 MoveNextCurrent 之間修改集合,Current 會傳回所設定的元素,即使列舉值已經無效。

不過我自己實驗這段程式碼的結果是沒有任何錯誤發生,不過總覺得怪怪的,後來我還是改成以下這段 Code 以防萬一:

List<string> cacheKeys = new List<string>();
IDictionaryEnumerator cacheEnum = Cache.GetEnumerator();
while (cacheEnum.MoveNext())
{
    cacheKeys.Add(cacheEnum.Key.ToString());
}
foreach (string cacheKey in cacheKeys)
{
    Cache.Remove(cacheKey);
}

除此之外,我還寫了個 Extension Method 直接將 Clear() 方法擴充到 System.Web.Caching.Cache 類別去,讓日後在使用上能夠更直覺:

using System;
using System.Web.Caching;
using System.Collections;
using System.Collections.Generic;

/// <summary>
/// 擴充 System.Web.Caching 命名空間的 Extension Methods
/// </summary>
static public class CacheExtensionMethod
{
    public static void Clear(this Cache x)
    {
        List<string> cacheKeys = new List<string>();
        IDictionaryEnumerator cacheEnum = x.GetEnumerator();
        while (cacheEnum.MoveNext())
        {
            cacheKeys.Add(cacheEnum.Key.ToString());
        }
        foreach (string cacheKey in cacheKeys)
        {
            x.Remove(cacheKey);
        }
    }
}

如果要使用的話就可以用以下語法直接清除所有目前的快取項目:

protected void Page_Init(object sender, EventArgs e)
{
    Cache.Clear();
}

相關連結