nestjs 全栈进阶--异常过滤器

1. 介绍

在NestJS中，异常过滤器（Exception Filters）是一种强大的错误处理机制，它允许开发者捕获和处理应用程序中发生的异常。这些过滤器可以全局或局部地应用于控制器或特定路由，以提供统一的错误处理和响应格式化。

nest new filter -p pnpm

2. 作用

1. 统一错误响应：异常过滤器可以标准化应用程序的错误响应格式，确保客户端接收到的错误信息一致且易于理解。
2. 错误转换：它可以将内部异常转换为更友好的错误信息，避免向客户端暴露敏感的内部错误详情。
3. 日志记录：异常过滤器可以用来记录错误日志，便于开发人员追踪和调试问题。
4. 错误处理逻辑：它允许开发者定义自定义的错误处理逻辑，例如重定向、事务回滚等。
5. 性能优化：通过在过滤器中处理异常，可以避免不必要的中间件调用，提高应用程序性能。

3. 基础使用

我们在之前的学习过程中，我们会发现，有时我们访问错了路由，他会给我们一个404的错误，对吧？这个就是nest的Exception Filte捕获并返回给我们的。还有类似的500,400等错误捕获

他的错误返回，不一定满足我们的需求，那么这个时候我们就需要自定义错误过滤器了，这里我们先快速回顾下我们在aop中讲的内容

nest g filter test --no-spec --flat

我们对他进行一下修改

import { ArgumentsHost, BadRequestException, Catch, ExceptionFilter } from '@nestjs/common';
import { Response } from 'express';

// @Catch 指定要捕获的异常，比如指定 BadRequestException
@Catch(BadRequestException)
export class TestFilter implements ExceptionFilter {
  catch(exception: BadRequestException, host: ArgumentsHost) {
    console.log(exception);
    console.log(host);

    const http = host.switchToHttp();
    const response = http.getResponse<Response>();

    const statusCode = exception.getStatus();

    response.status(statusCode).json({
       code: statusCode,
       message: exception.message,
       error: 'Bad Request'
    })
  }
}

全局使用

手动抛个错

4. 捕获所有错误

我们刚刚@Catch(BadRequestException)这个只捕获了BadRequestException，那如果我们这里不是BadRequestException错，他会怎么样呢？

可以看到，他又是默认的报错了，并不会走我们定义的过滤器，那我们是不是可以把@Catch 指定成 HttpException，因为HttpException是其他Exception的父类

现在就行了

5. 结合ValidationPipe

pnpm install class-validator class-transformer

新建一个aaaDto

可以看到他进我们的过滤器了，但是这明显不是我们希望的，我们希望的是他把我们字段错误也给返回，所以我们需要去调整我们的拦截器了

6. 自定义Exception

我们之前都是用的nest自带的exception，现在我们来试试，自己定义

import { ArgumentsHost, BadRequestException, Catch, ExceptionFilter, HttpException, HttpStatus } from '@nestjs/common';
import { Response } from 'express';


export class CustomException{
  message: string;

  constructor(message?: string){
    this.message = message;
  }
}

// @Catch 指定要捕获的异常，比如指定 BadRequestException
@Catch(CustomException)
export class TestFilter implements ExceptionFilter {
  catch(exception: CustomException, host: ArgumentsHost) {

    const http = host.switchToHttp();
    const response = http.getResponse<Response>();

    response.status(401).json({
       code: 401,
       message:  exception.message || '自定义错误',
       error: 'error'
    })
  }
}