自定义路由装饰器

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

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 对象很深或很复杂，这可以使请求处理程序的实现更简单、更可读。

提示

对于 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);
}

提示

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

装饰器组合

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() {}

这具有通过单个声明应用所有四个装饰器的效果。

警告

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