Nest.js async onModuleInit执行顺序异常问题排查与解决

Nest.js 中，同一模块内 Provider 的 onModuleInit 生命周期钩子没有固定执行顺序——构造函数注入仅保证依赖实例的创建顺序（先创建 RedisService，再创建 ServiceA），但所有实例创建完成后，Nest 会按内部遍历顺序触发 onModuleInit，这就导致了 ServiceA 的初始化逻辑先于 RedisService 执行的情况。

另外，你的 ServiceAModule 中同时在 providers 数组声明了 RedisService，但已经导入了 RedisModule（若 RedisModule 已导出 RedisService），这种重复声明可能会创建新的 RedisService 实例，进一步加剧初始化顺序问题。

方案1：改用 OnApplicationBootstrap 钩子 #

OnApplicationBootstrap 会在所有模块的 onModuleInit 执行完成后才触发，天然保证依赖的初始化完成。

修改 ServiceA 的代码：

import { OnApplicationBootstrap, Logger } from '@nestjs/common';

class ServiceA implements OnApplicationBootstrap {
    private readonly logger = new Logger(ServiceA.name);

    constructor(private readonly redisService: RedisService) {}

    async onApplicationBootstrap(): Promise<void> {
        this.logger.debug('Initializing ServiceA...');
        const client = await this.redisService.getClient();
        // 执行 Redis 客户端相关操作
        this.logger.debug('Initialized ServiceA');
    }
}

方案2：在 RedisService 中暴露初始化完成的 Promise #

让 RedisService 维护一个初始化 Promise，ServiceA 调用 getClient 时等待该 Promise 完成，从根源上避免未初始化的问题。

修改 RedisService：

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

class RedisService {
    private readonly logger = new Logger(RedisService.name);
    private initPromise: Promise<void>;
    private redis: Cluster;

    constructor(private readonly configService: ConfigService) {}

    async onModuleInit(): Promise<void> {
        this.initPromise = this.initRedisClient();
        await this.initPromise;
    }

    private async initRedisClient(): Promise<void> {
        const host = this.configService.get('REDIS_HOST');
        const port = this.configService.get('REDIS_PORT');
        this.logger.log(`Initializing Redis client at ${host}:${port}`);
        this.redis = new Cluster([{ port, host }], clusterConfig);
        // 等待 Redis 集群连接完成（根据 Redis 客户端 API 调整）
        await this.redis.connect();
    }

    async getClient(): Promise<Cluster> {
        // 确保初始化完成后再返回客户端
        await this.initPromise;
        return this.redis;
    }
}

这种方式即使 ServiceA 的 onModuleInit 先执行，调用 getClient 时也会等待 Redis 初始化完成。

方案3：修正模块依赖声明 #

如果 RedisModule 已经导出了 RedisService，移除 ServiceAModule 的 providers 数组中的 RedisService，避免创建重复实例：

@Module({
    imports: [RedisModule],
    controllers: [ServiceAController],
    providers: [ServiceAService], // 移除 RedisService
})
export class ServiceAModule {}

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