玩转NestJS过滤器，轻松搞定异常处理

2023-10-21 11:25:59

NestJS 过滤器：处理异常的利器

NestJS 过滤器是管理未手动捕获异常的有效工具。使用过滤器，我们可以轻松处理异常，为用户提供友好的错误消息。

深入了解 NestJS 过滤器的运作原理

基本用法

创建过滤器类： 在 src/filters/ 目录中创建 HttpExceptionFilter.ts 文件。
导入必需品： 导入 HttpException 和 ArgumentsHost。
实现 catch() 方法： 在这个方法中处理异常。

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

@Catch(HttpException)
export class HttpExceptionFilter implements ExceptionFilter {
  catch(exception: HttpException, host: ArgumentsHost) {
    // 处理异常
  }
}

导入过滤器： 在 src/app.module.ts 中导入 HttpExceptionFilter。
注册过滤器： 在 imports 数组中添加 HttpExceptionFilter。

import { HttpExceptionFilter } from './filters/HttpExceptionFilter';

@Module({
  imports: [HttpExceptionFilter],
  controllers: [],
  providers: [],
})
export class AppModule {}

高级用法

除了基本用法，NestJS 过滤器还提供了一些高级功能：

指定异常类型： 使用 @Catch() 装饰器指定要捕获的异常类型。
获取请求和响应对象： 使用 @ArgumentsHost() 装饰器获取请求和响应对象。
注入依赖项： 使用 @Inject() 装饰器注入依赖项。

import { HttpException, ArgumentsHost, Inject } from '@nestjs/common';
import { Catch, ExceptionFilter } from '@nestjs/common';
import { Logger } from 'nestjs-pino';

@Catch(HttpException)
export class HttpExceptionFilter implements ExceptionFilter {
  constructor(@Inject(Logger) private readonly logger: Logger) {}

  catch(exception: HttpException, host: ArgumentsHost) {
    // 处理异常
    this.logger.error(exception.message, exception.stack);
  }
}