Nest.js 中如何在全局范围应用异常过滤器？

推荐答案

在 Nest.js 中，可以通过以下步骤在全局范围应用异常过滤器：

1. 创建自定义异常过滤器：首先，创建一个自定义的异常过滤器类，并实现 ExceptionFilter 接口。

   // www.javascriptcn.com code example
   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,
         });
     }
   }

2. 全局应用异常过滤器：在 main.ts 文件中，使用 app.useGlobalFilters() 方法将自定义的异常过滤器应用到全局。

   // www.javascriptcn.com code example
   import { NestFactory } from '@nestjs/core';
   import { AppModule } from './app.module';
   import { HttpExceptionFilter } from './filters/http-exception.filter';
   
   async function bootstrap() {
     const app = await NestFactory.create(AppModule);
     app.useGlobalFilters(new HttpExceptionFilter());
     await app.listen(3000);
   }
   bootstrap();

本题详细解读

1. 自定义异常过滤器的作用

自定义异常过滤器允许你捕获应用程序中抛出的异常，并根据需要对异常进行处理。通过实现 ExceptionFilter 接口，你可以定义如何处理特定类型的异常（例如 HttpException），并返回自定义的响应格式。

2. @Catch() 装饰器

@Catch() 装饰器用于指定过滤器要捕获的异常类型。在上面的例子中，@Catch(HttpException) 表示该过滤器将捕获所有 HttpException 类型的异常。你可以根据需要捕获其他类型的异常，或者使用 @Catch() 不指定类型来捕获所有异常。

3. ArgumentsHost 的使用

ArgumentsHost 是一个包装了当前请求上下文的对象。通过 switchToHttp() 方法，你可以获取到 HTTP 请求的上下文，包括 Request 和 Response 对象。这使得你可以在异常处理过程中访问请求的详细信息，并根据需要修改响应。

4. 全局应用异常过滤器

app.useGlobalFilters() 方法允许你将异常过滤器应用到整个应用程序。这意味着无论异常在哪个模块或控制器中抛出，都会被这个全局过滤器捕获并处理。这种方式非常适合处理那些需要在全局范围内统一处理的异常场景。

5. 其他应用方式

除了全局应用外，你还可以在控制器或路由级别应用异常过滤器。例如，使用 @UseFilters() 装饰器可以将过滤器应用到特定的控制器或路由方法上。这种方式适用于需要针对特定场景进行异常处理的场景。

// www.javascriptcn.com code example
import { Controller, Get, UseFilters } from '@nestjs/common';
import { HttpExceptionFilter } from './filters/http-exception.filter';

@Controller('example')
@UseFilters(HttpExceptionFilter)
export class ExampleController {
  @Get()
  getExample() {
    throw new HttpException('Forbidden', 403);
  }
}

通过这种方式，你可以灵活地在不同层次上应用异常过滤器，以满足不同的需求。