如何在NestJS中加载同一模块的多个不同配置实例？

我有一个NestJS模块X，用于对接第三方API，该模块配置包含baseURL、username、password。现在希望在NestJS项目中让模块X支持多个不同配置的API实例（不同的baseURL、username、password），尝试过动态导入模块后用LazyModuleLoader加载，但LazyModuleLoader始终返回同一个模块实例，无法创建不同配置的实例。

要实现NestJS模块的多实例，核心是让每个模块实例拥有唯一的标识，让Nest容器将它们视为独立模块。以下是两种可行方案：

方案一：改造模块X，支持带唯一标识的动态模块 #

修改模块X的forRoot方法，允许传入自定义令牌（token），基于该令牌注册独立的配置和服务，确保每个实例的依赖相互隔离。

1. 改造模块X的定义 #

// x.module.ts
import { DynamicModule, Module } from '@nestjs/common';
import { ApiService } from './api.service';
import { Configuration } from './configuration';

// 生成唯一令牌，用于区分不同实例的配置和服务
export const getApiConfigToken = (instanceId: string) => `API_CONFIG_${instanceId}`;
export const getApiServiceToken = (instanceId: string) => `API_SERVICE_${instanceId}`;

@Module({})
export class ApiModule {
  static forRoot(instanceId: string, config: Configuration): DynamicModule {
    return {
      module: ApiModule,
      providers: [
        {
          provide: getApiConfigToken(instanceId),
          useValue: config,
        },
        {
          provide: getApiServiceToken(instanceId),
          useFactory: (config: Configuration) => new ApiService(config),
          inject: [getApiConfigToken(instanceId)],
        },
      ],
      exports: [getApiServiceToken(instanceId)],
    };
  }
}

2. 加载多实例示例 #

在业务服务中通过LazyModuleLoader加载不同标识的实例：

import { Injectable, LazyModuleLoader } from '@nestjs/common';
import { ApiModule, getApiServiceToken } from './x.module';
import { Configuration } from './configuration';

@Injectable()
export class AppService {
  constructor(private readonly lazyModuleLoader: LazyModuleLoader) {}

  async initApiInstances() {
    // 实例1：配置A
    const configA: Configuration = {
      basePath: 'https://api.example.com/v1',
      username: 'userA',
      password: 'passA',
    };
    const moduleRefA = await this.lazyModuleLoader.load(() => 
      ApiModule.forRoot('INSTANCE_A', configA)
    );
    const apiServiceA = moduleRefA.get(getApiServiceToken('INSTANCE_A'));

    // 实例2：配置B
    const configB: Configuration = {
      basePath: 'https://api.example.com/v2',
      username: 'userB',
      password: 'passB',
    };
    const moduleRefB = await this.lazyModuleLoader.load(() => 
      ApiModule.forRoot('INSTANCE_B', configB)
    );
    const apiServiceB = moduleRefB.get(getApiServiceToken('INSTANCE_B'));

    // 分别调用不同实例的服务
    await apiServiceA.fetchData();
    await apiServiceB.fetchData();
  }
}

方案二：包装模块，强制创建独立实例 #

如果无法修改模块X的源码，可以通过动态创建临时包装模块，为每个实例赋予唯一名称，避免Nest容器缓存重复模块：

// 包装模块工厂函数，生成唯一标识的临时模块
const createApiModuleWrapper = (instanceId: string, config: Configuration) => {
  @Module({
    imports: [
      ApiModule.forRoot(() => new Configuration({
        basePath: config.baseUrl,
        username: config.userName,
        password: config.password,
      })),
    ],
  })
  class TempApiModule {}

  // 修改临时模块名称，确保每个实例唯一
  Object.defineProperty(TempApiModule, 'name', {
    value: `TempApiModule_${instanceId}`,
  });

  return TempApiModule;
};

// 使用示例
async loadApiInstances() {
  // 加载实例A
  const configA = {
    baseUrl: 'https://api.example.com/v1',
    userName: 'userA',
    password: 'passA',
  };
  const moduleRefA = await this.lazyModuleLoader.load(() => 
    createApiModuleWrapper('A', configA)
  );
  const apiServiceA = moduleRefA.get(ApiService);

  // 加载实例B
  const configB = {
    baseUrl: 'https://api.example.com/v2',
    userName: 'userB',
    password: 'passB',
  };
  const moduleRefB = await this.lazyModuleLoader.load(() => 
    createApiModuleWrapper('B', configB)
  );
  const apiServiceB = moduleRefB.get(ApiService);
}

NestJS模块容器会根据模块的name属性和依赖关系做缓存，只要让每个模块实例的标识（自定义令牌或模块名称）唯一，就能避免被缓存，从而创建多个独立的模块实例。

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