NestJS中特定API调用时跳过日志记录的最佳实现方式

你设想的@SkipLog装饰器+标识判断跳过日志的思路完全可行，属于NestJS AOP编程的常规用法，不存在生态兼容问题。唯一可以优化的点是不需要给req对象挂载自定义属性，用NestJS原生的元数据能力实现会更规范，不会污染请求对象。

直接利用NestJS内置的SetMetadata和Reflector实现，不需要额外依赖：

1. 定义@SkipLog装饰器

import { SetMetadata } from '@nestjs/common';
export const SKIP_LOG_METADATA = 'skip_log';
export const SkipLog = () => SetMetadata(SKIP_LOG_METADATA, true);

2. 在现有日志拦截器中增加元数据判断逻辑

import { Injectable, NestInterceptor, ExecutionContext, CallHandler, Logger } from '@nestjs/common';
import { Reflector } from '@nestjs/core';
import { Observable } from 'rxjs';
import { tap } from 'rxjs/operators';
import { SKIP_LOG_METADATA } from './skip-log.decorator';

@Injectable()
export class AccessLogInterceptor implements NestInterceptor {
  private readonly logger = new Logger('AccessLog');
  constructor(private readonly reflector: Reflector) {}

  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    // 同时读取方法级、类级的元数据，方法级优先级更高
    const needSkipLog = this.reflector.getAllAndOverride<boolean>(SKIP_LOG_METADATA, [
      context.getHandler(),
      context.getClass(),
    ]);
    // 命中跳过规则直接放行，不执行后续日志逻辑
    if (needSkipLog) {
      return next.handle();
    }

    // 保留你原有的业务日志打印逻辑即可
    const request = context.switchToHttp().getRequest();
    const startTs = Date.now();
    return next.handle().pipe(
      tap(() => {
        this.logger.log(`${request.method} ${request.url} cost: ${Date.now() - startTs}ms`);
      })
    );
  }
}

3. 在需要跳过日志的接口上添加装饰器即可生效

import { Controller, Get } from '@nestjs/common';
import { SkipLog } from './skip-log.decorator';

@Controller('health')
export class HealthController {
  @Get()
  @SkipLog() // 加这一行即可跳过该接口的访问日志
  healthCheck() {
    return { status: 'ok' };
  }
}

针对K8s健康检查日志的场景，还有几个实现成本更低的方案可以选：

• 路径白名单过滤：如果健康检查路径固定（比如/health、/ready、/live），直接在日志拦截器最开头判断请求路径，命中白名单就直接跳过日志逻辑，不需要自定义装饰器，也不需要给每个健康检查接口加注解，代码量最少。
• 利用官方健康检查模块的配置：如果你用NestJS官方的Terminus健康检查模块，模块本身内置了关闭健康检查路由访问日志的配置项，直接在模块注册时打开对应开关即可，不需要自己写判断逻辑。
• 日志层直接过滤：如果你用nestjs-pino、nest-winston这类日志框架的NestJS适配包，基本都自带请求日志过滤配置，直接把健康检查路径加入过滤列表即可，不需要修改业务层的拦截器代码。

注意：尽量不要往req对象上挂载自定义属性做逻辑判断，NestJS的元数据体系本身就是为这类横切逻辑设计的，不会污染原生请求对象，也能避免和其他中间件、拦截器产生属性命名冲突。

内容的提问来源于stack exchange，提问作者Tiziano