基於Entity Framework的自定義分頁，增刪改的通用實現

簡介

之前寫個一個基於Dapper的分頁實現，現在再來寫一個基於Entity Framework的分頁實現，以及增刪改的通用實現。

代碼

還是先上代碼：https://github.com/jinweijie/EF.GenericRepository

如何運行示例

還是像先前一樣：

1. 先Clone下代碼，在Database裡面解壓縮Database.7z

2. Attach到Sql Server LocalDB上。如果你用的不是Sql Server的LocalDB，你需要更改App.Config里的連接字元串。

3. Ctrl + F5，運行示常式序。

Repository 基類 - 查詢

Common\AbstractRepository.cs 是Repository的基類，實現了增刪改查的一些方法，例如：

public virtual Tuple<IEnumerable<T>, int> Find(Expression<Func<T, bool>> criteria
            , int pageIndex
            , int pageSize
            , string[] asc
            , string[] desc
            , params Expression<Func<T, object>>[] includeProperties)

這個方法是AbstractRepository查詢方法中的一個，用於自定義分頁查詢，其中criteria 為一個表達式，作為查詢的條件，參數pageIndex, pageSize, asc, desc為分頁相關參數；

關於多表（關聯表）：

includeProperties為在多表時候，Join相關聯的表。因為EF預設是Lazy Loading，相關聯的表預設不是立即載入的，所以有時候如果寫代碼不小心，在for迴圈里就有可能會迴圈查詢n個字表。用來includeProperties參數，就可以在查詢時候join關聯表。

Repository 基類 - 增刪改

AbstractRepository已經用泛型實現了增刪改方法：

• public virtual T Create(T entity)
• public virtual T Update(T entity)
• public virtual T CreateOrUpdate(T entity)
• public virtual void Delete(TId id)

 另外，關於transaction的實現，我使用了Unit of Work模式，多個Repository共用一個DBContext，關於UOW，請在Common\UnitOfWork.cs里找到。

 調用UOW的時候，基本類似於這樣：

var uow = new EFUnitOfWork();
var repo = uow.GetLogRepository();

repo.Create(new Log
{
    LevelId = 1,
    Thread = "",
    Location = "Manual Creation",
    Message = "This is manually created log.",
    CreateTime = DateTimeOffset.Now,
    Date = DateTime.Now
});

uow.Commit();

從UnitOfWork里得到一個或多個Repository，共用DBContext，做增刪改操作，最後uow統一SaveChanges。

 Repository的派生類

由於已經有了AbstractRepository，實現了增刪改查的很多方法，所以派生類，例如示例項目里的LogRepository基本就可以變得很簡單，主要實現一些特定的業務邏輯，在示例項目里，因為沒有特殊的業務邏輯，所以會很簡單：

    public class LogRepository : AbstractRepository<Log, int>
    {
        public LogRepository(EFContext context)
            : base(context)
        {
        }
    }

關於Entity的生成

本人比較喜歡Database First 實現，先設計資料庫，然後用edmx reverse engineering，生成POCO。可以參考Entity目錄下的相關文件。

當然，如果你喜歡Code First，同樣沒有問題，仍然適用本文的實現。

使用Logging日誌追蹤EF SQL

在使用Entity Framework的時候，最好關心一下EF所生成的SQL，這樣可以在開發階段發現一些潛在的性能問題，避免在生產環境焦頭爛額:)

在Common\EFContext.cs 里，有一個配置項EnableTraceSql，如果為true，那麼所以EF生成的SQL將會被nlog記錄下來。我將nlog的日誌配置到了資料庫。也就是說，在你運行示例項目時，每次查詢，都會增加新的日誌記錄，內容為查詢時生成的SQL：

 Specification Pattern

在查詢方法里，有個重載是接受一個ISpecification示例，這樣的實現可以有效的控制業務邏輯，對於寫給被其他人調用的介面來說，可以明確的確定查詢參數，例如：

    public class LogSearchSpecification : ISpecification<Log>
    {
        public string LevelName { get; set; }
        public string Message { get; set; }
        public Expression<Func<Log, bool>> ToExpression()
        {
            return log => (log.Level.Name == LevelName || LevelName == "") &&
                          (log.Message.Contains(Message) || Message == "");
        }

        public bool IsSatisfiedBy(Log entity)
        {
            return (entity.Level.Name == LevelName || LevelName == "") &&
                   (entity.Message.Contains(Message) || Message == "");
        }
    }

那麼，調用這個查詢方法的代碼就可以明確知道，我的查詢條件為LevelName和Message，至於LevelName是等於以及Message為Like則是在LogSearchSpeficiation里實現，做到很好的封裝。

最後

這套實現是幾年來平時慢慢積累的，是經過實踐的，所以應該可以作為一定的參考，當然，在具體的項目里，可以用一些DI去拿到Repository等等，不在本文討論範圍，大家可以自由發揮，希望對大家可以有所幫助，謝謝。