Nest通用工具函数执行顺序

本文介绍如何利用请求流程去记忆这些通用函数的执行顺序,解决不知道时候用通用函数的问题

通用工具函数执行流程

通用工具函数这里包括Middleware中间件、Exception filters异常过滤器、Pipes管道、Guards守卫、Interceptors拦截器

执行流程为中间件→守卫→拦截器→管道→拦截器→异常管理器

中间件

cors中间件为例,这是用于处理跨域的一个函数,代码如下:

ts 复制代码
consumer.apply(cors()).forRoutes(CatsController); // 文档代码

这是第一层关卡,如果存在跨域状况,那么后续的就直接不存在请求流程,所以中间件处在执行顺序的第一位

守卫

以用于划分权限路由守卫为例,如果不具备当前控制器所需要的权限,则无权执行路由,代码如下:

ts 复制代码
@@filename(cats.controller)
@Post()
@Roles(['admin'])
async create(@Body() createCatDto: CreateCatDto) {
  this.catsService.create(createCatDto);
}

也就是即使不存在跨域 问题,如果用户不具备某个权限,也无法执行请求流程,所以守卫排在第二位

拦截器

拦截器是比较特殊的,可用于在方法执行之前/之后绑定额外的逻辑,这一步已经处于请求执行过程 以文档中的代码为例:

ts 复制代码
@@filename(logging.interceptor)
import { Injectable, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
import { Observable } from 'rxjs';
import { tap } from 'rxjs/operators';

@Injectable()
export class LoggingInterceptor implements NestInterceptor {
  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    console.log('Before...');

    const now = Date.now();
    return next
      .handle()
      .pipe(
        tap(() => console.log(`After... ${Date.now() - now}ms`)),
      );
  }
}

在执行路由处理程序之前,会输出Before...,而在执行完后,将输出After... 1ms,这是通过rxjs操作流实现的,可见在请求之前和请求之后都可执行拦截器的逻辑

所以过了守卫之后,会遇到拦截器,排在执行顺序的第三位(或第五位)

管道

管道的作用是对请求的数据进行处理,例如将字符串类型转换为Int类型,便于数据处理,代码如下:

ts 复制代码
@Get(':id')
async findOne(@Param('id', ParseIntPipe) id: number) {
  return this.catsService.findOne(id);
}

所以这一阶段是位于请求之中 了(实际上处于进入路由但没进入路由处理程序的阶段),即拦截器请求之前的下一位,故处于请求流程的第四位

异常过滤器

异常过滤器主要用于抛出错误反馈给客户端,通常结合```try...catch``,代码如下:

ts 复制代码
@@filename(cats.controller)
@Get()
async findAll() {
  try {
    await this.service.findAll()
  } catch (error) {
    throw new HttpException({
      status: HttpStatus.FORBIDDEN,
      error: 'This is a custom message',
    }, HttpStatus.FORBIDDEN, {
      cause: error
    });
  }
}

反馈信息是请求的最后流程,所以异常过滤器是最后执行顺序的最后一步

相关推荐
Cosolar16 分钟前
QwenPaw Agent 实现原理深度剖析
后端·面试·架构
Sincerelyplz40 分钟前
【AI会议纪要实践】mapReduce、RAG 与结构化输出
java·后端·agent
xiaohua0708day41 分钟前
Lodash库
前端·javascript·vue.js
突然好热1 小时前
TS 调试技巧
前端·javascript·typescript
zavoryn1 小时前
后端接入 AI Agent:Tool Calling 网关、幂等与审计日志实战
后端·架构
h64648564h1 小时前
Flutter 国际化(i18n)全指南:一键切换中/英/日多语言
前端·javascript·flutter
swipe2 小时前
混合检索 RAG 的工程化实践:不是多查几路,而是把召回、重排和上下文预算管好
后端·langchain·llm
uzong2 小时前
分布式下的系统,什么是算是好的架构设计
后端·架构
丷丩2 小时前
MapLibre GL JS第8课:禁用滚动缩放
javascript·mapbox·maplibre gl js
金銀銅鐵3 小时前
[Java] 如何理解 class 文件中方法的 access flags?
java·后端