NestJS单例类DI适配：兼容遗留代码并注入HttpService

针对既要保留遗留代码的getInstance()调用、又要接入NestJS DI注入HttpService的需求，以下两种可行的折中方案：

方案一：用NestJS容器托管单例，静态方法从容器取实例 #

这种方式完全让NestJS IoC容器管理单例生命周期，静态方法仅作为容器实例的"入口"，适合后续逐步移除getInstance()调用，彻底转向DI注入。

步骤1：改造提供者类 #

移除手动维护的静态实例，通过ModuleRef从容器获取实例：

import { Injectable, ModuleRef } from '@nestjs/common';
import { HttpService } from '@nestjs/axios';
import { AppModuleRef } from './app-module-ref';

@Injectable()
export class MCMProviderImplementation implements IProvider {
  constructor(
    private readonly http: HttpService,
    private readonly moduleRef: ModuleRef,
  ) {}

  public static getInstance(): MCMProviderImplementation {
    // 从全局存储的ModuleRef中获取容器管理的单例
    return AppModuleRef.get().get(MCMProviderImplementation);
  }

  // 原有私有/公共方法保持不变
}

步骤2：全局存储根ModuleRef #

创建一个工具类存储根模块的ModuleRef，让静态方法能访问容器：

import { ModuleRef } from '@nestjs/common';

export class AppModuleRef {
  private static moduleRef: ModuleRef;

  static set(ref: ModuleRef) {
    this.moduleRef = ref;
  }

  static get(): ModuleRef {
    return this.moduleRef;
  }
}

步骤3：根模块初始化时绑定ModuleRef #

import { Module, OnModuleInit } from '@nestjs/common';
import { AppModuleRef } from './app-module-ref';
import { MCMProviderImplementation } from './mcm-provider';

@Module({
  providers: [MCMProviderImplementation],
  exports: [MCMProviderImplementation], // 若其他模块需要注入，需导出
})
export class AppModule implements OnModuleInit {
  constructor(private readonly moduleRef: ModuleRef) {}

  onModuleInit() {
    // 把根模块的ModuleRef存入全局工具类
    AppModuleRef.set(this.moduleRef);
  }
}

方案二：IoC初始化后自动绑定静态实例 #

这种方式最小化改动原有代码结构，让Nest创建的实例自动赋值给静态属性，兼容旧的getInstance()调用逻辑。

改造提供者类 #

实现OnModuleInit接口，在模块初始化时把IoC创建的实例绑定到静态属性：

import { Injectable, OnModuleInit } from '@nestjs/common';
import { HttpService } from '@nestjs/axios';

@Injectable()
export class MCMProviderImplementation implements IProvider, OnModuleInit {
  private static instance: MCMProviderImplementation | null = null;

  constructor(private readonly http: HttpService) {}

  onModuleInit() {
    // 模块启动后，将IoC创建的单例赋值给静态属性
    MCMProviderImplementation.instance = this;
  }

  public static getInstance(): MCMProviderImplementation {
    // 兼容旧代码，若实例未初始化则抛出提示（需确保调用时机在Nest启动后）
    if (this.instance === null) {
      throw new Error('MCMProviderImplementation 未被NestJS容器初始化，请确保在应用启动后调用');
    }
    return this.instance;
  }

  // 原有私有/公共方法保持不变
}

模块注册 #

正常在模块中注册该提供者即可（Nest默认单例模式）：

import { Module } from '@nestjs/common';
import { MCMProviderImplementation } from './mcm-provider';

@Module({
  providers: [MCMProviderImplementation],
  exports: [MCMProviderImplementation],
})
export class AppModule {}

方案对比 #

• 方案一：更贴合NestJS DI设计，无手动实例维护，但依赖全局ModuleRef，适合长期逐步迁移到完全DI注入。
• 方案二：改动量最小，保留原有静态实例逻辑，但需确保所有getInstance()调用都在Nest应用启动之后，适合短期过渡。

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