栈记
Nest

拦截器 interceptor

NestInterceptor 方法与返回值转换

说明

拦截器是个一个可以被注入的类,实现了 NestInterceptor

可以在方法的前后绑定额外的逻辑、将方法的返回结果进行转换、变化方法抛出的异常、扩展函数的基本行为

该方法接受两个参数 ExecutionContext 和 CallHandler 并返回一个 Observable 的对象

  1. ExecutionContext 继承 ArgumentsHost 在异常过滤器中提到过

  2. CallHandler 中有个很重要的 handler 方法 返回值是一个 Observable 对象,可以把它看做是 controller 中的路由方法,必须要调用这个方法才能让请求继续下来,不然就会被挂起

  3. Observable 这是 RxJS 的核心,参考;

记录接口访问时长

import { Injectable, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
import { Observable } from 'rxjs';
import { tap } from 'rxjs/operators';

@Injectable()
export class LoggerInterceptor implements NestInterceptor {
  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    const now = Date.now()
    return next.handler().pipe(tap(() => console.log(`${Date.now() - now}ms...`)));
  }
}

使用拦截器

同样有三种使用方式,controller, global, appModule。 全局不太方便依赖注入;

// users.controller.ts
import { UseInterceptors } from '@nestjs/common';

// 可以在控制器或者某个方法上面使用
@UseIntercetors(LoggerInterceptor)
export class UsersController() {}

// main.ts
const app = await NestFactory.create(AppModule);
app.useGlobalInterceptors(new LoggingInterceptor());

// app.module.ts
import { APP_INTERCEPTOR } from '@nestjs/core';

@Module({
  providers: [{ provide: APP_INTERCEPTOR, useClass: LoggingInterceptor }]
})
export class AppModule {}

修改接口的返回结构

常规情况下接口的返回都会拥有一些通用的字段。可以通过 Rxjs 中的 map 方法对返回做出修改,或者增加超时限制,或者增加错误捕获。

import { Injectable, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
import { Observable, of } from 'rxjs';
import { map, catchError, timeout } from 'rxjs/operators';

@Injectable()
export class LoggerInterceptor implements NestInterceptor {
  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    const res = context.switchToHttp().getResponse<Response>()

    return next.handler().pipe(
      // 超过 5s 抛出异常
      timeout(5000),
      // 映射返回值
      map(data => ({ code: res.statusCode, data })),
      // 捕获错误并且返回
      catchError((err: Error) => of({ code: res.statusCode, data: err.message })),
    );
  }
}

On this page