第十五章 Nest Pipe（内置及自定义）

NestJS的Pipe是一个用于数据转换和验证的特殊装饰器。Pipe可以应用于控制器（Controller）的处理方法（Handler）和中间件（Middleware），用于处理传入的数据。它可以用来转换和验证数据，确保数据的有效性和一致性。

内置的 Pipe 是指在使用 NestJS 框架时，已经预定义好的一些管道，用于验证和转换传入的数据。

  • ValidationPipe（验证管道）：用于验证传入的数据是否符合指定的规则，可以使用 class-validator 和 class-transformer 库来实现验证和转换。
  • ParseIntPipe（整数转换管道）：用于将传入的字符串转换为整数。
  • ParseBoolPipe（布尔值转换管道）：用于将传入的字符串转换为布尔值。
  • ParseArrayPipe（数组转换管道）：用于将传入的字符串转换为数组。
  • ParseUUIDPipe（UUID 转换管道）：用于将传入的字符串转换为 UUID。
  • DefaultValuePipe（默认值管道）：用于在传入的参数不存在时，给参数设置一个默认值。
  • ParseEnumPipe（枚举转换管道）：用于将传入的字符串转换为枚举类型。
  • ParseFloatPipe（浮点数转换管道）：用于将传入的字符串转换为浮点数。
  • ParseFilePipe（文件转换管道）：用于将传入的文件转换为上传的文件对象。

接下来我们测试一下内置 Pipe 的功能：
创建项目

nest new pipe -p npm

1719120039619.png
修改 app.controller.ts 可以看到这个接口默认接收test的字符串参数

import { Controller, Get, Query } from '@nestjs/common';
import { AppService } from './app.service';@Controller()
export class AppController {constructor(private readonly appService: AppService) { }@Get()getHello(@Query('test') test: string): string {return test;}
}

1、ParseIntPipe

我们可以使用ParseIntPipe 将接收的字符串参数转为整数：

import { Controller, Get, ParseIntPipe, Query } from '@nestjs/common';
import { AppService } from './app.service';@Controller()
export class AppController {constructor(private readonly appService: AppService) { }@Get()getHello(@Query('test', ParseIntPipe) test: string): string {return test+10;}
}

访问接口 http://localhost:3000/?test=100 可以看到参数test传入 100 变成了 110
1719120853656.png
且当我们传入的参数不能转为init时 则会报错 例如下面 访问 http://localhost:3000/?test=ww
1719120993724.png
这个返回的报错 我们也可以自定义 但是这种方式需要使用new XxxPipe 的方式 例如指定状态码为404

import { Controller, Get, HttpStatus, ParseIntPipe, Query } from '@nestjs/common';
import { AppService } from './app.service';@Controller()
export class AppController {constructor(private readonly appService: AppService) { }@Get()getHello(@Query('test', new ParseIntPipe({errorHttpStatusCode: HttpStatus.NOT_FOUND,})) test: string): string {return test + 10;}
}

1719121317498.png
同时也可以抛出异常再进行处理

import { Controller, Get, HttpException, HttpStatus, ParseIntPipe, Query } from '@nestjs/common';
import { AppService } from './app.service';@Controller()
export class AppController {constructor(private readonly appService: AppService) { }@Get()getHello(@Query('test', new ParseIntPipe({errorHttpStatusCode: HttpStatus.NOT_FOUND,exceptionFactory(error) {console.log(error);throw new HttpException('测试报错' + error, HttpStatus.NOT_IMPLEMENTED)},})) test: string): string {return test + 10;}
}

1719121515372.png

2、ParseFloatPipe

ParseFloatPipe 的作用是将参数转为float 类型
我们新建一个接口： test

import { Controller, Get, HttpException, HttpStatus, ParseFloatPipe, ParseIntPipe, Query } from '@nestjs/common';
import { AppService } from './app.service';@Controller()
export class AppController {constructor(private readonly appService: AppService) { }@Get()getHello(@Query('test', new ParseIntPipe({errorHttpStatusCode: HttpStatus.NOT_FOUND,exceptionFactory(error) {console.log(error);throw new HttpException('测试报错' + error, HttpStatus.NOT_IMPLEMENTED)},})) test: string): string {return test + 10;}@Get('test')getTest(@Query('test', ParseFloatPipe) test: number) {return test + 10;}
}

访问 http://localhost:3000/test?test=10.4
1719122081715.png
同样可以new ParseFloatPipe 的形式，传入 errorHttpStatusCode 和 exceptionFactory

3、ParseBoolPipe

用于将传入的字符串转换为布尔值。

@Get('boolean')getBoolean(@Query('test') test: boolean) {return test;}

访问 http://localhost:3000/boolean?test=false
1719122405754.png

4、ParseArrayPipe

用于将传入的字符串转换为数组。

@Get('array')getArray(@Query('test', ParseArrayPipe) test: number[]) {return test.reduce((pre, cur) => pre + cur, 0);}

保存代码可以发现报错了 提示需要class-validator 这个包
1719122693022.pngclass-class-class-validator 允许使用基于装饰器和非装饰器的验证。 内部使用 validator.js 来执行验证。

pnpm install class-validator

安装之后启动 发现还是报错 缺少 class-transformer
class-transformer 允许您将普通对象转换为类的某个实例，反之亦然。 此外，它还允许根据条件序列化/反序列化对象。 这个工具在前端和后端都非常有用。
1719123624634.png

pnpm install class-transformer

访问 http://localhost:3000/array?test=1,2,3,4
1719123834101.png
可以发现 每一项都提取出来了但是类型还是string 没有转换成number类型
此时需要 new XxxPipe 的方式传入参数：

@Get('array')getArray(@Query('test', new ParseArrayPipe({items: Number,})) test: number[]) {return test.reduce((pre, cur) => pre + cur, 0);}

再次访问 http://localhost:3000/array?test=1,2,3,4
1719123963798.png
同时还可以指定传入时的分割符： separator: ‘/’,

@Get('array')getArray(@Query('test', new ParseArrayPipe({items: Number,separator: '/',})) test: number[]) {return test.reduce((pre, cur) => pre + cur, 0);}

访问 http://localhost:3000/array?test=1/2/3/4
1719124196570.png
当我们没有传入参数的时候会报错：
image.png
我们可以通过设置 optional 来实现不传参数不报错

  @Get('array')getArray(@Query('test', new ParseArrayPipe({items: Number,separator: '/',optional: true,})) test: number[]) {return test}

1719124324325.png

5、ParseEnumPipe

用于将传入的字符串转换为枚举类型。

import { Controller, Get, HttpException, HttpStatus, ParseArrayPipe, ParseEnumPipe, ParseFloatPipe, ParseIntPipe, Query } from '@nestjs/common';
import { AppService } from './app.service';enum TestEnum {A = 'A111',B = 'B111',
}@Controller()
export class AppController {constructor(private readonly appService: AppService) { }@Get()getHello(@Query('test', new ParseIntPipe({errorHttpStatusCode: HttpStatus.NOT_FOUND,exceptionFactory(error) {console.log(error);throw new HttpException('测试报错' + error, HttpStatus.NOT_IMPLEMENTED)},})) test: string): string {return test + 10;}@Get('test')getTest(@Query('test', ParseFloatPipe) test: number) {return test + 10;}@Get('boolean')getBoolean(@Query('test') test: boolean) {return test;}@Get('array')getArray(@Query('test', new ParseArrayPipe({items: Number,separator: '/',optional: true,})) test: number[]) {return test}@Get('enum/:test')getEnum(@Query('test', new ParseEnumPipe(TestEnum)) test: TestEnum) {return test}
}

访问 http://localhost:3000/enum/111
1719126381961.png
当我们传的参数不是枚举定义的类型时会报错
访问 http://localhost:3000/enum/555
1719126484884.png

6、 ParseUUIDPipe

用于将传入的字符串转换为 UUID。在参数里，可以用 ParseUUIDPipe 来校验是否是 UUID
首先我们安装一下 uuid 用于生成uuid

pnpm install uuid

接着我们实现2个接口 getUuid getUuid2

import { Controller, Get, HttpException, HttpStatus, Param, ParseArrayPipe, ParseEnumPipe, ParseFloatPipe, ParseIntPipe, ParseUUIDPipe, Query } from '@nestjs/common';
import { AppService } from './app.service';const uuid = require('uuid');enum TestEnum {A = '111',B = '222',C = '333'
}@Controller()
export class AppController {constructor(private readonly appService: AppService) { }@Get()getHello(@Query('test', new ParseIntPipe({errorHttpStatusCode: HttpStatus.NOT_FOUND,exceptionFactory(error) {console.log(error);throw new HttpException('测试报错' + error, HttpStatus.NOT_IMPLEMENTED)},})) test: string): string {return test + 10;}@Get('test')getTest(@Query('test', ParseFloatPipe) test: number) {return test + 10;}@Get('boolean')getBoolean(@Query('test') test: boolean) {return test;}@Get('array')getArray(@Query('test', new ParseArrayPipe({items: Number,separator: '/',optional: true,})) test: number[]) {return test}@Get('enum/:test')getEnum(@Param('test', new ParseEnumPipe(TestEnum)) e: TestEnum) {return e}@Get('uuid')getUuid() {return uuid.v4()}@Get('uuid/:uuid')getUuid2(@Param('uuid', new ParseUUIDPipe) uuid: string) {return uuid}
}

访问 http://localhost:3000/uuid 获取uuid
1719127289811.png
接着访问 http://localhost:3000/uuid/0a5c5ce9-22ff-4091-85ef-523fcb64223c 可以看到正常访问
1719127352975.png
但是如果参数不是正常的uuid那么会报错
http://localhost:3000/uuid/xxx
1719127399773.png

7、DefaultValuePipe

用于在传入的参数不存在时，给参数设置一个默认值。
创建一个接口：

@Get('default')getDefault(@Query('test', new DefaultValuePipe('test')) test: string) {return test}

当我们没传参数的时候 会使用默认值test http://localhost:3000/default
1719127714732.png
当我们传参数之后将会返回参数 例如 http://localhost:3000/default?test=123456
1719127771860.png


8、自定义Pipe

首先创建一个 pipe:

nest g pipe www --flat --no-spec

www.pipe.ts:

import { ArgumentMetadata, Injectable, PipeTransform } from '@nestjs/common';@Injectable()
export class WwwPipe implements PipeTransform {transform(value: any, metadata: ArgumentMetadata) {console.log(value,metadata);return 'www';}
}

增加接口：

  @Get('www')getWww(@Query('test', WwwPipe) test: string, @Query('test2', WwwPipe) test2: string) {return test + test2}

浏览器访问 http://localhost:3000/www?test=1234&test2=1
1719128253615.png
这就是Pipe返回的值
1719128288386.png
控制台打印了 value 就是 query、param 的值，而 metadata 里包含 type、metatype、data
1719129484281.png
1719129507003.png
type 就是 @Query、@Param、@Body 装饰器，或者自定义装饰器
metatype 是参数的 ts 类型
data 参数值

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/web/41013.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

【Linux进阶】文件系统5——ext2文件系统（inode）

【Linux进阶】文件系统5——ext2文件系统（inode）

1.再谈inode (1) 理解inode，要从文件储存说起。 文件储存在硬盘上，硬盘的最小存储单位叫做"扇区"（Sector）。每个扇区储存512字节（相当于0.5KB）。操作系统读取硬盘的时候，不会一个个…
阅读更多...
记录excel表生成一列按七天一个周期的方法

记录excel表生成一列按七天一个周期的方法

使用excel生成每七天一个周期的列。如下图所示： 针对第一列的生成办法，使用如下函数： TEXT(DATE(2024,1,1)(ROW()-2)*7,"yyyy/m/d")&" - "&TEXT(DATE(2024,1,1)(ROW()-1)*7-1,"yyyy/m/d") 特此记录。…
阅读更多...
charles使用教程

charles使用教程

安装与配置 下载链接：https://www.charlesproxy.com/download/ 进行移动端抓包： 电脑端配置： 关闭防火墙 Proxy–>勾选 macOS Proxy Proxy–>Proxy Setting–>填入代理端口8888–>勾选Enable transparent http proxying 安装c…
阅读更多...
昇思25天学习打卡营第1天|初识MindSpore

昇思25天学习打卡营第1天|初识MindSpore

# 打卡 day1 目录 # 打卡 day1 初识MindSpore 昇思 MindSpore 是什么？ 昇思 MindSpore 优势|特点 昇思 MindSpore 不足 官方生态学习地址 初识MindSpore 昇思 MindSpore 是什么？ 昇思MindSpore 是全场景深度学习架构，为开发者提供了全…
阅读更多...
女生学计算机好不好？感觉计算机分有点高……?

女生学计算机好不好？感觉计算机分有点高……?

众所周知，在国内的高校里，计算机专业的女生是非常少的，很多小班30人左右，但是每个班女生人数只有个位数。这就给很多人一个感觉，是不是女生天生就不适合学这个东西呢？女生是不是也应该放弃呢？当…
阅读更多...
常见算法和Lambda

常见算法和Lambda

常见算法和Lambda 文章目录 常见算法和Lambda常见算法查找算法基本查找（顺序查找）二分查找/折半查找插值查找斐波那契查找分块查找扩展的分块查找（无规律的数据） 常见排序算法冒泡排序选择排序插入排序快速排序递归快速排序 Array…
阅读更多...
SpringBoot新手快速入门系列教程二：MySql5.7.44的免安装版本下载和配置，以及简单的Mysql生存指令指南。

SpringBoot新手快速入门系列教程二：MySql5.7.44的免安装版本下载和配置，以及简单的Mysql生存指令指南。

我们要如何选择MySql 目前主流的Mysql有5.0、8.0、9.0 主要区别 MySQL 5.0 发布年份：2005年特性： 基础事务支持存储过程、触发器、视图基础存储引擎（如MyISAM、InnoDB）外键支持基本的全文搜索性能和扩展性： 相对较…
阅读更多...
2024年江苏省研究生数学建模竞赛B题火箭烟幕弹运用策略优化论文和代码分析

2024年江苏省研究生数学建模竞赛B题火箭烟幕弹运用策略优化论文和代码分析

经过不懈的努力， 2024年江苏省研究生数学建模竞赛B题火箭烟幕弹运用策略优化论文和代码已完成，代码为B题全部问题的代码，论文包括摘要、问题重述、问题分析、模型假设、符号说明、模型的建立和求解（问题1模型的建立和求解、问题2模…
阅读更多...
[学习笔记]SQL学习笔记（连载中。。。）

[学习笔记]SQL学习笔记（连载中。。。）

学习视频：【数据库】SQL 3小时快速入门 #数据库教程 #SQL教程 #MySQL教程 #database#Python连接数据库 目录 1.SQL的基础知识1.1.表(table)和键(key)1.2.外键、联合主键 2.MySQL安装（略，请自行参考视频）3.基本的MySQL语法3.1.规…
阅读更多...
进程控制-fork函数

进程控制-fork函数

一个进程，包括代码、数据和分配给进程的资源。 fork （）函数通过系统调用创建一个与原来进程几乎完全相同的进程，也就是两个进程可以做完全相同的事，但如果初始参数或者传入的变量不同，两个进程也可以做不同…
阅读更多...
DatawhaleAI夏令营2024 Task2

DatawhaleAI夏令营2024 Task2

#AI夏令营 #Datawhale #夏令营 赛题解析一、Baseline详解1.1 环境配置1.2 数据处理任务理解2.3 prompt设计2.4 数据抽取 二、完整代码总结 赛题解析 赛事背景 在数字化时代，企业积累了大量对话数据，这些数据不仅是交流记录，还隐藏着宝贵的信…
阅读更多...
【鸿蒙学习笔记】@Link装饰器：父子双向同步

【鸿蒙学习笔记】@Link装饰器：父子双向同步

官方文档：Link装饰器：父子双向同步 目录标题 [Q&A] Link装饰器作用 [Q&A] Link装饰器特点样例：简单类型样例：数组类型样例：Map类型样例：Set类型样例：联合类型 [Q&A] Link装饰器作用…
阅读更多...
信号与系统-实验6-离散时间系统的 Z 域分析

信号与系统-实验6-离散时间系统的 Z 域分析

一、实验目的 1、掌握 z 变换及其性质；了解常用序列的 z 变换、逆 z 变换； 2、掌握利用 MATLAB 的符号运算实现 z 变换； 3、掌握利用 MATLAB 绘制离散系统零、极点图的方法； 4、掌握利用 MATLAB 分析离散系统零、极点的方法&a…
阅读更多...
MySQL基础篇（二）字符集以及校验规则

MySQL基础篇（二）字符集以及校验规则

在MySQL基础篇（一）中，我们知道了如何创建数据库，这篇文章带大家了解创建的一些细节。 红色框：可省略，作用如果存在相同的数据库名称，就不会再创建，反之，创建。 蓝色框&…
阅读更多...
uniapp 封装请求

uniapp 封装请求

新建request文件夹 下新建index.js 和index.js 或者创建units文件放入index.js 和api文件夹放入index.js(api.js)//看公司规范 1. index.js // 全局请求封装 // const base_url http://localhost:8080/devapi var base_url process.env.NODE_ENV development ? http://…
阅读更多...
可用于多个微信管理的神器

可用于多个微信管理的神器

以下仅是多微信聚合聊天管理界面： 可以在一个页面上同时收发多个微信的消息，可以添加好友，通过好友请求。 可以修改昵称，不受字数限制。 可以将常用图片，文件等放入素材库，方便聊天时查找和发送。 可以设置…
阅读更多...
搜索旋转数组

搜索旋转数组

题目链接 搜索旋转数组 题目描述 注意点 数组已被旋转过很多次数组元素原先是按升序排列的若有多个相同元素，返回索引值最小的一个 解答思路 首先需要知道的是，本题数组中的旋转多次只是将头部的某些元素移动到尾部，所以不论怎么旋转&am…
阅读更多...
Pycharm python解释器 unsupported python 3.1 解决

Pycharm python解释器 unsupported python 3.1 解决

Pycharm 环境 unsupported python 3.1解决 1. 问题重现2. 原因分析3. 解决方法 1. 问题重现 之前使用Pycharm 2024.1.1的时候，环境配置的Python 3.11.9，现在改成使用Pycharm 2020.2.2，结果Python解释器显示“unsupported python 3.1”&#…
阅读更多...
陈志泊主编《数据库原理及应用教程第4版微课版》的实验题目参考答案实验2

陈志泊主编《数据库原理及应用教程第4版微课版》的实验题目参考答案实验2

实验目的 1．掌握在SQL Server中使用对象资源管理器和SQL命令创建数据库与修改数据库的方法。 2．掌握在SQL Server中使用对象资源管理器或者SQL命令创建数据表和修改数据表的方 法（以SQL命令为重点）。 实验设备 操作系统:Win11…
阅读更多...
使用Source Insight 4.0

使用Source Insight 4.0

一、使用书签 二、添加文件 三、Search 3.1 替换所有变量 四、右键查询 4.1 查看被调用的地方
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023