Nestjs框架: 管道机制(Pipe)从校验到转换的全流程解析

Node框架之NestJS入门学习 文章主要分为三部分:1 NestJS 与Egg对比2 NestJS 基础知识介绍3 使用NestJS快速搭建应用,实现CURD操作e-link文档Egg官网NestJS 官网NestJS中文文档(非官方) 阅读详情

为什么需要管道(Pipe)

在 NestJS 的开发过程中,数据校验和数据类型转换是两个至关重要的环节。尤其是在用户注册、登录等场景中,前端传入的数据往往存在格式不统一、字段缺失、类型错误等问题。

管道(Pipe) 是 NestJS 提供的一个强大机制,它允许我们在控制器(Controller)处理请求之前,对输入参数进行校验、转换、过滤等预处理操作,从而提升代码的健壮性与可维护性。

NestJS 中的管道类型与应用场景


1 ) 控制器级别管道(Controller-level Pipe)

作用范围:整个控制器的所有请求参数
使用场景:适用于对某一类接口进行统一的参数校验或转换
示例:

@UsePipes(new ValidationPipe())
@Controller('users')
export class UsersController {}

2 ) 方法参数级别管道(Parameter-level Pipe)

作用范围:单个参数
使用场景:适用于需要对某个特定参数进行转换或验证
示例:

@Get(':id')
findOne(@Param('id', ParseIntPipe) id: number) {
  return this.userService.findOne(id);
}

3 ) 全局管道(Global Pipe)

作用范围:整个应用
使用场景:适用于对所有请求参数做统一处理(如全局数据校验)
示例:

const app = await NestFactory.create(AppModule);
app.useGlobalPipes(new ValidationPipe({ whitelist: true }));

内置管道详解与实战


1 ) 数据校验管道 —— ValidationPipe

核心依赖包:

  • class-validator:用于对类属性进行校验
  • class-transformer:用于将原始数据转换为类实例

使用流程:

步骤一:安装依赖

npm install class-validator class-transformer

步骤二:定义 DTO(Data Transfer Object)

import { IsNotEmpty, IsString, Length } from 'class-validator';
 
export class SignInUserDto {
  @IsNotEmpty({ message: '用户名不能为空' })
  @IsString({ message: '用户名必须为字符串' })
  @Length(6, 20, { message: '用户名长度必须在6~20之间' })
  username: string;
 
  @IsNotEmpty({ message: '密码不能为空' })
  @IsString({ message: '密码必须为字符串' })
  @Length(6, 32, { message: '密码长度必须在6~32之间' })
  password: string;
}

步骤三:在控制器中使用 DTO

@Post('sign-in')
async signIn(@Body() signInUserDto: SignInUserDto) {
  return signInUserDto;
}

步骤四:配置全局校验管道

// main.ts
import { ValidationPipe } from '@nestjs/common';
 
async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useGlobalPipes(
    new ValidationPipe({
      whitelist: true, // 自动剔除非 DTO 属性
      transform: true, // 自动将原始数据转换为 DTO 实例
    }),
  );
  await app.listen(3000);
}
bootstrap();

数据转换管道(Transformation Pipe)


1 ) 内置转换管道(Built-in Pipes)

管道名称功能说明
ParseIntPipe将字符串转换为整数
ParseFloatPipe将字符串转换为浮点数
ParseBoolPipe将字符串转换为布尔值
ParseUUIDPipe校验并转换为合法的 UUID 字符串
ParseEnumPipe将字符串转换为枚举值

示例:

@Get(':id')
findOne(@Param('id', new ParseIntPipe()) id: number) {
  return this.userService.findOne(id);
}

2 ) 自定义转换管道(Custom Pipe)

实现方式:实现 PipeTransform 接口

import { PipeTransform, Injectable, BadRequestException } from '@nestjs/common';
 
@Injectable()
export class ParseArrayPipe implements PipeTransform {
  transform(value: any) {
    if (!Array.isArray(value)) {
      throw new BadRequestException('必须是一个数组');
    }
    return value.map(item => parseInt(item, 10));
  }
}

使用方式:

@Get('numbers')
getNumbers(@Query('nums', new ParseArrayPipe()) nums: number[]) {
  return { nums };
}

高级用法与注意事项


1 ) 嵌套对象校验(Nested Object Validation)

class UserDto {
  @IsArray()
  @ValidateNested({ each: true })
  @Type(() => AddressDto)
  addresses: AddressDto[];
}
 
class AddressDto {
  @IsString()
  street: string;
}

2 ) 自定义校验规则(Custom Validation)

import { registerDecorator, ValidationArguments } from 'class-validator';
 
function IsEven(validationOptions?: ValidationOptions) {
  return function (object: Object, propertyName: string) {
    registerDecorator({
      name: 'isEven',
      target: object.constructor,
      propertyName: propertyName,
      options: validationOptions,
      validator: {
        validate(value: number) {
          return value % 2 === 0;
        },
        defaultMessage(args: ValidationArguments) {
          return `${args.property} must be an even number`;
        },
      },
    });
  };
}

使用方式:

class NumberDto {
  @IsEven({ message: '必须为偶数' })
  number: number;
}

3 ) 中文化校验提示(Custom Error Message)

@IsNotEmpty({ message: '用户名不能为空' })
@IsString({ message: '用户名必须为字符串' })
username: string;

管道与 DTO 的区别与联系

项目DTO(Data Transfer Object)Entity(实体)
定义目的接口请求数据结构定义数据库模型映射
是否可校验可以使用 class-validator 来校验❌ 一般不作校验
是否可转换可使用 class-transformer 转换❌ 通常直接与数据库交互
使用场景接口请求处理数据库操作、业务逻辑处理

管道的优势总结

  1. 统一校验逻辑:避免在业务层重复写校验逻辑
  2. 提升接口健壮性:提前拦截非法请求,提升系统稳定性
  3. 数据结构清晰:使用 DTO 明确接口的输入输出形式
  4. 支持嵌套校验:可对数组、对象等复杂结构进行深度校验
  5. 支持自定义规则:灵活扩展,满足各种业务需求
  6. 提高开发效率:减少重复代码,增强代码可维护性

建议与最佳实践

  1. 全局配置校验管道,确保所有接口都经过统一校验
  2. 使用 DTO 而非实体类进行校验,保证接口与数据库解耦
  3. 合理使用 whitelist 和 transform,增强接口安全性
  4. 优先使用内置管道,避免重复造轮子
  5. 对于复杂场景可定义自定义管道,保持逻辑清晰与复用

总结

NestJS 的管道机制是构建高质量后端服务的重要工具。通过 ValidationPipe + class-validator + class-transformer 的组合,我们可以实现对请求数据的自动校验、类型转换、字段过滤等功能,极大地提升了代码的安全性、可读性与可维护性。

掌握管道的使用,不仅能够帮助我们写出更优雅的接口代码,也是迈向高级 NestJS 开发者的关键一步

后续,我们可以进一步探索:

  • 结合拦截器统一响应格式,统一返回 JSON 结构,提升 API 一致性
  • 使用异常过滤器捕获校验错误,自定义错误提示格式,支持国际化
  • 深入理解 PipeTransform 接口,掌握管道的底层原理,提升自定义能力
    结合 Swagger 实现接口文档自动生成,与 DTO 配合使用,自动识别参数结构
    探索 Joi、Zod 等其他校验方案,与其他校验库对比,选择最适合当前项目的方案
NestJs 管道(Pipe) 以上就是 Nest 中管道类的使用方式,也是保证参数正常接收、正常入库的必要手段。你的支持和肯定,是我坚持写作的动力~ 阅读详情

相关推荐

Nest.js 微服务实战之搭建系统框架(基于 GraphQL 和 RPC)

最近找到一个VUE的文档,它将VUE的各个知识点进行了总结,整理成了《Vue 开发必须知道的36个技巧》。内容比较详实,对各个知识点的讲解也十分到位。有需要的小伙伴,可以点击下方卡片领取,无偿分享。

老司机的后备箱 1557

Nest框架

认识NestJS ◼ 用于构建高效且可伸缩的服务端应用程序的渐进式 Node.js 框架。以在TypeScript和JavaScript (ES6、ES7、ES8)之上构建高效、可伸缩的企业 级服务器端应用程序。它的核心思想是提供了一个层与层直接的耦合度极小、抽象化极高的一个架构体系。Nest.js目前在行业内具有很高 的关注度,所以我们有必要学习一下。 ◼ Nest.js基于TypeScript 编写并且结合了 OOP(面向对象编程),FP(函数式编程)和 FRP(函数式响应编程)的相关理念。在设计上的很

JINGMaNong的博客 2866

NestJS管道机制详解:数据转换与验证实践

在Web开发中,数据预处理是确保系统健壮性的关键环节。NestJS的管道(Pipe)机制通过中间件模式实现了请求参数的自动化处理,其核心原理是通过实现PipeTransform接口对输入数据进行类型转换和有效性验证。这种设计模式有效分离了数据清洗逻辑与业务代码,特别适用于RESTful API开发中的参数校验场景。技术价值上,管道既能通过内置的ParseIntPipe等工具快速处理基础类型转换,也能结合class-validator实现复杂的DTO验证规则。实际工程中常见于文件上传大小校验、数据库ID存在性

weixin_31364787的博客 264

Nodejs之Nest.js框架

Nest (NestJS) 是一个用于构建高效、可扩展的 Node.js 服务器端应用程序的开发框架。它利用 JavaScript 的渐进增强的能力,使用并完全支持 TypeScript (仍然允许开发者使用纯 JavaScript 进行开发),并结合了 OOP (面向对象编程)、FP (函数式编程)和 FRP (函数响应式编程)。

在所有的事情背后,要有一颗坚定的的本心,要有一颗应对变革和提升自我的本心,世界瞬息万变,本心要坚持到底,保持学习,时刻复盘 4186

NestJS管道参数校验实战与优化指南

数据校验是服务端开发中确保系统健壮性的关键技术,其核心原理是通过预定义的规则对输入数据进行过滤和验证。NestJS框架通过管道机制(Pipe)实现了校验逻辑与业务代码的解耦,这种设计模式不仅提升了代码可维护性,还能有效防止SQL注入等安全风险。在工程实践中,开发者可以组合使用基础类型转换管道(如ParseIntPipe)、DTO类校验(配合class-validator)以及自定义校验规则,覆盖从简单参数到复杂对象的校验场景。特别是在微服务架构和RESTful API开发中,合理的校验策略能显著降低接口异常

weixin_32325225的博客 278

NestJS 系列教程(七):管道(Pipes)详解与参数校验实战

Pipe 是一种可以在方法处理前对数据进行转换或验证的机制。在控制器方法调用前对来自请求的数据(如 query、param、body)进行操作若验证失败,可以抛出异常中断请求自定义 Pipe 要实现接口。功能PipeGuard处理顺序早于 Guard 执行Pipe 执行后最后执行(控制器执行前后)常见用途验证、转换参数鉴权、角色控制响应结构统一、日志、缓存可否修改响应值❌❌✅。

weixin_43852569的博客 514

【NestJS】 管道(Pipe)核心原理解析

NestJS 管道(Pipe)详解:本文全面介绍了 NestJS 中的 Pipe 机制,包括其基本概念(参数转换验证器)、不同级别管道的使用(参数级、方法级、控制器级和全局管道),以及自定义管道的实现方法。重点解析了管道执行顺序、内部工作原理和不同场景下的应用特点,如参数级管道精确控制单个参数,全局管道自动处理所有装饰器参数,以及请求级管道可访问请求上下文。文章还提供了自定义管道的代码示例和使用场景对比表,帮助开发者根据需求选择合适的管道实现方式。

qq_59344127的博客 942

Nest.js 实战 (四):利用 Pipe 管道实现数据验证和转换

这篇文章介绍了Nest.js框架中管道的概念和使用。管道是一种强大的功能,用于在请求数据到达控制器方法之前对其进行预处理,如转换、验证、清理等。文章详细解释了数据转换、数据验证、错误处理和一致性等管道的主要用途,并通过代码示例演示了如何使用内置管道和自定义管道。最后,文章总结了管道在提升应用健壮性和安全性方面的作用,认为合理利用管道可以加速开发周期,提高软件质量。

白雾茫茫丶 1426

nestjs[管道pipe的使用]

在src下,新增shared文件夹并新增validation.pipe.ts如下:// 导出ValidationPipe类并且接上PipeTransform接口为泛型指任何类型// 实现transform方法value指的是传入的值,即dto中对应的字段值,如:username的值if (!// 使用class-transformer的plainToClass 对 数据和类型进行转换// 使用validate进行验证,返回错误的数据列表。

墨水白云的博客 3228

ubuntu 18.04 + Kimera slam 安装与demo测试

环境:opencv 3.4.12,其他的都是按照文档下载的。 首先进行组件的安装 一、Kimera-VIO 安装参考文档:https://github.com/MIT-SPARK/Kimera-VIO/blob/master/docs/kimera_vio_install.md 按照文档装就好,在安装过程中碰到如下问题: 0、make 过程很卡,不要用所有的核 1、cmake过程中卡下载 ORBvoc.zip ,手动下载这个文件,解压,将里面的3个文件,放到/Kimera-VIO/vocabu.

dna葡萄糖的博客 3630

ONNC Open Neural Network Compiler 开源神经网络编译器 一个 开源、模块化、可重用编译器算法和工具链的库,专门针对深度学习加速器(DLA)部署导入ONNX模型

ONNC是一个集合了开源、模块化、可重用编译器算法和工具链的库,专门针对深度学习加速器(DLA)。ONNC从底层开始构建,旨在将ONNX中间表示(IR)翻译成专有DLA代码。其软件架构设计强调可移植性和可重用性,从而简化了开发新后端的工作。上图展示了ONNC软件栈的顶层框图。软件栈从导入ONNX计算图模型到输出相应的硬件二进制文件,展示了各个功能块。

万有文的博客 1998

NestJs-管道

NestJS 管道与验证机制解析 NestJS 的管道(Pipe)是一种强大的预处理机制,主要用于控制器方法执行前的数据验证和转换。管道通过实现 PipeTransform 接口,可以在请求到达控制器前对输入数据进行处理。 核心功能 数据验证:自动验证输入数据,不符合规则时直接抛出异常 数据转换:将输入数据转换为所需格式(如字符串转数字、普通对象转DTO实例) 内置管道 Nest 提供多个开箱即用的管道: ParseIntPipe:字符串转整数 ValidationPipe:结合 class-validat

人之功成皆凭己为,何来侥幸之说! 883

伪傻瓜式安装sql server2008【附带安装包】

安装各式各样的软件无疑是学习过程中…较…为烦躁的一部分 木有醋 但还是开始吧 为什么这是伪呢? 因为刚开始天真无邪的我真的是傻瓜式安装(迷之自信),结果就B了(打开配置管理器的瞬间….一片空白) BaiduCloud分享 红领巾在何方?? Link链接:https://pan.baidu.com/s/1NZCxP0Y27dBPrgHoRWLDyQ...

EuniBoom的博客 6万+

NestJS Pipe参数校验:从原理到工程实践

参数校验是后端开发中确保数据完整性的关键技术,其核心原理是通过预定义的规则对输入数据进行过滤和转换。在Node.js生态中,NestJS框架的Pipe机制将校验过程抽象为可复用的处理单元,采用装饰器模式实现声明式校验。这种设计显著提升了代码可维护性,特别是在处理手机号格式化、权限校验等高频场景时,能有效减少重复代码。结合class-validator等工具链,开发者可以快速构建类型安全的DTO校验层,同时通过ValidationPipe的白名单机制防范非法字段注入。在微服务架构下,这些技术还可扩展应用于消息

weixin_31236101的博客 270

obdumper和obloader迁移OceanBase业务库(一):实施手册

⭐️ 要求导出一致性数据时,建议在导出数据前,手动触发一次合并,在合并成功后再重新导出数据。:统计业务数据库下的所有业务对象清单(表/索引/分区/包/存储过程/同义词/序列/…:检查业务数据库下的所有业务对象清单(表/索引/分区/包/存储过程/同义词/序列/…:统计单个模式下所有业务对象清单(表/索引/分区/包/存储过程/同义词/序列/…如果单张表的数据量太大,会导出为多个文件,文件命名会加上数字后缀。该过程会导出所有表的定义、以及定义在表上的索引定义。如果有多种数据库对象,会导出到不同的子路径下。

Sebastien23的博客 1032

C# MES通信从入门到精通(10)——C#使用HTTP的Post和Get方法和Mes系统通信

本文详细介绍了如何利用C#完成与HTTP协议的MES系统进行通信,通过POST和GET方法实现与MES系统的交互,由高级工程师的实战经验总结,实属C#与MES通信领域的葵花宝典!

qq_34059233的博客 3421

NestJS 入门(5):Pipe 与 DTO 校验

本文深入解析 NestJS 中 Pipe(管道)与 DTO(数据传输对象)的核心作用,解决“TypeScript 类型标注能否保证运行时参数合法性”的常见误解。通过对比有无 Pipe 的差异,详细讲解 DTO 定义、ValidationPipe 配置、校验错误处理,以及 Param/Query 参数转换。文章强调 Pipe 在请求链路中的位置(Guard 之后、Controller 之前),提供最小可跑示例和常见坑点,帮助开发者建立“格式/必填走 DTO,复杂业务规则仍在 Service”的最佳实践。

weixin_43160044的博客 351

dToF直方图之美_deadtime死区时间

IMX459的死区时间可以在6ns,这个时间是什么级别,车载激光雷达激光器的光脉宽一般都在4ns以上,也就是这个时间贴近去SPAD的死区时间,这就导致了pile up会非常弱,不会有太多数量的光子计数堆积,加上某些SPAD设计,对TDC有一些更深入的考量,所以不需要去校正pile up算法。Sensor层面决定了pile up的复杂程度,如果一个dToF的SPAD一致性非常好,那么pile up校正可以简单到极致,也就是一句代码的事,比如IMX611,优秀到不需要后端去考虑校正pile up。

致力于lidar应用开发 2152

nestjs 全栈进阶--管道

在Nest.js框架中,Pipe 是一种用于处理HTTP请求参数的装饰器和类,它是Nest应用中实现输入验证、数据转换和格式化的重要组件之一。当请求到达控制器(Controller)中的某个路由处理器方法时,可以在方法参数上使用@Body()、@Query()、@Param()等装饰器来指定期望获取的请求体、查询参数或路径参数。然后,通过在这些装饰器之上应用自定义的管道(Pipe),可以对这些参数进行预处理。

wangyuiba1314的博客 1151

DDR5中的On-Die Termination(ODT)详解:电阻值支持及其背后的秘密

DDR5支持多档ODT电阻值,范围从40Ω到480Ω,均基于240Ω标准参考电阻RZQR_{ZQ}RZQ​。不同电阻档位对应不同的信号负载和功耗需求。校准电压点关键,常用0.8×VDD进行精准调校。CA信号间ODT匹配必须严格控制,保证命令总线稳定。选择合适的ODT值是高速内存设计中不可忽视的细节。

weixin_43199439的博客 2103

华为OD机考双机位C卷 - 斗地主之顺子 (Java & Python& JS & C/C++ & GO )

华为OD机考双机位C卷 - 斗地主之顺子(OD上机考试双机位C卷)。提供在线OJ刷题。Java、C++、Python、GO语言、C语言、JavaScript题解,并提供完整思路讲解。

算法大师! 9695

NestJS管道机制:数据验证与转换的核心技术

在Node.js后端开发中,数据验证与转换是保障系统健壮性的关键技术。NestJS框架通过管道(Pipe)机制实现了声明式的参数处理,其核心原理是通过实现PipeTransform接口的拦截器类,在方法调用前对输入数据进行预处理。这种设计模式不仅提升了代码复用性,还能有效隔离验证逻辑与业务代码。典型应用场景包括请求参数校验(如集成class-validator进行类型检查)、数据格式标准化(如分页参数转换)以及数据库存在性验证等。通过全局管道注册和元数据驱动,开发者可以构建统一的验证层,配合异常过滤器实现规

weixin_30582943的博客 352

VB摄像头监控

该VB模块可对摄像头捕获的画面进行录像等,可在创建的窗口进行控制

nestjs之pipe是如何从dto校验的?

NestJS允许你自定义的行为,例如自定义错误响应或启用更复杂的验证规则。你可以通过传递选项到的构造函数来实现这些自定义行为。通过这种方式,NestJS中的Pipes提供了一种强大且灵活的方法来确保控制器接收到有效且正确类型的数据。

qq_35094120的博客 704

pscad IEEE标准系统搭建说明

pscad IEEE标准系统搭建说明,包含典型的IEEE 9节点、14节点、30节点、39节点和118节点系统。内含标准测试系统的原始数据和潮流结果。

IEM模型,地表粗糙度模拟

利用微波反演土壤水分时候,利用IEM模型可以实现对随机地表的模拟

NestJS管道:数据验证与转换的实战指南

在Node.js后端开发中,数据验证与转换是保障应用健壮性的关键技术。NestJS框架通过管道(Pipe)设计模式,提供了一种声明式的数据处理方案。管道本质上是一种中间件,能够在请求到达控制器前对输入数据进行预处理,包括类型转换、格式校验等操作。其核心原理基于装饰器模式和依赖注入,通过实现PipeTransform接口来定义处理逻辑。这种机制在REST API开发中尤为重要,能有效防止非法数据进入业务逻辑层。典型应用场景包括路由参数验证、文件上传校验以及DTO对象转换等。以ValidationPipe为例,

weixin_32175665的博客 323

nestjs[一例看懂中间件、守卫、管道、异常过滤器、拦截器]

看懂nestjs中间件、守卫、管道、异常过滤器、拦截器

墨水白云的博客 1万+

NestJS 7.x 折腾记: (5) 管道,一个好玩的东西!比如入参校验!

前言 管道这个词,若是有玩过Linux的小伙伴肯定知晓,比如(看图):意思就git的提交记录以单行显示的前三条,而且提交概要中有build这个词的~ 在nest里面的管道,主要是用来做入参数据类型的拦截转换;跟ng提供的概念差不多,大同小异~~ 效果图 实战 其实官方教程写的挺好了,局部管道和全局管道都写到了,这里我们以更具通用性的入参全局管道做例子,尽量写的更贴近业务和更为粗俗的解释吧~ 安装 # class-validator: 提供非常丰富的类型装饰器 # class-transformer: 可以

CRPER 1261
上一篇: Nestjs框架: 用户登录注册模块开发流程解析
下一篇: Nestjs框架: 使用 JWT 实现 NestJS 鉴权模块的开发与集成
Wang's Blog
博客等级 码龄12年 7440粉丝 2427原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Wang's Blog

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值