NestJS 7.x折腾记：异常过滤器，去其糟粕，取其精华！比如响应异常数据的包装~

2023-09-02 13:53:35

前言

NestJS是一个功能强大、备受欢迎的Node.js Web框架，它基于TypeScript，提供了完整的API，用于构建现代Web应用程序和RESTful API。NestJS内置了一系列强大的功能，可以帮助我们简化开发过程，其中就包括异常过滤器。

异常过滤器是一个特殊的NestJS组件，它允许我们在应用程序中注册一个或多个处理程序来捕获和处理特定的异常。当应用程序中抛出异常时，异常过滤器会自动生效，并执行相应的处理逻辑，从而确保应用程序能够优雅地处理错误，并为用户提供友好的响应。

在本文中，我们将深入探讨NestJS的异常过滤器，包括它的设计原理、实现细节以及如何自定义过滤器来处理应用程序中的异常。我们将从基础概念讲起，逐步深入剖析异常过滤器的各个方面，并辅以大量的代码示例，帮助你快速掌握NestJS异常处理的精髓。

异常过滤器的设计原理

NestJS的异常过滤器是一种基于拦截器（Interceptor）机制实现的组件。拦截器是一种可以在管道中插入一个或多个处理程序的机制，它允许我们在请求的生命周期中执行某些操作，比如对请求进行预处理、修改响应数据，或者捕获和处理异常。

异常过滤器就是一种特殊的拦截器，它专门用于处理异常。当应用程序中抛出异常时，异常过滤器会自动生效，并执行相应的处理逻辑，从而确保应用程序能够优雅地处理错误，并为用户提供友好的响应。

异常过滤器的实现细节

NestJS的异常过滤器是一个抽象类，它定义了一些抽象方法，用于处理应用程序中的异常。要使用异常过滤器，我们需要创建一个继承自异常过滤器的子类，并实现这些抽象方法。

以下是一个简单的异常过滤器示例：

import { ExceptionFilter, Catch, 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();
    const message = exception.message;

    response.status(status).json({
      statusCode: status,
      message,
    });
  }
}

在这个示例中，我们创建了一个名为HttpExceptionFilter的异常过滤器，它可以捕获所有继承自HttpException的异常。当应用程序中抛出HttpException异常时，HttpExceptionFilter的catch()方法就会被调用，并在其中执行相应的处理逻辑。

在catch()方法中，我们首先获取了请求和响应对象，然后根据异常的类型和错误信息，为用户提供一个友好的响应。

如何自定义异常过滤器

我们可以通过创建自定义的异常过滤器来处理应用程序中的异常。以下是一些自定义异常过滤器的示例：

全局异常过滤器： 全局异常过滤器可以捕获应用程序中的所有异常，无论它们是由什么原因引起的。这是最简单的异常过滤器类型，它只需要创建一个继承自ExceptionFilter的子类，并将其注册到NestJS模块中即可。
特定异常过滤器： 特定异常过滤器可以捕获特定类型的异常。例如，我们可以创建一个捕获所有HttpException异常的过滤器，或者创建一个捕获所有ValidationError异常的过滤器。要创建特定异常过滤器，我们需要创建一个继承自ExceptionFilter的子类，并在其@Catch()装饰器中指定要捕获的异常类型。
异步异常过滤器： 异步异常过滤器允许我们在异常处理逻辑中使用异步代码。要创建异步异常过滤器，我们需要创建一个继承自ExceptionFilter的子类，并在其catch()方法中使用async。

响应异常数据的包装

在异常处理过程中，我们经常需要对异常数据进行包装，以便为用户提供更加友好的响应。例如，我们可以将异常数据包装成一个JSON对象，并添加一些额外的信息，比如错误代码、错误消息和解决方案等。

以下是一个包装异常数据的示例：

const exceptionData = {
  statusCode: exception.status,
  message: exception.message,
  error: exception.error,
};

response.status(exceptionData.statusCode).json(exceptionData);

在上面的示例中，我们将异常数据包装成一个JSON对象，并将其发送给客户端。这样，客户端就可以收到一个包含错误代码、错误消息和解决方案的友好响应。