Nest.js 的过滤器 (Exception Filter) 是什么？-JavaScript中文网-JavaScript教程资源分享门户

本题详细解读

什么是过滤器（Exception Filter）？

在 Nest.js 中，过滤器是一种特殊的类，用于捕获和处理应用程序中抛出的异常。它们可以全局应用，也可以应用于特定的控制器或路由。过滤器的核心作用是拦截异常，并根据异常类型返回适当的 HTTP 响应。

如何创建自定义过滤器？

要创建一个自定义过滤器，你需要实现 ExceptionFilter 接口，并使用 @Catch() 装饰器来指定你想要捕获的异常类型。以下是一个简单的自定义过滤器示例：

// 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,
      });
  }
}

在这个示例中，HttpExceptionFilter 捕获了所有 HttpException 类型的异常，并返回一个包含状态码、时间戳和请求路径的 JSON 响应。

如何使用过滤器？

你可以通过以下几种方式使用过滤器：

全局过滤器：在应用程序的入口文件（通常是 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();

控制器级别过滤器：在控制器类上使用 @UseFilters() 装饰器来应用过滤器。

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

@Controller('cats')
@UseFilters(HttpExceptionFilter)
export class CatsController {
  @Get()
  findAll() {
    throw new HttpException('Forbidden', 403);
  }
}

方法级别过滤器：在控制器的方法上使用 @UseFilters() 装饰器来应用过滤器。

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

@Controller('cats')
export class CatsController {
  @Get()
  @UseFilters(HttpExceptionFilter)
  findAll() {
    throw new HttpException('Forbidden', 403);
  }
}

过滤器的执行顺序

当多个过滤器应用于同一个请求时，Nest.js 会按照以下顺序执行它们：

方法级别的过滤器
控制器级别的过滤器
全局过滤器

过滤器的应用场景

过滤器通常用于以下场景：

统一错误响应格式：通过过滤器，你可以确保所有异常都返回一致的错误响应格式。
日志记录：在过滤器中，你可以记录异常信息，便于后续分析和调试。
特定异常处理：你可以为特定的异常类型（如 HttpException）定义专门的错误处理逻辑。

通过使用过滤器，你可以更好地控制应用程序中的异常处理流程，提高代码的可维护性和用户体验。

Nest.js 的过滤器 (Exception Filter) 是什么？

推荐答案