分享我們項目中基於EF事務機制的架構

寫在前面：

1. 本文中單元測試用到的數據庫，在執行測試之前，會被清空，即使用空數據庫。

2. 本文中的單元測試都是正確通過的。

要理解EF的事務機制，首先要理解這2個類：TransactionScope和DbContext。

DbContext是我們的數據庫，通常我們會建一個類MyProjectDbContext繼承自DbContext，里面包含所有的數據庫表。這個類相當於定義了一個完整的數據庫。

下面通過一些單元測試來看看這2個類是如何工作的。

[Test]
public void Can_Rollback_On_Errors_In_Different_Context()
{
    var user1 = Mock.Users.Random();
    var user2 = Mock.Users.Random();
    user2.FirstName = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
    var userCount = 0;
    try
    {
        using (var scope = new TransactionScope())
        {
            using (var db = new MyProjectDbContext())
            {
                db.Users.Add(user1);
                db.SaveChanges();
                userCount = db.Users.Count();
            }
            using (var db = new MyProjectDbContext())
            {
                db.Users.Add(user2);
                db.SaveChanges();//will throw exception
            }
            scope.Complete();
        }
    }
    catch(Exception)
    {
                
    }
    Assert.AreEqual(1, userCount);
    using (var db = new MyProjectDbContext())
    {
        Assert.AreEqual(0, db.Users.Count());
    }
}

注意第一個assert，userCount是等於1的，也就是說第一個db.SaveChanges()是順利執行了的。但是看看第二個assert，數據庫里面卻沒有user記錄。這就是使用TransactionScope得到的真正的事務機制。

再看一個測試：

[Test]
public void Cannot_Rollback_Without_Scope()
{
    var user1 = Mock.Users.Random();
    var user2 = Mock.Users.Random();
    user2.FirstName = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
    var userCount = 0;
    try
    {
        using (var db = new MyProjectDbContext())
        {
            db.Users.Add(user1);
            db.SaveChanges();
            userCount = db.Users.Count();
        }
        using (var db = new MyProjectDbContext())
        {
            db.Users.Add(user2);
            db.SaveChanges();//will throw exception
        }
    }
    catch (Exception)
    {

    }
    Assert.AreEqual(1, userCount);
    using (var db = new MyProjectDbContext())
    {
        Assert.AreEqual(1, db.Users.Count());
    }
}

這個測試跟上面的測試差不多，唯一的區別就是沒有使用TransactionScope把兩個DbContext包起來。於是每個DbContext成為獨立的事務。

再來看一個測試：

[Test]
public void Shouldnot_SaveToDB_As_ScopeNotComitted()
{
    var user1 = Mock.Users.Random();
    var userCount = 0;
    try
    {
        using (var scope = new TransactionScope())
        {
            using (var db = new MyProjectDbContext())
            {
                db.Users.Add(user1);
                db.SaveChanges();
                userCount = db.Users.Count();
            }
            //scope.Complete();
        }
    }
    catch (Exception)
    {

    }
    Assert.AreEqual(1, userCount);
    using (var db = new MyProjectDbContext())
    {
        Assert.AreEqual(0, db.Users.Count());
    }
}

}

這個測試表明，一旦DbContext被TransactionScope包起來之后，那么scope必須要調用scope.Complete()才能將數據更新到數據庫。

基於上面的這些知識，我們可以很容易為EF搭建支持真正事務的框架。下面我簡單介紹下我們的項目架構（EF CodeFirst, MVC）。

基於EF事務機制的架構

Domain層：

定義數據實體類，即數據庫中的表。定義繼承自DbContext的MyProjectDbContext。

Service層：

主要用於封裝所有對數據庫的訪問。例子代碼如下：

public List<User> GetAllUsers()
{
    using (var db = new MyProjectDbContext())
    {
        return db.Users.ToList();
    }
}

上面這段代碼中注意要使用using，否則DbContext的延遲加載功能會在controller層被調用。加了using之后，可以避免在controller層對數據庫的直接訪問。

Controller層：

調用service層的代碼從數據庫中得到數據，返回給UI。例子：

public ActionResult GetAllUsers()
{
    var users = IoC.GetService<IUserService>().GetAll();
    return View(users);
}

同時將UI傳回來的數據更新到數據庫，這時如果需要調用多個service來更新數據庫，那么就需要用到事務。例子：

public ActionResult DeleteUser(int userId)
{
    try
    {
        using (var scope = new TransactionScope())
        {
            IoC.GetService<IUserService>().DeleteLogs(userId);
            IoC.GetService<IUserService>().DeleteUser(userId);
            scope.Complete();
            return View();
        }
    }
    catch(Exception)
    {
        
    }
    return View();
}

通常情況下，我們會在MyControllerBase里面加一個 ActionResult TryScope(Action action)的方法，這樣在子類里面就可以不用寫try-catch了。

對於EF更深層的機制，我了解的也不多。歡迎大家討論！