錯誤更正：有關 ASP.NET MVC 分層架構使用 Unity 的 DbContext 處理

2014-12-02 補充說明：
這一系列的文章並不適合初階及中階的開發人員，如果你是程式開發的初學者或是 ASP.NET MVC 初學者，甚至是開發經驗少於兩年的開發人員，請馬上離開此篇文章。

有網友在「ASP.NET MVC 專案分層架構 Part.6 - DI/IoC 使用 Unity.MVC」這篇文章提出了一個問題：

一開始我還以為是我的 DbContext 是不是有做了什麼特殊設定還是忘了做什麼設定才會出現這樣的情況，然後我把範例程式給找出來，按照網友所提出的情境做操作，結果還真的如他所說的，當我在執行的網頁上做新刪修查時都不會有問題，資料也會同步，但如果直接對資料做修改後，網頁上面的資料並不會跟著改變，在仔細看過原本的程式之後才恍然大悟，我犯了一個嚴重的低級錯誤才會導致這種資料不一致的狀況，這一篇就是來說明要如何改正這個問題。

有關這個錯誤的文章如下：

「ASP.NET MVC 專案分層架構 Part.6 - DI/IoC 使用 Unity.MVC」「ASP.NET MVC 4 使用 Unity bootstrapper for ASP.NET MVC」

可以按照此篇文章的作法來修正錯誤。

 

---

先看看原本的程式內容：

public static void RegisterTypes(IUnityContainer container)

{

    var dbContext = new TestDBEntities();

    // Repository

    container.RegisterType<IRepository<Categories>, GenericRepository<Categories>>(

        new InjectionConstructor(dbContext));

    container.RegisterType<IRepository<Products>, GenericRepository<Products>>(

        new InjectionConstructor(dbContext));

    // Service

    container.RegisterType<ICategoryService, CategoryService>();

    container.RegisterType<IProductService, ProductService>();

}

上面的 RegisterTypes Method 是位在 Bootstrapper.cs 這個檔案裡，先不對程式做修改，先模擬一下問題發生的情境。

先執行網頁，

接著直接到 SSMS 裡對 Category 裡去修改資料，

在 SSMS 修改玩資料之後回到網頁，重新整理網頁後卻發現到顯示的資料並不是修改後的內容，

進入到編輯頁面也一樣是顯示之前未修改的內容，

其實問題點就在於 Bootstrapper.cs 內的 RegisterTypes 這個 Method 是 static 的，

在靜態方法裡所建立的 DbContext 實例都將會維持同一個，直到該 Application 結束，所以我們既使有在 SSMS 裡去修改資料，程式執行中的 DbContext 並不會去讀取資料庫的資料，而是讀取在記憶體裡 DbContext 的資料，這是個嚴重的低級錯誤，不能也不該有這樣的錯誤產生，所以就必須要改正這個錯誤，怎麼改呢？

我們原本的做法是要把 DbContext 的建立從 Repository 給拿出去，但是用了 IoC 之後必須想辦法把 DbContext 建立並且注入到 Repository 裡，既然無法在靜態的 RegisterTypes 方法去建立 DbContext 實例，那我們可以另外建立一個類別與方法來做這件事情，然後在 RegisterType 裡增加這個類別的注入。

我這邊所建立的類別為 DbContextFactory

IDbContextFactory.cs

public interface IDbContextFactory

{

    DbContext GetDbContext();

}

DbContextFactory.cs (此實作會有問題，在下面有修正過的版本與說明)

public class DbContextFactory : IDbContextFactory

{

    private string _ConnectionString = string.Empty;

    public DbContextFactory(string connectionString)

    {

        this._ConnectionString = connectionString;

    }

    public DbContext GetDbContext()

    {

        return this.CreateDbContextInstance(this._ConnectionString);

    }

    private DbContext CreateDbContextInstance(string connectionString)

    {

        Type t = typeof(DbContext);

        return (DbContext)Activator.CreateInstance(t, connectionString);

    }

}

 

2013-09-08 更正

因為在寫「ASP.NET MVC 使用 Autofac」的時候就發現到 DbContextFactory 的 CreateDbContextInstance 方法有些不太對勁，因為每次仍然會建立一個新的 DbContext instance，所以 DbContextFactory 就做了修正，如下：

public class DbContextFactory : IDbContextFactory

{

    private string _ConnectionString = string.Empty;

    public DbContextFactory(string connectionString)

    {

        this._ConnectionString = connectionString;

    }

    private DbContext _dbContext;

    private DbContext dbContext

    {

        get

        {

            if (this._dbContext == null)

            {

                Type t = typeof(DbContext);

                this._dbContext =

                    (DbContext)Activator.CreateInstance(t, this._ConnectionString);

            }

            return _dbContext;

        }

    }

    public DbContext GetDbContext()

    {

        return this.dbContext;

    }

}

不過這還需要另外在 Unity 設定時再去調整 DbContextFactory 的 LifetimeManager，以確保 DbContextFactory instance 沒有重複，讓 DbContextFactory 不會建立重複的 DbContance instance。

 

再來就是修改 Bootstrapper.cs 的 RegisterTypes 內容，修改如下：

public static void RegisterTypes(IUnityContainer container)

{

    string connectionString = 

        WebConfigurationManager.ConnectionStrings["TestDBEntities"].ConnectionString;

    container.RegisterType<IDbContextFactory, DbContextFactory>(

        new HierarchicalLifetimeManager(),

        new InjectionConstructor(connectionString));

    // Repository

    container.RegisterType<IRepository<Categories>, GenericRepository<Categories>>();

    container.RegisterType<IRepository<Products>, GenericRepository<Products>>();

    // Service

    container.RegisterType<ICategoryService, CategoryService>();

    container.RegisterType<IProductService, ProductService>();

}

Uinty.MVC3 與 Unity.MVC4 為非官方的整合套件，使用 Enterprsie Library Unity 2.1 與 ASP.NET MVC 做整合，在 Unity 2.1 裡並沒有提供 PerHttpRequest 的 LifetimeManager 的支援，而 TransientLifetimeManager 是 Unity 在註冊類別時所使用的預設 LifetimeManager。

TransientLifetimeManager
http://msdn.microsoft.com/en-us/library/microsoft.practices.unity.transientlifetimemanager(v=pandp.20).aspx
「An LifetimeManager implementation that does nothing, thus ensuring that instances are created new every time.」

TransientLifetimeManager，這是 Unity 註冊類別時的預設值，如果沒有特別加註使用 TransientLifetimeManager 或其他 LifetimeManager 時就會預設使用，使用 TransientLifetimeManager 表示每次都會建立一個新的實例。

在註冊 IDbContextFactory 類別時要確保每次的 HttpRequest 只會建立一個 DbContrextFactory，而且建立的 DbContext 也必須在每次的 HttpRequest 不能夠重複，在這樣的前提下是無法使用 TransientLifetimeManager，不然會造成每個 Repository 都是使用個別的 DbContext，所以必須改使用另一個 LifetimeManager「HierarchicalLifetimeManager」。

HierarchicalLifetimeManager
http://msdn.microsoft.com/en-us/library/microsoft.practices.unity.hierarchicallifetimemanager(v=pandp.20).aspx

「A special lifetime manager which works like ContainerControlledLifetimeManager, except that in the presence of child containers, each child gets it's own instance of the object, instead of sharing one in the common parent.」

 

GenericRepository 也需要做修改，因為原本的 GenericRepository 建構式的參數要用到 DbContext，

現在要改成使用 IDbContextFactory，然後 GenericRepository 所使用的 DbContext 再由 IDbContextFactory 的 GetDbContext() 取得，修改後的程式如下，

原本在註冊各個 GenericRepository 時都會給 DbContext 這個參數到建構式，因為 GenericRepository 建構式改為使用 IDbContextFactory 後，在前面已經有處理 IDbContextFactory 的註冊，所以就可以不用再註冊 GenericRepository 時去給值了，Unity 會幫我們處理注入。

 

經過上面的修改之後就可以進行測試，不會再出現網頁顯示資料內容與資料庫不一致的情況。

 

上面是 Unity.MVC4（Unity.MVC3）的修改方式，而如果是使用 Unity bootstrapper for ASP.NET MVC 的話，因為所使用的 Unity 版本為 Unity Application Block 3，所以在使用上與 Unity.MVC4 or Unity.MVC3 有稍稍的些許不同（Unity.MVC4 or Unity.MVC3  用的版本為 Unity Application Block 2.1）。

 

Unity bootstrapper for ASP.NET MVC

前面的建立 IDbContextFactory 與 DbContextFactory、修改 GenericRepository 都是一樣的步驟與內容，不同的地方是在於 ~/App_Start/UnityCoinfig.cs 的 RegisterTypes 方法中，修改後的內容如下：

public static void RegisterTypes(IUnityContainer container)

{

    //資料庫連接字串由執行端環境來給予，而不寫死在 DbContextFactory 當中.

    string connectionString = WebConfigurationManager.ConnectionStrings["TestDBEntities"].ConnectionString;

    container.RegisterType<IDbContextFactory, DbContextFactory>(

        new PerRequestLifetimeManager(),

        new InjectionConstructor(connectionString));

    // Repository

    container.RegisterType<IRepository<Categories>, GenericRepository<Categories>>();

    container.RegisterType<IRepository<Products>, GenericRepository<Products>>();

    // Service

    container.RegisterType<ICategoryService, CategoryService>();

    container.RegisterType<IProductService, ProductService>();

}

在註冊 IDbContextFactory 類別時，LifetimeManage 是使用 PerRequestLifetimeManager 而非 HierarchicalLifetimeManager，這是 Unity Application Block 3 所新增的，這個 PerRequestLifetimeManager 主要是用在 HTTP Request 上，讓每一次的單一 HTTP Request 建立一個新的實例。

 

---

相關文章：

ASP.NET MVC 專案分層架構 Part.6 - DI/IoC 使用 Unity.MVC

ASP.NET MVC 4 使用 Unity bootstrapper for ASP.NET MVC

 

延伸閱讀：

MSDN - TransientLifetimeManager Class (Microsoft.Practices.Unity 2.1)
MSDN - HierarchicalLifetimeManager Class (Microsoft.Practices.Unity 2.1)

MSDN - PerRequestLifetimeManager Class (Microsoft.Practices.Unity 3.0)

Unity容器中的对象生存期管理 - Dennis Gao - 博客园

 

以上