从零开始进行ABP项目开发(十)——总结

好了,我们从一个简单的控制台程序出发,从零开始创建了ABP项目的各个部分,创建了可以对提供服务的服务层和对外的Web Api,基于服务层和Web Api分别创建了简单的多页面应用和单页面应用。下面,把我们在学习过程中的知识点做一个总结。

ABP模块(Module)与模块的初始化

ABP以模块的方式组织应用,每一个模块都继承自AbpModule,模块定义时,可以显示地定义模块之间的依赖关系,这样,在初始化模块时,所依赖的模块也会被初始化。
一个模块典型的定义如下:

using Abp.Modules;
using System.Reflection;

namespace ZL.Poem.Core
{
    public class PoemCoreModule : AbpModule
    {
        public override void Initialize()
        {
            IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());
        }
    }
}

可以使用AbpBootstrapper加载并运行模块:

using (var bootstrapper = AbpBootstrapper.Create())
    {
        //初始化模块
        bootstrapper.Initialize();

    }

领域层的定义

领域对象季承自Entity,比如:

using Abp.Domain.Entities;

namespace ZL.Poem.Core.Poems
{
    /// 
    /// 诗人,从ABP Entity派生
    /// 
    public class Poet : Entity
    {
        /// 
        /// 姓名
        /// 
        public virtual string Name { get; set; }

        /// 
        /// 介绍
        /// 
        public virtual string Description { get; set; }

    }
}

领域对象的Id字段是固定的,缺省为整型,也可以定义为其它类型。当我们采用EF等框架构建持久化层时,可以通过定义映射领域层与数据库之间的关系。比如:

protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            base.OnModelCreating(modelBuilder);

            //映射Poet到数据库表
            modelBuilder.Entity().ToTable("Poet");

            //映射实体与数据库中的字段,将Id映射到数据库表的PoetID字段
            modelBuilder.Entity()
                    .Property(p => p.Id)
                    .HasColumnName("PoetID");
        }

应用层的构建

应用层的服务实现 IApplicationService 接口。通常我们需要定义继承这个接口的服务接口,然后再实现这些自己的服务接口。比如:

using Abp.Application.Services;
using Abp.Application.Services.Dto;

namespace ZL.Poem.Application.Poems
{
    public interface IPoemAppService : IApplicationService
    {
        /// 
        /// 获取诗人分页
        /// 
        /// 
        /// 
        PagedResultDto GetPagedPoets(PagedResultRequestDto dto);

    }
}

应用层通过DTO与领域层打交道,我们不能对外暴露领域对象。Dto继承自EntityDto,可以使用AutoMap与领域层映射,比如:

using Abp.Application.Services.Dto;
using Abp.AutoMapper;
using ZL.Poem.Core.Poems;

namespace ZL.Poem.Application.Poems
{
    [AutoMapFrom(typeof(Poet))]
    public class PoetDto : EntityDto
    {
        public string Name { get; set; }

        public string Description { get; set; }
    }
}

动态Web Api

ABP可以为服务层动态生成Web Api,在一个Web Api项目中,可以增加一个ABP的模块,动态创建Web Api,比如:

using Abp.Modules;
using System.Reflection;
using ZL.Poem.Application;
using ZL.Poem.EF;

namespace ZL.Poem.WebApi
{
    [DependsOn(typeof(PoemDataModule),
       typeof(PoemApplicationModule),
        typeof(AbpAspNetCoreModule))]
   
    public class PoemWebApiModule : AbpModule
    {
        public override void Initialize()
        {
            IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());

            //创建动态Web Api
            Configuration.Modules.AbpAspNetCore().CreateControllersForAppServices(typeof(PoemApplicationModule).Assembly, moduleName: "app", useConventionalHttpVerbs: false); 

        }
    }
}

Web Api的接口约定的命名规则是I+服务名称+AppService,比如,IPoemAppService的服务名称为Poem,映射的地址为:

api/services/[moduleName]/[服务名称]/[方法名称]

基于RazorPage的多页面应用

创建基于RazorPage的多页面应用时,可以直接使用服务层,RazorPage的编程模型更为简单,代码结构上有点类似于WebForm:每个页面有一个后台代码文件,但本质上完全不同,后台代码定义了视图模型,与视图之间是松耦合的,也不负责管理页面的状态(WebForm中有ViewState,负责管理回传过程中的页面状态)。

基于Vue.js的单页面应用

可以使用Vistual Studio 创建基于Vue.js的单页面应用。这时,前端的单页面应用和后端的Web Api处于不同的域,会有跨域访问(CORS)的问题,需要启动跨域访问。需要在Startup的ConfigureServices方法中注册cors策略:

services.AddCors(option => option.AddPolicy("cors", policy => policy.AllowAnyHeader().AllowAnyMethod().AllowCredentials().AllowAnyOrigin()));

然后在Configure中使用这个策略

 public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            app.UseCors("cors");

下一步的工作

在这个系列里,还有一些没有涉及的内容,需要将来进行补充。

  • 权限:权限是应用系统的重要组成部分,同时也是比较复杂的部分,管理权限、认证、授权等等。
  • 集成测试:这个系列里讨论了单元测试,没有涉及集成测试。
  • ABP模块与现有系统的集成:如何将ABP模块与现有的非ABP系统集成。

以上内容,需要单独的专题进行讨论。

你可能感兴趣的:(从零开始进行ABP项目开发(十)——总结)