EF Code First：二級緩存

作者：郭明鋒 2013-09-08 23:30:56

緩存對于一個系統來說至關重要，但是是EF到版本6了仍然沒有見到有支持查詢結果緩存機制的跡象。EF4開始會把查詢語句編譯成存儲過程緩存在Sql Server中，據說EF6中對此做了改進，會把Linq To Entities 的查詢條件直接編譯緩存在EF中。但是這些都是只是對查詢條件做了緩存，而不是緩存查詢的結果集（DbSet.Find(object key)那個雖然走了DbSet.Local數據集，但也僅支持通過主鍵查找單個實體的情況，很有局限性），沒有達到我們想要的效果。

一、前言

今天我們來談談EF的緩存問題。

EF不加緩存功能，可能也有另外的考慮吧，這里不去猜測。雖然EF團隊沒有在EF中加入緩存功能，但已經給出的緩存功能的擴展，這就是Community Entity Framework Provider Wrappers，這個擴展的工作原理由下圖可以清晰的了解：

該擴展提供了跟蹤SQL運行日志與SQJ結果集緩存的功能，這里，我們只用到它的緩存功能來為EF建立二級緩存的支持。

二、緩存設計

(一) 引用EFProviderWrappers

如下圖，在NuGet中只提供了Entity Framework Provider Wrapper Toolkit（基礎類庫）與Entity Framework Tracing Provider（日志跟蹤）的下載，很遺憾的并沒有提供 Entity Framework Caching Provider（緩存）。

我們只能自己動手來引用了，這里提供幾種思路：

到 http://code.msdn.microsoft.com/EFProviderWrappers 下載代碼，自行編譯，然后在項目GMF.Component.Data項目中手動引用EFProviderWrapperToolkit.dll與EFCachingProvider.dll文件。
EFProviderWrapperToolkit由NuGet下載，EFCachingProvider手動引用。

我是覺得兩種思路都挺麻煩的，這個擴展的代碼貌似已經不更新了（3/18/2011），而且在GMF.Component.Data中額外的引用兩個程序集也是個麻煩事，于是我用下面的方法來引用：

在GMF.Component.Data項目中新建兩個文件夾，把以上源代碼中的兩個工程以文件夾的形式包含到項目中。

這樣，似乎更干凈利落，如圖：

(二) 緩存代碼分析及整合

1. 關鍵代碼簡介

在EFCachingProvider中，我們要用到的核心類有三個：

ICache：緩存緩存基類，系統中實現了一個內存緩存類（InMemoryCache），適用于單臺服務器的緩存實現，如果要實現分布式緩存，可以從這個基類進行擴展。
- InMemoryCache：內存緩存實現類，內部使用了一個Dictionary<string, CacheEntry>作為緩存容器，以查詢的SQL語句及參數的連接字符串（或其MD5值）為鍵（EFCachingCommands.cs類中定義）。還包含了緩存命中、緩存項數量等數據的統計及緩存清理功能。
CachingPolicy：緩存策略基類，定義了當前實體是否可緩存（CanBeCached）、定義緩存緩存數（GetCacheableRows）、緩存項滑動過期與絕對過期時間（GetExpirationTimeout）等功能，并默認了絕對過期時間為永不過期（DateTime.MaxValue）。
- NoCachingPolicy：不緩存策略，禁用緩存功能。
- CacheAllPolicy：緩存所有數據策略，緩存項最大數量為int.MaxValue。
- CustomCachingPolicy：自定義緩存策略，使用了CacheableTables與NonCacheableTables兩個集合來表示數據類型是否可緩存的白名單與黑名單，這兩個名單將在重寫的CanBeCached方法中作為類型是否可緩存的驗證依據。
EFCachingConnection：此類定義了類型為ICache，CachingPolicy的兩個屬性，分別用于接收上面據說的兩個擴展點。

2. 應用緩存擴展

EF的DbContext上下文類有一個重載

public DbContext(DbConnection existingConnection, bool contextOwnsConnection) { }

需要的是DbConnection參數，而EFCachingConnection正好是派生自DbConnection的，我們只需要構建一個EFCachingConnection對象作為參數去構造DbContext派生類的對象，即可完成緩存功能的注入（如本篇第一張圖所示）。這里，緩存專用的DbContext派生類只需要派生自原項目中定義的EFDbContext類。

namespace GMF.Component.Data  
{  
    /// <summary>  
    ///     啟用緩存的自定義EntityFramework數據訪問上下文  
    /// </summary>  
    [Export("EFCaching", typeof (DbContext))]  
    public class EFCachingDbContext : EFDbContext  
    {  
        private static readonly InMemoryCache InMemoryCache = new InMemoryCache();  
 
        public EFCachingDbContext()  
            : base(CreateConnectionWrapper("default")) { }  
 
        public EFCachingDbContext(string connectionStringName)  
            : base(CreateConnectionWrapper(connectionStringName)) { }  
 
        /// <summary>  
        ///     由數據庫連接串名稱創建連接對象  
        /// </summary>  
        /// <param name="connectionStringName">數據庫連接串名稱</param>  
        /// <returns></returns>  
        private static DbConnection CreateConnectionWrapper(string connectionStringName)  
        {  
            PublicHelper.CheckArgument(connectionStringName, "connectionStringName");  
 
            string providerInvariantName = "System.Data.SqlClient";  
            string connectionString = null;  
            ConnectionStringSettings connectionStringSetting = ConfigurationManager.ConnectionStrings[connectionStringName];  
            if (connectionStringSetting != null)  
            {  
                providerInvariantName = connectionStringSetting.ProviderName;  
                connectionString = connectionStringSetting.ConnectionString;  
            }  
            if (connectionString == null)  
            {  
                throw PublicHelper.ThrowComponentException("名稱為“" + connectionStringName + "”數據庫連接串的ConnectionString值為空。");  
            }  
            string wrappedConnectionString = "wrappedProvider=" + providerInvariantName + ";" + connectionString;  
            EFCachingConnection connection = new EFCachingConnection  
            {  
                ConnectionString = wrappedConnectionString,  
                CachingPolicy = CachingPolicy.CacheAll,  
                Cache = InMemoryCache  
            };  
 
            return connection;  
        }  
    }  
}

這里緩存策略使用了緩存所有數據（CacheAllPolicy）的策略，在實際項目中，最好自定義緩存策略，而不要使用這個策略，以免服務器內存被撐爆。

#p#

我們在應用程序配置（Web.Config或App.Config）中，添加一個名為“EntityFrameworkCachingEnabled”的AppSettings節點，用來進行啟用/禁用緩存的開關配置。

<appSettings> 
   ...  
    <add key="EntityFrameworkCachingEnabled" value="true" /> 
   ...  
  </appSettings>

另外，緩存擴展還需要我們在配置文件中添加如下節點的配置：

<system.data> 
    <DbProviderFactories> 
      <add name="EF Caching Data Provider" invariant="EFCachingProvider" description="Caching Provider Wrapper" type="EFCachingProvider.EFCachingProviderFactory, GMF.Component.Data" /> 
      <add name="EF Generic Provider Wrapper" invariant="EFProviderWrapper" description="Generic Provider Wrapper" type="EFProviderWrapperToolkit.EFProviderWrapperFactory, GMF.Component.Data" /> 
    </DbProviderFactories> 
  </system.data>

再來看看，怎樣使用“EntityFrameworkCachingEnabled”配置來控制緩存功能的開關。我們的設計中，DbContext對象的注入點為如下所示的Context屬性：

所以，我們只需要在UnitOfWorkContextBase的派生類中讀取 EntityFrameworkCachingEnabled 進行切換即可。

namespace GMF.Component.Data  
{  
    /// <summary>  
    ///     數據單元操作類  
    /// </summary>  
    [Export(typeof (IUnitOfWork))]  
    public class EFRepositoryContext : UnitOfWorkContextBase  
    {  
        /// <summary>  
        ///     獲取 當前使用的數據訪問上下文對象  
        /// </summary>  
        protected override DbContext Context  
        {  
            get 
            {  
                bool secondCachingEnabled = ConfigurationManager.AppSettings["EntityFrameworkCachingEnabled"].CastTo(false);  
                return secondCachingEnabled ? EFCachingDbContext.Value : EFDbContext.Value;  
            }  
        }  
 
        [Import("EF", typeof (DbContext))]  
        private Lazy<EFDbContext> EFDbContext { get; set; }  
 
        [Import("EFCaching", typeof(DbContext))]  
        private Lazy<EFCachingDbContext> EFCachingDbContext { get; set; }  
    }  
}