關於MVC EF架構及Repository模式的一點心得

   一直都想寫博客，可惜真的太懶了或者對自己的描述水平不太自信，所以。。。一直都是不想寫的狀態，關於領域驅動的東西看了不少，但是由於自己水平太差加上工作中實在用不到，所以一直處於擱置狀態，最近心血來潮突然想重新寫一個自己的項目架構，於是開始了新一論的學習歷程。

   在設計之前我理了一下自己的大致需求也參考了不同人的項目架構，在此特別感謝郭明峰的OSharp給我的啟示，每個人對架構的需求和使用習慣都是不一至的，在不同大小的項目上使用的架構也不盡相同，如何取舍性能、開發速度及維護性的問題上每開發者都在自己心中有一桿秤，下面談談我理想中的架構，它應該提供一些常用的操作封裝及各種工具方便實現多個功能，他應該包括數據操作的方便處理，他應該提供日志及緩存的處理功能，它的每種實現是自己換的但又得具有默認值讓我在做私單的時候更快捷方便，基於以上特點於是總結了如下模塊：

1，工具庫：提供了各種常用操作，如字符串截取，各種驗證之類的helper類

2，核心庫：提供緩存日志數據的接口及緩存日志的基礎實現

3，WEB庫：針對網站相關的擴展及操作封裝

4，MVC庫：針對MVC網站的相關擴展及操作封裝

5，基礎數據庫模塊實現庫（如：EF）

回到每個架構的重點：數據訪問模塊上來，現在比較流行使用EF+ IUnitOfWork+Repository來實現數據的處理，誠然這種方式讓每一個模塊相互的依賴變得更小，更方便測試，更XXX，但是在我的實踐中，還是發現他真的麻煩，在我做一個中小項目的時候，添加一個普通的表不得不去添加實體，實體配置，倉儲接口，倉儲實現，服務接口，服務實現，controller viewmodel,view一系列下來即便是拷貝也是非常慢，即使我們可以用代碼生成器，我還是覺得太麻煩了。當然Repository模式的反對者也不少，作為一種數據操作的隔離手段，我個人覺得Repository還是很有必要存在的，經過各種取舍，最后自己使用了一種折中的方式來使用Repository，我的方式是使用IStore來代替IUnitOfWork，本質是一樣的，只是IStore實現的功能要多一些，同時使用了IStore使得我們可以很容易的替換我們的數據庫功能實現，如下圖：

由於一般的項目不需要一人寫定義一人寫實現，所以直接省去了IUserRepository及IUserService這種並不會修改實現的接口，當然如果有團隊共同開發的時候使用也是完全沒有問題的，有了以上的圖就開以開始實現代碼了：

IDataStore：

 

/// <summary>
    /// 數據存儲器接口
    /// </summary>
    public interface IStore : IDisposable
    {
        #region UnitOfWork
        /// <summary>
        /// 獲取或設置 是否開啟事務提交
        /// </summary>
        bool TransactionEnabled { get; set; }
        /// <summary>
        /// 提交操作
        /// </summary>
        bool Commit();
        /// <summary>
        /// 異步提交
        /// </summary>
        Task<bool> CommitAsync();
        #endregion

        #region 基礎操作
        /// <summary>
        /// 添加對像
        /// </summary>
        void Add<TEntity>(TEntity entity) where TEntity : class;
        /// <summary>
        /// 更新對像
        /// </summary>
        void Update<TEntity>(TEntity entity) where TEntity : class;
        /// <summary>
        /// 刪除對像
        /// </summary>
        void Remove<TEntity>(TEntity entity) where TEntity : class; 
        #endregion

        #region 查詢操作
        /// <summary>
        /// 獲取數據集查詢對像
        /// </summary>
        IQueryable<TEntity> GetQueryEntities<TEntity, TKey>() where TEntity : class;
        #endregion
    }

IRepository：

/// <summary>
    /// 倉儲接口
    /// </summary>
    /// <typeparam name="TEntity">實體類型</typeparam>
    /// <typeparam name="TKey">實體主鍵類型</typeparam>
    public interface IRepository<TEntity, TKey> 
    {
        #region 屬性
        /// <summary>
        /// 獲取當前數據存儲器
        /// </summary>
        IStore DataStore { get; }
        /// <summary>
        /// 獲取當前實體的查詢數據集
        /// </summary>
        IQueryable<TEntity> Entities { get; }
        #endregion

        #region 基礎操作
        /// <summary>
        /// 添加實體到倉庫
        /// </summary>
        void Add(TEntity entity);
        /// <summary>
        /// 更新倉庫中的實體
        /// </summary>
        void Update(TEntity entity);
        /// <summary>
        /// 從倉庫刪除指定key的實體
        /// </summary>
        void Remove(TEntity entity);        
        #endregion

        #region 查詢
        /// <summary>
        /// 獲取指定key的實體
        /// </summary>
        TEntity FindByKey(TKey key);
        #endregion
    }

RepositroyBase：

/// <summary>
    /// 倉儲基類
    /// </summary>
    public abstract class RepositoryBase<TEntity, TKey> : IRepository<TEntity, TKey>
        where TEntity : EntityBase<TKey>, new()
    {

        public IStore DataStore { get; set; }

        public IQueryable<TEntity> Entities
        {
            get { return this.DataStore.GetQueryEntities<TEntity, TKey>(); }
        }

        public void Add(TEntity entity)
        {
            this.DataStore.Add<TEntity>(entity);
        }

        public void Update(TEntity entity)
        {
            this.DataStore.Update<TEntity>(entity);
        }

        public void Remove(TEntity entity)
        {
            this.DataStore.Remove<TEntity>(entity);
        }

        public TEntity FindByKey(TKey key)
        {
            return this.Entities.Where(t => t.Id.Equals(key)).SingleOrDefault();
        }
    }

當然BaseEntity這種東西就看自己愛好添加了，按key刪除，按條件更新的方法這里就不寫了

，另外關於返回Repository返回IEnumerable還是IQueryable這個問題我個人認為如果不按照DDD的的標准來看，一個倉庫每次拿你想要的東西還是給你一個通道你想拿多少就拿多少本質上都是可以的，不過對於隔離開發人員直接操作數據確實存在隱患，不過誰叫他簡單呢？看完定義，然后如果要使用EF做為ORM來操作數據庫或者任意繼承至IDataStore的庫來完成數據操作，不過這里要自己寫的話，解析表達式還是有點困難的。。貼下簡單EF基類的簡單實現：

 

/// <summary>
    /// EF數據存儲器（抽象類）
    /// </summary>
    public abstract class EFDataStore : DbContext, IStore
    {
        #region DbContext
        protected EFDataStore() { }
        protected EFDataStore(DbCompiledModel model) : base(model) { }
        public EFDataStore(string nameOrConnectionString) : base(nameOrConnectionString) { }
        public EFDataStore(DbConnection existingConnection, bool contextOwnsConnection) : base(existingConnection, contextOwnsConnection) { }
        public EFDataStore(ObjectContext objectContext, bool dbContextOwnsObjectContext) : base(objectContext, dbContextOwnsObjectContext) { }
        public EFDataStore(string nameOrConnectionString, DbCompiledModel model) : base(nameOrConnectionString, model) { }
        public EFDataStore(DbConnection existingConnection, DbCompiledModel model, bool contextOwnsConnection) : base(existingConnection, model, contextOwnsConnection) { }
        /// <summary>
        /// 實體映射集合
        /// </summary>
        public IEnumerable<IEntityMapper> EntityConfigurations { get; set; }

        protected override void OnModelCreating(DbModelBuilder modelBuilder)
        {
            //foreach (var mapper in EntityConfigurations)
            //{
            //    mapper.RegistTo(modelBuilder.Configurations);
            //}
        }
        #endregion

        public bool TransactionEnabled { get; set; }

        public IQueryable<TEntity> GetQueryEntities<TEntity, TKey>() where TEntity : class
        {
            return this.Set<TEntity>();
        }

        public bool Commit()
        {
            var r = this.SaveChanges();
            //this.Dispose();
            return r > 0;
        }

        public async Task<bool> CommitAsync()
        {
            return (await this.SaveChangesAsync()) > 0;
        }

        public void Add<TEntity>(TEntity entity) where TEntity : class
        {
            this.Set<TEntity>().Add(entity);
        }

        public void Update<TEntity>(TEntity entity) where TEntity : class
        {
            this.Entry(entity).State = EntityState.Modified;
        }

        public void Remove<TEntity>(TEntity entity) where TEntity : class
        {
            this.Entry(entity).State = EntityState.Deleted;
        }
    }

這。寫着寫着自己都有點不知所雲了，希望對正在學習階段的朋友有一點點幫助！