Nestjs 异常过滤器：保护应用免受未处理错误的影响

后端

2023-06-13 05:27:07

Nest.js 异常过滤器：全面指南

简介

在 Nest.js 的世界中，异常过滤器是一个必不可少的工具，用于捕获和处理未处理的异常。这些过滤器可以帮助您记录错误信息、向用户显示友好错误消息，甚至执行其他必需的操作，确保您的应用程序运行顺畅、稳定。

异常过滤器的工作原理

当发生异常时，Nest.js 会根据异常类型和作用域来寻找合适的异常过滤器。它从控制器、服务一直搜索到整个应用程序。如果找到匹配的过滤器，则交由它处理异常。如果没有，异常将不断向上冒泡，直到被处理或到达应用程序根目录。

创建异常过滤器

创建异常过滤器非常简单。让我们使用一个示例来捕获所有 HttpException：

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

@Catch(HttpException)
export class HttpExceptionFilter implements ExceptionFilter {
  catch(exception: HttpException, host: ArgumentsHost) {
    const ctx = host.switchToHttp();
    const response = ctx.getResponse();
    const request = ctx.getRequest();
    const status = exception.getStatus();

    response.status(status).json({
      statusCode: status,
      message: exception.message,
      timestamp: new Date().toISOString(),
    });
  }
}

注册异常过滤器

为了使用异常过滤器，您需要在 app.module.ts 中注册它：

import { Module } from '@nestjs/common';
import { HttpExceptionFilter } from './http-exception.filter';

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

异常过滤器的优势

异常过滤器为您的应用程序提供了许多好处：