NestJS 执行时间监控装饰器实现方案

在开发基于 NestJS 的分布式系统时，监控接口执行时间是一个常见的需求。当某些接口响应过慢时，我们需要快速定位性能瓶颈。本文将介绍如何在 NestJS 中实现一个优雅的执行时间监控方案。

核心思路

NestJS 的拦截器(Interceptor)机制非常适合用于实现执行时间监控。拦截器可以在方法执行前后插入自定义逻辑，这正是我们需要的。

实现方案

1. 创建时间监控拦截器

首先，我们创建一个可配置的拦截器，它能够：

1. 记录方法开始执行的时间
2. 在方法执行完成后计算耗时
3. 当执行时间超过阈值时输出警告日志

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

@Injectable()
export class TimeoutInterceptor implements NestInterceptor {
  constructor(private readonly threshold: number) {}

  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    const now = Date.now();
    const handlerName = context.getHandler().name;

    return next.handle().pipe(
      tap(() => {
        const executionTime = Date.now() - now;
        if (executionTime > this.threshold) {
          console.warn(
            `警告: ${handlerName} 方法执行时间 ${executionTime}ms 超过阈值 ${this.threshold}ms`
          );
        }
      }),
    );
  }
}

2. 创建装饰器工厂

为了使使用更加简洁，我们可以创建一个装饰器工厂函数：

import { UseInterceptors } from '@nestjs/common';

export const MaxExecutionTime = (threshold: number) => 
  UseInterceptors(new TimeoutInterceptor(threshold));

使用示例

在控制器中，我们可以这样使用这个装饰器：

import { Controller, Get } from '@nestjs/common';
import { MaxExecutionTime } from './timeout.decorator';

@Controller('example')
export class ExampleController {
  @Get()
  @MaxExecutionTime(500) // 设置500ms的阈值
  async getData() {
    // 这里是一些可能耗时的操作
    return { data: 'some data' };
  }
}

高级用法

1. 集成日志系统

我们可以将简单的 console.warn 替换为 NestJS 的 Logger 服务，实现更专业的日志记录：

import { Logger } from '@nestjs/common';

// 在拦截器中
const logger = new Logger('PerformanceMonitor');
logger.warn(
  `警告: ${handlerName} 方法执行时间 ${executionTime}ms 超过阈值 ${this.threshold}ms`
);

2. 添加性能指标收集

除了日志警告，我们还可以将性能数据收集起来，用于后续分析：

import { PrometheusService } from '../monitoring/prometheus.service';

// 在拦截器中
const metricsService = new PrometheusService();
metricsService.recordApiDuration(handlerName, executionTime);

注意事项

1. 异步操作：拦截器已经正确处理了异步操作，包括 Promise 和 Observable
2. 异常情况：如果方法抛出异常，拦截器仍然会计算执行时间
3. 性能开销：虽然拦截器本身会引入少量性能开销，但在大多数情况下可以忽略不计

总结

通过自定义拦截器和装饰器，我们在 NestJS 中实现了一个灵活的执行时间监控方案。这种实现方式具有以下优点：

1. 非侵入性：不需要修改业务逻辑代码
2. 可配置性：可以针对不同接口设置不同的阈值
3. 可扩展性：可以轻松添加更多监控功能

这种模式不仅适用于执行时间监控，还可以应用于其他横切关注点，如日志记录、缓存、权限检查等，是 NestJS 中间件架构的一个典型应用场景。