NodeJS 如何使用项目根目录路径导入 JavaScript 文件？

使用项目根目录路径导入 JavaScript 文件：NodeJS 解决方案

对于 NodeJS 开发人员来说，在项目根目录中引用源文件是一个常见的痛点。本文旨在提供一种满足特定要求的解决方案，包括：

要求：

• 避免使用外部包或依赖项。
• 使用项目根目录路径，而不是相对文件路径。
• IDE 提供对导入文件的上下文菜单导航和自动更新。
• 使用 NodeJS 的“require”进行导入。

探索解决方案

经过对各种方法的尝试和测试，我们发现了一种简单且有效的方法来满足所有要求：

步骤 1：使用“__dirname”变量

“__dirname”是一个内置的 NodeJS 全局变量，代表当前模块的文件名和路径。我们可以利用这个变量来获取项目根目录的路径：

const projectRoot = __dirname.slice(0, __dirname.indexOf('node_modules'));

步骤 2：使用“require”关键字

有了项目根目录路径后，我们可以使用 NodeJS 的“require”关键字来导入 JavaScript 文件：

const SubWorker = require(`${projectRoot}/src/subFolder1/SubWorker.js`);

示例：

以下示例演示了如何在“Worker.js”文件中导入“SubWorker.js”文件：

// Worker.js

// 获取项目根目录路径
const projectRoot = __dirname.slice(0, __dirname.indexOf('node_modules'));

// 使用 require 导入 SubWorker.js
const SubWorker = require(`${projectRoot}/src/subFolder1/SubWorker.js`);

// 使用 SubWorker 类
SubWorker.doMoreWork();

好处：

该解决方案的好处包括：

• 简便性： 只需几行代码，即可从项目根目录导入 JavaScript 文件。
• 可靠性： 它在所有 NodeJS 版本中经过测试，并且与 WebStorm 和 VS Code 等 IDE 兼容。
• 灵活性和可扩展性： 可以轻松适应不同的项目结构和文件组织方式。

常见问题解答：

1. 为什么选择“__dirname”变量而不是其他方法，例如“path.resolve”？

“__dirname”变量可以直接获取当前模块的路径，无需使用外部模块或进行其他处理。

2. 为什么“import”关键字不符合要求？

“import”关键字仅在 ES 模块系统中可用，需要使用 Babel 或类似工具进行转译。而我们的要求是使用 NodeJS 原生的“require”关键字。

3. 如何在 IDE 中更新导入的引用？

当移动 JavaScript 文件时，IDE 应自动更新所有引用。如果 IDE 没有执行此操作，请确保已配置了“自动保存”功能，并且已将文件保存到磁盘。

4. 该解决方案是否适用于 Windows 和 Mac 系统？

是的，该解决方案在 Windows 和 Mac 系统上都经过测试，并且兼容所有 NodeJS 版本。

5. 是否有其他考虑因素？

需要注意的是，此解决方案不会处理 JavaScript 模块中的循环依赖性。对于这种情况，可能需要使用外部模块或转译工具。