Node.js中通过环境变量配置灵活文件读取路径的问题

核心思路 #

通过Node.js的path模块结合当前文件的目录位置，动态计算应用根目录，自动适配相对路径和**根相对路径（以/开头）**两种格式，生成正确的文件读取路径，避免依赖环境变量的路径前缀。

应用结构回顾 #

app
  +---resources
      +--xml
      +-------data.xml
  +---file-utils
      +---- fs-utils.ts

具体实现步骤 #

1. 计算应用根目录

从fs-utils.ts所在的file-utils目录向上回溯一级，即可得到app根目录。根据模块类型分别处理：

• ES模块（使用import语法）
  在调用readData的文件中添加路径计算逻辑：

  import { fileURLToPath } from 'url';
  import { dirname, resolve } from 'path';
  import fs from 'fs';
  
  // 获取当前文件的绝对路径
  const __filename = fileURLToPath(import.meta.url);
  // 获取当前文件所在目录
  const __dirname = dirname(__filename);
  // 计算应用根目录（app目录）
  const appRoot = resolve(__dirname, '..');
  

• CommonJS模块（使用require语法）
  直接利用内置的__dirname计算：

  const { resolve } = require('path');
  const fs = require('fs');
  
  // 计算应用根目录（app目录）
  const appRoot = resolve(__dirname, '..');
  

2. 适配两种路径格式

修改环境变量读取逻辑，自动解析不同格式的路径：

let file = process.env.DATA_PATH || '';
if (file.trim().length === 0) {
  throw new Error('File is a required field');
}

// 解析路径：如果以/开头，从appRoot拼接；否则统一基于appRoot解析
const resolvedPath = file.startsWith('/') 
  ? resolve(appRoot, file.slice(1))  // 去掉开头的/，从根目录拼接
  : resolve(appRoot, file);  // 非根相对路径也基于appRoot解析，避免工作目录影响

// 调用读取函数
processData(resolvedPath);

3. 保留原有读取函数

你的readData函数无需修改，直接传入解析后的绝对路径即可：

export async function readData(fileName: string) {
  try {
    const data = await fs.promises.readFile(fileName, 'utf8');
    return data;
  } catch (err) {
    console.log(err);
    return null;
  }
}

效果验证 #

现在可以支持两种环境变量设置方式：

• 根相对路径格式：export DATA_PATH=/resources/xml/data.xml
• 相对路径格式：export DATA_PATH=../app/resources/xml/data.xml
  甚至直接设置为resources/xml/data.xml也能正确解析。

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