异常过滤器

内置的异常层负责处理整个应用程序中的所有抛出的异常。当捕获到未处理的异常时，最终用户将收到友好的响应。

异常过滤器 - 图1

开箱即用，此操作由内置的全局异常过滤器执行，该过滤器处理类型 HttpException（及其子类）的异常。每个发生的异常都由全局异常过滤器处理, 当这个异常无法被识别时 (既不是 HttpException 也不是继承的类 HttpException ) , 用户将收到以下 JSON 响应:

  1. {
  2.     "statusCode": 500,
  3.     "message": "Internal server error"
  4. }

基础异常类

Nest提供了一个内置的 HttpException 类，它从 @nestjs/common 包中导入。对于典型的基于HTTP REST/GraphQL API的应用程序，最佳实践是在发生某些错误情况时发送标准HTTP响应对象。

在 CatsController，我们有一个 findAll() 方法（GET 路由）。假设此路由处理程序由于某种原因引发异常。 为了说明这一点，我们将对其进行如下硬编码：

cats.controller.ts

  1. @Get()
  2. async findAll() {
  3.   throw new HttpException('Forbidden', HttpStatus.FORBIDDEN);
  4. }

我们在这里使用了 HttpStatus 。它是从 @nestjs/common 包导入的辅助枚举器。

现在当客户端调用这个端点时，响应如下所示：

  1. {
  2.     "statusCode": 403,
  3.     "message": "Forbidden"
  4. }

HttpException 构造函数有两个必要的参数来决定响应:

  • response 参数定义 JSON 响应体。它可以是 string 或 object，如下所述。

  • status参数定义HTTP状态代码。

默认情况下，JSON 响应主体包含两个属性：

  • statusCode：默认为 status 参数中提供的 HTTP 状态代码

  • message:基于状态的 HTTP 错误的简短描述

仅覆盖 JSON 响应主体的消息部分，请在 response参数中提供一个 string。

要覆盖整个 JSON 响应主体，请在response 参数中传递一个object。 Nest将序列化对象，并将其作为JSON 响应返回。

第二个构造函数参数-status-是有效的 HTTP 状态代码。 最佳实践是使用从@nestjs/common导入的 HttpStatus枚举。

这是一个覆盖整个响应正文的示例：

cats.controller.ts

  1. @Get()
  2. async findAll() {
  3.   throw new HttpException({
  4.     status: HttpStatus.FORBIDDEN,
  5.     error: 'This is a custom message',
  6.   }, HttpStatus.FORBIDDEN);
  7. }

使用上面的代码，响应如下所示：

  1. {
  2.   "status": 403,
  3.   "error": "This is a custom message"
  4. }

自定义异常

在许多情况下，您无需编写自定义异常，而可以使用内置的 Nest HTTP异常，如下一节所述。 如果确实需要创建自定义的异常，则最好创建自己的异常层次结构，其中自定义异常从基 HttpException 类继承。 使用这种方法，Nest可以识别您的异常，并自动处理错误响应。 让我们实现这样一个自定义异常：

forbidden.exception.ts

  1. export class ForbiddenException extends HttpException {
  2.   constructor() {
  3.     super('Forbidden', HttpStatus.FORBIDDEN);
  4.   }
  5. }

由于 ForbiddenException 扩展了基础 HttpException，它将和核心异常处理程序一起工作，因此我们可以在 findAll()方法中使用它。

cats.controller.ts

  1. @Get()
  2. async findAll() {
  3.   throw new ForbiddenException();
  4. }

内置HTTP异常

为了减少样板代码，Nest 提供了一系列继承自核心异常 HttpException 的可用异常。所有这些都可以在 @nestjs/common包中找到：

  • BadRequestException
  • UnauthorizedException
  • NotFoundException
  • ForbiddenException
  • NotAcceptableException
  • RequestTimeoutException
  • ConflictException
  • GoneException
  • PayloadTooLargeException
  • UnsupportedMediaTypeException
  • UnprocessableException
  • InternalServerErrorException
  • NotImplementedException
  • BadGatewayException
  • ServiceUnavailableException
  • GatewayTimeoutException

异常过滤器

虽然基本（内置）异常过滤器可以为您自动处理许多情况，但有时您可能希望对异常层拥有完全控制权，例如，您可能要添加日志记录或基于一些动态因素使用其他 JSON模式。 异常过滤器正是为此目的而设计的。 它们使您可以控制精确的控制流以及将响应的内容发送回客户端。

让我们创建一个异常过滤器，它负责捕获作为HttpException类实例的异常，并为它们设置自定义响应逻辑。为此，我们需要访问底层平台 Request和 Response。我们将访问Request对象，以便提取原始 url并将其包含在日志信息中。我们将使用 Response.json()方法，使用 Response对象直接控制发送的响应。

http-exception.filter.ts

  1. import { ExceptionFilter, Catch, ArgumentsHost, HttpException } from '@nestjs/common';
  2. import { Request, Response } from 'express';
  4. @Catch(HttpException)
  5. export class HttpExceptionFilter implements ExceptionFilter {
  6.   catch(exception: HttpException, host: ArgumentsHost) {
  7.     const ctx = host.switchToHttp();
  8.     const response = ctx.getResponse<Response>();
  9.     const request = ctx.getRequest<Request>();
  10.     const status = exception.getStatus();
  12.     response
  13.       .status(status)
  14.       .json({
  15.         statusCode: status,
  16.         timestamp: new Date().toISOString(),
  17.         path: request.url,
  18.       });
  19.   }
  20. }

所有异常过滤器都应该实现通用的 ExceptionFilter<T> 接口。它需要你使用有效签名提供 catch(exception: T, host: ArgumentsHost)方法。T 表示异常的类型。

@Catch() 装饰器绑定所需的元数据到异常过滤器上。它告诉 Nest这个特定的过滤器正在寻找 HttpException 而不是其他的。在实践中，@Catch() 可以传递多个参数，所以你可以通过逗号分隔来为多个类型的异常设置过滤器。

参数主机

让我们看一下该 catch() 方法的参数。该 exception 参数是当前正在处理的异常对象。该host参数是一个 ArgumentsHost 对象。 ArgumentsHost 是一个功能强大的实用程序对象，我们将在执行上下文章节 *中进一步进行研究。在此代码示例中，我们使用它来获取对 Request 和 Response 对象的引用，这些对象被传递给原始请求处理程序（在异常发生的控制器中）。在此代码示例中，我们使用了一些辅助方法 ArgumentsHost 来获取所需的 Request 和 Response 对象。ArgumentsHost 在此处了解更多信息。

之所以如此抽象，是因为它 ArgumentsHost 可以在所有上下文中使用（例如，我们现在正在使用的 HTTP 服务器上下文，以及微服务和 WebSocket ）。在执行上下文章中，我们会看到我们如何可以访问相应的基础参数进行任何与动力执行上下文 ArgumentsHost 和它的辅助功能。这将使我们能够编写可在所有上下文中运行的通用异常过滤器。

绑定过滤器

让我们将 HttpExceptionFilter 绑定到 CatsController 的 create() 方法上。

cats.controller.ts

  1. @Post()
  2. @UseFilters(new HttpExceptionFilter())
  3. async create(@Body() createCatDto: CreateCatDto) {
  4.   throw new ForbiddenException();
  5. }

@UseFilters() 装饰器需要从 @nestjs/common 包导入。

我们在这里使用了 @UseFilters() 装饰器。和 @Catch()装饰器类似，它可以使用单个过滤器实例，也可以使用逗号分隔的过滤器实例列表。 我们创建了 HttpExceptionFilter 的实例。另一种可用的方式是传递类（不是实例），让框架承担实例化责任并启用依赖注入。

cats.controller.ts

  1. @Post()
  2. @UseFilters(HttpExceptionFilter)
  3. async create(@Body() createCatDto: CreateCatDto) {
  4.   throw new ForbiddenException();
  5. }

尽可能使用类而不是实例。由于 Nest 可以轻松地在整个模块中重复使用同一类的实例，因此可以减少内存使用。

在上面的示例中，HttpExceptionFilter 仅应用于单个 create() 路由处理程序，使其成为方法范围的。 异常过滤器的作用域可以划分为不同的级别：方法范围，控制器范围或全局范围。 例如，要将过滤器设置为控制器作用域，您可以执行以下操作：

cats.controller.ts

  1. @UseFilters(new HttpExceptionFilter())
  2. export class CatsController {}

此结构为 CatsController 中的每个路由处理程序设置 HttpExceptionFilter。

要创建一个全局范围的过滤器，您需要执行以下操作:

main.ts

  1. async function bootstrap() {
  2.   const app = await NestFactory.create(AppModule);
  3.   app.useGlobalFilters(new HttpExceptionFilter());
  4.   await app.listen(3000);
  5. }
  6. bootstrap();

!> 该 useGlobalFilters() 方法不会为网关和混合应用程序设置过滤器。

全局过滤器用于整个应用程序、每个控制器和每个路由处理程序。就依赖注入而言，从任何模块外部注册的全局过滤器（使用上面示例中的 useGlobalFilters()）不能注入依赖，因为它们不属于任何模块。为了解决这个问题，你可以注册一个全局范围的过滤器直接为任何模块设置过滤器：

app.module.ts

  1. import { Module } from '@nestjs/common';
  2. import { APP_FILTER } from '@nestjs/core';
  4. @Module({
  5.   providers: [
  6.     {
  7.       provide: APP_FILTER,
  8.       useClass: HttpExceptionFilter,
  9.     },
  10.   ],
  11. })
  12. export class AppModule {}

?>当使用此方法对过滤器执行依赖注入时，请注意，无论采用哪种结构的模块，过滤器实际上都是全局的。 应该在哪里做？ 选择定义了过滤器（以上示例中为 HttpExceptionFilter）的模块。 同样，useClass不是处理自定义提供程序注册的唯一方法。 在这里了解更多。

您可以根据需要添加任意数量的过滤器;只需将每个组件添加到 providers（提供者）数组。

捕获异常

为了捕获每一个未处理的异常(不管异常类型如何)，将 @Catch() 装饰器的参数列表设为空，例如 @Catch()。

any-exception.filter.ts

  1. import {
  2.   ExceptionFilter,
  3.   Catch,
  4.   ArgumentsHost,
  5.   HttpException,
  6.   HttpStatus,
  7. } from '@nestjs/common';
  9. @Catch()
  10. export class AllExceptionsFilter implements ExceptionFilter {
  11.   catch(exception: unknown, host: ArgumentsHost) {
  12.     const ctx = host.switchToHttp();
  13.     const response = ctx.getResponse();
  14.     const request = ctx.getRequest();
  16.     const status =
  17.       exception instanceof HttpException
  18.         ? exception.getStatus()
  19.         : HttpStatus.INTERNAL_SERVER_ERROR;
  21.     response.status(status).json({
  22.       statusCode: status,
  23.       timestamp: new Date().toISOString(),
  24.       path: request.url,
  25.     });
  26.   }
  27. }

在上面的示例中，过滤器将捕获抛出的每个异常，而不管其类型(类)如何。

继承

通常，您将创建完全定制的异常过滤器，以满足您的应用程序需求。如果您希望重用已经实现的核心异常过滤器，并基于某些因素重写行为，请看下面的例子。

为了将异常处理委托给基础过滤器，需要继承 BaseExceptionFilter 并调用继承的 catch() 方法。

all-exceptions.filter.ts

  1. import { Catch, ArgumentsHost } from '@nestjs/common';
  2. import { BaseExceptionFilter } from '@nestjs/core';
  4. @Catch()
  5. export class AllExceptionsFilter extends BaseExceptionFilter {
  6.   catch(exception: unknown, host: ArgumentsHost) {
  7.     super.catch(exception, host);
  8.   }
  9. }

!> 继承自基础类的过滤器必须由框架本身实例化（不要使用 new 关键字手动创建实例）

上面的实现只是一个演示。扩展异常过滤器的实现将包括定制的业务逻辑(例如，处理各种情况)。

全局过滤器可以扩展基本过滤器。这可以通过两种方式来实现。

您可以通过注入 HttpServer 来使用继承自基础类的全局过滤器。

  1. async function bootstrap() {
  2.   const app = await NestFactory.create(AppModule);
  4.   const { httpAdapter } = app.get(HttpAdapterHost);
  5.   app.useGlobalFilters(new AllExceptionsFilter(httpAdapter));
  7.   await app.listen(3000);
  8. }
  9. bootstrap();

第二种方法是使用 APP_FILTER token，如下所示。

译者署名

| 用户名 | 头像 | 职能 | 签名 | |—-|—-|—-|—-|