自定义路由装饰器

    Nest 是围绕一种称为装饰器的语言特性构建的。装饰器在许多常用编程语言中是一个众所周知的概念，但在 JavaScript 世界中，它们仍然相对较新。为了更好地理解装饰器的工作原理，我们建议阅读 this article。以下是一个简单的定义：

    ES2016 装饰器是一个返回函数的表达式，可以接受目标、名称和属性描述符作为参数。通过在装饰器前加上 @ 字符，并将其放在要装饰的内容的最顶部来应用它。装饰器可以为类、方法或属性定义。

    参数装饰器

    Nest 提供了一组有用的参数装饰器，您可以与 HTTP 路由处理器一起使用。以下是提供的装饰器及其所代表的普通 Express（或 Fastify）对象的列表

    @Request(), @Req() req
    @Response(), @Res() res
    @Next() next
    @Session() req.session
    @Param(param?: string) req.params / req.params[param]
    @Body(param?: string) req.body / req.body[param]
    @Query(param?: string) req.query / req.query[param]
    @Headers(param?: string) req.headers / req.headers[param]
    @Ip() req.ip
    @HostParam() req.hosts

    此外，您可以创建自己的自定义装饰器。这有什么用呢？

    在 node.js 世界中，将属性附加到请求对象是一种常见做法。然后您在每个路由处理器中手动提取它们，使用如下代码：

    const user = req.user;

    为了使您的代码更具可读性和透明性，您可以创建一个 @User() 装饰器，并在所有控制器中重用它。

    import { createParamDecorator, ExecutionContext } from '@nestjs/common';

export const User = createParamDecorator(
  (data: unknown, ctx: ExecutionContext) => {
    const request = ctx.switchToHttp().getRequest();
    return request.user;
  },
);

    然后，您可以在任何符合您需求的地方简单地使用它。

    @Get()
async findOne(@User() user: UserEntity) {
  console.log(user);
}

    传递数据

    当您的装饰器的行为取决于某些条件时，您可以使用 data 参数将参数传递给装饰器的工厂函数。一个用例是按键从请求对象中提取属性的自定义装饰器。例如，假设我们的 认证层 验证请求并将用户实体附加到请求对象。经过认证的请求的用户实体可能如下所示：

    {
  "id": 101,
  "firstName": "Alan",
  "lastName": "Turing",
  "email": "alan@email.com",
  "roles": ["admin"]
}

    让我们定义一个装饰器，它接受属性名称作为键，并返回关联的值（如果存在），如果不存在或 user 对象尚未创建，则返回 undefined。

    import { createParamDecorator, ExecutionContext } from '@nestjs/common';

export const User = createParamDecorator(
  (data: string, ctx: ExecutionContext) => {
    const request = ctx.switchToHttp().getRequest();
    const user = request.user;

    return data ? user?.[data] : user;
  },
);

    以下是如何在控制器中通过 @User() 装饰器访问特定属性的方法：

    @Get()
async findOne(@User('firstName') firstName: string) {
  console.log(`Hello ${firstName}`);
}

    您可以使用相同的装饰器配合不同的键来访问不同的属性。如果 user 对象是深层或复杂的，这可以使请求处理器的实现更简单、更易读。

    info 提示 对于 TypeScript 用户，请注意 createParamDecorator<T>() 是一个泛型。这意味着您可以显式地强制类型安全，例如 createParamDecorator<string>((data, ctx) => ...)。或者，在工厂函数中指定参数类型，例如 createParamDecorator((data: string, ctx) => ...)。如果两者都省略，data 的类型将是 any。

    使用管道

    Nest 以与内置装饰器（@Body()、@Param() 和 @Query()）相同的方式处理自定义参数装饰器。这意味着管道也会为自定义注解的参数执行（在我们的示例中，即 user 参数）。此外，您可以直接将管道应用于自定义装饰器：

    @Get()
async findOne(
  @User(new ValidationPipe({ validateCustomDecorators: true }))
  user: UserEntity,
) {
  console.log(user);
}

    info 提示 请注意，validateCustomDecorators 选项必须设置为 true。ValidationPipe 默认不会验证使用自定义装饰器注解的参数。

    同样的规则适用于 StandardSchemaValidationPipe。如果您的自定义装饰器附加了应通过 Standard Schema 兼容模式验证的数据，请在配置管道时启用 validateCustomDecorators。

    装饰器组合

    Nest 提供了一个辅助方法来组合多个装饰器。例如，假设您想将所有与认证相关的装饰器组合成一个装饰器。可以通过以下构造来实现：

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

export function Auth(...roles: Role[]) {
  return applyDecorators(
    SetMetadata('roles', roles),
    UseGuards(AuthGuard, RolesGuard),
    ApiBearerAuth(),
    ApiUnauthorizedResponse({ description: 'Unauthorized' }),
  );
}

    然后您可以按如下方式使用这个自定义的 @Auth() 装饰器：

    @Get('users')
@Auth('admin')
findAllUsers() {}

    这样做的效果是，通过单个声明即可应用所有四个装饰器。

    warning 警告 来自 @nestjs/swagger 包的 @ApiHideProperty() 装饰器不可组合，无法与 applyDecorators 函数正常工作。