如何在NestJS启动服务器前完成外部API健康检查？

方法一：在main.ts中前置检查逻辑 #

最直接的方式是在启动NestJS应用前，先手动执行外部API的健康检查，确认通过后再推进启动流程：

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

async function bootstrap() {
  // 替换为你的外部API健康检查地址
  const externalHealthEndpoint = 'https://your-service-domain.com/getHealth';
  const maxRetryTimes = 5;
  const retryInterval = 2000; // 重试间隔（毫秒）
  let healthCheckPassed = false;

  // 带重试的健康检查逻辑
  for (let attempt = 0; attempt < maxRetryTimes; attempt++) {
    try {
      const response = await axios.get(externalHealthEndpoint, { timeout: 5000 });
      if (response.status === 200) {
        healthCheckPassed = true;
        console.log('[健康检查] 外部API状态正常，启动NestJS服务');
        break;
      }
    } catch (err) {
      console.log(`[健康检查] 第${attempt + 1}次失败，${retryInterval / 1000}秒后重试...`);
      await new Promise(resolve => setTimeout(resolve, retryInterval));
    }
  }

  // 检查不通过则终止进程
  if (!healthCheckPassed) {
    console.error('[健康检查] 外部API多次检查失败，终止服务启动');
    process.exit(1);
  }

  // 启动NestJS应用
  const app = await NestFactory.create(AppModule);
  await app.listen(3000);
}

bootstrap();

方法二：利用NestJS的APP_INITIALIZER钩子 #

如果希望把检查逻辑封装到模块中，可以使用APP_INITIALIZER提供者，它会在应用初始化阶段自动执行：

// app.module.ts
import { Module, APP_INITIALIZER } from '@nestjs/common';
import axios from 'axios';

// 健康检查初始化函数
async function verifyExternalServiceHealth() {
  const healthUrl = 'https://your-service-domain.com/getHealth';
  const maxRetries = 5;
  const retryDelay = 2000;

  for (let i = 0; i < maxRetries; i++) {
    try {
      const res = await axios.get(healthUrl, { timeout: 5000 });
      if (res.status === 200) {
        console.log('[健康检查] 外部API验证通过');
        return;
      }
    } catch (error) {
      console.log(`[健康检查] 第${i + 1}次尝试失败，${retryDelay / 1000}秒后重试`);
      await new Promise(resolve => setTimeout(resolve, retryDelay));
    }
  }

  console.error('[健康检查] 外部API不可用，终止应用启动');
  process.exit(1);
}

@Module({
  providers: [
    {
      provide: APP_INITIALIZER,
      useFactory: () => verifyExternalServiceHealth,
      multi: true, // 允许多个初始化器并存
    },
  ],
})
export class AppModule {}

注意事项 #

• 超时与重试：建议添加超时配置和重试机制，避免因临时网络波动导致服务启动失败
• 依赖选择：除了axios，也可以使用node-fetch或原生http模块实现请求，根据项目依赖调整
• 环境变量：可以把外部API地址、重试次数等配置放到环境变量中，方便不同环境切换

内容的提问来源于stack exchange，提问作者Sylvain.L