理解 Nest.js 中的 Pipe

理解 Nest.js 中的 Pipe

在 Nest.js 中，Pipe 可以帮助我们对输入的数据进行处理和转换，比如验证数据、类型转换等等。Nest.js 提供了一些内置的 Pipe，同时也支持开发者编写自定义的 Pipe。

内置 Pipe

在 Nest.js 中，内置的 Pipe 包括以下几种：

• ValidationPipe：用于数据验证，可以通过使用 class-validator 和 class-transformer 库来实现验证和转换操作。
• ParseIntPipe：用于将传入的字符串转换为整数。
• ParseBoolPipe：用于将传入的字符串转换为布尔值。
• DefaultValuePipe：用于设置默认值。
• BodyParserPipe：用于解析请求体。

下面是一个示例，展示如何在 Nest.js 中使用内置 Pipe：

import { Controller, Get, Param, ParseIntPipe } from '@nestjs/common';

@Controller('cats')
export class CatsController {
  @Get(':id')
  findOne(@Param('id', ParseIntPipe) id: number): string {
    return `This action returns a cat with id ${id}`;
  }
}

在上述示例中，我们定义了一个 CatsController 类，并在类上使用了 @Controller('cats') 装饰器来指定控制器路径。我们还定义了一个 findOne() 方法，该方法接受一个 id 参数，并使用 ParseIntPipe 进行类型转换。

当使用 findOne() 方法时，将传入的字符串参数被转换为了数字类型，并且在 findOne() 方法中可以直接使用该数值。

自定义 Pipe

除了内置的 Pipe 外，Nest.js 还支持开发者编写自定义的 Pipe。自定义 Pipe 可以根据开发者的需求，对数据进行更加细致和灵活的处理。

下面是一个示例，展示如何在 Nest.js 中编写自定义 Pipe：

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

@Injectable()
export class CustomPipe implements PipeTransform {
  transform(value: any, metadata: ArgumentMetadata) {
    console.log(`value before transformation: ${JSON.stringify(value)}`);
    value.transformed = true;
    return value;
  }
}

在上述示例中，我们定义了一个名为 CustomPipe 的自定义 Pipe，并实现了 PipeTransform 接口。在 transform() 方法中，我们可以对传入的数据进行自定义的处理。在这个例子中，我们简单地添加了一个 transformed 属性，并输出一条日志信息。

下面是一个示例，展示如何在 Nest.js 中使用自定义 Pipe：

import { Controller, Get } from '@nestjs/common';
import { CustomPipe } from './custom.pipe';

@Controller('cats')
export class CatsController {
  @Get()
  findAll(@Body(new CustomPipe()) body): string[] {
    return ['Cat1', 'Cat2', 'Cat3'];
  }
}

在上述示例中，我们在控制器方法的参数上使用了 @Body(new CustomPipe()) 装饰器，将自定义的 Pipe 传入控制器方法中，并对传入的数据进行处理。在该例子中，我们对传入的数据添加了一个 transformed 属性。

总结

在 Nest.js 中，Pipe 可以帮助我们对输入的数据进行处理和转换，Nest.js 提供了一些内置的 Pipe，同时也支持开发者编写自定义的 Pipe。希望这篇文章对您理解 Nest.js 中 Pipe 的使用有所帮助。