NestJS学习笔记之管道验证DTO

1.先创建一个pipe验证管道

nest g pi 文件名字

如利用p模块创建，创建好是一个p.pipe.ts

2.安装验证器

npm i --save class-validator class-transformer

import {IsNotEmpty,IsString} from 'class-validator'
export class CreatePDto {
    @IsNotEmpty()//验证是否为空
    @IsString() //是否为字符串
    name:string;
 
    @IsNotEmpty()
    age:number
}

3.controller使用管道和定义类型

4.实现验证transform

value就是前端传过来的数据，metaData就是元数据，通过metatype可以去实例化这个类

import { ArgumentMetadata, Injectable, PipeTransform } from '@nestjs/common';

@Injectable()
export class PPipe implements PipeTransform {
  transform(value: any, metadata: ArgumentMetadata) {
    console.log(value,metadata);
    return value;
  }
}

访问接口http://localhost:3000/p

控制台打印出value和metadata

实例化DTO

import { ArgumentMetadata, Injectable, PipeTransform } from '@nestjs/common';
import { plainToInstance } from 'class-transformer';

@Injectable()
export class PPipe implements PipeTransform {
  transform(value: any, metadata: ArgumentMetadata) {
    const dto = plainToInstance(metadata.metatype, value)
    console.log(dto);
    return value;
  }
}

再次访问接口http://localhost:3000/p，打印出dto

通过 validate验证DTO返回一个promise的错误信息，如果有错误抛出

import { ArgumentMetadata, HttpException, HttpStatus, Injectable, PipeTransform } from '@nestjs/common';
import { plainToInstance } from 'class-transformer';
import { validate } from 'class-validator';

@Injectable()
export class PPipe implements PipeTransform {
  async transform(value: any, metadata: ArgumentMetadata) {
    const dto = plainToInstance(metadata.metatype, value)
    const error=await validate(dto)
    console.log(error);
    if(error.length>0){
      throw new HttpException(error,HttpStatus.BAD_REQUEST)
    }
    return value;
  }
}

访问接口http://localhost:3000/p，可以看到，当name为空字符串时，接口访问失败，返回了错误信息

控制台打印出error，说明了name属性不能为空

5.注册全局DTO验证管道

前1，2，3，4小节是自己实现的dto管道验证，其实nestjs已经帮我们内置了全局的dto验证管道，只需要自己引入使用即可

main.ts

import { ValidationPipe, VersioningType } from '@nestjs/common'; //引入ValidationPipe

 app.useGlobalPipes(new ValidationPipe()) //使用ValidationPipe

create-p.dto中还是定义我们需要验证哪些属性即可