.NetCore(.Net5)快速开发框架一：快速开发

上一篇我们完成了项目首次启动的初始化工作，这一篇我们来看看使用AdmBoots实现一个业务的具体实践。

系列教程

01.NetCore(.Net5)快速开发框架一：前言
02.NetCore(.Net5)快速开发框架二：快速开发
03.NetCore(.Net5)快速开发框架三：WebAPI性能监控-MiniProfiler与Swagger集成
04.NetCore(.Net5)快速开发框架四：实现审计日志
...

创建Model

在Domain层下创建模型 Test.cs 然后使用Code First将表生成到数据库。或者你也可以使用DB First 现在数据库建表，然后通过命令反向生成Model。

[Table("Test")]
 public class Test : AuditEntity {

     [Required, MaxLength(EntityDefault.FieldsLength50)]
     public string Name { get; set; }
     public int Age { get; set; }
 }

Test类继承了抽象类AuditEntity，AuditEntity具有以下属性

 public class AuditEntity : CreationEntity<int> {
     public int? ModifierId { get; set; }

     [MaxLength(EntityDefault.LongNameLength)]
     public string ModifierName { get; set; }

     public DateTime? ModifyTime { get; set; }
 }


 public class CreationEntity : CreationEntity<int> { }

 public class CreationEntity<TKey> : Entity<TKey> {
     public TKey CreatorId { get; set; }

     [MaxLength(EntityDefault.LongNameLength)]
     public string CreatorName { get; set; }

     public virtual DateTime? CreateTime { get; set; }
 }

 [Serializable]
 public abstract class Entity<TPrimaryKey> : IEntity<TPrimaryKey> {

     [Key]
     public virtual TPrimaryKey Id { get; set; }

     public virtual bool IsTransient() {
         if (EqualityComparer<TPrimaryKey>.Default.Equals(Id, default(TPrimaryKey))) {
             return true;
         }
         if (typeof(TPrimaryKey) == typeof(int)) {
             return Convert.ToInt32(Id) <= 0;
         }
         if (typeof(TPrimaryKey) == typeof(long)) {
             return Convert.ToInt64(Id) <= 0;
         }
         return false;
     }

 }

想必大家已经看出来继承AuditEntity的作用了，它是一个审计接口，继承这个类，可以在我们对Test进行增加，修改的时候，数据库中AuditEntity对应字段会自动赋值，无需我们在逻辑层手动编码。这对我们开发业务时，会大大减少重复编码工作量。

Model编写完后，别忘了在AdmDbContext中添加DbSet

    public class AdmDbContext : DbContext {
        //...

        public virtual DbSet<Test> Tests { get; set; }

        //...
    }

代码生成

框架实现了代码生成器，可以生成CURD框架代码，减少代码的重复编写。目前实体类生成还只限Mysql数据库，可以根据自己的数据库自行扩展。

下面我们来看看具体怎么使用

1. 启动项目，在Swagger页面的CodeGenerator 控制器下做如下操作
   

返回我们的项目，可以看到在Controller下，Application层都创建好了文件夹及代码，我们向里面添加逻辑就可以了

创建Service

一些相关解释

Service 在应用服务层也就是application层。应用服务用于将领域(业务)逻辑暴露给展现层。展现层通过传入DTO(数据传输对象)参数来调用应用服务，而应用服务通过领域对象来执行相应的业务逻辑并且将DTO返回给展现层。

也就是这样避免了应用服务层和展现层的直接数据交互，而是通过dto实现了数据过滤，这样就可以较好的避免非法数据的传入传出。另外还有实现数据隐藏，方便扩展等好处。

创建应用服务时需要注意：

1. IxxxService 要实现ITransientDependency接口，继承此接口可将服务注入到容器。

2. 继承AppServiceBase抽象类，该类通过属性提供了工作单元，AutoMapper，Session对象

3. AdmBoots中，一个应用服务方法默认是一个工作单元（Unit of Work），AdmBoots自动进行事务管理。可通过在方法上添加特性[UnitOfWork(IsDisabled = true)] 关闭工作单元。（是不是和ABP这里很像☺）

public class TestService : AppServiceBase, ITestService {
    //...
}

public interface ITestService :ITransientDependency {
    //...
}

Dto 数据传输对象

建议命名 input/ouput 对象类似于 MethodNameInput/MethodNameOutput，对于每个应用服务方法都需要将 Input 和 Output 进行分开定义。甚至你的方法只接收或者返回一个值，也最好创建相应的 DTO 类型。 这样会使代码有更好的扩展性。

怎么将Test实体类转换为dto，这时就需要使用AutoMapper 进行映射了。

 public Task AddOrUpdateTest(int? id, AddOrUpdateTestInput input) {
    var testEntity = ObjectMapper.Map<Test>(input);
    //...
}

public class AutoMapProfile : Profile {

    /// <summary>
    /// 配置构造函数，用来创建关系映射
    /// </summary>
    public AutoMapProfile() {
        //
        CreateMap<Test, GetTestOutput>();
    }
}

注意，根据DDD领域驱动设计，业务比较复杂时(多领域)，业务逻辑的实现应该在Domain层实现

应用层要尽量简单，主要用于协调领域模型与其他应用组件的工作（并不处理业务逻辑）。相对于领域层，应用层应该是很薄的一层。它只是协调领域层对象执行实际的工作。

领域层主要负责表达业务概念，业务状态信息和业务规则。

Domain层是整个系统的核心层，几乎全部的业务逻辑会在该层实现。

API策略授权

API授权可以参照框架中RoleController，主要分为以下几个部分

1. 在RoleController 上添加特性 [Authorize(AdmConsts.POLICY)]

[Authorize(AdmConsts.POLICY)]
public class RoleController : ControllerBase {
    //...
}

2. Action上添加特性 [AdmAuthorizeFilter("Role:Add")] 其中"Role:Add"为该资源的标识，这里先记住这个标识，后面授权会用到。也可以不添加AdmAuthorizeFilter特性，那么资源标识默认为"ControllerName:ActionName", 如"Role:AddRole"为AddRole这个Action的默认资源标识

[HttpPost]
//自定义资源标识
[AdmAuthorizeFilter("Role:Add")]
public async Task<IActionResult> AddRole([FromBody]AddOrUpdateRoleInput input) {
    await _roleService.AddOrUpdateRole(null, input);
    return Ok(ResponseBody.From("保存成功"));
}

3. 如果在标有[Authorize(AdmConsts.POLICY)]策略授权的Controller中某个Action我们不想设置权限，我们可以在Action上使用特性[AllowAnonymous]

[HttpGet("transferRoles")]
[AllowAnonymous]
public IActionResult GetTransferRoles() {
    var roles = _roleService.GetTransferRoles();
    return Ok(ResponseBody.From(roles));
}

3. 将API资源分配个某个角色
   一般情况下，一个API地址为前端一个具体操作，比如一个按钮的动作。
   这里我们运行前端AdmBoots-Client，通过菜单管理及角色管理来进行API授权。
   登陆账号：admin 密码：a123456

   a.菜单管理 中添加按钮权限信息

   

   b.角色管理 中会看到我们刚才添加的按钮信息，勾选保存。这样拥有该角色的用户就拥有了此操作的权限。

   

   c.前端使用AuthWrapper组件嵌套权限按钮，可以实现对没有权限操作的按钮进行隐藏

   //authorized: 菜单按钮的code值
   //pageCode: 按钮所在菜单的路由
    <AuthWrapper authorized="add" pageCode="juesgl">
            <Button type="primary" icon={<PlusOutlined/>} onClick={this.onAdd}>
            新增
            </Button>
    </AuthWrapper>
   

至此，AdmBoots实践内容就介绍完了，可能介绍的并不完全，比如自定义仓储，分页操作，数据返回格式，分步事务提交等，还有很多细节没有说明，大家自行探索吧。有什么问题欢迎留言或进群询问。

源码地址

后端：https://github.com/xuke353/AdmBoots

前端：https://github.com/xuke353/AdmBoots-Client