[NestJs]管道验证、字段验证

本文介绍了如何在NestJS项目中使用管道pipes进行数据验证和转换,包括自定义Pipe实现和利用NestJS内置的ValidationPipe。详细讲解了关键类如PipeTransform、class-validator和class-transformer的用法。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

管道pipes是什么

管道(pipes)是一种有效的方式来处理输入数据的验证和转换

方式一

需要使用到两个库

npm install class-validator class-transformer -S -D

在项目中新建pipe文件,如login.pipe.ts

import {
  ArgumentMetadata,
  HttpException,
  HttpStatus,
  Injectable,
  PipeTransform,
} from '@nestjs/common';
import { plainToInstance } from 'class-transformer';
import { validate } from 'class-validator';
@Injectable()
export class LoginPipe implements PipeTransform {
  async transform(value: any, metadata: ArgumentMetadata) {
    const DTO = metadata.metatype;
    const instance = plainToInstance(DTO, value);
    const error = await validate(instance);
    if (error.length) {
      throw new HttpException(error, HttpStatus.BAD_REQUEST);
    }
    return value;
  }
}

  1. ArgumentMetadata:用于在管道中访问关于转换过程的元数据。
  2. HttpException:NestJS 中的异常类,用于在管道中抛出 HTTP 异常。
  3. HttpStatus:定义了 HTTP 状态码的枚举。
  4. Injectable:用于标记类作为 NestJS 中的可注入服务。
  5. PipeTransform:定义了管道类需要实现的接口。
  6. plainToInstance:来自 class-transformer 库,用于将普通对象转换为类实例。
  7. validate:来自 class-validator 库,用于验证类实例的数据。

然后定义一个管道类LoginPipe并实现PipeTransform接口
在这里插入图片描述
我们需要在类中实现transform方法,这个方法主要作用只对值进行转换,value为通过结果传入的数据,metadata为我们创建的DTO的元数据
接下来使用plainToInstance实例化并接受返回的实例,使用 class-validator 进行验证,返回验证错误的数组,如果数据长度不为空的话则验证失败,返回的结构如下
在这里插入图片描述
使用throw new HttpException抛出 HTTP 异常,其中包含验证错误信息,这里抛出的异常可以使用之前的文章里写过的错误拦截器去拦截然后返回给用户

dto文件如下
在这里插入图片描述

注册管道验证

在这里插入图片描述
直接在需要验证的接口中传入即可

方式二使用NestJs自带的ValidationPipe验证

import { ValidationPipe } from '@nestjs/common';

在这里插入图片描述
第二种方法写起来比较简单,推荐使用第二种方法,验证不通过返回的错误同样可以使用错误拦截器去拦截

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值