上一篇:《 "DDD 領域驅動設計-談談 Repository、IUnitOfWork 和 IDbContext 的實踐(2)" 》 這篇文章主要是對 "DDD.Sample" 框架增加 Transaction 事務操作,以及增加了一些必要項目。 雖然現在的 IUnitOfWork 實現中有 Com ...
上一篇:《DDD 領域驅動設計-談談 Repository、IUnitOfWork 和 IDbContext 的實踐(2)》
這篇文章主要是對 DDD.Sample 框架增加 Transaction 事務操作,以及增加了一些必要項目。
雖然現在的 IUnitOfWork 實現中有 Commit 的實現,但也就是使用的 EF SaveChanges,滿足一些簡單操作可以,但一些稍微複雜點的實體操作就不行了,並且 Rollback 也沒有實現。
現在的 UnitOfWork 實現代碼:
public class UnitOfWork : IUnitOfWork
{
private IDbContext _dbContext;
public UnitOfWork(IDbContext dbContext)
{
_dbContext = dbContext;
}
public void RegisterNew<TEntity>(TEntity entity)
where TEntity : class
{
_dbContext.Set<TEntity>().Add(entity);
}
public void RegisterDirty<TEntity>(TEntity entity)
where TEntity : class
{
_dbContext.Entry<TEntity>(entity).State = EntityState.Modified;
}
public void RegisterClean<TEntity>(TEntity entity)
where TEntity : class
{
_dbContext.Entry<TEntity>(entity).State = EntityState.Unchanged;
}
public void RegisterDeleted<TEntity>(TEntity entity)
where TEntity : class
{
_dbContext.Set<TEntity>().Remove(entity);
}
public async Task<bool> CommitAsync()
{
return await _dbContext.SaveChangesAsync() > 0;
}
public void Rollback()
{
throw new NotImplementedException();
}
}
基於上面的實現,比如要處理這樣的一個操作:先添加一個 Teacher,然後再添加一個 Student,Student 實體中有一個 TeacherId,一般實現方式如下:
public async Task<bool> Add(string name)
{
var teacher = new Teacher { Name = "teacher one" };
_unitOfWork.RegisterNew(teacher);
await _unitOfWork.CommitAsync();
//可能還有一些 web 請求操作,比如 httpClient.Post(tearch); 可能會出選異常。
var student = new Student { Name = name, TeacherId = teacher.Id };
_unitOfWork.RegisterNew(student);
await _unitOfWork.CommitAsync();
return true;
}
上面的實現可能會出現一些問題,比如添加 Teacher 出現了異常,web 請求出現了異常,添加 Student 出現了異常等,該如何進行處理?所以你可能會增加很多判斷,還有就是異常出現後的修複操作,當需求很複雜的時候,我們基於上面的處理也就會更加複雜,根本原因是並沒有真正的實現 Transaction 事務操作。
如果單獨在 EF 中實現 Transaction 操作,可以使用 TransactionScope,參考文章:在 Entity Framework 中使用事務
TransactionScope 的實現比較簡單,如何在 DDD.Sample 框架中,結合 IUnitOfWork 和 IDbContext 進行使用呢?可能實現方式有很多中,現在我的實現是這樣:
首先,IDbContext 中增加 Database 屬性定義:
public interface IDbContext
{
Database Database { get; } //add
DbSet<TEntity> Set<TEntity>()
where TEntity : class;
DbEntityEntry<TEntity> Entry<TEntity>(TEntity entity)
where TEntity : class;
Task<int> SaveChangesAsync();
}
增加 Database 屬性的目的是,便於我們在 UnitOfWork 中訪問到 Transaction,其實還可以定義這樣的介面:DbContextTransaction BeginTransaction();
,但 EF 中的 DbContext 並沒有進行實現,而是需要通過 Database 屬性,所以還需要在 IDbContext 實現中額外實現,另外增加 Database 屬性的好處,還有就是可以在 UnitOfWork 中訪問執行很多的操作,比如執行 SQL 語句等等。
這裡需要說下 IDbContext 定義,我原先的設計初衷是,讓它脫離 EF,作為所有數據操作上下文的定義,但其實實現的時候,還是脫離不了 EF,因為介面返回的類型都在 EF 下,最後 IDbContext 就變成了 EF DbContext 的部分介面定義,所以這部分是需要再進行設計的,但好在有了 IDbContext,可以讓 EF 和 UnitOfWork 隔離開來。
SchoolDbContext 中的實現沒有任何變換,因為繼承的 EF DbContext 已經有了實現,UnitOfWork 改動比較大,代碼如下:
public class UnitOfWork : IUnitOfWork
{
private IDbContext _dbContext;
private DbContextTransaction _dbTransaction;
public UnitOfWork(IDbContext dbContext)
{
_dbContext = dbContext;
_dbTransaction = _dbContext.Database.BeginTransaction();
}
public async Task<bool> RegisterNew<TEntity>(TEntity entity)
where TEntity : class
{
_dbContext.Set<TEntity>().Add(entity);
return await _dbContext.SaveChangesAsync() > 0;
}
public async Task<bool> RegisterDirty<TEntity>(TEntity entity)
where TEntity : class
{
_dbContext.Entry<TEntity>(entity).State = EntityState.Modified;
return await _dbContext.SaveChangesAsync() > 0;
}
public async Task<bool> RegisterClean<TEntity>(TEntity entity)
where TEntity : class
{
_dbContext.Entry<TEntity>(entity).State = EntityState.Unchanged;
return await _dbContext.SaveChangesAsync() > 0;
}
public async Task<bool> RegisterDeleted<TEntity>(TEntity entity)
where TEntity : class
{
_dbContext.Set<TEntity>().Remove(entity);
return await _dbContext.SaveChangesAsync() > 0;
}
public void Commit()
{
_dbTransaction.Commit();
}
public void Rollback()
{
_dbTransaction.Rollback();
}
}
UnitOfWork 構造函數中,根據 DbContext 創建 DbContextTransaction 對象,然後在實體每個操作中,都添加了 SaveChanges,因為我們用了 Transaction,所以在執行 SaveChanges 的時候,並沒有應用到資料庫,但可以獲取到新添加實體的 Id,比如上面示例 Student 中的 TeacherId,並且用 Sql Profiler 可以檢測到執行的 SQL 代碼,當執行 Commit 的時候,數據對應進行更新。
測試代碼:
public async Task<bool> AddWithTransaction(string name)
{
var teacher = new Teacher { Name = "teacher one" };
await _unitOfWork.RegisterNew(teacher);
//可能還有一些 web 請求操作,比如 httpClient.Post(tearch); 可能會出選異常。
var student = new Student { Name = name, TeacherId = teacher.Id };
await _unitOfWork.RegisterNew(student);
_unitOfWork.Commit();
return true;
}
在上面代碼中,首先在沒執行到 Commit 之前,是可以獲取到新添加 Teacher 的 Id,並且如果出現了任何異常,都是可以進行回滾的,當然也可以手動進行 catch 異常,並執行_unitOfWork.Rollback()
。
不過上面的實現有一個問題,就是每次實體操作,都用了 Transaction,性能我沒測試,但肯定會有影響,好處就是 IUnitOfWork 基本沒有改動,還是按照官方的定義,只不過部分介面改成了非同步介面。
除了上面的實現,還有一種解決方式,就是在 IUnitOfWork 中增加一個類似 BeginTransaction 的介面,大致實現代碼:
public class UnitOfWork : IUnitOfWork
{
private IDbContext _dbContext;
private DbContextTransaction _dbTransaction;
public UnitOfWork(IDbContext dbContext)
{
_dbContext = dbContext;
}
//add
public void BeginTransaction()
{
_dbTransaction = _dbContext.Database.BeginTransaction();
}
public async Task<bool> RegisterNew<TEntity>(TEntity entity)
where TEntity : class
{
_dbContext.Set<TEntity>().Add(entity);
if (_dbTransaction != null)
return await _dbContext.SaveChangesAsync() > 0;
return true;
}
public async Task<bool> RegisterDirty<TEntity>(TEntity entity)
where TEntity : class
{
_dbContext.Entry<TEntity>(entity).State = EntityState.Modified;
if (_dbTransaction != null)
return await _dbContext.SaveChangesAsync() > 0;
return true;
}
public async Task<bool> RegisterClean<TEntity>(TEntity entity)
where TEntity : class
{
_dbContext.Entry<TEntity>(entity).State = EntityState.Unchanged;
if (_dbTransaction != null)
return await _dbContext.SaveChangesAsync() > 0;
return true;
}
public async Task<bool> RegisterDeleted<TEntity>(TEntity entity)
where TEntity : class
{
_dbContext.Set<TEntity>().Remove(entity);
if (_dbTransaction != null)
return await _dbContext.SaveChangesAsync() > 0;
return true;
}
public async Task<bool> Commit()
{
if (_dbTransaction == null)
return await _dbContext.SaveChangesAsync() > 0;
else
_dbTransaction.Commit();
return true;
}
public void Rollback()
{
if (_dbTransaction != null)
_dbTransaction.Rollback();
}
}
上面這種實現方式就解決了第一種方式的問題,需要使用 Transaction 的時候,直接在操作之前調用 BeginTransaction 就行了,但不好的地方就是改動了 IUnitOfWork 的介面定義。
除了上面兩種實現方式,大家如果有更好的解決方案,歡迎提出。
另外,DDD.Sample 增加和改動了一些東西:
- 增加 DDD.Sample.Domain.DomainEvents、DDD.Sample.Domain.DomainServices 和 DDD.Sample.Domain.ValueObjects。
- 從 DDD.Sample.Domain 分離出 DDD.Sample.Domain.Repository.Interfaces。
- 增加 DDD.Sample.BootStrapper,執行 Startup.Configure 用於系統啟動的配置。
- 去除 IEntity,在 IAggregateRoot 中添加 Id 屬性定義。