如何灵活创建 DTO

Pdto 是 data transfer object，用于封装请求参数，后端应用常见对象。

当开发 CRUD 接口的时候，你会发现 create 的 dto 对象和 update 的 dto 对象很类似。

那能不能不从头创建，而是基于已有的对象来创建呢？

可以的。

我们来试一下：

nest new dto-vo-test

创建个 nest 项目。

进入项目，创建 aaa 的 crud 模块：

nest g resource aaa

可以看到，它自动创建了 CreateAaaDto、UpdateAaaDto 用来封装 create、update 的参数：

改下 aaa.entity.ts

export class Aaa {

    id: number;

    name: string;

    age: number;

    sex: boolean;
    
    email: string;

    hoobies: string[]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

Entity 有 id、name、age、sex、email、hobbies 这些字段。

那 CreateAaaDto 里要有 name、age、sex、email、hobbies 这些字段

而 UpdateAaaDto 里也是 name、age、sex、email、hobbies 这些字段。

export class CreateAaaDto {
    name: string;

    age: number;

    sex: boolean;

    email: string;

    hoobies: string[]
}

1
2
3
4
5
6
7
8
9
10
11

export class UpdateAaaDto  {

    name: string;

    age: number;

    sex: boolean;

    email: string;

    hoobies: string[]
}

1
2
3
4
5
6
7
8
9
10
11
12

而且我们还要用 ValidationPipe 加上参数校验。

安装用到的包：

npm install --save class-validator class-transformer

然后在 CreateAaaDto 和 UpdateAaaDto 加一下验证：

import { IsBoolean, IsEmail, IsNotEmpty, IsNumber, Length, MaxLength, MinLength } from "class-validator";

export class CreateAaaDto {
    @IsNotEmpty()
    @MinLength(4)
    @MaxLength(20)
    name: string;

    @IsNotEmpty()
    @IsNumber()
    age: number;

    @IsNotEmpty()
    @IsBoolean()
    sex: boolean;

    @IsNotEmpty()
    @IsEmail()
    email: string;

    hoobies: string[]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

import { IsBoolean, IsEmail, IsNotEmpty, IsNumber, Length, MaxLength, MinLength } from "class-validator";

export class UpdateAaaDto {
    @IsNotEmpty()
    @MinLength(4)
    @MaxLength(20)
    name: string;

    @IsNotEmpty()
    @IsNumber()
    age: number;

    @IsNotEmpty()
    @IsBoolean()
    sex: boolean;

    @IsNotEmpty()
    @IsEmail()
    email: string;

    hoobies: string[]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

然后全局启用 ValidationPipe：

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { ValidationPipe } from '@nestjs/common';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  app.useGlobalPipes(new ValidationPipe({
    transform: true
  }))

  await app.listen(3000);
}
bootstrap();

1
2
3
4
5
6
7
8
9
10
11
12
13
14

transform 指定为 true，这样会自动把参数的 js 对象转换为 dto 类型对象。

打印下 dto 对象：

测试下：

npm run start:dev

create 接口，当参数没通过校验时：

参数通过校验后：

可以看到，打印的是 CreateAaaDto 的对象，说明 ValidationPipe 的 transform 生效了：

再试下 update 接口：

也没问题。

虽然没问题，但是现在 CreateAaaDto 和 UpdateAaaDto 明显重复太多了。

很多字段重复写了两次。

有什么办法能避免这种重复呢？

很简单呀，继承不就行了？

import { CreateAaaDto } from "./create-aaa.dto";

export class UpdateAaaDto extends CreateAaaDto {
}

1
2
3
4

试一下：

没啥问题。

当然，现在所有字段都是必填的，比如 name、age、email 等。

其实更新的时候可以只更新 name 或者 email。

这时候直接继承就不行了。

可以用 PartialType 处理下：

import { PartialType } from '@nestjs/mapped-types';
import { CreateAaaDto } from "./create-aaa.dto";

export class UpdateAaaDto extends PartialType(CreateAaaDto) {

}

1
2
3
4
5
6

试下：

现在只填部分字段依然校验通过了。

好神奇，我们不是指定了 @IsNotEmpty 了么？

咋继承过来就没了呢？

这是因为 PartialType 内部做了处理。

简单看下源码：

它创建了一个新的 class 返回，继承了传入的 class 的属性，和 validation metadata。

但是添加一个一个 @IsOptional 的装饰器。

这样可不就变为可选的了么？

类似的这样的方法还有几个：

比如 PickType：

import { PartialType, PickType } from '@nestjs/mapped-types';
import { CreateAaaDto } from "./create-aaa.dto";

export class UpdateAaaDto extends PickType(CreateAaaDto, ['age', 'email']) {

}

1
2
3
4
5
6
7

现在可以只传 age、email 这两个字段：

但它和 PartialType 不同，Pick 出来的字段并不会变为可选：

或者也可以用 OmitType，从之前的 dto 删除几个字段：

import { OmitType, PartialType, PickType } from '@nestjs/mapped-types';
import { CreateAaaDto } from "./create-aaa.dto";

export class UpdateAaaDto extends OmitType(CreateAaaDto, ['name', 'hoobies', 'sex']) {

}

1
2
3
4
5
6

效果一样。

PickType 是从中挑选几个，OmitType 是从中去掉几个取剩下的。

此外，如果你有两个 dto 想合并，可以用 IntersectionType。

创建个 xxx.dto.ts

import { IsNotEmpty, IsNumber, MinLength } from "class-validator";

export class XxxDto {
    @IsNotEmpty()
    @MinLength(4)
    xxx: string;

    @IsNotEmpty()
    @IsNumber()
    yyy: number;
}

1
2
3
4
5
6
7
8
9
10
11
12

用 CreateAaaDto 和 XxxDto 来创建 UpdateAaaDto：

import { IntersectionType } from '@nestjs/mapped-types';
import { CreateAaaDto } from "./create-aaa.dto";
import { XxxDto } from './xxx.dto';

export class UpdateAaaDto extends IntersectionType(CreateAaaDto, XxxDto) {

}

1
2
3
4
5
6
7

可以看到，现在会提示你这些字段都是必填的：

这些字段都填上之后，校验就通过了：

服务端接收到了 dto 的数据。

当然，PartialType、PickType、OmitType、IntersectionType 经常会组合用：

import { IntersectionType, OmitType, PartialType, PickType } from '@nestjs/mapped-types';
import { CreateAaaDto } from "./create-aaa.dto";
import { XxxDto } from './xxx.dto';

export class UpdateAaaDto extends IntersectionType(
    PickType(CreateAaaDto, ['name', 'age']), 
    PartialType(OmitType(XxxDto, ['yyy']))
) {

}