执行上下文

Nest 提供了几个实用工具类，帮助你轻松编写能在多种应用上下文（例如基于 Nest HTTP 服务器、微服务和 WebSockets 应用上下文）中运行的应用程序。这些工具提供了关于当前执行上下文的信息，可用于构建通用的守卫、过滤器和拦截器，使其能够在广泛的控制器、方法和执行上下文中工作。

本章我们将介绍两个这样的类：ArgumentsHost 和 ExecutionContext。

ArgumentsHost 类

ArgumentsHost 类提供了用于检索传递给处理程序的参数的方法。它允许选择适当的上下文（例如 HTTP、RPC（微服务）或 WebSockets）来获取参数。框架在你可能需要访问它的地方提供了一个 ArgumentsHost 实例，通常作为 host 参数引用。例如，异常过滤器的 catch() 方法会接收一个 ArgumentsHost 实例。

ArgumentsHost 只是作为处理程序参数的抽象。例如，对于 HTTP 服务器应用程序（当使用 @nestjs/platform-express 时），host 对象封装了 Express 的 [request, response, next] 数组，其中 request 是请求对象，response 是响应对象，next 是控制应用程序请求-响应周期的函数。另一方面，对于 GraphQL 应用程序，host 对象包含 [root, args, context, info] 数组。

当前应用上下文

当构建旨在跨多个应用上下文运行的通用守卫、过滤器和拦截器时，我们需要一种方法来确定当前方法正在运行的应用类型。可以使用 ArgumentsHost 的 getType() 方法来实现：

if (host.getType() === 'http') {
  // 仅在常规 HTTP 请求（REST）上下文中重要的操作
} else if (host.getType() === 'rpc') {
  // 仅在微服务请求上下文中重要的操作
} else if (host.getType<GqlContextType>() === 'graphql') {
  // 仅在 GraphQL 请求上下文中重要的操作
}

提示

GqlContextType 从 @nestjs/graphql 包中导入。

有了可用的应用类型，我们可以编写更通用的组件，如下所示。

宿主处理程序参数

要检索传递给处理程序的参数数组，一种方法是使用 host 对象的 getArgs() 方法。

const [req, res, next] = host.getArgs();

你可以使用 getArgByIndex() 方法按索引获取特定参数：

const request = host.getArgByIndex(0);
const response = host.getArgByIndex(1);

在这些示例中，我们通过索引检索了请求和响应对象，这通常不推荐，因为它将应用程序耦合到特定的执行上下文。相反，你可以使用 host 对象的实用方法之一切换到适合你应用程序的应用上下文，从而使代码更加健壮和可复用。上下文切换的实用方法如下所示。

/**
 * 切换上下文到 RPC。
 */
switchToRpc(): RpcArgumentsHost;
/**
 * 切换上下文到 HTTP。
 */
switchToHttp(): HttpArgumentsHost;
/**
 * 切换上下文到 WebSockets。
 */
switchToWs(): WsArgumentsHost;

让我们使用 switchToHttp() 方法重写前面的示例。host.switchToHttp() 辅助方法调用返回一个适用于 HTTP 应用上下文的 HttpArgumentsHost 对象。HttpArgumentsHost 对象有两个有用的方法，可以用来提取所需的对象。在这种情况下，我们还使用 Express 类型断言来返回原生 Express 类型的对象：

const ctx = host.switchToHttp();
const request = ctx.getRequest<Request>();
const response = ctx.getResponse<Response>();

类似地，WsArgumentsHost 和 RpcArgumentsHost 有方法在微服务和 WebSockets 上下文中返回适当的对象。以下是 WsArgumentsHost 的方法：

export interface WsArgumentsHost {
  /**
   * 返回 data 对象。
   */
  getData<T>(): T;
  /**
   * 返回 client 对象。
   */
  getClient<T>(): T;
}

以下是 RpcArgumentsHost 的方法：

export interface RpcArgumentsHost {
  /**
   * 返回 data 对象。
   */
  getData<T>(): T;

  /**
   * 返回 context 对象。
   */
  getContext<T>(): T;
}

ExecutionContext 类

ExecutionContext 扩展了 ArgumentsHost，提供了关于当前执行过程的额外详细信息。与 ArgumentsHost 一样，Nest 在你可能需要的地方提供了 ExecutionContext 的实例，例如在守卫的 canActivate() 方法和拦截器的 intercept() 方法中。它提供了以下方法：

export interface ExecutionContext extends ArgumentsHost {
  /**
   * 返回当前处理程序所属的控制器类的类型。
   */
  getClass<T>(): Type<T>;
  /**
   * 返回将在请求管道中下一个被调用的处理程序（方法）的引用。
   */
  getHandler(): Function;
}

getHandler() 方法返回即将被调用的处理程序的引用。getClass() 方法返回该特定处理程序所属的 Controller 类的类型。例如，在 HTTP 上下文中，如果当前处理的请求是一个 POST 请求，绑定到 CatsController 上的 create() 方法，getHandler() 返回 create() 方法的引用，getClass() 返回 CatsController 类（而非实例）。

const methodKey = ctx.getHandler().name; // "create"
const className = ctx.getClass().name; // "CatsController"

能够访问当前类和处理程序方法的引用提供了极大的灵活性。最重要的是，它使我们有机会在守卫或拦截器中访问通过 Reflector#createDecorator 创建的装饰器或内置的 @SetMetadata() 装饰器设置的元数据。我们将在下面介绍这个用例。

反射和元数据

Nest 提供了通过 Reflector#createDecorator 方法创建的装饰器和内置的 @SetMetadata() 装饰器将自定义元数据附加到路由处理程序的能力。在本节中，让我们比较这两种方法，并了解如何在守卫或拦截器中访问元数据。

要使用 Reflector#createDecorator 创建强类型装饰器，我们需要指定类型参数。例如，让我们创建一个接受字符串数组作为参数的 Roles 装饰器。

import { Reflector } from '@nestjs/core';

export const Roles = Reflector.createDecorator<string[]>();

这里的 Roles 装饰器是一个接受单个 string[] 类型参数的函数。

现在，要使用这个装饰器，我们只需用它来注解处理程序：

@Post()
@Roles(['admin'])
async create(@Body() createCatDto: CreateCatDto) {
  this.catsService.create(createCatDto);
}

这里我们将 Roles 装饰器元数据附加到了 create() 方法上，表示只有具有 admin 角色的用户才能访问此路由。

要访问路由的角色（自定义元数据），我们将再次使用 Reflector 辅助类。Reflector 可以以常规方式注入到类中：

@Injectable()
export class RolesGuard {
  constructor(private reflector: Reflector) {}
}

提示

Reflector 类从 @nestjs/core 包中导入。

现在，要读取处理程序的元数据，使用 get() 方法：

const roles = this.reflector.get(Roles, context.getHandler());

Reflector#get 方法允许我们通过传入两个参数来轻松访问元数据：一个装饰器引用和一个上下文（装饰器目标）来检索元数据。在这个示例中，指定的装饰器是 Roles（参考上面的 roles.decorator.ts 文件）。上下文由 context.getHandler() 调用提供，这会提取当前处理的路由处理程序的元数据。记住，getHandler() 给我们一个路由处理程序函数的引用。

或者，我们可以在控制器级别应用元数据来组织控制器，将其应用于控制器类中的所有路由。

@Roles(['admin'])
@Controller('cats')
export class CatsController {}

在这种情况下，要提取控制器元数据，我们传递 context.getClass() 作为第二个参数（以提供控制器类作为元数据提取的上下文），而不是 context.getHandler()：

const roles = this.reflector.get(Roles, context.getClass());

鉴于能够在多个级别提供元数据，你可能需要从多个上下文中提取和合并元数据。Reflector 类提供了两个实用方法来帮助实现这一点。这些方法同时提取控制器和方法的元数据，并以不同的方式组合它们。

考虑以下场景，你在两个级别都提供了 Roles 元数据。

@Roles(['user'])
@Controller('cats')
export class CatsController {
  @Post()
  @Roles(['admin'])
  async create(@Body() createCatDto: CreateCatDto) {
    this.catsService.create(createCatDto);
  }
}

如果你的意图是将 'user' 指定为默认角色，并为某些方法选择性地覆盖它，你可能会使用 getAllAndOverride() 方法。

const roles = this.reflector.getAllAndOverride(Roles, [context.getHandler(), context.getClass()]);

在 create() 方法的上下文中运行的守卫，使用上述元数据，将导致 roles 包含 ['admin']。

要获取两者的元数据并合并它们（此方法合并数组和对象），使用 getAllAndMerge() 方法：

const roles = this.reflector.getAllAndMerge(Roles, [context.getHandler(), context.getClass()]);

这将导致 roles 包含 ['user', 'admin']。

对于这两种合并方法，你将元数据键作为第一个参数传递，将元数据目标上下文的数组（即对 getHandler() 和/或 getClass() 方法的调用）作为第二个参数传递。

低级方法

如前所述，除了使用 Reflector#createDecorator，你还可以使用内置的 @SetMetadata() 装饰器将元数据附加到处理程序。

@Post()
@SetMetadata('roles', ['admin'])
async create(@Body() createCatDto: CreateCatDto) {
  this.catsService.create(createCatDto);
}

提示

@SetMetadata() 装饰器从 @nestjs/common 包中导入。

通过上面的构造，我们将 roles 元数据（roles 是元数据键，['admin'] 是关联的值）附加到了 create() 方法。虽然这可以工作，但直接在路由中使用 @SetMetadata() 不是好的实践。相反，你可以创建自己的装饰器，如下所示：

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

export const Roles = (...roles: string[]) => SetMetadata('roles', roles);

这种方法更加简洁和可读，并且在某种程度上类似于 Reflector#createDecorator 方法。区别在于使用 @SetMetadata 你可以更好地控制元数据键和值，还可以创建接受多个参数的装饰器。

现在我们有了自定义的 @Roles() 装饰器，可以用它来装饰 create() 方法。

@Post()
@Roles('admin')
async create(@Body() createCatDto: CreateCatDto) {
  this.catsService.create(createCatDto);
}

要访问路由的角色（自定义元数据），我们将再次使用 Reflector 辅助类：

@Injectable()
export class RolesGuard {
  constructor(private reflector: Reflector) {}
}

提示

Reflector 类从 @nestjs/core 包中导入。

现在，要读取处理程序的元数据，使用 get() 方法。

const roles = this.reflector.get<string[]>('roles', context.getHandler());

这里我们传递元数据键作为第一个参数（在我们的例子中是 'roles'），而不是传递装饰器引用。其他一切与 Reflector#createDecorator 示例保持一致。