基于NestJS DI创建非Web请求场景下的服务实例问题

问题描述 #

在使用NestJS依赖注入（DI）时遇到两个场景问题（官方文档仅覆盖基础用法）：

• 构建AppModule后，如何在非Web请求场景（如Moleculer托管的RabbitMQ处理器）创建DocumentService实例？
• 该场景下DocumentService依赖的USER实例需以不同于Web请求的方式注入，该如何实现？

现有代码示例 #

DocumentService 定义

@Injectable()
class DocumentService {
    @Inject('USER') user: IUser;
    @Inject() protected userRepository: UserRepository;
    @Inject() protected documentRepository: DocumentRepository;

    public saveDocument() {
        // 业务逻辑实现
    } 
}

AppModule 配置

@Module({
    controllers: [DocumentController],
    providers: [
        // 仓储类
        UserRepository, DocumentRepository, 
        // 服务类
        DocumentService,
        // Web请求场景下的USER注入逻辑
        {
            provide: 'USER',
            scope: Scope.REQUEST,
            useFactory: (req: Request) => req["user"] ?? null,
        },
    ],
    exports: ['USER'],
})
export class AppModule {}

期望实现效果

希望在非Web场景中能灵活注入自定义USER实例，同时保留Web请求场景的原有DI配置：

const rabbitMqUser = new User('rabbitMqServiceUser');
// 获取使用rabbitMqUser作为USER依赖的DocumentService实例
const documentService = /* NestJS DI容器创建实例并替换USER依赖 */;

解决方案 #

1. 非Web场景创建Service实例：使用独立应用上下文 #

Nest提供独立应用模式，可以在不启动HTTP服务器的情况下初始化完整的DI容器，用于非Web场景：

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

// 在RabbitMQ处理器初始化阶段执行
async function initRabbitMQProcessor() {
  // 创建独立应用上下文，加载AppModule的DI配置
  const appContext = await NestFactory.createApplicationContext(AppModule);
  // 上下文创建后即可获取或定制Service实例
}

2. 替换非Web场景的USER依赖：两种实现方式 #

方案一：创建专用模块覆盖提供者

通过创建针对RabbitMQ场景的专用模块，继承原模块并替换USER的注入逻辑：

@Module({
  imports: [AppModule],
  providers: [
    {
      provide: 'USER',
      useValue: new User('rabbitMqServiceUser'), // 非Web场景的固定用户实例
    },
  ],
  exports: [DocumentService],
})
export class RabbitMQModule {}

然后在独立容器中初始化该模块，获取实例：

const appContext = await NestFactory.createApplicationContext(RabbitMQModule);
const documentService = appContext.get(DocumentService);
// 此时documentService.user即为rabbitMqServiceUser

方案二：动态覆盖容器中的提供者

如果不需要新增模块，可以在初始化上下文后，动态替换USER的实现：

async function getDocumentServiceForRabbitMQ(customUser: IUser) {
  const appContext = await NestFactory.createApplicationContext(AppModule);
  
  // 定位到AppModule，覆盖USER提供者的实例
  appContext.select(AppModule)
    .overrideProvider('USER')
    .useValue(customUser);
  
  // 获取覆盖依赖后的DocumentService实例
  const documentService = appContext.get(DocumentService);
  return documentService;
}

// 使用示例
const rabbitMqUser = new User('rabbitMqServiceUser');
const documentService = await getDocumentServiceForRabbitMQ(rabbitMqUser);

关键注意事项

• 原USER的Scope.REQUEST配置仅在Web请求场景生效，非Web场景的独立容器不会处理请求作用域，替换时无需保留该配置。
• 如果需要为每条RabbitMQ消息使用不同用户，可以在消息处理前调用上述动态覆盖方法，传入对应用户实例。

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