能够动态推断与生成DTO是Node生态的一个重要里程碑

在开发后端 API 服务时，DTO 是进行参数验证、生成Swagger元数据的关键节点。如果不能像推断类型一样动态推断出 DTO，那么，我们就仍然需要手工创建 DTO。随着业务的增长，复杂的表间关系会让手工补充 DTO 的工作日益繁重
而 Vona ORM 首创 DTO 动态推断与生成能力，解放我们的双手，显著提升生产力。甚至可以说，对于构建更加优雅的 Node.js 后端框架而言，能够动态推断与生成 DTO，是非常重要的里程碑
DTO清单

Vona ORM 提供了以下 DTO：
名称说明get标注返回结果query标注Query参数queryPage标注带分页的Query参数selectAndCount标注带分页的返回结果create标注Create参数update标注Update参数aggregate标注聚合操作的返回结果group标注分组操作的返回结果DTO使用方法

下面以 Order/Product 为例，演示如何针对主表-明细表进行查询操作
1. Model关系定义

先在 Model Order 中定义与 Model Product 的1:n关系

1. @Model({
2.   entity: EntityOrder,
3.   relations: {
4.     products: $relation.hasMany(() => ModelProduct, 'orderId', {
5.       columns: ['id', 'name', 'price', 'quantity', 'amount'],
6.     }),
7.   },
8. })
9. class ModelOrder {}

复制代码

• relations.products: 定义1:n关系
  

2. 创建Api端点

创建 Controller，提供 findAll 方法

1. class ControllerOrder {
2.   @Web.get('findAll')
3.   async findAll() {
4.     return this.scope.model.order.select({
5.       include: {
6.         products: true,
7.       },
8.     });
9.   }
10. }

复制代码

• model.order: 是Order的model实例
  
• select：指定include.products: true，从而查询出主表-明细表数据
  

3. 动态推断与生成DTO

由于此 Api 返回的结果是主表-明细表结构，我们不能简单的使用EntityOrder数组来标注返回类型。而是使用 DTO 进行动态推断与生成

1. + import { $Dto } from 'vona-module-a-orm';
3. class ControllerOrder {
4.   @Web.get('findAll')
5. + @Api.body(v.array($Dto.get(() => ModelOrder, { include: { products: true } })))
6.   async findAll() {
7.     return this.scope.model.order.select({
8.       include: {
9.         products: true,
10.       },
11.     });
12.   }
13. }

复制代码

• @Api.body：标注返回结果
  
• v.array: 标注数组
  
• $Dto.get: 用于动态推断与生成 DTO
  

$Dto.get生成的 DTO 是主表-明细表结构，其 Swagger/Openapi 效果如下：

4. 封装DTO

我们还可以创建一个新的 DTO class，将前面的$Dto.get动态推断代码封装起来，从而用于其他地方

• 在 VSCode 中，可以通过右键菜单Vona Create/Dto创建 DTO 的代码骨架：
  

1. @Dto()
2. export class DtoOrderResult {}

复制代码

• 使用继承机制来封装 DTO：
  

1. + import { $Dto } from 'vona-module-a-orm';
3. @Dto()
4. export class DtoOrderResult
5. + extends $Dto.get(() => ModelOrder, { include: { products: true } }) {}

复制代码

• 现在，我们再使用DtoOrderResult重构前面的 API 代码：
  

1. class ControllerOrder {
2.   @Web.get('findAll')
3. + @Api.body(v.array(DtoOrderResult))
4. + async findAll(): Promise<DtoOrderResult[]> {
5.     return this.scope.model.order.select({
6.       include: {
7.         products: true,
8.       },
9.     });
10.   }
11. }

复制代码

• 行 3: 直接使用v.array(DtoOrderResult)标注类型
  
• 行 4: 方法返回类型为Promise
  

Vona ORM已开源：github.com/vonajs/vona

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

热心回复！