CommonJS 是一种模块规范,旨在为 JavaScript 提供一个模块系统,使得开发者可以在服务器端和客户端之间共享代码。CommonJS 规范定义了一套 API,用于模块的定义和加载。Node.js 是 CommonJS 规范的一个重要实现。
一、CommonJS 的主要特点:
模块化:每个文件都是一个独立的模块,具有自己的作用域。
同步加载:模块是同步加载的,适用于服务器端环境。
导出和导入:使用 module.exports 导出模块,使用 require 导入模块。
二、示例代码
定义模块
在 CommonJS 中,你可以通过 module.exports 导出模块:
// math.js
function add(a, b) {
return a + b;
}
function subtract(a, b) {
return a - b;
}
module.exports = {
add,
subtract
};
导入模块
使用 require 导入模块:
// app.js
const math = require('./math');
console.log(math.add(2, 3)); // 输出: 5
console.log(math.subtract(5, 2)); // 输出: 3
三、CommonJS 的优势
- 简单易用:语法简单,容易上手。
- 广泛支持:Node.js 原生支持 CommonJS 模块。
- 模块隔离:每个模块都有自己的作用域,避免了全局变量污染。
四、CommonJS 与其他模块系统的比较
- CommonJS vs. AMD:AMD(Asynchronous Module Definition)主要用于浏览器环境,支持异步加载模块。CommonJS 主要用于服务器端,模块是同步加载的。
- CommonJS vs. ES Modules:ES Modules 是 JavaScript 的官方模块系统,支持静态分析和树摇优化。CommonJS 是动态加载的,不支持静态分析。
五、结论
CommonJS 是一个强大的模块系统,特别适用于服务器端的 JavaScript 开发。它的简单性和广泛支持使其成为 Node.js 开发的标准选择。随着 ES Modules 的普及,CommonJS 可能会逐渐被取代,但在现有的 Node.js 生态系统中,它仍然占据重要地位。