全面解析Nest的异常过滤器

前端

2023-11-11 10:12:54

深入了解 Nest 的异常过滤器：统一错误处理、转换格式和记录日志

在 NestJS 中，异常过滤器是一个强大的工具，可帮助开发人员管理应用程序中的错误。它提供了对异常处理的细粒度控制，使其成为统一错误处理、转换错误格式和添加错误日志的理想选择。

什么是异常过滤器？

异常过滤器是一种特殊的提供者，用于处理由控制器方法抛出的错误。这些过滤器可以用来拦截错误并对其进行转换和处理，确保应用程序以一致的方式处理和返回错误。

Nest 异常过滤器的优势

Nest 异常过滤器具有以下优势：

统一错误处理： 集中处理应用程序中的所有错误，确保以一致的方式处理和返回错误。
转换错误格式： 将错误转换为更适合返回给客户端的格式，例如将错误消息转换为 JSON 格式。
添加错误日志： 在处理错误时记录错误日志，以便于调试和分析。

如何使用 Nest 异常过滤器

在 Nest 中使用异常过滤器非常简单，只需执行以下步骤：

创建一个异常过滤器类，继承自 Nest 的 BaseExceptionFilter 类。
在异常过滤器类中实现 catch 方法，该方法将用来处理和转换异常。
在控制器或模块中使用 @Catch() 装饰器指定要使用的异常过滤器。

Nest 异常过滤器示例

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

@Catch()
export class MyExceptionFilter implements ExceptionFilter {
  catch(exception: any, host: ArgumentsHost) {
    // 获取请求和响应对象
    const ctx = host.switchToHttp();
    const request = ctx.getRequest();
    const response = ctx.getResponse();

    // 将错误消息转换为 JSON 格式
    const errorResponse = {
      statusCode: response.statusCode,
      message: exception.message,
    };

    // 返回错误响应
    response.status(response.statusCode).json(errorResponse);
  }
}

在控制器中使用异常过滤器：

import { Controller, Get, Catch } from '@nestjs/common';
import { MyExceptionFilter } from './my-exception-filter';

@Controller()
export class MyController {
  @Get()
  @Catch(MyExceptionFilter)
  findAll() {
    throw new Error('An error occurred!');
  }
}