MVC通用仓储类

原文链接：http://www.codeproject.com/Articles/1095323/Generic-Repository-Pattern-MVC

良好的架构师任何项目的核心，开发人员一直在寻找一个牛X的架构，它能减少重复代码，分离数据访问与业务逻辑。因此，我们需要在MVC中使用EF创建一个泛型仓储类。如果不了解EF，去这里学习。在开始之前，我们需要了解什么是仓储模式，为什么使用仓储模式。

仓储模式和工作单元

简言之，仓储模式意味着，数据访问层与业务逻辑层之间的抽象，这是非常有利于单元测试或TDD。通过使用仓储模式，你的系统会更加松散耦合。

在开发过程中，我们通常为每个仓储或实体创建一个接口。例如，我们为Student这个实体创建一个接口约束（IStudentInterface），定义所有的CRUD操作，同时创建另一个类（StudentRepository）实现接口中所定义的所有方法。当我们在控制器中实例化仓储类的时候，我们将使用实现了对应接口的类的引用。当控制器在运行的时候，它将调用在EF基础上工作的仓储类。

当对控制器进行单元测试的时候，我们可以操作仓储类的具体数据实现，例如内存数据集。这样我们可以使用伪数据进行单元测试。

如果你想了解详细的实现，可以参照如下链接：

•getting started with ef 5 using mvc 4 / implementing the repository and unit of work patterns in an asp.net mvc application

不利因素

每次我们都需要为实体创建仓储类，导致代码冗余

代码实现

现在我们仅仅需要一个数据访问类，介绍一些实体和执行必要的操作，例如CRUD.在学习了很多文章、理论和示例代码后，我获得了一个很好的通用的仓储模式的实现。

我的代码在很大程度上基于Huy Nguyen的博客。请参阅以下链接

•entity-framework-4-poco-repository-and-specification-pattern

•entity-framework-poco-repository-and-specification-pattern-upgraded-to-ef-5

我修改了很多实现代码同时添加了一些在项目中常用的代码实现。现在我能使用这个类库在任何项目。下面是文件结构：

Mayur.DAL – 通用仓储和公共方法类库

• Core – 文件夹

  • GlobalCommonHelper.cs – 一个为每个项目提供大部分公共方法的抽象类

• Repository – 文件夹

  • IRepository.cs – 通用仓储接口
  • Repository.cs – 通用仓储实现类，继承与仓储接口
  • IUnitOfWork.cs – 工作单元接口.
  • UnitOfWork.cs – 实现了EF的SaveChanges()方法。工作单元类保证我们在对数据库执行事务性的插入、更新、删除操作时，直到我们执行Savechanges()方法以后EF才会提交所做的修改。

Mayur.Web – MVC Web项目

• Controller – 文件夹

  • HomeController.cs – 包含CRUD动作的控制器

• Core – 文件夹

  • CommonHelper.cs – 继承于 Mayur.DAL.Core.GlobalCommonHelper.cs which 包含MVC项目中相关的公共方法。

• Model – 文件夹

  • Student.cs – 实体类

• Views – Folder

  • Index.chtml – 不用说了吧都
  • Create.chtml – Create new student html
  • Edit.cshtml – Update student info html
  • Delete.cshtml – Delete student info html

让我们简单了解下DAL中每个文件的作用：

Repository 文件夹: 在这个文件夹，包含所有的数据访问逻辑。有4个文件， 2个接口文件，两个接口的实现类

1. IRepository 接口

    public interface IRepository : IDisposable
       {
           /// <summary>
           /// 获取工作单元
           /// </summary>
           /// <value>The unit of work.</value>
           IUnitOfWork UnitOfWork { get; }
    
           /// <summary>
           ///     Gets entity by key.
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <param name="keyValue">The key value.</param>
           /// <returns></returns>
           TEntity GetByKey<TEntity>(object keyValue) where TEntity : class;
    
           /// <summary>
           ///     Gets the query.
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <returns></returns>
           IQueryable<TEntity> GetQuery<TEntity>() where TEntity : class;
    
           /// <summary>
           ///     Gets the query.
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <param name="predicate">The predicate.</param>
           /// <returns></returns>
           IQueryable<TEntity> GetQuery<TEntity>(Expression<Func<TEntity, bool>> predicate) where TEntity : class;
    
    
           /// <summary>
           ///     Gets all.
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <returns></returns>
           IEnumerable<TEntity> GetAll<TEntity>() where TEntity : class;
    
           /// <summary>
           ///     Gets the specified order by.
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <typeparam name="TOrderBy">The type of the order by.</typeparam>
           /// <param name="orderBy">The order by.</param>
           /// <param name="pageIndex">Index of the page.</param>
           /// <param name="pageSize">Size of the page.</param>
           /// <param name="sortOrder">The sort order.</param>
           /// <returns></returns>
           IEnumerable<TEntity> Get<TEntity, TOrderBy>(Expression<Func<TEntity, TOrderBy>> orderBy, int pageIndex,int pageSize, SortOrder sortOrder = SortOrder.Ascending) where TEntity : class;
    
           /// <summary>
           ///     Gets the specified criteria.
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <typeparam name="TOrderBy">The type of the order by.</typeparam>
           /// <param name="criteria">The criteria.</param>
           /// <param name="orderBy">The order by.</param>
           /// <param name="pageIndex">Index of the page.</param>
           /// <param name="pageSize">Size of the page.</param>
           /// <param name="sortOrder">The sort order.</param>
           /// <returns></returns>
           IEnumerable<TEntity> Get<TEntity, TOrderBy>(Expression<Func<TEntity, bool>> criteria,
               Expression<Func<TEntity, 
               TOrderBy>> orderBy, 
               int pageIndex, 
               int pageSize,
               SortOrder sortOrder = SortOrder.Ascending) where TEntity : class;
    
    
           /// <summary>
           ///     Gets one entity based on matching criteria
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <param name="criteria">The criteria.</param>
           /// <returns></returns>
           TEntity Single<TEntity>(Expression<Func<TEntity, bool>> criteria) where TEntity : class;
    
    
    
           /// <summary>
           ///     Firsts the specified predicate.
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <param name="predicate">The predicate.</param>
           /// <returns></returns>
           TEntity First<TEntity>(Expression<Func<TEntity, bool>> predicate) where TEntity : class;
    
           /// <summary>
           ///     Finds entities based on provided criteria.
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <param name="criteria">The criteria.</param>
           /// <returns></returns>
           IEnumerable<TEntity> Find<TEntity>(Expression<Func<TEntity, bool>> criteria) where TEntity : class;
    
    
    
           /// <summary>
           ///     Finds one entity based on provided criteria.
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <param name="criteria">The criteria.</param>
           /// <returns></returns>
           TEntity FindOne<TEntity>(Expression<Func<TEntity, bool>> criteria) where TEntity : class;
    
    
    
           /// <summary>
           ///     Counts the specified entities.
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <returns></returns>
           int Count<TEntity>() where TEntity : class;
    
           /// <summary>
           ///     Counts entities with the specified criteria.
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <param name="criteria">The criteria.</param>
           /// <returns></returns>
           int Count<TEntity>(Expression<Func<TEntity, bool>> criteria) where TEntity : class;
    
    
    
           /// <summary>
           ///     Adds the specified entity.
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <param name="entity">The entity.</param>
           void Add<TEntity>(TEntity entity) where TEntity : class;
    
           /// <summary>
           ///     Attaches the specified entity.
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <param name="entity">The entity.</param>
           void Attach<TEntity>(TEntity entity) where TEntity : class;
    
           /// <summary>
           ///     Updates changes of the existing entity.
           ///     The caller must later call SaveChanges() 
           ///     on the repository explicitly to save the entity to database
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <param name="entity">The entity.</param>
           void Update<TEntity>(TEntity entity) where TEntity : class;
    
           /// <summary>
           ///     Deletes the specified entity.
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <param name="entity">The entity.</param>
           void Delete<TEntity>(TEntity entity) where TEntity : class;
    
           /// <summary>
           ///     Deletes one or many entities matching the specified criteria
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <param name="criteria">The criteria.</param>
           void Delete<TEntity>(Expression<Func<TEntity, bool>> criteria) where TEntity : class;
    
           /// <summary>
           ///     Deletes entities which satisfy specificatiion
           /// </summary>
           /// <typeparam name="TEntity">The type of the entity.</typeparam>
           /// <param name="criteria">The criteria.</param>
           //void Delete<TEntity>
           //(ISpecification<TEntity> criteria) where TEntity : class;
       }

2. Repository 类

3. IUnitOfWork 接口

4. UnitOfWork 类

在Mayur.DAL.Core文件夹中，还有一个抽象类，包含了一些项目中常用到的公共方法，如果你也有一些新的方法函数是我们在项目中需要的，请在评论中提出建议（原文这么说的，在我这评论我也不介意）。

1. GlobalCommonHelper.cs 类

现在通用仓储已经具备了公共的方法，现在来看下我们怎么在控制器中使用它。假设我们有一个Student实体，包含studentID, name, rollNo 等列，下面是控制器中的代码

1. 在继续之前，我们需要先完善数据上下文信息，以生成数据库和数据表 ，如下：

2. 我在数据访问层创建了一个抽象的包含了每个项目中都要使用的公共方法的类。因为是一个抽象类，这意味着我们为它创建实例。所以我们需要创建一个新的类在Web项目中，这个类继承于GlobalCommonHelper类，命名为CommonHelper，我们可以在这个类中实现一些项目独有的公共方法。

3. 现在我们可以看下如何在我们的控制器中使用仓储类，看控制器中的代码：

我需要更多来自你的建议和改进，请提给我吧。（原作）

译注

正好在学习仓储模式和工作单元，想整理一个通用的仓储类，作者的做参考。

英语不好有些翻译很生硬，还有的直接表意，省掉了作者一些话（他们写文章都很认真，像教小学生一样敦敦教诲）

版本

•31/05/2015: Article published

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)