NestJS使用@Inject注入SESSION_CONFIG时依赖解析失败求助

问题场景 #

我正在开发一个NPM模块，包含两个核心动态模块：

GameSystemDBModule #

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

import { DATABASE_TYPE, GameSystemDBModuleFactory, IConfig } from './common';
import { GameSystemDBCacheModule } from './cache';
import { GameSystemDBService } from './game-system-db.service';


@Module({})
export class GameSystemDBModule {
  static register<T extends DATABASE_TYPE>(configs: IConfig<T>): DynamicModule {
    return {
      module: GameSystemDBModule,
      imports: [
        GameSystemDBModuleFactory.createModule<T>(configs.databaseConfig),
        GameSystemDBCacheModule.register(configs.cacheConfig),
      ],
      providers: [
        GameSystemDBService,
        {
          provide: 'SESSION_CONFIG',
          useValue: configs.sessionConfig,
        },
      ],
      exports: [GameSystemDBService, 'SESSION_CONFIG'],
    };
  }
}

PostgresGameSystemDBModule #

import { DynamicModule, Module } from '@nestjs/common';
import {
  GAME_SYSTEM_DB_SERVICE_TOKEN,
  IPostgresConnectionConfig,
} from '../common';

import { PostgresGameSystemDBService } from './postgres-game-system-db.service';
import { SequelizeModule } from '@nestjs/sequelize';
import { UserSessionModule } from './user-session';

@Module({})
export class PostgresGameSystemDBModule {
  static register(config: IPostgresConnectionConfig): DynamicModule {
    const providers = [
      {
        provide: GAME_SYSTEM_DB_SERVICE_TOKEN,
        useClass: PostgresGameSystemDBService,
      },
    ];
    return {
      module: PostgresGameSystemDBModule,
      imports: [SequelizeModule.forRoot(config), UserSessionModule],
      providers,
      exports: providers,
    };
  }
}

在PostgresGameSystemDBService中尝试注入依赖时：

import { Inject, Injectable } from '@nestjs/common';

import { GameSystemDBCacheService } from '../cache';
import { SessionConfig } from 'lib/common/types/session-config.type';
import { UserSessionRepository } from './user-session';

@Injectable()
export class PostgresGameSystemDBService implements IGameSystemDBService {
  constructor(
    private readonly userSessionRepository: UserSessionRepository,
    private readonly gameSystemDBCacheService: GameSystemDBCacheService,
    @Inject('SESSION_CONFIG') private readonly sessionConfig: SessionConfig,
  ) {}
}

抛出以下错误：

[Nest] 16076  - 22.09.2023, 10:10:05   ERROR [ExceptionHandler] Nest can't resolve dependencies of the PostgresGameSystemDBService (UserSessionRepository, GameSystemDBCacheService, ?). Please make sure that the argument SESSION_CONFIG at index [2] is available 
in the PostgresGameSystemDBModule context.

Potential solutions:
- Is PostgresGameSystemDBModule a valid NestJS module?
- If SESSION_CONFIG is a provider, is it part of the current PostgresGameSystemDBModule?
- If SESSION_CONFIG is exported from a separate @Module, is that module imported within PostgresGameSystemDBModule?
  @Module({
    imports: [ /* the Module containing SESSION_CONFIG */ ]
  })

已尝试在GameSystemDBModule的exports中添加SESSION_CONFIG，但问题仍未解决。

问题原因 #

NestJS的模块上下文是相互隔离的。GameSystemDBModule作为上层模块导入了PostgresGameSystemDBModule，但下层模块（PostgresGameSystemDBModule）无法直接访问上层模块（GameSystemDBModule）提供的SESSION_CONFIG——即使上层模块导出了该提供者，也需要下层模块主动导入上层模块才能访问，而这里的模块依赖关系是反向的，所以无法生效。

解决方案 #

提供两种可行的修复方式：

方式一：将SESSION_CONFIG传递到PostgresGameSystemDBModule中 #

核心思路是让数据库模块直接持有SESSION_CONFIG的提供者，而非依赖上层模块。

1. 扩展数据库配置接口：在公共文件中新增包含session配置的接口

// src/common/index.ts
import { IPostgresConnectionConfig } from './postgres-config.type';
import { SessionConfig } from './types/session-config.type';

export interface IPostgresModuleConfig extends IPostgresConnectionConfig {
  sessionConfig: SessionConfig;
}

2. 修改PostgresGameSystemDBModule的register方法：在模块内注册SESSION_CONFIG提供者

static register(config: IPostgresModuleConfig): DynamicModule {
  const providers = [
    {
      provide: GAME_SYSTEM_DB_SERVICE_TOKEN,
      useClass: PostgresGameSystemDBService,
    },
    {
      provide: 'SESSION_CONFIG',
      useValue: config.sessionConfig,
    },
  ];
  return {
    module: PostgresGameSystemDBModule,
    imports: [SequelizeModule.forRoot(config), UserSessionModule],
    providers,
    exports: providers,
  };
}

3. 调整GameSystemDBModuleFactory的createModule方法：让它接收并传递session配置

// 假设GameSystemDBModuleFactory的createModule方法逻辑如下
createModule<T extends DATABASE_TYPE>(config: any): DynamicModule {
  if (config.type === DATABASE_TYPE.POSTGRES) {
    // 传递包含sessionConfig的完整配置
    return PostgresGameSystemDBModule.register(config as IPostgresModuleConfig);
  }
  // 其他数据库类型的处理逻辑
}

4. 更新GameSystemDBModule的register调用：将sessionConfig合并到数据库配置中传递

static register<T extends DATABASE_TYPE>(configs: IConfig<T>): DynamicModule {
  return {
    module: GameSystemDBModule,
    imports: [
      GameSystemDBModuleFactory.createModule<T>({
        ...configs.databaseConfig,
        sessionConfig: configs.sessionConfig,
      }),
      GameSystemDBCacheModule.register(configs.cacheConfig),
    ],
    providers: [
      GameSystemDBService,
      {
        provide: 'SESSION_CONFIG',
        useValue: configs.sessionConfig,
      },
    ],
    exports: [GameSystemDBService, 'SESSION_CONFIG'],
  };
}

方式二：将SESSION_CONFIG注册为全局提供者 #

如果SESSION_CONFIG需要在整个应用中全局可用，可以将其标记为全局提供者：

修改GameSystemDBModule中SESSION_CONFIG的提供者定义，添加global: true：

{
  provide: 'SESSION_CONFIG',
  useValue: configs.sessionConfig,
  global: true,
}

这样所有模块无需额外导入，就能直接注入SESSION_CONFIG。注意：全局提供者会增加模块间耦合，仅在配置确实需要全局共享时使用。

验证 #

修改完成后重启应用，NestJS即可正确解析PostgresGameSystemDBService中的SESSION_CONFIG依赖。

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