NestJS自定义拦截器注入Reflector报依赖解析错误解决方法

问题复现 #

开发NestJS拦截器时，需要读取控制器方法上通过自定义装饰器配置的元数据，在拦截器构造函数注入Reflector实例时服务启动抛出依赖解析错误，手动在模块imports、providers中添加Reflector仍无法解决。
相关代码片段：

• 拦截器实现

@Injectable()
export class MyCustomInterceptor implements CacheInterceptor {
  private reflector: Reflector;

  constructor(reflector: Reflector) {
    this.reflector = reflector;
  }

  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    const myReflectionData = this.reflector.get<string[]>('mykey', context.getHandler());
  //...

• 自定义元数据装饰器

import { applyDecorators, SetMetadata } from '@nestjs/common';

export const MyCustomDecorator = (listOfData: Array<string>) => applyDecorators(
  SetMetadata('mykey', listOfData),
);

• 控制器使用

@MyCustomDecorator(['data1', 'data2'])
@UseInterceptors(MyCustomInterceptor)
@Get()
async listMyData(
  @Query('limit') limit = 10,
  @Query('skip') skip = '',
  @Query('orderBy') orderBy = 'id',
  @Query('sort') sort = 'DESC',
) {
  // 业务逻辑
}

启动报错核心信息：

Nest can't resolve dependencies of the MyCustomInterceptor (?). Please make sure that the argument Reflector at index [0] is available in the CommunitiesModule context.

Potential solutions:

• If Reflector is a provider, is it part of the current MyAppModule?
• If Reflector is exported from a separate @Module, is that module imported within MyAppModule?

错误根因 #

Reflector是NestJS内置的全局可用Provider，由@nestjs/core的根模块默认提供，完全不需要手动在业务模块中注册。出现这个报错90%以上是两个原因：

1. 拦截器文件没有显式从@nestjs/core导入Reflector类型，TS编译后类型元数据丢失，Nest依赖注入容器无法识别要注入的依赖项
2. 拦截器没有注册到当前模块的providers数组中，Nest在@UseInterceptors中实例化拦截器时脱离了DI容器，无法完成依赖注入
   另外代码里还有个隐含问题：拦截器实现的接口应该是NestInterceptor，不是CacheInterceptor——后者是Nest内置缓存拦截器的实现类，不是接口类型。

修复步骤 #

1. 补全拦截器文件的导入项，修正接口实现，代码调整如下：

// 必须显式导入Reflector
import { Injectable, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
import { Reflector } from '@nestjs/core';
import { Observable } from 'rxjs';

@Injectable()
// 修正实现的接口为NestInterceptor
export class MyCustomInterceptor implements NestInterceptor {
  // 直接用TS参数属性简写，不用手动给类属性赋值
  constructor(private reflector: Reflector) {}

  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    const myReflectionData = this.reflector.get<string[]>('mykey', context.getHandler());
    // 你的业务逻辑
    // 必须返回next.handle()，否则请求会挂起
    return next.handle();
  }
}

2. 在使用该拦截器的业务模块（报错提示中提到的CommunitiesModule/MyAppModule）中，将拦截器加入providers数组：

import { Module } from '@nestjs/common';
import { MyCustomInterceptor } from './interceptors/my-custom.interceptor';
import { MyController } from './my.controller';

@Module({
  controllers: [MyController],
  providers: [MyCustomInterceptor], // 注册拦截器到当前模块
})
export class MyAppModule {}

3. 如果你是全局绑定拦截器，不要用app.useGlobalInterceptors(new MyCustomInterceptor())这种手动实例化的方式——手动new出来的实例脱离Nest DI容器，自然无法注入依赖，要改用模块级全局拦截器注册方式：

import { Module } from '@nestjs/common';
import { APP_INTERCEPTOR } from '@nestjs/core';
import { MyCustomInterceptor } from './interceptors/my-custom.interceptor';

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

额外优化建议 #

不要硬编码元数据key，单独抽成常量维护，避免装饰器和拦截器两边key写不一致导致读不到元数据：

// 新建src/common/constants/metadata.constant.ts
export const MY_CUSTOM_METADATA_KEY = 'mykey';

装饰器和拦截器中都引用这个常量即可。 #

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