《解剖 PetShop》系列之四：PetShop ASP.NET 快取機制深度解析

4.3 PetShop 4.0 中 ASP.NET 快取的實現

PetShop 作為 B2C 寵物網店，需充分考慮訪客用戶體驗。若因數據量大導致 Web 伺服器響應不及時、頁面查詢遲遲無結果，會破壞客戶訪問心情，耗盡耐心後可能失去客戶。故架構設計時系統性能殊為重要。但不能因噎廢食，專注性能而忽略數據正確性。PetShop 3.0 及之前版本因 ASP.NET 快取局限性，此問題未獲良好解決。PetShop 4.0 引入 SqlCacheDependency，使系統對快取處理大為改觀。

4.3.1 CacheDependency 介面

PetShop 4.0 引入 SqlCacheDependency，對 Category、Product、Item 資料表對應快取實施 SQL Cache Invalidation 技術。對應資料表數據發生更改後，該技術能將相關項從快取移除。實現核心為 SqlCacheDependency 類，繼承 CacheDependency 類。為保證架構可擴展性，也允許設計者建立自定義 CacheDependency 類擴展快取依賴，故需為 CacheDependency 建立抽象介面，在 web.config 配置。

命名空間 PetShop.ICacheDependency 定義 IPetShopCacheDependency 介面，僅含一介面方法：

public interface IPetShopCacheDependency
{
    AggregateCacheDependency GetDependency();
}

AggregateCacheDependency 為 .NET Framework 2.0 新增類，負責監視依賴項對象集合。集合中任一依賴項對象發生改變時，對應快取對象將自動移除。它起組合 CacheDependency 對象作用，可將多個甚至不同類型 CacheDependency 對象與快取項建立關聯。PetShop 需為 Category、Product、Item 建立依賴項，故 GetDependency() 目的為返回建立這些依賴項的 AggregateCacheDependency 對象。

4.3.2 CacheDependency 實現

實現為 Category、Product、Item 建立對應 SqlCacheDependency 類型依賴項：

public abstract class TableDependency : IPetShopCacheDependency
{
    protected char[] configurationSeparator = new char[] { ',' };
    protected AggregateCacheDependency dependency = new AggregateCacheDependency();

    protected TableDependency(string configKey)
    {
        string dbName = ConfigurationManager.AppSettings["CacheDatabaseName"];
        string tableConfig = ConfigurationManager.AppSettings[configKey];
        string[] tables = tableConfig.Split(configurationSeparator);

        foreach (string tableName in tables)
            dependency.Add(new SqlCacheDependency(dbName, tableName));
    }
    public AggregateCacheDependency GetDependency() { return dependency; }
}

需建立依賴項的資料庫與資料表配置於 web.config：

<add key="CacheDatabaseName" value="MSPetShop4"/>
<add key="CategoryTableDependency" value="Category"/>
<add key="ProductTableDependency" value="Product,Category"/>
<add key="ItemTableDependency" value="Product,Category,Item"/>

依各資料表間依賴關係，不同表需建立依賴項不同，從配置 value 可見。但建立依賴項行為邏輯相似，故設計抽象共同類 TableDependency，透過帶參數建構函數完成依賴項建立。介面方法 GetDependency() 返回的對象 dependency 在受保護建構函數創建，此實現方式可視為 Template Method 模式 靈活運用。如 TableDependency 子類 Product 利用父類建構函數建立 Product、Category 依賴：

public class Product : TableDependency
{
    public Product() : base("ProductTableDependency") { }
}

若需自定義 CacheDependency，創建依賴項方式不同。但無論創建 SqlCacheDependency 或自定義對象，皆添加至 AggregateCacheDependency，故可為自定義 CacheDependency 建立專門類，只需實作 IPetShopCacheDependency 介面。

4.3.3 CacheDependency 工廠

繼承 TableDependency 的 Product、Category、Item 類調用時需創建各自對象。因父類實作 IPetShopCacheDependency，故它們間接實作該介面，為工廠模式提供前提。

PetShop 4.0 仍利用配置檔與反射技術實現工廠模式。命名空間 PetShop.CacheDependencyFactory 中 DependencyAccess 類為創建 IPetShopCacheDependency 對象工廠類：

public static class DependencyAccess
{
    public static IPetShopCacheDependency CreateCategoryDependency() { return LoadInstance("Category"); }
    public static IPetShopCacheDependency CreateProductDependency() { return LoadInstance("Product"); }
    public static IPetShopCacheDependency CreateItemDependency() { return LoadInstance("Item"); }

    private static IPetShopCacheDependency LoadInstance(string className)
    {
        string path = ConfigurationManager.AppSettings["CacheDependencyAssembly"];
        string fullyQualifiedClass = path + "." + className;
        return (IPetShopCacheDependency)Assembly.Load(path).CreateInstance(fullyQualifiedClass);
    }
}

工廠模式實現：

DependencyAccess 創建實作 IPetShopCacheDependency 的類 Category、Product、Item，但引入介面目的在於獲得創建依賴項的 AggregateCacheDependency 類型對象。可調用介面方法 GetDependency()：

AggregateCacheDependency dependency = DependencyAccess.CreateCategoryDependency().GetDependency();

為方便調用者，似可改進 DependencyAccess 將 CreateCategoryDependency() 修改為創建 AggregateCacheDependency 類型對象方法。但這擾亂工廠類職責，且創建介面對象行為仍可能被調用者調用，故保留原類仍必要。

PetShop 4.0 設計中透過引入 Facade 模式 方便調用者更簡單獲得 AggregateCacheDependency 類型對象。

4.3.4 引入 Facade 模式

Facade 模式可將複雜邏輯包裝，方便調用者調用。如提供統一門面，將內部子系統封裝，統一為高層次介面。典型 Facade 模式示意圖：

Facade 目的非引入新功能，而是在現有功能基礎上提供更高層次抽象，使調用者可直接調用無需關心內部實現。以 CacheDependency 工廠為例，創建 DependencyFacade 類：

public static class DependencyFacade
{
    private static readonly string path = ConfigurationManager.AppSettings["CacheDependencyAssembly"];
    public static AggregateCacheDependency GetCategoryDependency()
    {
        if (!string.IsNullOrEmpty(path)) return DependencyAccess.CreateCategoryDependency().GetDependency();
        else return null;
    }
    public static AggregateCacheDependency GetProductDependency()
    {
        if (!string.IsNullOrEmpty(path)) return DependencyAccess.CreateProductDependency().GetDependency();
        else return null;
    }
    public static AggregateCacheDependency GetItemDependency()
    {
        if (!string.IsNullOrEmpty(path)) return DependencyAccess.CreateItemDependency().GetDependency();
        else return null;
    }
}

DependencyFacade 封裝獲取 AggregateCacheDependency 邏輯，調用者可調用相關方法獲得創建相關依賴項的對象：

AggregateCacheDependency dependency = DependencyFacade.GetCategoryDependency();

比直接調用 DependencyAccess.GetDependency() 更簡單，同時對 CacheDependencyAssembly 配置節判斷，值為空則返回 null。

PetShop.Web App_Code 下靜態類 WebUtility 的 GetCategoryName() 與 GetProductName() 調用 DependencyFacade。如 GetCategoryName()：

public static string GetCategoryName(string categoryId)
{
    Category category = new Category();
    if (!enableCaching) return category.GetCategory(categoryId).Name;

    string cacheKey = string.Format(CATEGORY_NAME_KEY, categoryId);
    string data = (string)HttpRuntime.Cache[cacheKey];
    if (data == null)
    {
        int cacheDuration = int.Parse(ConfigurationManager.AppSettings["CategoryCacheDuration"]);
        data = category.GetCategory(categoryId).Name;
        AggregateCacheDependency cd = DependencyFacade.GetCategoryDependency();
        HttpRuntime.Cache.Add(cacheKey, data, cd, DateTime.Now.AddHours(cacheDuration), Cache.NoSlidingExpiration, CacheItemPriority.High, null);
    }
    return data;
}

GetCategoryName() 先檢查快取中是否存在 CategoryName 數據項，存在則直接獲取；否則透過 BLL 調用 DAL 訪問資料庫獲取，獲得後將新數據連同 DependencyFacade 創建的 AggregateCacheDependency 添加到快取。

WebUtility 被表示層許多頁面調用，如 Products 頁面：

public partial class Products : System.Web.UI.Page
{
    protected void Page_Load(object sender, EventArgs e)
    {
        Page.Title = WebUtility.GetCategoryName(Request.QueryString["categoryId"]);
    }
}

顯示頁面 Title 邏輯置於 Page_Load，每次打開頁面都執行獲取 CategoryName。未採用快取機制時，Category 數據較多會導致頁面顯示緩慢。

4.3.5 引入 Proxy 模式

BLL 中與 Product、Category、Item 相關業務方法，實現邏輯為調用 DAL 對象訪問資料庫獲取數據。為改善性能，需為這些方法增加快取機制邏輯。操作增加快取機制的業務對象時，對調用者應與 BLL 業務對象調用保持一致。故需引入新對象控制原 BLL 業務對象，此為 Proxy 模式中的代理對象。

以 PetShop.BLL.Product 為例，PetShop 為其建立代理對象 ProductDataProxy，在 GetProductsByCategory() 等方法引入快取機制：

public static class ProductDataProxy
{
    private static readonly int productTimeout = int.Parse(ConfigurationManager.AppSettings["ProductCacheDuration"]);
    private static readonly bool enableCaching = bool.Parse(ConfigurationManager.AppSettings["EnableCaching"]);

    public static IList<ProductInfo> GetProductsByCategory(string category)
    {
        Product product = new Product();
        if (!enableCaching) return product.GetProductsByCategory(category);

        string key = "product_by_category_" + category;
        IList<ProductInfo> data = (IList<ProductInfo>)HttpRuntime.Cache[key];
        if (data == null)
        {
            data = product.GetProductsByCategory(category);
            AggregateCacheDependency cd = DependencyFacade.GetProductDependency();
            HttpRuntime.Cache.Add(key, data, cd, DateTime.Now.AddHours(productTimeout), Cache.NoSlidingExpiration, CacheItemPriority.High, null);
        }
        return data;
    }
}

與 BLL Product.GetProductsByCategory() 比較，增加快取機制。快取內不存在相關數據項時，直接調用 BLL Product 方法獲取數據，並與對應 AggregateCacheDependency 存儲在快取中。

引入 Proxy 模式實現快取層級上對業務對象封裝，增強對業務對象控制。因暴露方法一致，對調用方而言調用代理對象與真實對象無實質區別。

從職責分離與分層設計角度，筆者更希望 Proxy 對象定義在 BLL 中，而非像 PetShop 設計劃分到表示層 UI。若考慮程式可擴展性與可替換性，可為真實對象與代理對象建立統一介面或抽象類。但單以 PetShop 表示層調用看，採用靜態類與靜態方法或許更合理。需謹記「過度設計」是軟體設計警戒線。

若需對 UI 層採用快取機制將應用程式數據存放快取，可調用代理對象。以 ProductsControl 用戶控件為例：

productsList.DataSource = ProductDataProxy.GetProductsByCategory(categoryKey);

productsList 為自定義 CustomList 類型（繼承 DataList），DataSource 接受 IList 集合。

但 PetShop 4.0 設計中，對類似 ProductsControl 控件採用頁輸出快取。從 ProductsControl.ascx Source 代碼可見端倪：

<%@ OutputCache Duration="100000" VaryByParam="page;categoryId" %>

ASP.NET 2.0 為用戶控件新引入 CachePolicy 屬性（型別 ControlCachePolicy），以編程方式實現輸出快取設置。可透過設置 ControlCachePolicy.Dependency 設置相關依賴項，如 ProductsControl：

protected void Page_Load(object sender, EventArgs e)
{
    this.CachePolicy.Dependency = DependencyFacade.GetProductDependency();
}

採用頁輸出快取並利用 ControlCachePolicy 設置，能將業務數據與整個頁面放入快取。此方式比應用程式快取在性能上有大幅提高，又透過引入 SqlCacheDependency 有效避免「數據過期」缺點，故在 PetShop 4.0 廣泛採用。相對地，之前為 Product、Category、Item 建立的代理對象被「投閒置散」，僅作為設計方法展示而「倖存」於系統源代碼中。