面试题：Node.js模块解析优先级与复杂路径

Question

在Node.js项目中，有如下目录结构：根目录下有`app.js`，`node_modules`文件夹，以及`lib`文件夹。`lib`文件夹中有`subdir`子文件夹，`subdir`中有`util.js`。`util.js`导出了一个类。现在，在`app.js`中尝试通过不同方式引入`util.js`，比如使用相对路径、使用NODE_PATH环境变量（假设已正确设置指向`lib`文件夹），并且说明这两种引入方式在模块路径解析优先级中的差异，以及在实际应用场景中各自的优缺点。

Answer 1

使用相对路径引入

在app.js中可以这样引入：

const Util = require('./lib/subdir/util.js');

• 模块路径解析优先级：相对路径引入方式，Node.js会根据当前文件的位置，按照指定的相对路径去查找模块。在这种情况下，会直接从当前app.js所在目录下的lib/subdir中寻找util.js，优先级较高，只要路径正确就能准确找到模块。
• 优点：
  • 路径明确，与项目的目录结构紧密相关，直观易懂。即使项目的整体目录结构发生变化，只要相对关系不变，引入依然有效。
  • 不会受到NODE_PATH环境变量等外部配置的影响，模块的查找相对稳定。
• 缺点：
  • 如果项目目录结构复杂，相对路径可能会变得很长且难以维护，例如在多层嵌套目录中，相对路径会显得冗长。
  • 不利于代码的复用，如果需要在不同位置复用模块，相对路径可能需要根据位置不同而修改。

使用NODE_PATH环境变量引入

假设NODE_PATH已正确设置指向lib文件夹，在app.js中可以这样引入：

const Util = require('subdir/util.js');

• 模块路径解析优先级：当使用NODE_PATH引入模块时，Node.js会在NODE_PATH指定的目录中查找模块。其优先级低于相对路径引入，如果存在同名模块，相对路径引入的模块会优先被加载。只有在相对路径找不到模块时，才会去NODE_PATH指定的目录查找。
• 优点：
  • 可以简化模块引入路径，特别是在项目目录结构复杂时，使用NODE_PATH可以避免冗长的相对路径。
  • 方便代码复用，不同位置引入模块时路径一致，无需根据不同位置修改相对路径。
• 缺点：
  • 依赖于NODE_PATH环境变量的配置，如果配置不正确或在不同环境中配置不一致，可能导致模块引入失败。
  • 不够直观，模块的实际位置与引入路径没有直接关联，增加了理解代码的难度。
  • 由于优先级较低，可能会出现同名模块被相对路径引入的模块覆盖的情况，导致预期外的行为。