common.js 源码

CommonJS 是一种用于 JavaScript 模块化的标准，在 Node.js 环境中被原生支持，以下是对 CommonJS 源码的详细解析：

CommonJS 模块的基础结构

1、模块表示：在 Node.js 中，每个文件都被视为一个独立的模块，由Module 构造函数创建实例来表示，当加载一个文件时，会执行类似new Module(id, parent) 的操作，其中id 通常是文件的绝对路径，parent 是父模块（如果有的话），模块实例具有一些属性，如id（模块标识）、path（模块所在文件夹路径）、exports（导出的内容）、filename（文件名）、loaded（是否已加载）等。

2、模块的创建与初始化：当创建一个新模块时，会设置其基本属性。exports 属性初始为空对象，用于后续存储模块导出的内容，会将该模块实例添加到父模块的children 列表中，以维护模块之间的层级关系。

CommonJS 的核心方法

1、require 方法

功能：用于引入其他模块，它是 CommonJS 模块系统中最重要的方法之一，通过指定模块的路径或标识符来加载并返回相应的模块。

实现原理：在 Node.js 源码中，require 方法首先会检查缓存，如果所需模块已被缓存且未修改，则直接从缓存中获取；否则，会按照一定的规则搜索模块文件，找到后进行加载和编译，并将结果缓存起来以供后续使用。

示例：假设有两个模块文件moduleA.js 和moduleB.js，在moduleB.js 中可以通过const moduleA = require('./moduleA.js'); 来引入moduleA.js 模块，并在后续代码中使用moduleA 提供的接口和功能。

2、module.exports 和 exports

功能：用于将模块的导出内容暴露给其他程序，以便其他程序可以通过require 方法引入并使用该模块的功能。

区别与联系：module.exports 是模块对象自带的一个属性，它的值默认是一个空对象，而exports 实际上是module.exports 的一个快捷引用（在模块初始化时，exports 被赋值为module.exports），在为模块添加属性或方法时，可以直接向exports 或module.exports 添加，效果是一样的，但如果重新赋值exports，如exports = someValue;，则会破坏module.exports 和exports 之间的引用关系，导致原本的module.exports 不再指向新的exports 对象。

示例：在moduleA.js 中可以这样写：

     const sayHello = () => {
       console.log('Hello, World!');
     };
     module.exports = {
       sayHello
     };
     // 或者
     // exports.sayHello = sayHello;

然后在moduleB.js 中通过require('./moduleA.js') 引入后，就可以使用moduleA.sayHello() 来调用sayHello 函数。

3、load 方法

功能：负责加载模块文件的内容，它会读取文件，并将其内容传递给模块的_compile 方法进行编译执行。

实现细节：在加载过程中，会根据文件扩展名调用相应的处理函数来处理不同类型的文件，对于.js 文件，会使用特定的处理逻辑来解析和执行 JavaScript 代码。

4、_compile 方法

功能：对加载的模块代码进行编译和执行，它会将模块的源代码包裹在一个函数作用域中，以确保模块内部的变量和函数不会被墙全局命名空间，然后将编译后的函数放入缓存中以便后续重复使用。

作用：通过这种方式，每个模块都有自己独立的作用域，实现了模块化的封装和隔离，避免了不同模块之间的变量冲突和相互影响。

CommonJS 的缓存机制

1、缓存原理：Node.js 会将加载过的模块缓存到内存中，当再次需要加载同一个模块时，会先检查缓存中是否存在该模块的编译结果，如果存在且模块未被修改过，则直接从缓存中返回该模块的导出对象，而不会再去重新加载和编译模块文件，这样可以提高模块加载的性能，尤其是在多次引用同一模块的情况下。

2、缓存的影响：缓存机制虽然提高了性能，但也可能带来一些问题，在开发过程中，如果修改了模块的代码，可能需要清除缓存或重新启动应用程序才能使修改生效，因为缓存中的旧版本可能仍然被使用。

CommonJS 的循环引用处理

1、问题描述：循环引用是指在两个或多个模块之间出现了相互依赖的情况，即模块 A 依赖于模块 B，而模块 B 又依赖于模块 A，这种情况如果不妥善处理，会导致模块加载的过程中出现死循环，从而引发错误。

2、解决方式：Node.js 在处理循环引用时，会在第一次加载模块时只进行部分处理，即只执行模块的声明部分，而不执行模块的导出部分，当所有模块都完成声明后，再依次执行它们的导出部分，从而避免了死循环的发生，但在实际应用中，应尽量避免不必要的循环引用，以保持代码的清晰和可维护性。

CommonJS 的应用场景和优势

1、应用场景：CommonJS 主要用于服务器端的 JavaScript 编程，特别是在构建大型、复杂的应用程序时，它可以方便地将代码拆分成多个模块，每个模块负责特定的功能，从而提高代码的可读性、可维护性和可扩展性，在开发一个 Web 应用的后端服务时，可以将不同的业务逻辑、数据库操作、中间件等功能分别放在不同的模块文件中，然后通过require 方法进行组合和使用。

2、优势：它使得代码的组织更加清晰，易于理解和管理；提高了代码的复用性，减少了重复代码的编写；方便了团队协作开发，不同开发人员可以专注于不同的模块开发；由于模块的独立性，也降低了代码的耦合度，便于进行单元测试和调试。

相关问答FAQs

1、为什么 CommonJS 模块中的变量是局部的？

答：在 CommonJS 模块中，每个模块都有自己独立的作用域，当定义一个变量或函数时，它们只能在该模块的内部访问和使用，这是因为模块系统会将模块的代码包裹在一个函数作用域中执行，从而防止了变量泄露到全局命名空间，避免了不同模块之间的变量冲突和相互干扰，这种局部性保证了模块的独立性和封装性，使得每个模块可以专注于完成自己的特定功能，而不必担心对其他模块或全局环境造成影响。

2、如何在浏览器中使用 CommonJS 模块？

答：浏览器本身并不直接支持 CommonJS 模块规范，但可以通过一些工具和技术来实现类似的模块化效果，使用 Browserify、Webpack 等打包工具，它们可以将 CommonJS 模块语法转换为浏览器能够理解的格式（如 ES6 模块或通过<script> 标签注入的方式），这些工具会在构建过程中分析模块之间的依赖关系，将所有需要的模块代码打包成一个或多个浏览器可执行的文件，从而在浏览器环境中实现 CommonJS 风格的模块化开发。