NestJS无法访问应用上下文模块依赖图的解决方案咨询

方案一：注入Nest应用实例，每次请求生成依赖图 #

这个方案能满足「每次请求调用SpelunkerModule.explore(app)」的需求，核心是把Nest的应用实例注入到服务中，让控制器可以调用服务方法实时生成依赖图。

1. 定义注入令牌
   创建一个常量文件（比如src/common/constants.ts），用来标记应用实例的注入标识：

export const NEST_APP_INSTANCE = Symbol('NEST_APP_INSTANCE');

2. 在main.ts中注入应用实例
   启动应用时，把创建好的app实例注册为全局提供者：

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { NEST_APP_INSTANCE } from './common/constants';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  // 将app实例注入为全局可用的提供者
  app.provide(NEST_APP_INSTANCE, { useValue: app });
  await app.listen(3000);
}
bootstrap();

3. 创建依赖图服务
   新建一个服务（比如src/module-graph/module-graph.service.ts），注入应用实例并封装生成依赖图的方法：

import { Inject, Injectable } from '@nestjs/common';
import { INestApplication } from '@nestjs/common';
import { SpelunkerModule } from 'nestjs-spelunker';
import { NEST_APP_INSTANCE } from '../common/constants';

@Injectable()
export class ModuleGraphService {
  constructor(@Inject(NEST_APP_INSTANCE) private readonly app: INestApplication) {}

  // 每次调用都会重新生成依赖图
  generateModuleGraph() {
    return SpelunkerModule.explore(this.app);
  }
}

4. 在控制器中使用服务
   创建控制器（比如src/module-graph/module-graph.controller.ts），注入服务并暴露接口：

import { Controller, Get } from '@nestjs/common';
import { ModuleGraphService } from './module-graph.service';

@Controller('module-graph')
export class ModuleGraphController {
  constructor(private readonly moduleGraphService: ModuleGraphService) {}

  @Get()
  getModuleGraph() {
    // 每次请求都会触发依赖图生成
    return this.moduleGraphService.generateModuleGraph();
  }
}

最后别忘了在对应的模块（比如AppModule）中导入并注册这个控制器和服务。

方案二：启动时生成依赖图，注入全局模块 #

如果你的模块结构是静态的（运行时不会动态添加/移除模块），可以在启动时一次性生成依赖图，注入到全局模块中，避免每次请求的性能开销。

1. 定义依赖图的注入令牌

export const MODULE_GRAPH = Symbol('MODULE_GRAPH');

2. 创建动态模块
   新建一个动态模块（比如src/module-graph/module-graph.module.ts），通过forRoot方法接收预先生成的依赖图：

import { DynamicModule, Module } from '@nestjs/common';
import { MODULE_GRAPH } from '../common/constants';

@Module({})
export class ModuleGraphModule {
  static forRoot(graph: any): DynamicModule {
    return {
      module: ModuleGraphModule,
      providers: [
        {
          provide: MODULE_GRAPH,
          useValue: graph,
        },
      ],
      exports: [MODULE_GRAPH],
      global: true, // 标记为全局模块，其他模块无需导入即可注入
    };
  }
}

3. 在main.ts中注册动态模块
   启动应用时生成依赖图，再注册这个动态模块：

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { SpelunkerModule } from 'nestjs-spelunker';
import { ModuleGraphModule } from './module-graph/module-graph.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  // 启动时生成一次依赖图
  const moduleGraph = SpelunkerModule.explore(app);
  // 将动态模块注册到已构建的应用中
  await app.register(ModuleGraphModule.forRoot(moduleGraph));
  await app.listen(3000);
}
bootstrap();

4. 在控制器中注入使用
   直接通过令牌注入依赖图：

import { Controller, Get, Inject } from '@nestjs/common';
import { MODULE_GRAPH } from '../common/constants';

@Controller('module-graph')
export class ModuleGraphController {
  constructor(@Inject(MODULE_GRAPH) private readonly moduleGraph: any) {}

  @Get()
  getModuleGraph() {
    return this.moduleGraph;
  }
}

注意事项 #

• 如果选择方案一，频繁调用SpelunkerModule.explore()可能会有性能损耗，建议只在开发环境启用，或者给生成方法添加缓存逻辑（比如用@CacheKey和@CacheTTL装饰器）。
• 确保nestjs-spelunker版本与你的NestJS版本兼容，避免出现上下文读取异常。

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