乐趣区

关于程序员:手动从0搭建ABP框架ABP官方完整解决方案和手动搭建简化解决方案实践

作者：

jiezi

在

  本文次要解说了如何把ABP官网的在线生成解决方案运行起来，并阐明了解决方案中我的项目间的依赖关系。而后手动实际了如何从0搭建了一个简化的解决方案。ABP官网的在线生成解决方案源码下载参考[3]，手动搭建的简化的解决方案源码下载参考[4]。

一.ABP官网在线生成解决方案

1.将在线生成解决方案跑起来

首先进入页面https://abp.io/get-started，而后创立我的项目：

而后头脑中要有一个我的项目之间的依赖关系图，不分明的能够参考《基于ABP实现DDD》：

截止目前为止，我的项目应用的.NET版本是6.0，ABP版本是5.3.3。
应用Rider关上我的项目Acme.BookStore后，会提醒应用yarn装置package，安装包后：

在整个解决方案中搜寻ConnectionStrings，发现其在Acme.BookStore.HttpApi.Host、Acme.BookStore.DbMigrator和Acme.BookStore.IdentityServer这3个启动我的项目中呈现：

将ConnectionStrings中的内容替换为：

"ConnectionStrings": {
    "Default": "Server=127.0.0.1;Database=BookStore;Trusted_Connection=True;User ID=sa;Password=913292836;"
  },

而后开始运行Acme.BookStore.DbMigrator进行数据种子迁徙：

呈现下面图片输入后果，基本上示意迁徙胜利实现了，接下来看看数据库：

运行Acme.BookStore.Web我的项目如下：

启动后发现报错了，发现次要是3个问题：一个是Redis没有启动，另一个问题是IDS4服务没有启动，最初一个问题是Acme.BookStore.HttpApi.Host没有启动：

启动IDS4服务的时候发现报错Volo.Abp.AbpException: Could not find the bundle file '/libs/abp/core/abp.css' for the bundle 'Basic.Global'!：

在该我的项目下执行命令abp install-libs：

发现音讯提醒说ABP CLI有个更新的5.3.3版本，通过命令dotnet tool update -g Volo.Abp.Cli进行降级。再次运行Acme.BookStore.IdentityServer我的项目，发现不报谬误了。如果在启动其它我的项目(特指Acme.BookStore.Web我的项目)的时候报同样的谬误，那么同样执行命令abp install-libs即可解决问题。同时启动这3个我的项目如下：

启动胜利后就能够见到相熟的界面：

上面是我的项目Swagger的界面：

至此，曾经把从官网下载下来的我的项目胜利地运行起来了。

2.ABP运行流程

上面是在网上[1]找到的一张图，很清晰的阐明了AspNet Core和ABP模块的运行流程，集体认为图上的Startup.ConfigureServices应该是Startup.Configure，曾经在图中做了批改。

(1)AspNet Core运行流程
简略了解，基本上就是在Startup.ConfigureServices中进行依赖注入配置，而后在Startup.Configure中配置管道中间件，拜访的时候就像洋葱模型。
(2)ABP模块运行流程

  • 在ABP模块中对Startup.ConfigureServices做了扩大，减少了PreConfigureServices和PostConfigureServices。对Startup.Configure也做了扩大，当然名字也批改了，Startup.Configure相当于是OnApplicationInitialization，同时减少了OnPreApplicationInitialization和OnPostApplicationInitialization。
  • 在ABP解决方案中有多个我的项目，每个我的项目都会有一个类继承自AbpModule。并且通过DependsOn形容了该模块依赖的模块。这样在ABP解决方案中就会有很多模块之间的依赖关系，通过拓扑排序算法对模块进行排序，从最深层的模块顺次加载，直到启动所有模块。

(3)AbpModule抽象类中的办法
除了次要的PreConfigureServices()、ConfigureServices()、PostConfigureServices()、OnPreApplicationInitialization()、OnApplicationInitialization()、OnPostApplicationInitialization()办法外，还有一些其它的办法。abp\framework\src\Volo.Abp.Core\Volo\Abp\Modularity\AbpModule.cs：

二.手动创立解决方案

0.创立解决方案

首先创立一个目录BookStoreHand用于寄存解决方案：

而后创立一个解决方案，执行命令dotnet new sln -n Acme.BookStore：

用Rider关上后解决方案是空的，而后手动创立2个New Solution Folder，别离为src和test：

1.创立畛域共享层和畛域层

(1)Acme.BookStore.Domain.Shared[畛域共享层]
通常定义的常量和枚举，都放在该我的项目中。通过命令dotnet new classlib -n Acme.BookStore.Domain.Shared和dotnet sln ../Acme.BookStore.sln add Acme.BookStore.Domain.Shared创立畛域共享层，并将其增加到解决方案当中：

而后就是创立模块类BookStoreDomainSharedModule如下：

namespace Acme.BookStore.Domain.Shared
{
    public class BookStoreDomainSharedModule: AbpModule
    {
        public override void ConfigureServices(ServiceConfigurationContext context)
        {
            base.ConfigureServices(context);
        }

        public override void OnApplicationInitialization(ApplicationInitializationContext context)
        {
            base.OnApplicationInitialization(context);
        }
    }
}

阐明：接下来创立我的项目、增加我的项目间的援用等都应用Rider，而不再应用CLI操作，感觉CLI并不不便操作。基本思路程序都是：创立我的项目，设置援用关系，创立模块，其它操作。
(2)Acme.BookStore.Domain[畛域层]
该我的项目蕴含实体、值对象、畛域服务、规约、仓储接口等。通过Rider创立Class Library我的项目Acme.BookStore.Domain如下：

Acme.BookStore.Domain我的项目依赖于Acme.BookStore.Domain.Shared我的项目：

创立模块类BookStoreDomainSharedModule如下：

[DependsOn(
    typeof(BookStoreDomainSharedModule) //依赖畛域共享模块
)]
public class BookStoreDomainModule: AbpModule
{
    public override void ConfigureServices(ServiceConfigurationContext context)
    {
        base.ConfigureServices(context);
    }

    public override void OnApplicationInitialization(ApplicationInitializationContext context)
    {
        base.OnApplicationInitialization(context);
    }
}

创立畛域实体Book：

public class Book: Entity<int>
{
    public string BookName { get; set; } //名字
    
    public string Author { get; set; } //作者
    
    public DateTime PublishDate { get; set; } //出版日期
    
    public double Price { get; set; } //价格
}

创立仓储IBookRepository接口：

public interface IBookRepository: IRepository<Book, int>
{
}

2.创立基础设施层

(1)创立我的项目
基础设施层Acme.BookStore.EntityFrameworkCore是EF Core外围根底依赖我的项目，蕴含数据上下文、数据库映射、EF Core仓储实现等。通过Rider创立Class Library我的项目Acme.BookStore.EntityFrameworkCore如下：

Acme.BookStore.EntityFrameworkCore我的项目依赖于Acme.BookStore.Domain我的项目：

(2)创立模块
创立模块类BookStoreEntityFrameworkCoreModule如下：

[DependsOn(
    typeof(BookStoreDomainModule),
    typeof(AbpEntityFrameworkCoreSqlServerModule)
)]
public class BookStoreEntityFrameworkCoreModule: AbpModule
{
    public override void ConfigureServices(ServiceConfigurationContext context)
    {
        context.Services.AddAbpDbContext<BookStoreDbContext>(options =>
        {
            // 给所有的实体都减少默认仓储
            options.AddDefaultRepositories(includeAllEntities: true);
        });
        
        Configure<AbpDbContextOptions>(options =>
        {
            options.UseSqlServer();
        });
    }

    public override void OnApplicationInitialization(ApplicationInitializationContext context)
    {
        base.OnApplicationInitialization(context);
    }
}

(3)创立数据库上下文
创立数据库上下文BookStoreDbContext：

public class BookStoreDbContext: AbpDbContext<BookStoreDbContext>
{
    public BookStoreDbContext(DbContextOptions<BookStoreDbContext> options) : base(options)
    {
    }
    
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);
        
        modelBuilder.ApplyConfigurationsFromAssembly(typeof(BookStoreDbContext).Assembly);
    }
}

ApplyConfigurationsFromAssembly利用来自IEntityTypeConfiguration中的配置。定义实体映射BookDbMapping如下：

public class BookDbMapping: IEntityTypeConfiguration<Book>
{
    public void Configure(EntityTypeBuilder<Book> builder)
    {
        // 配置主键
        builder.HasKey(b => b.Id).HasName("Id");
        
        // 配置表和字段
        builder.ToTable("AbpBook");
        builder.Property(t => t.BookName).IsRequired().HasColumnName("BookName").HasComment("书名");
        builder.Property(t => t.Author).IsRequired().HasColumnName("Author").HasComment("作者");
        builder.Property(t => t.PublishDate).IsRequired().HasColumnName("PublishDate").HasComment("出版日期");
        builder.Property(t => t.Price).IsRequired().HasColumnName("Price").HasComment("价格");
        
        // 配置关系
    }
}

(4)创立仓储实现
定义IBookRepository的实现BookRepository如下：

public class BookRepository: EfCoreRepository<BookStoreDbContext, Book, int>, IBookRepository
{
    public BookRepository(IDbContextProvider<BookStoreDbContext> dbContextProvider) : base(dbContextProvider)
    {
    }
}

3.创立利用契约层和应用层

(1)Acme.BookStore.Application.Contracts[利用契约层]
蕴含应用服务接口和数据传输对象。该项⽬被应⽤程序客户端援用，比方Web我的项目、API客户端我的项目。通过Rider创立Class Library我的项目Acme.BookStore.Application.Contracts：

Acme.BookStore.Application.Contracts我的项目依赖于Acme.BookStore.Domain.Shared我的项目如下：

创立模块类BookStoreApplicationContractsModule如下：

[DependsOn(
    typeof(BookStoreDomainSharedModule), //依赖于BookStoreDomainSharedModule
    typeof(AbpObjectExtendingModule) //依赖于AbpObjectExtendingModule
)]
public class BookStoreApplicationContractsModule: AbpModule
{
    public override void ConfigureServices(ServiceConfigurationContext context)
    {
        base.ConfigureServices(context);
    }

    public override void OnApplicationInitialization(ApplicationInitializationContext context)
    {
        base.OnApplicationInitialization(context);
    }
}

创立服务接口IBookAppService如下：

public interface IBookAppService: IApplicationService
{
    /// <summary>
    /// 获取书籍
    /// </summary>
    Task<BookDto> GetBookAsync(int id);
}

创立输入DTO为BookDto如下：

public class BookDto
{
    public int Id { get; set; } //主键
    
    public string BookName { get; set; } //名字
    
    public string Author { get; set; } //作者
    
    public DateTime PublishDate { get; set; } //出版日期
    
    public double Price { get; set; } //价格
}

(2)Acme.BookStore.Application[应用层]
实现在Contracts我的项目中定义的接⼝。通过Rider创立Class Library我的项目Acme.BookStore.Application如下：

Acme.BookStore.Application我的项目依赖于
Acme.BookStore.Application.Contracts和Acme.BookStore.Domain我的项目：

创立模块类BookStoreApplicationModule如下：

[DependsOn(
    typeof(AbpAutoMapperModule), //依赖于AutoMapper
    typeof(BookStoreDomainModule), //依赖于BookStoreDomainModule
    typeof(BookStoreApplicationContractsModule) //依赖于BookStoreApplicationContractsModule
)]
public class BookStoreApplicationModule: AbpModule
{
    public override void ConfigureServices(ServiceConfigurationContext context)
    {
        var services = context.Services;
        // 增加ObjectMapper注入
        services.AddAutoMapperObjectMapper<BookStoreApplicationModule>();
        
        // Abp AutoMapper设置
        Configure<AbpAutoMapperOptions>(config =>
        {
            config.AddMaps<BookStoreApplicationAutoMapperProfile>();
        });
    }

    public override void OnApplicationInitialization(ApplicationInitializationContext context)
    {
        base.OnApplicationInitialization(context);
    }
}

创立主动映类BookStoreApplicationAutoMapperProfile如下：

public class BookStoreApplicationAutoMapperProfile: Profile
{
    public BookStoreApplicationAutoMapperProfile()
    {
        CreateMap<BookDto, Book>();
        CreateMap<Book, BookDto>();
    }
}

创立IBookAppService类的实现类BookAppService如下：

public class BookAppService: ApplicationService, IBookAppService
{
    private readonly IBookRepository _bookRepository;

    public BookAppService(IBookRepository bookRepository)
    {
        _bookRepository = bookRepository;
    }
    
    public async Task<BookDto> GetBookAsync(int id)
    {
        var queryable = await _bookRepository.GetQueryableAsync();
        var book = queryable.FirstOrDefault(t => t.Id == id);
        if (book == null)
        {
            throw new ArgumentNullException(nameof(book));
        }
        return ObjectMapper.Map<Book, BookDto>(book);
    }
}

4.创立种子迁徙

Acme.BookStore.DbMigrator是控制台应用程序，次要是迁徙数据库构造并初始化种子数据。通过Rider创立ASP.NET Core Web Application的Empty我的项目Acme.BookStore.DbMigrator如下：

Acme.BookStore.DbMigrator我的项目依赖于Acme.BookStore.Application.Contracts和Acme.BookStore.EntityFrameworkCore我的项目如下：

创立模块类BookStoreDbMigratorModule如下：

[DependsOn(
    typeof(AbpAutofacModule),
    typeof(BookStoreEntityFrameworkCoreModule),
    typeof(BookStoreApplicationContractsModule)
    )]
public class BookStoreDbMigratorModule : AbpModule
{
    public override void ConfigureServices(ServiceConfigurationContext context)
    {
        base.ConfigureServices(context);
    }

    public override void OnApplicationInitialization(ApplicationInitializationContext context)
    {
        base.OnApplicationInitialization(context);
    }
}

在Program.cs中增加services.AddHostedService<DbMigratorHostedService>()这个数据库迁徙主机服务，在DbMigratorHostedService类中蕴含StartAsync()和StopAsync()这2个办法，在StartAsync()中获取BookStore数据库迁徙服务BookStoreDbMigrationService，并执行数据库迁徙办法MigrateAsync()。数据库迁徙的思路基本上就是在Acme.BookStore.DbMigrator目录下执行命令：dotnet ef migrations add InitialCreate和dotnet ef database update，只不过应用的C#代码来实现的。本人通过Acme.BookStore.DbMigrator我的项目没有迁徙胜利，最初还是通过命令行实现迁徙的。迁徙后果如下：

阐明：Program.cs、DbMigratorHostedService.cs和BookStoreDbMigrationService.cs的源码等残缺我的项目源码参考[4]。

5.创立近程服务层

Acme.BookStore.HttpApi[近程服务层]，简略了解就是很薄的管制层，该我的项目次要用于定义HTTP API，即应用服务层的包装器，将它们公开给近程客户端调用。通过Rider创立Class Library我的项目Acme.BookStore.HttpApi如下：

Acme.BookStore.HttpApi我的项目依赖于Acme.BookStore.Application.Contracts我的项目如下：

创立模块类BookStoreHttpApiModule如下：

[DependsOn(
    typeof(BookStoreApplicationContractsModule) //依赖于BookStoreApplicationContractsModule
)]
public class BookStoreHttpApiModule : AbpModule
{
    public override void ConfigureServices(ServiceConfigurationContext context)
    {
        base.ConfigureServices(context);
    }

    public override void OnApplicationInitialization(ApplicationInitializationContext context)
    {
        base.OnApplicationInitialization(context);
    }
}

为了简要阐明问题，创立一个简略的控制器类BookStoreController如下：

[RemoteService]
[Area("BookStore")]
[Route("api/app/book")]
public class BookStoreController: AbpControllerBase
{
    private readonly IBookAppService _bookAppService;
    
    public BookStoreController(IBookAppService bookAppService)
    {
        _bookAppService = bookAppService;
    }

    [HttpGet]
    [Route("get-book")]
    public Task<BookDto> GetBookAsync(int id)
    {
        return _bookAppService.GetBookAsync(id);
    }
}

6.创立展现层

Acme.BookStore.HttpApi.Host这个是前后端拆散时的我的项目命名形式。通过Rider创立ASP.NET Core Web Application的Empty我的项目Acme.BookStore.HttpApi.Host如下：

Acme.BookStore.HttpApi.Host我的项目依赖于Acme.BookStore.Application、Acme.BookStore.EntityFrameworkCore和Acme.BookStore.HttpApi我的项目如下：

创立模块类BookStoreHttpApiHostModule如下：

[DependsOn(
    typeof(BookStoreHttpApiModule), //依赖于BookStoreHttpApiModule
    typeof(AbpAutofacModule), //依赖于AbpAutofacModule
    typeof(BookStoreApplicationModule), //依赖于BookStoreApplicationModule
    typeof(BookStoreEntityFrameworkCoreModule), //依赖于BookStoreEntityFrameworkCoreModule
    typeof(AbpAspNetCoreSerilogModule), //依赖于AbpAspNetCoreSerilogModule
    typeof(AbpSwashbuckleModule) //依赖于AbpSwashbuckleModule
)]
public class BookStoreHttpApiHostModule : AbpModule
{
    public override void ConfigureServices(ServiceConfigurationContext context)
    {
        var services = context.Services;
        var configuration = services.GetConfiguration();

        ConfigureConventionalControllers();
        ConfigureCors(context, configuration);
        ConfigureSwaggerServices(context, configuration);
    }

    private void ConfigureConventionalControllers()
    {
        Configure<AbpAspNetCoreMvcOptions>(options =>
        {
            options.ConventionalControllers.Create(typeof(BookStoreApplicationModule).Assembly);
        });
    }
            
    private void ConfigureCors(ServiceConfigurationContext context, IConfiguration configuration)
    {
        context.Services.AddCors(options =>
        {
            options.AddPolicy("AllowAll",builder =>
            {
                builder
                    .WithOrigins(
                        configuration["App:CorsOrigins"]
                            .Split(",", StringSplitOptions.RemoveEmptyEntries)
                            .Select(o => o.RemovePostFix("/"))
                            .ToArray()
                    )
                    .WithAbpExposedHeaders()
                    .SetIsOriginAllowedToAllowWildcardSubdomains()
                    .AllowAnyHeader()
                    .AllowAnyMethod()
                    .AllowCredentials();
            });
        });
    }
            
    private static void ConfigureSwaggerServices(ServiceConfigurationContext context, IConfiguration configuration)
    {
        context.Services.AddSwaggerGen(options =>
        {
            options.SwaggerDoc("v1", new OpenApiInfo { Title = "BookStore API", Version = "v1" });
            options.DocInclusionPredicate((docName, description) => true);
            options.CustomSchemaIds(type => type.FullName);
        });
    }
             
    public override void OnApplicationInitialization(ApplicationInitializationContext context)
    {
        var env = context.GetEnvironment();
        var app = context.GetApplicationBuilder();
        var configuration = context.GetConfiguration();
        
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseCors("AllowAll");

        if (configuration["UseSwagger"] == "true")
        {
            app.UseSwagger();
            app.UseSwaggerUI(options =>
            {
                options.SwaggerEndpoint("/swagger/v1/swagger.json", "Acme.BookStore API");
            });
        }
        
        app.UseRouting();
        app.UseConfiguredEndpoints();
    }
}

阐明：HomeController.cs、Program.cs和配置文件等我的项目残缺源码参考[4]。
将Acme.BookStore.HttpApi.Host我的项目启动起来后如下：

通过Swagger界面测试https://localhost:7016/api/app/book/get-book?id=1接口如下：

  奇怪的是在线生成解决方案的时候，UI框架抉择了MVC，然而还是呈现了这个我的项目，并且在启动Acme.BookStore.Web我的项目的时候，如果不启动Acme.BookStore.HttpApi.Host我的项目，还会报错Volo.Abp.AbpException: Remote service 'AbpMvcClient' was not found and there is no default configuration，并且还没有找到Acme.BookStore.Web我的项目在哪里用到了Acme.BookStore.HttpApi.Host我的项目。因为本人次要关注前后端拆散的我的项目，所以就不纠结这个细节了。
  在线生成解决方案中还包含：Acme.BookStore.IdentityServer(认证受权我的项目)，Acme.BookStore.HttpApi.Client(近程服务代理层)，Acme.BookStore.Web(前后端不拆散的展现层)，Acme.BookStore.TestBase(其它我的项目共享或应用的类)，Acme.BookStore.Domain.Tests(测试畛域层对象)，Acme.BookStore.EntityFrameworkCore.Tests(测试自定义仓储实现或EF Core映射)，Acme.BookStore.Application.Tests(测试应用层对象)，Acme.BookStore.HttpApi.Client.ConsoleTestApp(从.NET控制台中调用HTTP API)等。一篇文章放不下，前面持续讲解实际。

参考文献：
[1]聊一聊ABP vNext的模块化零碎：https://www.sohu.com/a/436373…
[2]Abp vNext源码剖析文章目录：https://www.cnblogs.com/myzon…
[3]手动从0搭建ABP框架-ABP官网残缺解决方案源码：https://url39.ctfile.com/f/25… (拜访明码: 2096)
[4]手动从0搭建ABP框架-手动搭建简化解决方案源码：https://url39.ctfile.com/f/25… (拜访明码: 2096)

本文由mdnice多平台公布

评论

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

这个站点使用 Akismet 来减少垃圾评论。了解你的评论数据如何被处理。

更多文章