Node.js中axios请求响应完成后如何正确导出env配置对象

问题本质 #

CommonJS 模块的导出逻辑是同步执行的，axios 发起的异步网络请求不会阻塞后续代码运行，所以导出 env 对象时，请求还没有返回，protocol和opticalIp还没有被赋值。以下是3种可行的实现方案：

方案1：导出初始化函数（兼容性最佳，支持所有Node.js版本） #

该方案通过导出异步初始化方法，确保调用时已经完成接口请求和env组装，支持重复调用时复用已经请求到的配置，避免重复发起网络请求。

配置文件代码 #

const axios = require('axios');

let env = null;

async function initEnv() {
  // 已经初始化过直接返回结果，避免重复请求
  if (env) return env;
  try {
    // 注意：原代码的请求URL缺少http/https协议前缀，必须补全否则axios会报错
    const response = await axios.get(`http://www.mydomain.com/api`);
    let protocol = '';
    let opticalIp = '';
    if(response.data && response.data.data) {
      protocol = response.data.data['scheme'];
      opticalIp = response.data.data['optical_ip'];
    }
    env = {
      API_URL: `${protocol}://${opticalIp}/`,
      configHeaders: ''
    };
    return env;
  } catch (error) {
    console.log('配置请求失败：', error);
    // 抛出错误给上层调用方处理
    throw error;
  }
}

module.exports = initEnv;

引用方使用代码 #

const initEnv = require('./你的配置文件名');

async function main() {
  const env = await initEnv();
  // 拿到完整配置后再执行业务逻辑
  console.log(env.API_URL);
}

main();

方案2：导出Promise实例 #

适合不想额外封装函数的场景，直接导出自执行异步函数返回的Promise，引用时await即可拿到配置。

配置文件代码 #

const axios = require('axios');

module.exports = (async () => {
  try {
    const response = await axios.get(`http://www.mydomain.com/api`);
    let protocol = '';
    let opticalIp = '';
    if(response.data && response.data.data) {
      protocol = response.data.data['scheme'];
      opticalIp = response.data.data['optical_ip'];
    }
    return {
      API_URL: `${protocol}://${opticalIp}/`,
      configHeaders: ''
    };
  } catch (error) {
    console.log('配置请求失败：', error);
    throw error;
  }
})();

引用方使用代码 #

const envPromise = require('./你的配置文件名');

async function main() {
  const env = await envPromise;
  console.log(env.API_URL);
}

main();

方案3：ES模块顶层await（Node.js 14.8+ 版本支持） #

如果你的项目使用ES模块规范（文件后缀为.mjs，或者package.json中配置"type": "module"），可以直接使用顶层await，模块会等待异步逻辑执行完成后再导出。

配置文件代码 #

import axios from 'axios';

const response = await axios.get(`http://www.mydomain.com/api`);
let protocol = '';
let opticalIp = '';
if(response.data && response.data.data) {
  protocol = response.data.data['scheme'];
  opticalIp = response.data.data['optical_ip'];
}

const env = {
  API_URL: `${protocol}://${opticalIp}/`,
  configHeaders: ''
};

export default env;

引用方使用代码 #

import env from './你的配置文件名.mjs';
console.log(env.API_URL);

注意事项 #

原代码中axios.get的请求URL缺少http/https协议前缀，直接填写域名会被axios识别为相对路径，导致请求失败，必须补全协议前缀。

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