ABP框架之——数据访问基础架构

大家好，我是张飞洪，感谢您的阅读，我会不定期和你分享学习心得，希望我的文章能成为你成长路上的一块垫脚石，我们一起精进。

几乎所有的业务应用程序都要适用一种数据库基础架构，用来实现数据访问逻辑，以便从数据库读取或写入数据，我们还需要处理数据库事务，以确保数据源中的一致性。

ABP框架可以与任何数据库兼容，同时它提供了EF Core和MongoDB的内置集成包。您将通过定义DbContext类、将实体映射到数据库表、实现仓储库以及在有实体时部署加载相关实体的不同方式，学习如何将EF Core与ABP框架结合使用。您还将看到如何将MongoDB用作第二个数据库提供程序选项。

本章介绍了ABP的基本数据访问架构，包括以下主题：

• 定义实体
• 定义D库
• EF核心集成
• 了解UoW

ABP通过接口和基类来标准化实体的定义

1 定义实体

1.1 聚合根类（AggregateRoot）

聚合一般包括多个实体或者值对象，聚合根可以理解为根实体或者叫主实体。聚合的概念我们会在后面第10节的DDD会详细讲到，这里只是做个大概了解。

在ABP框架中，您可以从一个AggregateRoot类派生来定义主实体和聚合根，BasicAggregateRoot是定义聚合根的最简单的类。
以下示例实体类派生自BasicAggregateRoot类：

namespace FormsApp
{
    public class Form : BasicAggregateRoot<Guid> //
    {
        public string Name { get; set; }
        public string Description { get; set; }
        public bool IsDraft { get; set; }
        public ICollection<Question> Questions { get; set; }
    }
}

BasicAggregateRoot只是将Id属性定义为PK，并将PK类型作为泛型参数。在本例中，Form的PK类型是Guid。只要底层数据库支持，就可以使用任何类型作为PK（例如int, string等）。

还有其他一些基类可以从中派生聚合根，如下所述：

• AggregateRoot 有其他属性来支持乐观并发和对象扩展特性
• CreationAuditedAggregateRoot 继承自 AggregateRoot类，并添加 CreationTime (DateTime) 和 CreatorId (Guid) 属性来存储创建审核信息。
• AuditedAggregateRoot 继承* CreationAuditedAggregateRoot类，并添加 LastModificationTime (DateTime) 和LastModifierId (Guid)属性来存储修改审核信息。
• FullAuditedAggregateRoot继承自AuditedAggregateRoot类，并添加 DeletionTime (DateTime) 和 DeleterId (Guid) 属性来存储删除审核信息。它还通过实现ISoftDelete接口添加了IsDeleted (bool)，实现实体软删除。

1.2 实体类（Entity）

Entity基类类似于AggregateRoot类，但它们用于子集合实体，而不是主（根）实体。例如，上面的Form聚合根示例包含一系列问题子实体集合，它派生自实体类，如以下代码段所示：

public class Question : Entity<Guid> //
{
    public Guid FormId { get; set; }
    public string Title { get; set; }
    public bool AllowMultiSelect { get; set; }
    //public ICollection<Option> Options { get; set; }
}

与AggregateRoot类一样，Entity类还定义了给定类型的Id属性。在本例中，Question实体还有一组Option，其中Option是另一种实体类型。

还有一些其他预定义的基本实体类，如CreationAuditedEntity, AuditedEntity和FullAuditedEntity。它们类似于上面介绍的审计聚合根类。

1.3 带复合主键实体

关系数据库支持CPK（复合键），即PK由多个值组成，复合键对于具有多对多关系表特别有用。
假设要为Form设置多个Managers，向Form类添加Managers集合属性，如下所示：

public class Form : BasicAggregateRoot<Guid>
{
    ...
    public ICollection<FormManager> Managers { get; set; }
}

public class FormManager : Entity
{
    public Guid FormId { get; set; }
    public Guid UserId { get; set; }
    public Guid IsOwner { get; set; }
    public override object[] GetKeys()
    {
        return new object[] {FormId, UserId};
    }
}

从非泛型Entity类继承时，必须实现GetKeys方法以返回键数组。这样，ABP可以在需要的地方使用CPK值。在本例中，FormId和UserId是其他表的FK，它们构建FormManager实体的CPK。

聚合根的CPKs

AggregateRoot类也有用于CPK的非通用版本，但为聚合根实体设置CPK并不常见。

1.4 GUID主键

ABP主要使用GUIDs作为预构建实体的PK类型。GUIDs通常与自动增量IDs（如int或long，由关系数据库支持）进行比较。与自动递增键相比，使用GUIDs作为PK有一些众所周知的好处：

GUID vs 自动增量ID

1）GUID优点：

• GUID 全局唯一，适合分布式系统，方便拆分或合并表。
• 无需数据库往返即可在客户端生成 GUID。
• GUID 是无法猜测的，某些情况下它们可能更安全（例如，如果最终用户看到一个实体的 ID，他们就找不到另一个实体的 ID）。

与自动递增整数值相比，GUID也有一些缺点，如下所示：

2）GUID缺点：

• GUID 占16个字节，int 4个字节， long 8个字节。
• GUID 本质上不是连续的，这会导致聚集索引出现性能问题。

ABP 提供IGuidGenerator，默认生成顺序Guid值，解决了聚集索引的性能问题。建议用IGuidGenerator设置Id，而不是Guid.NewGuid()，如果你不设置Id，仓储库默认会使用IGuidGenerator。

GUID与自动增量PKs是软件开发中的热门话题，目前还没有明确的赢家。ABP适用于任何PK类型，因此您可以根据自己的需求进行选择。

Repository模式是抽象数据访问代码的常用方法。在接下来的部分中，您将学习如何使用ABP框架的通用存储库方法查询或操作数据库中的数据。当需要扩展通用存储库并添加自己的存储库方法时，您还可以创建自定义存储库。

2 定义仓储库

2.1 通用仓储库

一旦有了一个实体，就可以直接注入并使用该实体的通用存储库。下面是一个使用存储库的示例类：

using Volo.Abp.DependencyInjection;
using Volo.Abp.Domain.Repositories;
namespace FormsApp
{
    public class FormService : ITransientDependency
    {
        private readonly IRepository<Form, Guid> _formRepository;
        public FormService(IRepository<Form, Guid> formRepository)
        {
            _formRepository = formRepository;
        }
        public async Task<List<Form>> GetDraftForms()
        {
            return await _formRepository.GetListAsync(f => f.IsDraft);
        }
    }
}

在本例中，我们注入了IRepository<Form, Guid>，Form实体的默认通用存储库。然后，我们使用GetListAsync方法从数据库中获取经过筛选的表单列表。通用IRepository接口有两个通用参数：实体类型（本例中为Form）和PK类型（本例中为Guid）。

非聚合根实体的存储库

默认情况下，通用存储库仅适用于聚合根实体，因为通过聚合根对象访问聚合是最佳做法。但是，如果您使用的是关系数据库，则可以为其他实体类型启用通用存储库。我们将在EF Core集成部分看到如何配置。

2.2 增删改查方法

通用存储库提供了许多用于查询、插入、更新和删除实体的内置方法。

• InsertAsync 用于插入新实体
• InsertManyAsync 用于插入多个实体
• UpdateAsync 用于更新现有实体
• UpdateManyAsync 用于更新多个实体
• DeleteAsync 用于删除现有实体
• DeleteManyAsync 用于删除多个实体

所有仓储库方法都是异步的，强烈建议尽可能使用 async/await模式，因为在 .NET 中，将异步与同步混合潜在的死锁、超时和可伸缩性问题，不容易检测。

如果您使用的是EF Core，这些方法可能不会立即执行实际的数据库操作，因为EF Core使用的是更改跟踪系统。它仅在调用DbContext.SaveChanges方法时保存更改。当当前HTTP请求成功完成时，ABP 框架的UoW系统会自动调用SaveChanges方法。如果要立即将更改保存到数据库中，可以将autoSave参数作为true传递给存储库方法。

以下示例创建一个新的Form实体，并立即将其保存到InsertAsync方法中的数据库中：

1）autoSave

await _formRepository.InsertAsync(new Form(), autoSave: true);

EF Core 中，以上方法不会立即执行刷库，因为 EF Core 使用更改跟踪系统。它仅在你调用DbContext.SaveChanges方法时保存更改。如果要立即执行，可以将autoSave设置为true。

2）CancellationToken

所有仓储库默认带有一个CancellationToken参数，在需要的时候用来取消数据库操作，比如关闭浏览器后，无需继续执行冗长的数据库查询操作。大部分情况下，我们无需手动传入cancellation token，因为ABP框架会自动从HTTP请求中捕捉并使用取消令牌。

2.3 查询单个实体

• GetAsync：根据Id或表达式返回单个实体。如果未找到请求的实体，则抛出EntityNotFoundException
• FindAsync：根据Id或表达式返回单个实体。如果未找到请求的实体，则返回null。

FindAsync适用于有自定义逻辑，否则使用GetAsync

public async Task<Form> GetFormAsync(Guid formId)
{
    return await _formRepository.GetAsync(formId);
}

public async Task<Form> GetFormAsync(string name)
{
    return await _formRepository.GetAsync(form => form.Name == name);
}

2.4 查询实体列表

• GetListAsync：返回满足给定条件的所有实体或实体列表
• GetPagedListAsync：分页查询

public async Task<List<Form>> GetFormsAsync(string name)
{
    return await _formRepository.GetListAsync(form => form.Name.Contains(name));
}

2.5 LINQ高级查询

public class FormService2 : ITransientDependency
{
    private readonly IRepository<Form, Guid>  _formRepository;
    private readonly IAsyncQueryableExecuter  _asyncExecuter;
    public FormService2(IRepository<Form, Guid> formRepository,IAsyncQueryableExecuter asyncExecuter)
    {
        _formRepository = formRepository;
        _asyncExecuter = asyncExecuter;
    } 
  

    public async Task<List<Form>> GetOrderedFormsAsync(string name)
    {
    	//var queryable = await _formRepository.WithDetailsAsync(x => x.Category);
        var queryable = await _formRepository.GetQueryableAsync();
        var query = from form in queryable
            where form.Name.Contains(name)
            orderby form.Name
            select form;
        return await _asyncExecuter.ToListAsync(query);
    } 
}

为什么不用return await query.ToListAsync() ？

ToListAsync它是由 EF Core定义的扩展方法，位于Microsoft.EntityFrameworkCoreNuGet 包内。如果你想保持你的应用层独立于 ORM，ABP 的IAsyncQueryableExecuter服务提供了必要的抽象。

2.6 异步扩展方法

ABP 框架为IRepository接口提供所有标准异步 LINQ 扩展方法：

AllAsync, AnyAsync, AverageAsync, ContainsAsync, CountAsync, FirstAsync, FirstOrDefaultAsync, LastAsync, LastOrDefaultAsync, LongCountAsync, MaxAsync, MinAsync, SingleAsync, SingleOrDefaultAsync, SumAsync, ToArrayAsync, ToListAsync.

public async Task<int> GetCountAsync()
{
    return await _formRepository.CountAsync(x => x.Name.StartsWith("A"));
}

注意：以上方法只对IRepository有效。

2.6 复合主键查询

复合主键不能使用该IRepository<TEntity, TKey>接口，因为它是获取单个 PK ( Id) 类型。我们可以使用IRepository接口。

public class FormManagementService : ITransientDependency
{
    private readonly IRepository<FormManager> _formManagerRepository;
    public FormManagementService(IRepository<FormManager> formManagerRepository)
    {
        _formManagerRepository = formManagerRepository;
    }
    public async Task<List<FormManager>> GetManagersAsync(Guid formId)
    {
        return await _formManagerRepository.GetListAsync(fm => fm.FormId == formId);
    }
}

2.7 其他仓储库类型

• IBasicRepository<TEntity, TPrimaryKey>和IBasicRepository提供基本的仓储库方法，但它们不支持 LINQ 和IQueryable功能。
• IReadOnlyRepository<TEntity, TKey>, IReadOnlyRepository,IReadOnlyBasicRepository<Tentity, TKey>和IReadOnlyBasicRepository<TEntity, TKey>提供获取数据的方法，但不包括任何操作方法。

2.8 自定义存储库

public interface IFormRepository : IRepository<Form, Guid>
{
    Task<List<Form>> GetListAsync(string name,bool includeDrafts = false);
}

• 定义在Domain项目中
• 从通用仓储库派生
• 如果不想包含通用仓储库的方法，也可以派生自IRepository（无泛型参数）接口，这是一个空接口

结尾

由于文章有点长，分作上下两篇，下篇待续……