项目

从 ASP.NET Boilerplate 迁移到 ABP

ABP 是开源框架 ASP.NET Boilerplate继任者。本指南旨在帮助您将现有解决方案(使用 ASP.NET Boilerplate 框架开发的)迁移到 ABP。

引言

ASP.NET Boilerplate2013 年 以来一直在积极开发中。它深受社区喜爱、使用和贡献。它最初是一位开发者的副业项目,但现在除了强大的社区支持外,也由 Volosoft 公司官方维护和改进。

ABP 与 ASP.NET Boilerplate 框架有相同的目标:不要重复你自己!它提供基础架构、工具和启动模板,使开发者在开发企业软件解决方案时生活更轻松。

如果您想知道为什么我们需要重写 ASP.NET Boilerplate 框架,请参阅 介绍博客文章

我应该迁移吗?

不,您不必!

  • ASP.NET Boilerplate 仍处于积极开发和维护中。
  • 它也可以在最新的 ASP.NET Core 及相关库和工具上运行。它是保持更新的。

但是,如果您希望利用新的 ABP 特性 和新的架构机会(如支持 NoSQL 数据库、微服务兼容性、高级模块化),您可以将本文档作为指南。

ASP.NET Zero 怎么样?

ASP.NET Zero 是核心 ASP.NET Boilerplate 团队在 ASP.NET Boilerplate 框架之上开发的商业产品。它提供预构建的应用程序功能、代码生成工具和美观的现代 UI。它受到并正被全球数千家公司信任和使用。

我们创建了 ABP 作为 ASP.NET Zero 的替代品。与 ASP.NET Zero 相比,ABP 更具模块化和可升级性。它目前的功能比 ASP.NET Zero 少,但这个差距会随着时间而缩小(它也有一些 ASP.NET Zero 中不存在的功能)。

我们认为 ASP.NET Zero 在开始新应用时仍然是一个不错的选择。它是一个生产就绪且成熟的解决方案,以完整源代码形式交付。它正在积极开发中,我们也在不断添加新功能。

我们不建议将基于 ASP.NET Zero 的解决方案迁移到 ABP,如果:

  • 您的 ASP.NET Zero 解决方案已经很成熟,并且处于维护阶段而非快速开发阶段。
  • 您没有足够的开发时间来执行迁移。
  • 单体架构适合您的业务。
  • 您已经根据需求对现有的 ASP.NET Zero 功能进行了大量定制。

我们也建议您根据自己的需求比较两个产品的功能。

如果您有基于 ASP.NET Zero 的解决方案并希望迁移到 ABP,本指南也会对您有所帮助。

ASP.NET MVC 5.x 项目

ABP 不支持 ASP.NET MVC 5.x,它只与 ASP.NET Core 一起工作。因此,如果您迁移基于 ASP.NET MVC 5.x 的项目,您还需要处理 .NET Core 的迁移。

迁移进度

我们通过借鉴 ASP.NET Boilerplate 框架的最佳部分来设计 ABP,因此如果您开发过基于 ASP.NET Boilerplate 的应用程序,您会对它感到熟悉。

在 ASP.NET Boilerplate 中,我们在 UI 方面投入不多,而是使用了一些免费主题(另一方面,我们为 ASP.NET Zero 使用了 metronic 主题)。在 ABP 中,我们在 UI 方面做了大量工作(特别是对于 MVC / Razor Pages UI,因为 Angular 已经有自己良好的模块化系统)。因此,迁移中最具挑战性的部分将是您解决方案的用户界面

ABP(以及 ASP.NET Boilerplate)是基于领域驱动设计模式和原则设计的,启动模板根据 DDD 分层。因此,本指南遵循该分层模型,并逐层解释迁移。

创建解决方案

迁移的第一步是创建一个新的解决方案。我们建议您使用 启动模板 创建一个全新的项目(关于 ABP 的详细信息,请参阅 此文档 )。

创建项目并运行应用程序后,您可以按部就班地将现有解决方案中的代码逐层复制到新解决方案中。

关于预构建模块

ABP 的启动项目使用 预构建模块(并非全部,而是核心模块)和主题作为 NuGet/NPM 包。因此,您在解决方案中看不到模块/主题的源代码。这样做的好处是,当新版本发布时,您可以轻松更新这些包。但是,您无法像直接拥有源代码那样轻松地定制它们。

我们建议继续将这些模块作为包引用使用,这样您可以轻松获取新功能(请参阅 abp update 命令)。在这种情况下,您有几个选项来定制或扩展所用模块的功能:

  • 您可以创建自己的实体,并与所用模块中的实体共享同一个数据库表。启动模板中的 AppUser 实体就是一个例子。
  • 您可以用自己的实现替换领域服务、应用服务、控制器、页面模型或其他类型的服务。我们建议您从现有实现继承并重写所需的方法。
  • 您可以使用虚拟文件系统,用自己的 .cshtml 视图、页面、视图组件、部分视图...替换现有的。
  • 您可以使用虚拟文件系统覆盖 JavaScript、CSS、图像或任何其他类型的静态文件。

更多的扩展/定制选项将随着时间的推移而被开发和记录。但是,如果您需要完全更改模块的实现,最好将相关模块的源代码添加到您自己的解决方案中,并移除包依赖。

模块和主题的源代码采用 MIT 许可,您可以完全拥有和自定义它,没有任何限制(对于 ABP,如果您拥有包含源代码的许可证类型,则可以下载 模块 / 主题 的源代码)。

领域层

您的领域层代码大部分将保持不变,但您需要在领域对象中进行一些小的更改。

聚合根和实体

ABP 和 ASP.NET Boilerplate 都有 IEntityIEntity<T> 接口以及 EntityEntity<T> 基类来定义实体,但它们有一些不同。

如果您在 ASP.NET Boilerplate 应用程序中有一个这样的实体:

public class Person : Entity //ASP.NET Boilerplate 的默认 PK 是 int
{
    ...
}

那么您的主键(基类中的 Id 属性)是 int,这是 ASP.NET Boilerplate 的默认主键类型。如果您想设置其他类型的 PK,您需要明确声明:

public class Person : Entity<Guid> //在 ASP.NET Boilerplate 中设置显式 PK
{
    ...
}

ABP 的行为不同,它要求始终明确设置 PK 类型:

public class Person : Entity<Guid> //在 ABP 中设置显式 PK
{
    ...
}

在这种情况下,Id 属性(以及数据库中的相应 PK)将是 Guid

复合主键

ABP 也有一个非泛型 Entity 基类,但这次它没有 Id 属性。其目的是允许您创建具有复合 PK 的实体。有关复合 PK 的更多信息,请参阅文档

聚合根

现在的最佳实践是对聚合根实体使用 AggregateRoot 基类而不是 Entity。有关聚合根的更多信息,请参阅文档

与 ASP.NET Boilerplate 相反,ABP 只为聚合根创建默认仓库(IRepository<T>)。它不为从 Entity 派生的其他类型创建。

如果您仍然想为所有实体类型创建默认仓库,请在您的解决方案中找到 YourProjectNameEntityFrameworkCoreModule 类,并将 options.AddDefaultRepositories() 更改为 options.AddDefaultRepositories(includeAllEntities: true)(应用启动模板可能已经是这样)。

迁移现有实体

我们建议并针对所有 ABP 模块使用 GUID 作为 PK 类型。但是,为了更轻松地迁移您的数据库表,您可以继续使用现有的 PK 类型。

具有挑战性的部分将是与 ASP.NET Boilerplate 相关的实体的主键,例如用户、角色、租户、设置……等。我们的建议是使用工具或手动方式将数据从现有数据库复制到新的数据库表(注意外键值)。

文档

有关实体的详细信息,请参阅文档:

仓储

ABP 只为聚合根创建默认仓库(IRepository<T>)。它不为从 Entity 派生的其他类型创建。更多信息,请参见上面的"聚合根"部分。

ABP 和 ASP.NET Boilerplate 都有默认的通用仓储系统,但有一些不同。

注入仓储

在 ASP.NET Boilerplate 中,有两个默认的仓储接口可以直接注入和使用:

  • IRepository<TEntity>(例如 IRepository<Person>)用于具有 int 主键的实体,这是默认的 PK 类型。
  • IRepository<TEntity, TKey>(例如 IRepository<Person, Guid>)用于具有其他类型 PK 的实体。

ABP 没有默认的 PK 类型,因此您需要显式声明实体的 PK 类型,例如 IRepository<Person, int>IRepository<Person, Guid>

ABP 也有 IRepository<TEntity>(不带 PK),但它主要用于实体具有复合 PK 时(因为此仓储没有使用 Id 属性的方法)。有关复合 PK 的更多信息,请参阅文档

受限仓储

ABP 额外提供了一些仓储接口:

  • IBasicRepository<TEntity, TKey> 的方法与 IRepository 相同,只是它不支持 IQueryable。如果您不想将复杂的查询代码暴露给应用层,这可能很有用。在这种情况下,您通常希望创建自定义仓储来封装查询逻辑。对于不支持 IQueryable 的数据库提供程序也很有用。
  • IReadOnlyRepository<TEntity,TKey> 具有从数据库获取数据的方法,但不包含任何更改数据库的方法。
  • IReadOnlyBasicRepository<TEntity, TKey> 类似于只读仓储,但也不支持 IQueryable

所有接口也有不带 TKey 的版本(如 IReadOnlyRepository<TEntity>),这些版本可以像上面解释的那样用于复合 PK。

GetAll() 与 IQueryable

ASP.NET Boilerplate 的仓储有一个 GetAll() 方法,用于获取 IQueryable 对象以便在其上执行 LINQ。示例应用服务调用 GetAll() 方法:

public class PersonAppService : ApplicationService, IPersonAppService
{
    private readonly IRepository<Person, Guid> _personRepository;

    public PersonAppService(IRepository<Person, Guid> personRepository)
    {
        _personRepository = personRepository;
    }

    public async Task DoIt()
    {
        var people = await _personRepository
            .GetAll() //GetAll() 返回 IQueryable
            .Where(p => p.BirthYear > 2000) //使用 LINQ 扩展方法
            .ToListAsync();
    }
}

ABP 的仓储有 GetQueryableAsync 替代:

public class PersonAppService : ApplicationService, IPersonAppService
{
    private readonly IRepository<Person, Guid> _personRepository;

    public PersonAppService(IRepository<Person, Guid> personRepository)
    {
        _personRepository = personRepository;
    }

    public async Task DoIt()
    {
        var queryable = await _personRepository.GetQueryableAsync();
        var people = await queryable
            .Where(p => p.BirthYear > 2000) //使用 LINQ 扩展方法
            .ToListAsync();
    }
}

注意,为了使用异步 LINQ 扩展方法(如这里的 ToListAsync),您可能需要依赖数据库提供程序(如 EF Core),因为这些方法是在数据库提供程序包中定义的,它们不是标准的 LINQ 方法。有关异步查询执行的替代方法,请参阅仓库文档

FirstOrDefault(predicate), Single()... 方法

ABP 仓储没有这些接收谓词(表达式)的方法,因为仓储本身是 IQueryable,所有这些方法都已经是可以直接使用的标准 LINQ 扩展方法。

但是,它提供了以下方法,可用于通过其 Id 查询单个实体:

  • FindAsync(id) 返回实体,如果未找到则返回 null。
  • GetAsync(id) 方法返回实体,如果未找到则抛出 EntityNotFoundException(这会导致 HTTP 404 状态码)。

同步与异步

ABP 仓储没有同步方法(如 Insert)。所有方法都是异步的(如 InsertAsync)。因此,如果您的应用程序使用了同步仓储方法,请将它们转换为异步版本。

总的来说,ABP 强制您在所有地方完全使用异步,因为混合使用异步和同步方法不是推荐的做法。

文档

有关仓储的详细信息,请参阅文档:

领域服务

您的领域服务逻辑在迁移中大部分将保持不变。ABP 也定义了基类 DomainService 和接口 IDomainService,其工作方式与 ASP.NET Boilerplate 类似。

应用层

您的应用服务逻辑在迁移中将保持相似。ABP 也定义了基类 ApplicationService 和接口 IApplicationService,其工作方式与 ASP.NET Boilerplate 类似,但细节上有一些差异。

声明式授权

ASP.NET Boilerplate 有 AbpAuthorizeAbpMvcAuthorize 属性用于声明式授权。示例用法:

[AbpAuthorize("MyUserDeletionPermissionName")]
public async Task DeleteUserAsync(...)
{
    ...
}

ABP 没有这样的自定义属性。它在所有层都使用标准的 Authorize 属性。

[Authorize("MyUserDeletionPermissionName")]
public async Task DeleteUserAsync(...)
{
    ...
}

这得益于与 Microsoft Authorization Extensions 库的更好集成。有关授权系统的更多信息,请参见下面的授权部分。

CrudAppService 和 AsyncCrudAppService 类

ASP.NET Boilerplate 有 CrudAppService(具有同步服务方法)和 AsyncCrudAppService(具有异步服务方法)类。

ABP 只有 CrudAppService,它实际上只有异步方法(而不是同步方法)。

ABP 的 CrudAppService 方法签名与旧版本略有不同。例如,旧的更新方法签名是 Task<TEntityDto> UpdateAsync(TUpdateInput input),而新的是 Task<TGetOutputDto> UpdateAsync(TKey id, TUpdateInput input)。主要区别在于,它将更新实体的 Id 作为一个单独的参数获取,而不是包含在输入 DTO 中。

数据传输对象 (DTOs)

ABP 中也有类似的 DTO 基类(如 EntityDto)。因此,如果您需要,可以找到对应的 DTO 基类。

验证

您可以继续使用数据注解属性来验证您的 DTO,就像在 ASP.NET Boilerplate 中一样。

ABP 不包含 ASP.NET Boilerplate 中存在的 ICustomValidate。相反,您应该为标准 IValidatableObject 接口实现自定义验证逻辑。

基础设施层

命名空间

ASP.NET Boilerplate 使用 Abp.* 命名空间,而 ABP 为框架和预构建的基础模块使用 Volo.Abp.* 命名空间。

此外,还有一些使用 Volo.* 命名空间(如 Volo.Blogging.*Volo.Docs.*)的预构建应用模块(如文档和博客模块)。我们将这些模块视为由 Volosoft 开发的独立开源产品,而不是补充 ABP 并在应用程序中使用的附加组件或通用模块。我们将它们开发为模块,以便作为更大解决方案的一部分可重用。

模块系统

ASP.NET Boilerplate 和 ABP 都有 AbpModule,但它们略有不同。

ASP.NET Boilerplate 的 AbpModule 类有 PreInitializeInitializePostInitialize 方法,您可以重写这些方法来配置框架和依赖的模块。您还可以在这些方法中注册和解析依赖项。

ABP 的 AbpModule 类有 ConfigureServicesOnApplicationInitialization 方法(以及它们的 Pre 和 Post 版本)。它类似于 ASP.NET Core 的 Startup 类。您在 ConfigureServices 中配置其他服务和注册依赖项。但是,此时您还不能解析依赖项。您可以在 OnApplicationInitialization 方法中解析依赖项并配置 ASP.NET Core 中间件管道,但不能在此处注册依赖项。因此,新的模块类遵循 ASP.NET Core 的方法,将依赖项注册阶段与依赖项解析阶段分开。

依赖注入

DI 框架

ASP.NET Boilerplate 使用 Castle Windsor 作为依赖注入框架。这是 ASP.NET Boilerplate 框架的一个基本依赖。我们收到了很多反馈,希望 ASP.NET Boilerplate 的 DI 框架不依赖特定实现,但由于设计原因,这并不容易实现。

ABP 是依赖注入框架无关的,因为它使用微软的 依赖注入扩展 库作为抽象。任何 ABP 或模块包都不依赖于任何特定的库。

然而,ABP 并未使用微软的基础 DI 库,因为它缺少 ABP 需要的一些功能:属性注入和拦截。所有启动模板和示例都使用 Autofac 作为 DI 库,并且它是唯一 官方集成 到 ABP 的库。如果没有充分的理由,我们建议您将 Autofac 与 ABP 一起使用。如果您有充分的理由,请在 GitHub 上创建一个 issue 来请求它,或者直接实现它并发送一个拉取请求 :)

注册依赖项

注册依赖项的方式类似,并且大部分由框架按约定处理(例如仓库、应用服务、控制器...等)。对于未被约定注册的服务,实现相同的 ITransientDependencyISingletonDependencyIScopedDependency 接口。

当您需要手动注册依赖项时,请在模块的 ConfigureServices 方法中使用 context.Services。例如:

public class BlogModule : AbpModule
{
    public override void ConfigureServices(ServiceConfigurationContext context)
    {
        // 将一个实例注册为单例
        context.Services.AddSingleton<TaxCalculator>(new TaxCalculator(taxRatio: 0.18));

        // 注册一个从 IServiceProvider 解析的工厂方法
        context.Services.AddScoped<ITaxCalculator>(
            sp => sp.GetRequiredService<TaxCalculator>()
        );
    }
}

详见 ABP 的 依赖注入文档

配置与选项系统

ASP.NET Boilerplate 拥有自己的配置系统来配置框架和模块。例如,您可以在模块Initialize 方法中禁用审计日志:

public override void Initialize()
{
    Configuration.Auditing.IsEnabled = false;
}

ABP 使用选项模式来配置框架和模块。您通常在模块ConfigureServices 方法中配置选项:

public override void ConfigureServices(ServiceConfigurationContext context)
{
    Configure<AbpAuditingOptions>(options =>
    {
        options.IsEnabled = false;
    });
}

ABP 没有中心配置对象,而是为每个模块和功能定义了独立的选项类,这些选项类在相关文档中有说明。

IAbpSession 与 ICurrentUser 和 ICurrentTenant

ASP.NET Boilerplate 的 IAbpSession 服务用于获取当前用户和租户信息,如 UserIdTenantId

ABP 没有相同的服务。取而代之的是使用 ICurrentUserICurrentTenant 服务。这些服务在一些常见类中(如 ApplicationServiceAbpController)已定义为基本属性,因此通常您不需要手动注入它们。它们也比 IAbpSession 拥有更多的属性。

授权

ABP 通过将权限作为自动策略添加,并允许授权系统也能在应用服务中使用,从而扩展了 ASP.NET Core 授权

AbpAuthorize 与 Authorize

使用标准的 [Authorize][AllowAnonymous] 属性,而不是 ASP.NET Boilerplate 的自定义 [AbpAuthorize][AbpAllowAnonymous] 属性。

IPermissionChecker 与 IAuthorizationService

使用标准的 IAuthorizationService 来检查权限,而不是 ASP.NET Boilerplate 的 IPermissionChecker 服务。虽然 IPermissionChecker 在 ABP 中也存在,但它是用于显式使用权限的。使用 IAuthorizationService 是推荐的方式,因为它也涵盖了其他类型的策略检查。

AuthorizationProvider 与 PermissionDefinitionProvider

在 ASP.NET Boilerplate 中,您继承 AuthorizationProvider 来定义您的权限。ABP 用 PermissionDefinitionProvider 基类替换了它。因此,通过继承 PermissionDefinitionProvider 类来定义您的权限。

工作单元

工作单元系统被设计为无缝工作。在大多数情况下,您不需要更改任何东西。

ABP 的 UnitOfWork 属性没有 ScopeOptionTransactionScopeOption 类型)属性。相反,使用 IUnitOfWorkManager.Begin() 方法,并将 requiresNew 参数设置为 true,以在事务范围内创建一个独立的内部事务。

数据过滤器

ASP.NET Boilerplate 将数据过滤系统作为工作单元的一部分实现。ABP 有一个独立的 IDataFilter 服务。

有关如何启用/禁用过滤器,请参阅数据过滤文档

有关 UOW 系统的更多信息,请参阅 UOW 文档

多租户

IMustHaveTenant & IMayHaveTenant 与 IMultiTenant

ASP.NET Boilerplate 定义了 IMustHaveTenantIMayHaveTenant 接口供您的实体实现。通过这种方式,您的实体会根据当前租户自动过滤。由于设计原因,存在一个问题:如果您想创建一个非多租户的应用程序,您必须在数据库中创建一个 Id 为 "1" 的"默认"租户(这个"默认"租户被用作单租户)。

ABP 为多租户实体定义了一个统一的接口:IMultiTenant,它定义了一个 Guid? 类型的 TenantId 属性。如果您的应用程序不是多租户的,那么您的实体的 TenantId 将为 null(而不是默认值)。

在迁移时,您需要更改 TenantId 字段类型,并用 IMultiTenant 替换这些接口。

切换租户

在某些情况下,您可能需要为某段代码切换到特定租户,并在该范围内处理该租户的数据。

在 ASP.NET Boilerplate 中,这是使用 IUnitOfWorkManager 服务完成的:

public async Task<List<Product>> GetProducts(int tenantId)
{
    using (_unitOfWorkManager.Current.SetTenantId(tenantId))
    {
        return await _productRepository.GetAllListAsync();
    }
}

在 ABP 中,这是通过 ICurrentTenant 服务完成的:

public async Task<List<Product>> GetProducts(Guid tenantId)
{
    using (_currentTenant.Change(tenantId))
    {
        return await _productRepository.GetListAsync();
    }
}

Change 方法传递 null 以切换到宿主端。

缓存

ASP.NET Boilerplate 拥有自己的分布式缓存抽象,它有内存和 Redis 实现。您通常注入 ICacheManager 服务,并使用其 GetCache(...) 方法来获取缓存,然后在缓存中获取和设置对象。

ABP 使用并扩展了 ASP.NET Core 的分布式缓存抽象。它定义了 IDistributedCache<T> 服务,用于注入缓存并获取/设置对象。

日志记录

ASP.NET Boilerplate 使用 Castle Windsor 的日志记录工具作为抽象,并支持包括 Log4Net(启动项目默认包含)和 Serilog 在内的多个日志记录提供程序。您通常通过属性注入日志记录器:

using Castle.Core.Logging; //1: 导入日志记录命名空间

public class TaskAppService : ITaskAppService
{
    //2: 使用属性注入获取日志记录器
    public ILogger Logger { get; set; }

    public TaskAppService()
    {
        //3: 如果没有提供日志记录器,则不写入日志。
        Logger = NullLogger.Instance;
    }

    public void CreateTask(CreateTaskInput input)
    {
        //4: 写入日志
        Logger.Info("Creating a new task with description: " + input.Description);
        //...
    }
}

ABP 依赖于微软的日志记录扩展库,该库也是一个抽象,并且有许多提供程序实现了它。启动模板使用 Serilog 作为预配置的日志记录库,但您可以在项目中轻松更改。使用模式类似:

//1: 导入日志记录命名空间
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Abstractions;

public class TaskAppService : ITaskAppService
{
    //2: 使用属性注入获取日志记录器
    public ILogger<TaskAppService> Logger { get; set; }

    public TaskAppService()
    {
        //3: 如果没有提供日志记录器,则不写入日志。
        Logger = NullLogger<TaskAppService>.Instance;
    }

    public void CreateTask(CreateTaskInput input)
    {
        //4: 写入日志
        Logger.LogInformation("Creating a new task with description: " + input.Description); //注意:ABP使用LogInformation,Info是旧版API的简化写法,实际应使用标准方法
        //...
    }
}

您注入 ILogger<T> 而不是 ILogger。注意日志级别方法的不同(例如 LogInformation 对应之前的 Info)。

对象到对象映射

IObjectMapper 服务

ASP.NET Boilerplate 定义了一个 IObjectMapper 服务(参见),并与 AutoMapper 库有集成。

用法示例:使用给定的 CreateUserInput 对象创建一个 User 对象:

public void CreateUser(CreateUserInput input)
{
    var user = ObjectMapper.Map<User>(input);
    ...
}

示例:使用给定的 UpdateUserInput 对象更新现有 User 的属性:

public async Task UpdateUserAsync(Guid id, UpdateUserInput input)
{
    var user = await _userRepository.GetAsync(id);
    ObjectMapper.Map(input, user);
}

ABP 有相同的 IObjectMapper 服务(参见)和 AutoMapper 集成,但映射方法略有不同。

用法示例:使用给定的 CreateUserInput 对象创建一个 User 对象:

public void CreateUser(CreateUserInput input)
{
    var user = ObjectMapper.Map<CreateUserInput, User>(input);
}

这次您需要明确声明源类型和目标类型(而 ASP.NET Boilerplate 只需要目标类型)。

示例:使用给定的 UpdateUserInput 对象更新现有 User 的属性:

public async Task UpdateUserAsync(Guid id, UpdateUserInput input)
{
    var user = await _userRepository.GetAsync(id);
    ObjectMapper.Map<UpdateUserInput, User>(input, user);
}

同样,ABP 要求明确设置源类型和目标类型。

AutoMapper 集成

自动映射属性

ASP.NET Boilerplate 有 AutoMapToAutoMapFromAutoMap 属性,用于为声明的类型自动创建映射。示例:

[AutoMapTo(typeof(User))]
public class CreateUserInput
{
    public string Name { get; set; }
    public string Surname { get; set; }
    ...
}

ABP 没有这样的属性,因为 AutoMapper 现在有类似的属性。您需要切换到 AutoMapper 的属性。

映射定义

ABP 紧密遵循 AutoMapper 原则。您可以定义从 Profile 类派生的类来定义映射。

配置验证

配置验证是 AutoMapper 的最佳实践,可以安全地维护您的映射配置。

有关对象映射的更多信息,请参阅文档

设置管理

定义设置

在基于 ASP.NET Boilerplate 的应用程序中,您创建一个从 SettingProvider 类派生的类,实现 GetSettingDefinitions 方法,并将您的类添加到 Configuration.Settings.Providers 列表中。

在 ABP 中,您需要从 SettingDefinitionProvider 派生您的类并实现 Define 方法。您不需要注册您的类,因为 ABP 会自动发现它。

获取设置值

ASP.NET Boilerplate 提供了 ISettingManager 来在服务器端读取设置值,并在 JavaScript 端提供了 abp.setting.get(...) 方法。

ABP 有 ISettingProvider 服务用于在服务器端读取设置值,并在 JavaScript 端有 abp.setting.get(...) 方法。

设置设置值

对于 ASP.NET Boilerplate,您使用相同的 ISettingManager 服务来更改设置值。

ABP 将其分离,并提供了设置管理模块(预添加到启动项目中),该模块具有 ISettingManager 来更改设置值。引入这种分离是为了支持分层部署场景(其中 ISettingProvider 也可以在客户端应用程序中工作,而 ISettingManager 也可以在服务器端工作)。

时钟

ASP.NET Boilerplate 有一个静态的 Clock 服务(参见),用于抽象 DateTime 类型,因此您可以轻松地在本地时间和 UTC 时间之间切换。您不需要注入它,只需使用 Clock.Now 静态方法来获取当前时间。

ABP 有 IClock 服务(参见),它具有类似的目标,但现在您需要在需要时注入它。

事件总线

ASP.NET Boilerplate 有一个进程内的事件总线系统。您通常注入 IEventBus(或使用静态实例 EventBus.Default)来触发事件。它会自动为实体更改触发事件(如 EntityCreatingEventDataEntityUpdatedEventData)。您通过实现 IEventHandler<T> 接口来创建一个类。

ABP 将事件总线分为两个服务:ILocalEventBusIDistributedEventBus

本地事件总线类似于 ASP.NET Boilerplate 的事件总线,而分布式事件总线是 ABP 中引入的新功能。

因此,要迁移您的代码:

  • 使用 ILocalEventBus 代替 IEventBus
  • 实现 ILocalEventHandler 代替 IEventHandler

请注意,ABP 也有一个 IEventBus 接口,但它存在的目的是作为本地和分布式事件总线的通用接口。它不会被注入和直接使用。

功能管理

功能系统用于多租户应用程序中,以定义应用程序的功能,并检查给定功能是否对当前租户可用。

定义功能

在 ASP.NET Boilerplate 中(参见),您创建一个继承自 FeatureProvider 的类,重写 SetFeatures 方法,并将您的类添加到 Configuration.Features.Providers 列表中。

在 ABP 中(参见),您从 FeatureDefinitionProvider 派生您的类并重写 Define 方法。无需将您的类添加到配置中,框架会自动发现它。

检查功能

您可以继续使用 RequiresFeature 属性和 IFeatureChecker 服务来检查某个功能是否对当前租户启用。

更改功能值

在 ABP 中,您使用 IFeatureManager 来更改租户的功能值。

审计日志

ASP.NET Boilerplate(参见)和 ABP(参见)具有类似的审计日志系统。ABP 要求将 UseAuditing() 中间件添加到 ASP.NET Core 中间件管道中,这在启动模板中已经添加。因此,大多数情况下它将开箱即用。

本地化

ASP.NET Boilerplate 支持 XML 和 JSON 文件来为 UI 定义本地化键值对(参见)。ABP 仅支持 JSON 格式的本地化文件(参见)。因此,您需要将 XML 文件转换为 JSON。

ASP.NET Boilerplate 有自己的 ILocalizationManager 服务,可以注入并用于服务器端的本地化。

ABP 使用 微软本地化扩展 库,因此它与 ASP.NET Core 完全集成。您使用 IStringLocalizer<T> 服务来获取本地化文本。示例:

public class MyService
{
    private readonly IStringLocalizer<TestResource> _localizer;

    public MyService(IStringLocalizer<TestResource> localizer)
    {
        _localizer = localizer;
    }

    public void Foo()
    {
        var str = _localizer["HelloWorld"]; // 获取本地化文本
    }
}

因此,您需要用 IStringLocalizer 替换 ILocalizationManager 的使用。

它同样提供了在客户端使用的 API:

var testResource = abp.localization.getResource('Test');
var str = testResource('HelloWorld');

在 ASP.NET Boilerplate 中,这类似于 abp.localization.localize(...)

导航与菜单

在 ASP.NET Boilerplate 中,您创建一个从 NavigationProvider 派生的类来定义您的菜单元素。菜单项具有 requiredPermissionName 属性以限制对菜单元素的访问。菜单项是静态的,您的类只执行一次。

在 ABP 中,您需要创建一个实现 IMenuContributor 接口的类。每当需要渲染菜单时,您的类就会被执行。因此,您可以根据条件添加菜单项。

例如,这是租户管理模块的菜单贡献者:

public class AbpTenantManagementWebMainMenuContributor : IMenuContributor
{
    public async Task ConfigureMenuAsync(MenuConfigurationContext context)
    {
        // 仅向主菜单添加项目
        if (context.Menu.Name != StandardMenus.Main)
        {
            return;
        }

        // 获取标准的管理菜单项
        var administrationMenu = context.Menu.GetAdministration();

        // 从 DI 容器解析一些需要的服务
        var l = context.GetLocalizer<AbpTenantManagementResource>();

        var tenantManagementMenuItem = new ApplicationMenuItem(
            TenantManagementMenuNames.GroupName,
            l["Menu:TenantManagement"],
            icon: "fa fa-users");

        administrationMenu.AddItem(tenantManagementMenuItem);

        // 根据权限有条件地添加“租户”菜单项
        if (await context.IsGrantedAsync(TenantManagementPermissions.Tenants.Default))
        {
            tenantManagementMenuItem.AddItem(
                new ApplicationMenuItem(
                    TenantManagementMenuNames.Tenants,
                    l["Tenants"],
                    url: "/TenantManagement/Tenants"));
        }
    }
}

因此,如果您希望仅在用户拥有相关权限时才显示菜单项,则需要使用 IAuthorizationService 检查权限。

导航/菜单系统仅用于 ASP.NET Core MVC / Razor Pages 应用程序。Angular 应用程序在启动模板中实现了不同的系统。

缺失的功能

以下功能在 ABP 中尚不存在。这里列出了一些主要的缺失功能(以及 ABP GitHub 仓库中等待该功能的相关 issue):

其中一些功能最终将被实现。但是,如果它们对您很重要,您可以自己实现它们。如果您愿意,可以 贡献 给框架,我们将非常感激。

在本文档中