Nestjs AOP 编程之 Pipe 的使用前三篇系列文章： # Nestjs AOP 编程之中间件的使用 # Nes

前三篇系列文章：

本文主要介绍 Pipe 的使用。

概念

Pipe 是管道的意思，在 Nestjs 中它可以在处理请求之前对数据进行预处理，从而简化控制器和业务逻辑层的代码。所以如果有需要对数据处理的任务，你应该优先用管道，它主要有两种数据处理场景：

转换数据：将输入数据转换为需要的数据
校验数据：校验成功则继续传递，否则就抛出异常

借助官方图片理解：

管道会先解析请求中的参数，再将数据传递给相应的路由控制器方法。

创建

在 Nestjs 项目中创建一个 Pipe：

nest g pipe parse --no-spec --flat

会在 src 目录下生成一个 parse.pipe.ts 文件，文件内容：

// parse.pipe.ts

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

@Injectable()
export class ParsePipe implements PipeTransform {
  transform(value: any, metadata: ArgumentMetadata) {
    return value;
  }
}

自定义管道需要实现 PipeTransform 接口，接口中有一个方法 transform，方法中有两个参数，参数 value 就是传入的要处理的数据，而 metadata 是来源数据的元信息。

现在给这个管道加上处理逻辑，我们希望它可以将传入数据转换成整数，如果不能转换就抛出异常，完整代码：

// parse.pipe.ts

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

@Injectable()
export class ParsePipe implements PipeTransform {
  transform(value: any, metadata: ArgumentMetadata) {
    // 标记执行到达
    console.log('执行 ParsePipe');
    // 尝试转换成整数
    const val = parseInt(value, 10);
    // 不能转换为整数则抛出异常
    if (isNaN(val)) {
      throw new BadRequestException('ParseInt failed');
    }
    // 将转换好的数据传出去
    return val;
  }
}

代码逻辑很好理解，关键是要将转换好的数据传递传递出去。接下来介绍怎么使用 Pipe。

使用

用在路由处理器方法上

管道通常是使用在某个路由处理器方法上的，以处理这个路由传入的参数，比如需要转换用户 id，就可以这样用：

当请求 /user/1 这个路径时，就会拿到值为 1 的 id，转换结果：

可以看到 ParsePipe 成功转换了数据。也可以直接将管道类直接传入到 @Param 的第二个参数来使用：

这样写也能生效，同理也支持 @Query、@Body、@Header等内置的装饰器。

需要注意你接收到的参数类型，如果用 @Body 接收参数，得到的会是一个对象，直接用 ParsePipe 转换肯定永远无法成功的，此时可以只对某个字段进行转换。例如有一个 post 请求，会传入这样的一个 json 数据：

如果直接验证整个传入的数据：

因为对象无法转换为数字，所以报错：

此时我们可以只转换某一个字段，例如要将 code 字段转换为整数，可以这样写：

当然也可以这样：

得到结果：

这个主要涉及 Nestjs 中装饰器的基础用法，注意下结合管道怎么使用就行。

用在 Controller 上

管道可以应用到 Controller 上，这样它下面所有的路由方法的参数都会被管道接收到，去掉所有单个路由方法的管道，写到 Controller 上：

此时这个 Controller 下的两个路由方法都应用到了 ParsePipe，结果：

全局使用

跟之前介绍的 Guard 和 Interceptor 一样，管道也有两种全局使用方法，第一种是在 main.ts 中注册实例：

第二种就是在 AppModule 中声明：

关于这两种方式的区别，请参考 # Nestjs AOP 编程之 Guard 的使用中的全局使用方式。

多个管道的使用

多个管道会按照传入的顺序依次执行，且数据可以被传递。在添加一个管道 AddPipe：

nest g pipe add --no-spec --flat

这个管道的作用就是对传入的数据进行 +1 操作，可以这样写：

// add.pipe.ts

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

@Injectable()
export class AddPipe implements PipeTransform {
  transform(value: any, metadata: ArgumentMetadata) {
    let newVal = value;
    // 如果是数字且不是 NaN，则加 1；否则抛出异常
    if (typeof value === 'number' && !isNaN(value)) {
      newVal++;
    } else {
      throw new BadRequestException('Add failed');
    }
    return newVal;
  }
}