Nest.js 中如何创建自定义异常过滤器？

推荐答案

在 Nest.js 中，创建自定义异常过滤器的步骤如下：

1. 创建异常过滤器类：使用 @Catch() 装饰器来捕获特定类型的异常，并实现 ExceptionFilter 接口。

2. 实现 catch 方法：在 catch 方法中处理异常，并返回自定义的响应。

3. 绑定异常过滤器：可以通过控制器、方法或全局范围来绑定异常过滤器。

以下是一个自定义异常过滤器的示例代码：

-- -------------------- ---- -------
------ - ---------------- ------ -------------- ------------- - ---- -----------------
------ - -------- -------- - ---- ----------

---------------------
------ ----- ------------------- ---------- --------------- -
  ---------------- -------------- ----- -------------- -
    ----- --- - --------------------
    ----- -------- - ----------------------------
    ----- ------- - --------------------------
    ----- ------ - ----------------------

    --------
      ---------------
      -------
        ----------- -------
        ---------- --- ---------------------
        ----- ------------
        -------- ------------------
      ---
  -
-

然后，可以通过以下方式绑定异常过滤器：

• 控制器级别：

  @UseFilters(new HttpExceptionFilter())
  @Controller('cats')
  export class CatsController {}

• 方法级别：

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

• 全局范围：

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

本题详细解读

1. 创建异常过滤器类

在 Nest.js 中，异常过滤器用于捕获和处理应用程序中抛出的异常。通过实现 ExceptionFilter 接口，可以自定义异常的处理逻辑。@Catch() 装饰器用于指定要捕获的异常类型，例如 HttpException。

2. 实现 catch 方法

catch 方法是异常过滤器的核心部分，它接收两个参数：

• exception：捕获到的异常对象。
• host：一个 ArgumentsHost 对象，用于获取当前请求的上下文。

在 catch 方法中，可以通过 host.switchToHttp() 获取 HTTP 请求和响应对象，然后根据异常信息构建自定义的响应。

3. 绑定异常过滤器

异常过滤器可以在不同的范围内绑定：

• 控制器级别：使用 @UseFilters() 装饰器将过滤器应用到整个控制器。
• 方法级别：使用 @UseFilters() 装饰器将过滤器应用到特定的方法。
• 全局范围：使用 app.useGlobalFilters() 将过滤器应用到整个应用程序。

4. 示例代码解析

在示例代码中，HttpExceptionFilter 类捕获了 HttpException 类型的异常，并返回了一个包含状态码、时间戳、请求路径和错误信息的 JSON 响应。通过这种方式，可以统一处理应用程序中的 HTTP 异常，并返回一致的错误格式。

5. 使用场景

自定义异常过滤器适用于以下场景：

• 需要统一处理特定类型的异常。
• 需要在异常发生时记录日志或执行其他操作。
• 需要返回自定义的错误响应格式。

通过自定义异常过滤器，可以增强应用程序的异常处理能力，并提供更友好的错误信息。