nestJs 管道

文档：https://docs.nestjs.cn/9/pipes

管道是什么

管道是具有 @Injectable() 装饰器的类。管道应实现 PipeTransform 接口。

管道的作用

管道有两个典型的应用场景:

• 转换：管道将输入数据转换为所需的数据输出(例如，将字符串转换为整数)
• 验证：对输入数据进行验证，如果验证成功继续传递; 验证失败则抛出异常

内置管道

Nest 自带九个开箱即用的管道，即

• ValidationPipe
• ParseIntPipe
• ParseFloatPipe
• ParseBoolPipe
• ParseArrayPipe
• ParseUUIDPipe
• ParseEnumPipe
• DefaultValuePipe
• ParseFilePipe

他们从 @nestjs/common 包中导出

内置管道案例

创建 P 模块

nest g resource p

案例1: string 转 number

我们接受的路由参数希望是一个number 类型 现在是string

这时候可以用 ParseIntPipe内置管道

例：

@Get(':id')
findOne(@Param('id', ParseIntPipe) id: number) {
    console.log('id type===========>: ', typeof id);
    return this.pService.findOne(+id);
}

案例2：验证UUId

安装uuid

npm install uuid -S
npm install @types/uuid -D

关键代码

// uuid 用于后面正确的验证
import * as uuid from 'uuid';
console.log(uuid.v4());

// 验证uuid
@Get(':id')
findOne(@Param('id', ParseUUIDPipe) id: string) {
	return this.pService.findOne(+id);
}

完整代码

import { Controller, Get, Post, Body, Patch, Param, Delete, ParseUUIDPipe } from '@nestjs/common';
import { PService } from './p.service';
import { CreatePDto } from './dto/create-p.dto';
import { UpdatePDto } from './dto/update-p.dto';

// uuid 用于后面正确的验证
import * as uuid from 'uuid';
console.log(uuid.v4());

@Controller('p')
export class PController {
  constructor(private readonly pService: PService) {}

  @Post()
  create(@Body() createPDto: CreatePDto) {
    return this.pService.create(createPDto);
  }

  @Get()
  findAll() {
    return this.pService.findAll();
  }

  // 验证uuid
  @Get(':id')
  findOne(@Param('id', ParseUUIDPipe) id: string) {
    return this.pService.findOne(+id);
  }

  @Patch(':id')
  update(@Param('id') id: string, @Body() updatePDto: UpdatePDto) {
    return this.pService.update(+id, updatePDto);
  }

  @Delete(':id')
  remove(@Param('id') id: string) {
    return this.pService.remove(+id);
  }
}

测试

uuid 格式错误

效果如图

uuid 格式正确

上面代码里面我们生成了一个uuid

7f145099-e9c7-47d9-99fb-a0a3f9a39bd7

正确的就通过了

管道验证DTO

其实也叫类验证器，文档：

https://docs.nestjs.cn/9/pipes?id=类验证器

官方内置的功能太少了，这时候可以使用类验证器的方式使用第三方的

安装

npm i --save class-validator class-transformer

文档

https://github.com/typestack/class-validator

验证修饰器

通用验证装饰器

类型验证装饰器

数字验证装饰器

日期验证装饰器

字符串类型验证装饰器

字符串验证装饰器

数组验证装饰器

对象验证装饰器

其他验证装饰器

管道验证DTO 案例

创建一个管道

nest g pi 文件名字

例：

nest g pi p

创建DTO 验证类

例：

import {IsNotEmpty,IsString} from 'class-validator'

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

在controller 使用管道 和 定义类型

关键代码

// 类验证器
@Post()
create(@Body(PPipe) createPDto: CreatePDto) {
	return this.pService.create(createPDto);
}

完整代码

import { Controller, Get, Post, Body, Patch, Param, Delete, ParseUUIDPipe } from '@nestjs/common';
import { PService } from './p.service';
import { CreatePDto } from './dto/create-p.dto';
import { UpdatePDto } from './dto/update-p.dto';
import { PPipe } from './p/p.pipe'

// uuid 用于后面正确的验证
import * as uuid from 'uuid';
console.log(uuid.v4());

@Controller('p')
export class PController {
  constructor(private readonly pService: PService) {}

  // 类验证器
  @Post()
  create(@Body(PPipe) createPDto: CreatePDto) {
    return this.pService.create(createPDto);
  }

  @Get()
  findAll() {
    return this.pService.findAll();
  }

  // 验证uuid
  @Get(':id')
  findOne(@Param('id', ParseUUIDPipe) id: string) {
    return this.pService.findOne(+id);
  }

  @Patch(':id')
  update(@Param('id') id: string, @Body() updatePDto: UpdatePDto) {
    return this.pService.update(+id, updatePDto);
  }

  @Delete(':id')
  remove(@Param('id') id: string) {
    return this.pService.remove(+id);
  }
}

实现验证transform

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) {
    // value 就是 前端传过来的数据
    // metaData 就是元数据 通过 metatype 可以去实例化这个类
    console.log(value, metadata);
    // 实例化DTO
    const DTO = plainToInstance(metadata.metatype, value);
    // 通过 validate 验证 DTO 返回一个promise 的错误信息
    const errors = await validate(DTO);
    // 如果有错误抛出
    if(errors.length > 0){
      throw new HttpException(errors, HttpStatus.BAD_REQUEST);
    }
    return value;
  }
}

测试

格式错误

格式正确

注册全局的DTO验证管道

https://docs.nestjs.cn/9/pipes?id=全局管道

上面那个案例是我们根据官方文档写的，其实官方已经提供了一个写好的

只不过我们使用自己的可以自定义，你也可以全局注册自己的验证管道

注册

全局的一般在main.ts中注册

例：

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());
  await app.listen(3000);
}
bootstrap();

使用

上面那个例子，我们使用的是自定义的，这次使用全局的

全局是默认的，所以不用特意写

测试

格式错误

格式正确

本栏目推荐文章
• Linux多命令顺序执行与管道符
• C# 使用命名管道本地转移数据
• 使用nestjs和react快速搭建项目架子
• scrapy使用文件管道FilesPipeline下载视频
• 爬虫中scrapy管道的使用
• Kernel Memory 入门系列：异步管道
• linux 中 paste、cat 结合管道符合并方向调整
• vscode的ssh连接报错过程试图写入的管道不存在
• windows2019 iis配置（应用程序池.net v4.5 classic 托管管道模式要设为“集成”）
• Python MongoDB 聚合管道操作符及使用

管道 nestJs管道nestjs nestjs 模块nestjs nestjs day2 day nestjs day3 day nestfactory核心nestjs 提供者nestjs 中间件nestjs websocket nestjs http nestjs day4 day