老趙點滴 - 追求編程之美 先做人，再做技術人員，最后做程序員。打造國內最好的.NET技術博客。

還有一種情況就是需要“無條件”地為控件保存多個版本的緩存。例如有個需求是寫一個RandomUsers控件，根據UserIDs指定的數據中隨機挑選出幾個用于展示的用戶數據，例如：

<jeffz:RandomUsers runat="server" UserIDs="1, 2, 3, 4, 5" Count="3" />

那么現在還能夠使用ASP.NET的OutputCache嗎？至少老趙不知道該如何做。因此我們需要一個額外的緩存輸出的解決方案，它的要求其實只有兩個：

• 可以自由地定義緩存版本。
• 可以為每個版本緩存不同的副本，并隨機輸出。

這就是老趙下面要提到的這個解決方案：CachePanel的需求來源。

CachePanel的構建與使用

其實CachePanel很簡單，相信已經有一些朋友能夠想象出這個組件的大致邏輯了。根據老趙的習慣，我們還是使用“用例驅動開發”的方式來進行組件開發。例如老趙期望的使用方式是這樣的：

<jeffz:CachePanel runat="server"
    Duration="00:15:00"
    CopyCount="10"
    CacheKey="RandomUsers"
    ResolveCacheKey="CachePanel_ResolveCacheKey"
> 
    <jeffz:RandomUsers runat="server" UserIDs="1, 2, 3, 4, 5" Count="3" />
</asp:CachePanel>

以下是CachePanel的各種成員描述與代碼：

public class CachePanel : Control
{
    public TimeSpan Duration { get; set; }
 
    public int CopyCount { get; set; }
 
    public string CacheKey { get; set; }
 
    public EventHandler ResolveCacheKey { get; set; }
 
    ...
}

• Duration屬性：每份緩存副本的有效時間長度。這里使用TimeSpan的字符串表示法，老趙認為相較傳統的秒數，這樣能夠更直接地設定和讀取一段時間長度。
• CopyCount屬性：每個緩存版本的副本數量，輸出時將任意選擇一個副本輸出。在上例中，我們通過生成10個副本讓用戶看起來的確是在輸出隨機的結果，而其實我們只是緩存了10個副本而已。
• CacheKey屬性：不同的CacheKey決定了不同的緩存版本。請注意這個CacheKey是全局的，因此不同頁面中的CachePanel如果CacheKey相同，將會得到相同的緩存結果（排除CopyCount屬性的影響）。
• ResolveCacheKey事件：提供了一個動態指定緩存版本的可能。開發人員可以響應該事件，根據上下文環境的不同（例如QueryString，Form或Header的不同）對CacheKey進行改變。

可以看到，其實只是這簡單的四個成員就能滿足上文的要求（而且事實上，在理論上CopyCount也能夠省略，因為我們有ResolveCacheKey事件，不是嗎？）。

至于與緩存相關的具體邏輯，其實非常簡單。首先是在OnInit事件中檢查是否命中緩存：

1. 執行ResolveCacheKey事件以確認CacheKey。
2. 隨機選取副本編號。
3. 根據CacheKey和副本編號確認被緩存的數據所使用的key（如果CacheKey為空，則使用默認的CacheKey，它保證了同一頁面中的位置相同的CachePanel實例共享緩存版本）。
4. 如果緩存命中，則清除CachePanel內的所有子控件。

代碼如下：

public class CachePanel : Control
{
    ...
    private static Random s_random = new Random(DateTime.Now.Millisecond);
 
    public bool CacheHit { get; private set; }
 
    private string m_cacheKey;
    private string m_cachedContent;
 
    protected override void OnInit(EventArgs e)
    {
        var resolveCacheKey = this.ResolveCacheKey;
        if (resolveCacheKey != null)
        {
            resolveCacheKey(this, EventArgs.Empty);
        }
 
        int copyIndex = s_random.Next(this.CopyCount);
        this.m_cacheKey = this.GetCacheKey(copyIndex);
 
        this.m_cachedContent = this.Context.Cache.Get(this.m_cacheKey) as string;
        this.CacheHit = (this.m_cachedContent != null);
        if (this.CacheHit) this.Controls.Clear();
 
        base.OnInit(e);
    }
 
    private string GetCacheKey(int copyIndex)
    {
        var cacheKeyBase = this.CacheKey ?? this.GetDefaultCacheKeyBase();
        return "$CachePanel$" + cacheKeyBase + "_" + copyIndex;
    }
 
    private string GetDefaultCacheKeyBase()
    {
        return this.Context.Request.AppRelativeCurrentExecutionFilePath + "_" + this.UniqueID;
    }
    ...
}

由于內容被清空，然后到了生成內容階段，事情就好辦了——簡單的緩存子控件生成的HTML內容即可：

public partial class CachePanel : Control
{ 
    ...
    protected override void RenderChildren(HtmlTextWriter writer)
    {
        if (this.m_cachedContent == null)
        {
            StringBuilder sb = new StringBuilder();
            HtmlTextWriter innerWriter = new HtmlTextWriter(new StringWriter(sb));
            base.RenderChildren(innerWriter);
 
            this.m_cachedContent = sb.ToString();
            this.Context.Cache.Insert(this.m_cacheKey, this.m_cachedContent, null, 
                DateTime.Now.Add(this.Duration), Cache.NoSlidingExpiration);
        }
 
        writer.Write(this.m_cachedContent);
    }
}

至此，CachePanel就制作完成了，其實只是短短的幾十行代碼而已。到這里老趙不禁又要發一句感慨：只要了解了框架的運行規則，開發出各種擴展又有多少難度呢？一切都只是看您有多少想象力而已。

不過大家在使用CachePane時可能還需要注意以下幾點：

• CacheKey的作用域是整個ASP.NET應用程序，因此如果您要指定CacheKey的話，請給出清晰而明確的值。
• CachePanel能夠緩存頁面中任意部分的內容，不過在使用時可能就需要您根據CacheHit屬性的值來判斷是否需要為控件填充數據，否則可能就會無法達到緩存的目的。
• CachePanel將會在緩存命中時清空所有子控件，因此在操作時也請注意這一點，以免出現不可預知（Unpredictable）的結果。