具有通用存储库和依赖注入和 SoC 的 EF6 Code First

Question

经过大量阅读和尝试Entity Framework 最新稳定版本（6.1.1）。

我正在阅读很多关于是否使用 EF6 或 EF 的存储库的矛盾，因为它的 DbContext 已经提供了一个存储库，而 DbSet 是开箱即用的 UoW .

让我先解释一下我的解决方案在项目方面包含的内容，然后我会回到矛盾之处。

它有一个类库项目和一个asp.net-mvc 项目。类库项目是数据访问，并且为 Code First 启用了 Migrations。

在我的类库项目中，我有一个通用存储库：

public interface IRepository<TEntity> where TEntity : class
{
    IEnumerable<TEntity> Get();

    TEntity GetByID(object id);

    void Insert(TEntity entity);

    void Delete(object id);

    void Update(TEntity entityToUpdate);
}

下面是它的实现：

public class Repository<TEntity> where TEntity : class
{
    internal ApplicationDbContext context;
    internal DbSet<TEntity> dbSet;

    public Repository(ApplicationDbContext context)
    {
        this.context = context;
        this.dbSet = context.Set<TEntity>();
    }

    public virtual IEnumerable<TEntity> Get()
    {
        IQueryable<TEntity> query = dbSet;
        return query.ToList();
    }

    public virtual TEntity GetByID(object id)
    {
        return dbSet.Find(id);
    }

    public virtual void Insert(TEntity entity)
    {
        dbSet.Add(entity);
    }

    public virtual void Delete(object id)
    {
        TEntity entityToDelete = dbSet.Find(id);
        Delete(entityToDelete);
    }

    public virtual void Update(TEntity entityToUpdate)
    {
        dbSet.Attach(entityToUpdate);
        context.Entry(entityToUpdate).State = EntityState.Modified;
    }
}

这里有几个实体：

public DbSet<User> User{ get; set; }
public DbSet<Order> Orders { get; set; }
public DbSet<UserOrder> UserOrders { get; set; }
public DbSet<Shipment> Shipments { get; set; }

我不想重复自己，但是使用EF6，您不再传递存储库，而是使用DbContext。所以对于DI，我使用Ninject在asp-net-mvc项目中设置了以下内容：

private static void RegisterServices(IKernel kernel)
{
    kernel.Bind<ApplicationDbContext>().ToSelf().InRequestScope();
}

这将通过构造函数注入将ApplicationDbContext注入适用的上层类。

现在回到矛盾。

如果我们不再需要存储库，因为 EF 已经提供了开箱即用的存储库，我们该怎么做 Separation of Concern（标题中缩写为 SoC）？

如果我错了，现在纠正我，但听起来我只需要执行所有数据访问逻辑/计算（如添加、获取、更新、删除和一些自定义逻辑/计算（实体具体））在asp.net-mvc项目中，如果我不添加存储库。

非常感谢您对此事的任何了解。

Answer 1

一点解释有望消除您的困惑。存储库模式的存在是为了抽象出数据库连接和查询逻辑。 ORM（对象关系映射器，如 EF）以一种或另一种形式存在已久，以至于许多人已经忘记或从未享受过处理充斥着 SQL 查询和语句的意大利面条式代码的巨大乐趣和乐趣。时间是，如果你想查询一个数据库，你实际上要负责一些疯狂的事情，比如启动一个连接，并实际从 ether 构造 SQL 语句。存储库模式的重点是为您提供一个单一的地方来放置所有这些讨厌的东西，远离您美丽的原始应用程序代码。

快进到 2014 年，实体框架和其他 ORM 是您的存储库。所有的 SQL 逻辑都被整齐地打包，远离你的窥探，相反，你有一个很好的编程 API 可以在你的代码中使用。一方面，这已经足够抽象了。它唯一没有涵盖的是对 ORM 本身的依赖。如果您后来决定要为 NHibernate 甚至 Web API 之类的东西切换实体框架，那么您必须对您的应用程序进行手术才能这样做。因此，添加另一层抽象仍然是一个好主意，但不是存储库，或者至少可以说是一个典型的存储库。

您拥有的存储库是一个典型 存储库。它只是为实体框架 API 方法创建代理。您调用repo.Add，存储库调用context.Add。坦率地说，这很荒谬，这就是为什么包括我自己在内的许多人说不要将存储库与实体框架一起使用。

那么应该你怎么办？创建服务，或者最好将其称为“类服务类”。当开始讨论与 .NET 相关的服务时，突然之间，您谈论的是与我们在此讨论的内容完全无关的各种事物。类服务类与服务类似，因为它具有返回特定数据集或对某些数据集执行非常特定功能的端点。例如，对于典型的存储库，您会发现自己在做如下事情：

articleRepo.Get().Where(m => m.Status == PublishStatus.Published && m.PublishDate <= DateTime.Now).OrderByDescending(o => o.PublishDate)

您的服务类的工作方式如下：

service.GetPublishedArticles();

看，符合“已发表文章”的所有逻辑都巧妙地包含在端点方法中。此外，使用存储库，您仍在公开底层 API。 更容易切换到其他东西，因为基本数据存储是抽象的，但是如果用于查询该数据存储的 API 发生变化，你仍然是一条小河。

更新

设置将非常相似；区别主要在于您使用服务与存储库的方式。也就是说，我什至不会让它依赖于实体。换句话说，你基本上每个上下文都有一个服务，而不是每个实体。

一如既往，从界面开始：

public interface IService
{
    IEnumerable<Article> GetPublishedArticles();

    ...
}

然后，你的实现：

public class EntityFrameworkService<TContext> : IService
    where TContext : DbContext
{
    protected readonly TContext context;

    public EntityFrameworkService(TContext context)
    {
        this.context = context;
    }

    public IEnumerable<Article> GetPublishedArticles()
    {
        ...
    }
}

然后，事情开始变得有点棘手。在示例方法中，您可以简单地直接引用DbSet，即context.Articles，但这意味着了解上下文中的DbSet 名称。最好使用context.Set<TEntity>()，以获得更大的灵活性。不过，在我跳火车太多之前，我想指出为什么我将其命名为EntityFrameworkService。在您的代码中，您只会引用您的 IService 接口。然后，通过你的依赖注入容器，你可以用 EntityFrameworkService<YourContext> 代替它。这开启了创建其他服务提供者的能力，例如 WebApiService 等。

现在，我喜欢使用一个受保护的方法，它返回一个我所有服务方法都可以使用的可查询对象。这消除了很多麻烦，比如每次都必须通过var dbSet = context.Set<YourEntity>(); 初始化一个DbSet 实例。看起来有点像：

protected virtual IQueryable<TEntity> GetQueryable<TEntity>(
    Expression<Func<TEntity, bool>> filter = null,
    Func<IQueryable<TEntity>, IOrderedQueryable<TEntity>> orderBy = null,
    string includeProperties = null,
    int? skip = null,
    int? take = null)
    where TEntity : class
{
    includeProperties = includeProperties ?? string.Empty;
    IQueryable<TEntity> query = context.Set<TEntity>();

    if (filter != null)
    {
        query = query.Where(filter);
    }

    foreach (var includeProperty in includeProperties.Split
        (new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries))
    {
        query = query.Include(includeProperty);
    }

    if (orderBy != null)
    {
        query = orderBy(query);
    }

    if (skip.HasValue)
    {
        query = query.Skip(skip.Value);
    }

    if (take.HasValue)
    {
        query = query.Take(take.Value);
    }

    return query;
}

请注意，此方法首先是受保护的。子类可以使用它，但这应该绝对不是公共 API 的一部分。这个练习的重点是不暴露可查询对象。其次，它是通用的。换句话说，它可以处理你扔给它的任何类型，只要它的上下文中有东西。

然后，在我们的小示例方法中，您最终会执行以下操作：

public IEnumerable<Article> GetPublishedArticles()
{
    return GetQueryable<Article>(
        m => m.Status == PublishStatus.Published && m.PublishDate <= DateTime.Now,
        m => m.OrderByDescending(o => o.PublishDate)
    ).ToList();
}

这种方法的另一个巧妙技巧是能够使用接口提供通用服务方法。假设我希望能够有一种方法来获取已发布的anything。我可以有这样的界面：

public interface IPublishable
{
    PublishStatus Status { get; set; }
    DateTime PublishDate { get; set; }
}

然后，任何可发布的实体都会实现这个接口。有了这些，您现在可以执行以下操作：

public IEnumerable<TEntity> GetPublished<TEntity>()
    where TEntity : IPublishable
{
    return GetQueryable<TEntity>(
        m => m.Status == PublishStatus.Published && m.PublishDate <= DateTime.Now,
        m => m.OrderByDescending(o => o.PublishDate)
    ).ToList();
}

然后在您的应用程序代码中：

service.GetPublished<Article>();