Nest-admin

nestjs+typeOrm+react+amis 组成的基础管理后台，含权限管理、菜单管理、自定义表单设计器

• 配套前端：react+amis： https://github.com/a709691139/react-antd-pro-admin

文档

• nestjs: https://nestjs.bootcss.com/first-steps.html
• swagger: https://docs.nestjs.com/openapi/types-and-parameters https://docs.nestjs.com/openapi/operations
• typeorm: https://typeorm.bootcss.com/entities
• 校验 dto: class-validator

接口

• api: http://localhost:3000/api/xxx 接口统一前缀 /api
• swagger: http://localhost:3000/swagger
• 静态文件: 位置/public，访问: http://localhost:3000/static/temp.js

运行

• 安装 mysql ，创建 nestjs 数据库
• 运行 /sql/init_mysql.sql
• 安装 redis
• 配置好config/development.ts

注意事项

• nestjs 全局 provider 里 不能引入 Scope.REQUEST 的 provider 如全局监听里，不能引入 HttpCommonDataProvider

分页查询，前端可自定义参数条件

• 1、支持模糊查询 前后带*
• 2、取非查询 在查询输入框前面输入! 则查询该字段不等于输入值的数据 (数值类型不支持此种查询,可以将数值字段定义为字符串类型的)
• 3、in 查询 若传入的数据带,(逗号) 则表示该查询为 in 查询
• 4、时间范围查询，需包含两个字段：{}_begin，{}_end
• 5、大小查询："lt 100" 中间空格 , 小于查询 lt 100, 小于等于 le 100, 大于 gt 100, 大于等于 ge 100

接口返回数据

统一格式返回， {status:0,message:"成功", data:'xxx'}

• 普通 @ApiResponseWrap(DemoOne)
• 分页 @ApiPaginatedResponse(DemoOne)

redis

@InjectRedis() private readonly redis: Redis,
await this.redis.set('testMap', JSON.stringify({ heh: 1 }), 'EX', 10);

// 锁
await this.lockService.lock('test1', 2 * 60 * 1000, 100, 10);
await new Promise((resolve) => setTimeout(resolve, 5000));
this.count++;
this.lockService.unlock('test1');

接口校验

不建议在 entity 里加，因为会把那些分页查询编辑接口也校验

import { IsNotEmpty, IsArray, ArrayNotEmpty } from 'class-validator';

class Item{
  @IsNotEmpty({ message: 'name 不允许为空' })
  name:string
}
/** 新增接口dto */
export class AddUserDto {
  @ApiProperty({
    description: '名称',
    required: true,
  })
  @IsNotEmpty({ message: 'name 不允许为空' })
  name: string;

  @IsNotEmpty({ message: 'code 不允许为空' })
  code: string;

  @IsArray()
  @ArrayNotEmpty()
  @ValidateNested()
  @Type(() => Item)
  myArray: Item[];
}

// 可以自动去除多余的字段，只要RegisUserDto定义的
@UsePipes(new ValidationPipe({ whitelist: true }))
async regis(@Body() dto: RegisUserDto) {
  console.log('dto', dto);
}

数据表命名

系统级别的都用sys_前缀，如sys_user

QueryBuilder 查询

复杂的 sql 请用这个

todo

demo 例子

• demoOne 单表查询增删改查
• demoOneSoftDelete 单表查询增删改查-软删除，deletedAt entity 加入 CommonSoftDeleteEntity，删除用 repository.softRemove
• demoOneToOne 一对一表
• demoOneToMany 一对多表 如果修改 parent.children, 只会把已存在数据库的 child 的 parentId 修改，不会自动更新 child 的其他字段， 也不会自动删除和新增 child
• demoManyToMany 多对多

生成 demo 模板

方法，先编写好模板，然后用lodash/template库做文本替换

const _ = require('lodash');
const templateString = '<%= age > 18 ? "Adult" : "Minor" %>';
const compiledTemplate = _.template(templateString);
const result = compiledTemplate({ age: 25 });
console.log(result); // 输出: Adult

登陆注册

默认全部接口都需要校验登陆，如不需要就加个@NotNeedLogin()

• 验证码
• 登陆
• 注册
• 怎么添加 token 验证+swagger
• 校验权限

// 添加，传多个就需要有其中一个权限
@NeedPermissions('user:add')

• 建议通用权限设计：table:action 分页 page 、详情 get 、新增 create、 删除 remove 、编辑 update、导出 excel: export_excel

表单

• 表单验证+swagger
• 表单设计器，前端的增删改查可视化 schema
• • 如果存后端：前端根据/apiSchemaPage/:pageid， 来获取
• • 如果存前端：前端根据/apiSchemaPage/:pageid， 先判断前端有无定义了，无就去读接口。 或者自定义其他页面+路由吧

依赖注入问题

• 每个 http 请求都有的唯一单例: @Injectable({ scope: Scope.REQUEST })
• 全局单一服务MyGobalService : 只能在一个moduleA的providers:[MyGobalService]被引入，然后其他moduleB通过imports:[forwardRef(() => ModuleA)]来注入