前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >NestJS 7.x 折腾记: (6) 异常过滤器,取其精华去其糟粕!比如响应异常数据的包装~

NestJS 7.x 折腾记: (6) 异常过滤器,取其精华去其糟粕!比如响应异常数据的包装~

作者头像
CRPER
发布2022-03-08 14:58:34
1.2K0
发布2022-03-08 14:58:34
举报
文章被收录于专栏:CRPER折腾记

前言

正如官方所说: 内置的异常层负责处理整个应用程序中的所有抛出的异常。 当捕获到未处理的异常时,最终用户将收到友好的响应。

image.png
image.png

NestJS提供了一波拿来即用的内置异常过滤器; 在@nestjs/common里面,搜索下Exception就有~ 我们来一个具体的例子(全局异常过滤), 基于内置的异常过滤器实现,采用第三方日志(pino)记录异常日志, 做一些处理并包裹返回信息;

效果图

image.png
image.png

实战

代码语言:javascript
复制
# 基于cli生成filter模板
nest g f common/filters/http-exception
http-exception.filter.ts
代码语言:javascript
复制
// 日期格式化库,很小巧,类moment 风格api
import * as dayjs from 'dayjs';

import {
  ArgumentsHost,
  Catch,
  ExceptionFilter,
  HttpException,
  HttpStatus,
} from '@nestjs/common';
// nest默认底层是基于express封装,所以可以直接引入
import { Request, Response } from 'express';
// 第三方logger
import { Logger } from 'nestjs-pino';

// 捕获请求异常类型
// 可以传递多个参数,所以你可以通过逗号分隔来为多个类型的异常设置过滤器。
@Catch(HttpException)
export class HttpExceptionFilter implements ExceptionFilter {
  // 我们要把异常塞到自定义logger,必须引入对应的实例
  // 在构建函数声明定义下,从外部传入
  constructor(private readonly logger: Logger) {}
  
  catch(exception: HttpException, host: ArgumentsHost) {
    // 把请求相关的参数转成标准http的上下文
    // 有兴趣可以点进去,GPRC,WEBSOCKET都能直接转换
    // 也能直接拿到一些参数的及返回上下文类型
    const ctx = host.switchToHttp();
    // 响应体
    const response = ctx.getResponse<Response>();
    // 请求体
    const request = ctx.getRequest<Request>();
    
    // 判断状态是否为请求异常,否则直接抛回来服务内部错误
    const status =
      exception instanceof HttpException
        ? exception.getStatus()
        : HttpStatus.INTERNAL_SERVER_ERROR;
    
    // 此刻的时间
    const nowDate = dayjs(Date.now()).format('YYYY-MM-DDTHH:mm:ss');
    
    // 包装异常信息
    const errorResponse = {
      statusCode: status,
      message: exception.message,
      error: exception.name,
      date: nowDate,
      path: request.url,
    };

    // 记录异常信息到第三方logger
    this.logger.error(
      `【${nowDate}】${request.method} ${request.url} query:${JSON.stringify(
        request.query,
      )} params:${JSON.stringify(request.params)} body:${JSON.stringify(
        request.body,
      )}`,
      JSON.stringify(errorResponse),
      'HttpExceptionFilter',
    );
    
    // 塞回去响应体,也就是客户端请求可以感知到的
    response.status(status).json(errorResponse);
  }
}
主入口(main.ts)
代码语言:javascript
复制
import { AppModule } from './app.module';
import { HttpExceptionFilter } from './common/filters/http-exception.filter';
import { Logger } from 'nestjs-pino';
import { NestFactory } from '@nestjs/core';
async function bootstrap() {
  const app = await NestFactory.create(AppModule, {
    cors: false,
    logger: false,
  });
  // 获取pino logger实例 
  const logger = app.get(Logger);
  // nestjs-pino 取代nest logger
  app.useLogger(logger);


  // 设置全局异常过滤器
  app.useGlobalFilters(new HttpExceptionFilter(logger));
  await app.listen(configService.get('SERVE_LISTENER_PORT'));
}
bootstrap()
app.module.ts

若是只要特定模块生效可以使用Providers去实现,从核心模块导出;

代码语言:javascript
复制
import { Module } from '@nestjs/common';
// 包括网关,拦截器都可以走这种模式!
import { APP_FILTER } from '@nestjs/core';
import { HttpExceptionFilter } from './common/filters/http-exception.filter';
@Module({
  providers: [
    {
      provide: APP_FILTER,
      useClass: HttpExceptionFilter,
    },
  ],
})
export class AppModule {}

若是加上@Global装饰器也能达到全局模块的效果! 这个东东一般不推荐用在app.module,而是你需要导出的复用模块! 这里只是演示写法

代码语言:javascript
复制
import { Module,Global } from '@nestjs/common';
import { APP_FILTER } from '@nestjs/core';

@Global()
@Module({
  providers: [
    {
      provide: APP_FILTER,
      useClass: HttpExceptionFilter,
    },
  ],
})
export class AppModule {}

@Global() 推荐用于给外部复用,又需要变成全局模块的,比如

代码语言:javascript
复制
import { Module, Global } from '@nestjs/common';
import { CatsController } from './cats.controller';
import { CatsService } from './cats.service';

@Global()
@Module({
  controllers: [CatsController],
  providers: [CatsService],
  exports: [CatsService],
})
export class CatsModule {}

总结

有不对之处请留言,会及时修正!谢谢阅读~

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2020/11/16 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 前言
  • 效果图
  • 实战
    • http-exception.filter.ts
      • 主入口(main.ts)
        • app.module.ts
        • 总结
        领券
        问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档