深入理解Node.js中的CommonJS模块系统-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01147/article/details/148505666

深入理解Node.js中的CommonJS模块系统

jstutorial Javascript tutorial book 项目地址: https://gitcode.com/gh_mirrors/js/jstutorial

CommonJS模块系统是Node.js的核心组成部分，它为JavaScript带来了模块化编程的能力。本文将全面解析CommonJS规范在Node.js中的实现细节，帮助开发者更好地理解和使用模块系统。

模块基础概念

在Node.js中，每个文件都被视为一个独立的模块，拥有自己的作用域。这意味着在一个模块中定义的变量、函数或类默认情况下对其他模块是不可见的。

// mathUtils.js
const PI = 3.14159;

function circleArea(radius) {
  return PI * radius * radius;
}

上面的PI和circleArea只能在mathUtils.js中使用，其他模块无法直接访问它们。

模块导出机制

Node.js提供了两种导出方式：

module.exports：这是模块系统的主要导出接口
exports：这是对module.exports的一个引用

使用module.exports

// logger.js
const logLevel = 'INFO';

function log(message) {
  console.log(`[${logLevel}] ${message}`);
}

module.exports = {
  log
};

使用exports

// calculator.js
exports.add = (a, b) => a + b;
exports.subtract = (a, b) => a - b;

注意：不能直接对exports重新赋值，这会切断它与module.exports的联系。

模块导入机制

使用require函数可以导入其他模块：

const logger = require('./logger');
const { add, subtract } = require('./calculator');

logger.log('Module system example');
console.log(add(5, 3)); // 8

模块加载规则

Node.js的模块加载遵循一套明确的规则：

核心模块：直接使用模块名，如require('fs')
文件模块：
- 相对路径：require('./module')
- 绝对路径：require('/path/to/module')
目录模块：
- 查找目录下的package.json的main字段
- 如果没有package.json，查找index.js或index.node
node_modules查找：从当前目录向上递归查找node_modules

模块缓存机制

Node.js会对加载过的模块进行缓存，以提高性能：

// 第一次加载会执行模块代码
const mod1 = require('./module');
// 第二次加载直接从缓存读取
const mod2 = require('./module');

console.log(mod1 === mod2); // true

可以通过require.cache查看或清除缓存：

// 查看缓存
console.log(require.cache);
// 删除特定模块缓存
delete require.cache[require.resolve('./module')];

循环依赖处理

当模块A依赖模块B，而模块B又依赖模块A时，Node.js会如何处理？

// a.js
exports.loaded = false;
const b = require('./b');
exports.loaded = true;

// b.js
exports.loaded = false;
const a = require('./a');
exports.loaded = true;

这种情况下，Node.js会返回未完全加载的模块副本，开发者需要注意这种场景。