7 CommonJS模块简介

在学习Node.js的过程中，理解模块系统是至关重要的一步。今天，我们将探讨Node.js采用的默认模块系统——CommonJS模块。通过本教程，你将了解到CommonJS模块的基本概念、用法，以及如何在Node.js应用程序中使用它们来组织代码。

1. 什么是CommonJS模块？

CommonJS是一个模块标准，它定义了如何在JavaScript环境中创建和使用模块。Node.js采用了这一标准，允许开发者将代码分割成小的可重用的模块，使得开发过程更加高效和管理便利。

1.1 模块的基本特性

• 封闭性：模块内的变量和函数是局部的，不会污染全局作用域。
• 可重用性：模块可以被其他模块引入，避免代码重复。
• 依赖管理：模块可以指定其所需要的其他模块，方便依赖管理。

2. 创建和使用CommonJS模块

2.1 创建模块

在Node.js中，模块实际上是文件。下面我们来创建一个简单的自定义模块。

创建一个名为math.js的文件：

// math.js
function add(a, b) {
    return a + b;
}

function subtract(a, b) {
    return a - b;
}

// 导出模块中的函数
module.exports = {
    add,
    subtract
};

在这个示例中，我们定义了两个函数：add和subtract。使用module.exports将这两个函数导出，使得其他模块可以使用它们。

2.2 使用模块

现在我们可以在另一个文件中引入上面的math.js模块。创建一个名为app.js的文件：

// app.js
const math = require('./math');

const sum = math.add(5, 3);
const difference = math.subtract(5, 3);

console.log(`Sum: ${sum}`); // 输出: Sum: 8
console.log(`Difference: ${difference}`); // 输出: Difference: 2

在app.js中，我们使用require函数引入了math.js模块，并调用了模块中的add和subtract函数。

3. CommonJS模块的详细用法

3.1 逐步导出

除了导出整个对象外，CommonJS允许逐步导出模块的内容。例如，我们可以在math.js中逐个导出函数：

// math.js
function add(a, b) {
    return a + b;
}

function subtract(a, b) {
    return a - b;
}

exports.add = add;
exports.subtract = subtract;

这样在app.js中仍然可以通过相同的方式使用这些导入的函数。

3.2 导入JSON文件

Node.js也支持导入JSON文件作为模块。例如，如果我们有一个名为config.json的配置文件：

{
    "host": "localhost",
    "port": 8080
}

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

// app.js
const config = require('./config.json');

console.log(`Host: ${config.host}, Port: ${config.port}`); // 输出: Host: localhost, Port: 8080

3.3 循环依赖

使用CommonJS时需要注意循环依赖的问题。例如，当两个模块相互依赖时，Node.js会根据需要加载模块的部分内容。

// moduleA.js
const moduleB = require('./moduleB');
console.log('This is module A');

module.exports = 'Module A';

// moduleB.js
const moduleA = require('./moduleA');
console.log('This is module B');

module.exports = 'Module B';

虽然moduleA.js和moduleB.js互相依赖，但Node.js会处理这种循环依赖，保证加载不会崩溃。

4. 总结

在本篇中，我们深入探讨了CommonJS模块的概念、创建与使用方式，以及如何在Node.js应用中利用其特性来组织代码。通过模块化，你可以更好地管理代码，提升项目的可维护性。

接下来，我们将会讨论另一种模块系统——ES模块，这种模块系统在现代JavaScript开发中越来越流行。敬请期待！