[WCF REST] 通過ASP.NET Output Caching實現聲明式緩存

ASP.NET的輸出緩存（Output Caching）機制允許我們針對整個Web頁面或者頁面的某個部分（主要針對用戶控件）最終呈現的HTML進行緩存。對於后續針對相同資源的請求，只需要直接將緩存的HTML予以回復而無須按照頁面處理生命周期對每次請求進行重復處理。WCF通過操作行為AspNetCacheProfileAttribute利用ASP.NET的輸出緩存提供一種針對於某個操作的聲明式緩存機制。[源代碼從這里下載]

一、AspNetCacheProfileAttribute

WCF對ASP.NET緩存的支持是通過AspNetCacheProfileAttribute特性來實現的。通過如下的代碼我們不難看出AspNetCacheProfileAttribute是實現了IOperationBehavior接口的操作行為，我們可以直接將其應用到契約接口/類中的某個具有緩存需要的操作方法上。

[AttributeUsage(AttributeTargets.Method)]
public sealed class AspNetCacheProfileAttribute : Attribute, IOperationBehavior
{
    //其他成員
    public AspNetCacheProfileAttribute(string cacheProfileName);
    public string CacheProfileName { get; }
}

AspNetCacheProfileAttribute構造函數參數cacheProfileName表示的CacheProfile的配置名稱，目標操作按照定義在相應CacheProfile的緩存策略實施緩存。CacheProfile配置在<system.web>/<caching>/<outputCacheSettings>/<outputCacheProfiles>節點下。

<configuration>
  <connectionStrings>
    <add name="localDb"
         connectionString="Server=.; Database=TestDb; Uid=sa; Pwd=password"
         providerName="System.Data.SqlClient"/>
  </connectionStrings>
  <system.web>
    <caching>
      <outputCacheSettings>
        <outputCacheProfiles>
          <add name="default"
               duration="60"
               varyByParam="none"
               sqlDependency="TestDb: TestTable"/>
        </outputCacheProfiles>
      </outputCacheSettings>
      <sqlCacheDependency>
        <databases>
          <add name="TestDb" connectionStringName="localDb"/>
        </databases>
      </sqlCacheDependency>
    </caching>
  </system.web>
</configuration>

在如上所示的配置片斷中，我們定義了一個名稱為default的CacheProfile。代表緩存時間的duration屬性被設置為60，意味着緩存項在被存儲之后1分鍾之后實失效；屬性varyByParam被設置為none表示緩存項與請求的查詢字符串無關。此外，該CacheProfile還設置針對某個本地數據庫中的TestTable表的SQL依賴（SQL Dependency）。關於CacheProfile的配置屬於ASP.NET的范疇，在這里我們不會作過多的討論。

既然是采用ASP.NET輸出緩存，WCF服務自然需要采用IIS寄宿並采用ASP.NET 兼容模式。值得一提的是，基於AspNetCacheProfileAttribute的輸出緩存僅僅針對HTTP-GET。

二、實例演示：創建采用輸出緩存的服務

接下來我們通過一個簡單的實例來演示如何通過操作行為對某個操作的返回值實施緩存，為此我們創建一個用於返回當前時間的服務。如下所示的是作為服務契約的ITime接口的定義，AspNetCacheProfileAttribute特性被應用到了用於返回當前時間的操作方法GetCurrentTime上。

using System;
using System.ServiceModel;
using System.ServiceModel.Web;
namespace Artech.WcfServices.Service.Interface
{
    [ServiceContract(Namespace = "http://www.artech.com/")]
    public interface ITime
    {
        [WebGet(UriTemplate = "/current")]
        [AspNetCacheProfile("default")]
        DateTime GetCurrentTime();
    }
}

實現了契約接口ITime的服務類型TimeService定義如下。我們將AspNetCompatibilityRequirementsAttribute特性應用在服務類型上並將RequirementsMode屬性設置為Allowed以提供對ASP.NET兼容模式的支持。

using System;
using System.ServiceModel.Activation;
using Artech.WcfServices.Service.Interface;
namespace Artech.WcfServices.Service
{
    [AspNetCompatibilityRequirements(
     RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]
    public class TimeService : ITime
    {
        public DateTime GetCurrentTime()
        {
            return DateTime.Now;
        }
    }
}

在一個Web項目中我們為通過IIS寄宿的服務TimeService添加一個對應的.svc文件（TimeService.svc），如下所示的是<%@ServiceHost%>指令的定義。表示ServiceHostFactory類型的指令屬性Factory被設置為System.ServiceModel.Activation.WebServiceHostFactory.

<%@ ServiceHost Service="Artech.WcfServices.Service.TimeService" Factory="System.ServiceModel.Activation.WebServiceHostFactory"%>

我們在作為服務宿主的Web項目下添加一個配置文件（Web.config）並定義如下的配置。除了服務寄宿的基本配置外，我們將<system.serviceModel>/<serviceHostingEnvironment >配置節的aspNetCompatibilityEnabled屬性設置為True以開啟ASP.NET兼容模式。應用在操作方法GetCurrentTime上的AspNetCacheProfileAttribute特性中指定的名稱為default的CacheProfile定義在該配置中，duration和varyByParam分別被設置為60和none。

<configuration>
    <system.serviceModel>
        <services>
            <service name="Artech.WcfServices.Service.TimeService">
                <endpoint binding="webHttpBinding"
                          contract="Artech.WcfServices.Service.Interface.ITime"/>
            </service>
        </services>
      <serviceHostingEnvironment aspNetCompatibilityEnabled="true" />
    </system.serviceModel>
  <system.web>
    <caching>
      <outputCacheSettings>
        <outputCacheProfiles>
          <add name="default" duration="60" varyByParam="none"/>
        </outputCacheProfiles>
      </outputCacheSettings>
    </caching>
  </system.web>
</configuration>

作為客戶端的控制台程序在進行了相應配置之后通過如下的代碼進行服務的調用。在這段代碼中，我們通過創建的服務代理進行了5次服務調用，並將獲取的時間打印出來。每次服務的時間間隔為1秒。

using (ChannelFactory<ITime> channelFactory =  new ChannelFactory<ITime>("timeService"))
{
    ITime proxy = channelFactory.CreateChannel();
    for (int i = 0; i < 5; i++)
    {
        Console.WriteLine(proxy.GetCurrentTime().ToLongTimeString());
        Thread.Sleep(1000);
    }
}

客戶端代碼執行之后會在控制台上輸出如下的結果。由於服務端通過ASP.NET的輸出緩存對第一次執行GetCurrentTime操作的結果進行了緩存，所以客戶端返回的時間都是相同的。

4:48:43 PM
4:48:43 PM
4:48:43 PM
4:48:43 PM
4:48:43 PM

三、 AspNetCacheProfileAttribute是如何實現輸出緩存的？

既然我們采用ASP.NET兼容模式來寄宿服務，意味着我們調用某個服務與訪問某個頁面沒有本質的區別，所以基於Web頁面的輸出緩存能夠應用於基於某個服務操作的調用就不足為奇了。現在有這么一個問題：通過AspNetCacheProfileAttribute特性指定CacheProfile是如何生效的？

如果對ASP.NET具有一定的了解，應該知道可以通過當前HttpResponse（HttpContext.Current.Response）的Cache屬性表示的HttpCachePolicy對象來控制當前輸出緩存的基本策略。實際上AspNetCacheProfileAttribute就是通過這種方式將定義在指定CacheProfile的緩存策略應用到針對當前操作的調用上的。

具體來說，AspNetCacheProfileAttribute針對輸出緩存策略的控制是通過一個實現了接口IParameterInspector的自定義參數檢驗器實現的，這是一個名稱為CachingParameterInspector的內部類型。操作行為AspNetCacheProfileAttribute通過實現的ApplyDispatchBehavior方法將針對某個CacheProfile創建的CachingParameterInspector對象添加到當前分發操作（DispatchOperation）的參數檢驗器列表中。

internal class CachingParameterInspector : IParameterInspector
{
    public CachingParameterInspector(string cacheProfileName);
    public object BeforeCall(string operationName, object[] inputshens);
    public void AfterCall(string operationName, object[] outputs, object returnValue, object correlationState)
    {
        //將指定CacheProfile的輸出緩存策略應用到當前HttpResponse
    }
}

如上面的代碼片斷所示，當AfterCall方法被執行的之后，在構造函數中指定的CacheProfile定義的輸出緩存策略應用到當前HttpResponse。而AfterCall會在操作執行之后，回復消息序列化之前被執行。