Nestjs 异常过滤器

NestJs仿小米商城项目实战视频教程(视频+课件+源码)： https://www.itying.com/goods-1139.html

异常过滤器

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

每个发生的异常都由全局异常过滤器处理, 当这个异常无法被识别时 (既不是HttpException也不是继承的类HttpException) , 用户将收到以下 JSON 响应:

{
    "statusCode": 500,
    "message": "Internal server error"
}

基础异常类

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

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

cats.controller.ts

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

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

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

{
    "statusCode": 403,
    "message": "Forbidden"
}

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

@Get()
async findAll() {
  throw new HttpException({
    status: HttpStatus.FORBIDDEN,
    error: 'This is a custom message',
  }, 403);
}

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

{
  "status": 403,
  "error": "This is a custom message"
}

自定义异常

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

forbidden.exception.ts

export class ForbiddenException extends HttpException {
  constructor() {
    super('Forbidden', HttpStatus.FORBIDDEN);
  }
}

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

cats.controller.ts

@Get()
async findAll() {
  throw new ForbiddenException();
}

内置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

import { ExceptionFilter, Catch, ArgumentsHost, HttpException } from '@nestjs/common';
import { Request, Response } from 'express';

@Catch(HttpException)
export class HttpExceptionFilter implements ExceptionFilter {
  catch(exception: HttpException, host: ArgumentsHost) {
    const ctx = host.switchToHttp();
    const response = ctx.getResponse<Response>();
    const request = ctx.getRequest<Request>();
    const status = exception.getStatus();

    response
      .status(status)
      .json({
        statusCode: status,
        timestamp: new Date().toISOString(),
        path: request.url,
      });
  }
}

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

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

参数主机

让我们看看catch()方法的参数。exception参数是当前正在处理的异常对象。host参数是一个ArgumentsHost对象。ArgumentsHost 是传递给原始处理程序的参数的一个包装，我们将在其他章节中进一步讨论它。在这个上下文中，它的主要目的是为我们提供一个Request和Response对象的引用，这些对象被传递给原始请求处理程序(在产生异常的控制器中)。在本文中，我们使用了ArgumentsHost上的一些帮助方法来获得所需的Request和Response对象。

switchtohttp()返回一个HttpArgumentsHost对象。HttpArgumentsHost对象有两个方法。我们使用这些方法来提取所需的对象，在本例中还使用了Express类型断言来返回原生的Express类型化对象:

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

这种抽象级别的原因是ArgumentsHost在所有上下文中都起作用（例如，我们现在正在使用的HTTP Server上下文，以及微服务和Sockets）。稍后，我们将看到如何利用ArgumentsHost及其辅助函数的功能为任何执行上下文访问适当的基础参数。这将使我们能够编写可在所有上下文中运行的通用异常过滤器。

绑定过滤器

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

cats.controller.ts

@Post()
@UseFilters(new HttpExceptionFilter())
async create(@Body() createCatDto: CreateCatDto) {
  throw new ForbiddenException();
}

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

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

cats.controller.ts

@Post()
@UseFilters(HttpExceptionFilter)
async create(@Body() createCatDto: CreateCatDto) {
  throw new ForbiddenException();
}

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

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

cats.controller.ts

@UseFilters(new HttpExceptionFilter())
export class CatsController {}

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

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

main.ts

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useGlobalFilters(new HttpExceptionFilter());
  await app.listen(3000);
}
bootstrap();

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

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

app.module.ts

import { Module } from '@nestjs/common';
import { APP_FILTER } from '@nestjs/core';

@Module({
  providers: [
    {
      provide: APP_FILTER,
      useClass: HttpExceptionFilter,
    },
  ],
})
export class AppModule {}

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

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

捕获异常

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

any-exception.filter.ts

import { ExceptionFilter, Catch, ArgumentsHost, HttpException, HttpStatus } from '@nestjs/common';

@Catch()
export class AllExceptionsFilter implements ExceptionFilter {
  catch(exception: unknown, host: ArgumentsHost) {
    const ctx = host.switchToHttp();
    const response = ctx.getResponse();
    const request = ctx.getRequest();

    const status =
      exception instanceof HttpException
        ? exception.getStatus()
        : HttpStatus.INTERNAL_SERVER_ERROR;

    response.status(status).json({
      statusCode: status,
      timestamp: new Date().toISOString(),
      path: request.url,
    });
  }
}

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

继承

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

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

all-exceptions.filter.ts

import { Catch, ArgumentsHost } from '@nestjs/common';
import { BaseExceptionFilter } from '@nestjs/core';

@Catch()
export class AllExceptionsFilter extends BaseExceptionFilter {
  catch(exception: unknown, host: ArgumentsHost) {
    super.catch(exception, host);
  }
}

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

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

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

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

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  const { httpAdapter } = app.get(HttpAdapterHost);
  app.useGlobalFilters(new AllExceptionsFilter(httpAdapter));

  await app.listen(3000);
}
bootstrap();

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