【Node.js】CommonJS 模块化规范详解

文章目录

CommonJS 模块化规范是 Node.js 中默认的模块系统，它为服务器端 JavaScript 提供了一种结构化和模块化的开发方式。通过 CommonJS 规范，开发者可以将代码分成不同的模块，并且轻松地进行加载和使用。本文将详细介绍 CommonJS 模块化规范的核心概念、用法以及与 ES Modules 的区别。

一、CommonJS 模块化概述

1. 什么是 CommonJS？

CommonJS 是一套为 JavaScript 提供模块化支持的规范，它最初的目标是为服务器端 JavaScript 提供模块化机制。Node.js 采用了 CommonJS 作为其模块系统的基础，帮助开发者更好地组织代码，避免命名冲突，同时支持模块重用。

2. CommonJS 的特点

CommonJS 模块化有以下几个显著特点：

• 同步加载：CommonJS 模块是同步加载的，意味着在服务器端执行时，模块会在代码执行时立即加载。
• 单例模式：每个模块在第一次加载后会被缓存，后续的加载将直接返回缓存中的实例。
• 模块导出：使用 module.exports 或 exports 将模块的内容暴露给外部使用。
• 模块引入：通过 require() 函数引入模块。

3. 为什么需要模块化？

在开发大型应用时，模块化设计有助于将代码分成更小、更易管理的部分。模块化提供了以下好处：

• 代码重用：通过模块化，可以将通用功能封装到模块中，不同的文件可以共享这些功能。
• 代码隔离：模块化有助于避免变量命名冲突和全局污染，确保模块内的变量和函数在其作用域内可见。
• 提高可维护性：将项目分成多个模块后，每个模块只负责其特定的功能，开发者可以更轻松地调试和维护代码。

二、CommonJS 的基本用法

1. 模块导出

在 CommonJS 中，使用

module.exports

或

exports

对象将模块中的内容导出。

module.exports

是整个模块的出口对象，而

exports

是

module.exports

的引用，可以用来简化导出操作。

例子：使用

module.exports

导出

// math.jsfunctionadd(a, b){return a + b;}functionsubtract(a, b){return a - b;}

module.exports ={
  add,
  subtract,};

在这个示例中，

add

和

subtract

函数通过

module.exports

对象导出。

例子：使用

exports

导出

// greet.js
exports.sayHello=function(name){return`Hello, ${name}!`;};

在此示例中，

exports

是

module.exports

的引用，它将

sayHello

函数导出。

2. 模块引入

使用

require()

函数引入其他模块。

require()

接受模块的路径或者模块的名称，并返回导出的对象。

例子：引入模块

// app.jsconst math =require('./math');const greet =require('./greet');

console.log(math.add(2,3));// 输出 5
console.log(greet.sayHello('World'));// 输出 Hello, World!

在这个例子中，

require()

函数分别引入了

math

和

greet

模块，并且可以直接调用这些模块中导出的函数。

三、CommonJS 模块加载机制

1. 加载流程

CommonJS 模块在加载时会经历以下几个步骤：

1. 路径解析：require() 会先根据传入的参数解析路径。如果是本地模块（如 ./math），则直接查找文件；如果是核心模块（如 fs、http 等），则直接从 Node.js 内置模块中加载。
2. 文件定位：Node.js 会尝试按顺序查找以下几种文件格式： - .js 文件：作为 JavaScript 文件加载。- .json 文件：作为 JSON 文件加载，解析为对象。- .node 文件：加载为编译后的二进制模块。
3. 编译和执行：模块文件加载后，Node.js 会对 JavaScript 代码进行编译，然后执行模块代码。
4. 缓存模块：加载的模块会被缓存，后续对同一模块的 require() 调用将直接返回缓存中的结果，避免重复加载。

2. 单例模式与缓存机制

CommonJS 模块是单例模式，意味着每个模块在第一次加载后会被缓存。如果多次

require()

同一个模块，返回的将是相同的实例。

例子：模块缓存

// counter.jslet count =0;

exports.increment=function(){
  count++;return count;};js
// app.jsconst counter1 =require('./counter');const counter2 =require('./counter');

console.log(counter1.increment());// 输出 1
console.log(counter2.increment());// 输出 2

在上面的例子中，虽然

counter1

和

counter2

分别通过

require()

引入

counter

模块，但它们共享相同的模块实例，因此输出结果连续增长。

四、CommonJS 与 ES Modules 的区别

1. 导入和导出语法

CommonJS 使用

module.exports

和

require()

进行导入导出，而 ES Modules 使用

export

和

import

语法。

CommonJS 示例：

// commonjs.jsconst math =require('./math');
module.exports = math;

ES Modules 示例：

// esm.jsimport{ add, subtract }from'./math';export{ add, subtract };

2. 加载方式

CommonJS 模块是同步加载的，适合服务器端环境；而 ES Modules 支持异步加载，更适合浏览器端环境。

3. 动态引入

在 CommonJS 中，可以通过

require()

动态引入模块；而在 ES Modules 中，动态导入使用

import()

，它返回一个

Promise

，更加灵活。

CommonJS 动态引入：

if(condition){const moduleA =require('./moduleA');}

ES Modules 动态引入：

if(condition){import('./moduleA').then(module=>{// 使用 module});}

4. 模块缓存机制

CommonJS 模块加载后会被缓存，而 ES Modules 默认不缓存，除非明确指定。

五、实际应用场景

1. 服务端开发

由于 Node.js 默认采用 CommonJS 模块规范，因此在开发服务器端应用时，CommonJS 是最常见的模块化方式。它的同步加载机制非常适合服务器端环境。

2. 前端开发

随着 ES Modules 在浏览器中的广泛支持，前端开发通常会选择 ES Modules，但在构建工具（如 Webpack）中，CommonJS 仍然可以通过转换支持前端应用。

六、总结

CommonJS 是 Node.js 的核心模块化规范，提供了简单易用的模块导入导出方式。虽然随着 ES Modules 的普及，前端领域逐渐转向使用 ESM，但在服务器端开发中，CommonJS 依然占据重要地位。理解它的模块机制、加载流程和缓存机制，有助于开发者在构建复杂 Node.js 应用时更好地组织代码。希望本文能帮助你全面了解 CommonJS 模块化规范，并在实际项目中更好地应用它。

推荐：

• JavaScript
• react
• vue