NestJS中异步设置TypeScript类属性出现undefined问题

核心问题 #

你遇到的问题本质是构造函数无法等待异步方法完成：

• 父类ApiClient的构造函数直接调用了异步的setupBaseUrl()，但构造函数本身是同步执行的，不会等待异步操作结束。
• 子类MyService重写的setupBaseUrl()里，先给baseUrl赋值为'Something Wrong'，然后才异步拉取配置。如果在await this.config.get()完成前调用printBaseUrl()，就会拿到这个临时值；即使等待一段时间，也可能因为构造阶段的异步调用没有被正确等待，导致后续逻辑出现不一致。

另外，NestJS的依赖注入流程是同步的，构造函数中执行异步操作本身就不符合框架的生命周期规范。

修复方案 #

改用NestJS的生命周期钩子（比如OnModuleInit）来执行异步初始化逻辑，确保配置拉取完成后再对外提供服务。

修改后的代码如下：

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

@Injectable()
export abstract class ApiClient implements OnModuleInit {
    protected abstract readonly logger: Logger;
    protected baseUrl: string;

    constructor(protected readonly config: ConfigClientService) {}

    // 实现OnModuleInit接口，在模块初始化时执行异步操作
    async onModuleInit() {
        await this.setupBaseUrl();
    }

    async setupBaseUrl() {
        this.logger.debug('Base Setup');
        this.baseUrl = 'Nothing';
        return true;
    }
}

@Injectable()
export class MyService extends ApiClient {
    protected readonly logger = new Logger(MyService.name);

    constructor(protected readonly config: ConfigClientService) {
        super(config);
    }

    async setupBaseUrl() {
        this.baseUrl = 'Something Wrong';
        // 等待配置拉取完成后再赋值
        this.baseUrl = await this.config.get('serviceUrl');
        this.logger.debug('Normal');
        return true;
    }

    async printBaseUrl() {
        this.logger.debug(this.baseUrl);
        return 'Done';
    }
}

关键改动说明 #

• 让ApiClient实现OnModuleInit接口，重写onModuleInit方法，在这个方法里等待setupBaseUrl()执行完成。
• 移除父类构造函数中对setupBaseUrl()的直接调用，交由NestJS的生命周期管理来触发异步初始化。
• 这样可以保证在MyService的任何方法被调用前，baseUrl已经完成了从配置服务的拉取和赋值。

额外建议 #

如果需要确保baseUrl一定被初始化后才能使用，可以在printBaseUrl等方法中添加检查，比如：

async printBaseUrl() {
    if (!this.baseUrl) {
        throw new Error('Base URL not initialized');
    }
    this.logger.debug(this.baseUrl);
    return 'Done';
}

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