JS模块：CJM

关于

规范的主要内容：模块必须通过 module.exports 导出对外的变量或接口，通过 require() 来导入其他模块的输出到当前模块作用域中。

1、所有代码都运行在模块作用域，不会污染全局作用域 —— 一个文件就是一个模块
2、模块初次加载会被缓存，再次使用将从缓存中读取 —— 要让模块再次运行，必须清除缓存

Node.js 将对模块代码封装为如下形式：

(function(exports, require, module, __filename, __dirname) {
// 模块代码实际存在于此处
});

• 将变量限制在在模块内。
• 提供了使用模块的属性、方法：
  1. __dirname：当前模块的绝对目录名；
  2. __filename：当前模块的绝对文件名；
  3. exports：对 module.exports 的引用；
  4. module：（对象）对当前模块的引用；
  5. require：（方法）用于导入其他模块（核心模块、文件模块、第三方模块）；

exports

exports 变量：是对 module.exports 的引用 —— ❗ 不能对 exports 进行赋值操作，否则只是让其不再对 module.exports 进行引用，而变成一个局部变量。

正确用法：

exports.area = function(x) {console.log(x)};

错误用法：

exports = function(x) {console.log(x)};

module

module 变量：是一个代表当前模块的对象

它提供了以下属性：

1. module.id：模块的识别符，通常是模块的完全解析文件名。
2. module.filename：模块的完全解析文件名（带有绝对路径的文件名）。
3. module.parent：（对象）表示调用该模块的模块。
4. module.children：（数组）表示该模块用到的其他模块。
5. module.isPreloading：（布尔值）表示模块是否在 Node.js 预加载阶段运行。
6. module.loaded：（布尔值）表示模块是否已经完成加载。
7. module.exports：表示模块对外输出的值。

module.exports 属性表示当前模块对外输出的接口。加载某个模块，其实是加载该模块的 module.exports 属性。

❗ 不建议同时使用 exports 与 module.exports：可能导致对外输出失效。

示例：

exports.hello = function() {
  return 'hello';
};

module.exports = 'Hello world';

如上，exports 的输出会因 module.exports 重新赋值而失效。

require

require 变量：通常就是模块的 require() 方法

它提供了以下属性、方法：

1. require(id)：用于导入模块、JSON 和本地文件。
   • id 即 module.id（模块识别符）， 可以使用相对路径（将根据 __dirname 或当前工作目录进行解析）；
2. require.cache：（对象）缓存对象，模块在需要时缓存在此对象中。
3. require.main：（对象）代表 Node.js 进程启动时加载的入口脚本。
   • 如果程序的入口点不是 CommonJS 模块，则为 undefined；
4. require.resolve(request[, options])：查找模块位置，但不加载模块，只返回解析的文件名。
   • request：要解析的模块路径；
   • 如果找不到模块，则会抛出 MODULE_NOT_FOUND 错误；
5. require.resolve.paths(request)：如果 request 字符串引用核心模块（如 http 或 fs），则返回包含在解析 request 或 null 期间搜索的路径的数组。
   • request：要解析的模块路径；

Module

Module 对象：Node 内部的构建函数，提供了当与 Module 的实例交互时提供通用的实用方法

所有模块（module）都是 Module 的实例。

它提供了以下属性、方法：

1. module.builtinModules：Node.js 提供的所有模块的名称列表。
   • 要访问它，需要 Node 内部的 Module 模块：

     import { builtinModules as builtin } from 'node:module';
     

   • 可用于：验证模块是否由第三方维护；
2. module.createRequire(filename)：用于构造 require 函数的文件名。
   • filename：（string / URL）用于构造 require 函数的文件名（必须是文件网址对象、文件网址字符串、或绝对路径字符串）；
3. module.isBuiltin(moduleName)：用于判断一个模块是否为“内置模块”。
   • moduleName：模块名称
4. module.syncBuiltinESMExports()：用于更新内置的 ES 模块的所有实时绑定，以匹配 CommonJS 导出的属性。❓

加载机制

require() 的伪代码高级算法：

1. 如果 X 是内置模块
   a. 返回内置模块
   b. 停止执行
2. 如果 X 以 '/' 开头
   a. 设置 Y 为文件根路径
3. 如果 X 以 './' 或 '/' or '../' 开头
   a. LOAD_AS_FILE(Y + X)
   b. LOAD_AS_DIRECTORY(Y + X)
4. LOAD_NODE_MODULES(X, dirname(Y))
5. 抛出异常 "not found"

LOAD_AS_FILE(X)
1. 如果 X 是一个文件, 将 X 作为 JavaScript 文本载入并停止执行。
2. 如果 X.js 是一个文件, 将 X.js 作为 JavaScript 文本载入并停止执行。
3. 如果 X.json 是一个文件, 解析 X.json 为 JavaScript 对象并停止执行。
4. 如果 X.node 是一个文件, 将 X.node 作为二进制插件载入并停止执行。

LOAD_INDEX(X)
1. 如果 X/index.js 是一个文件,  将 X/index.js 作为 JavaScript 文本载入并停止执行。
2. 如果 X/index.json 是一个文件, 解析 X/index.json 为 JavaScript 对象并停止执行。
3. 如果 X/index.node 是一个文件,  将 X/index.node 作为二进制插件载入并停止执行。

LOAD_AS_DIRECTORY(X)
1. 如果 X/package.json 是一个文件,
   a. 解析 X/package.json, 并查找 "main" 字段。
   b. let M = X + (json main 字段)
   c. LOAD_AS_FILE(M)
   d. LOAD_INDEX(M)
2. LOAD_INDEX(X)

LOAD_NODE_MODULES(X, START)
1. let DIRS=NODE_MODULES_PATHS(START)
2. for each DIR in DIRS:
   a. LOAD_AS_FILE(DIR/X)
   b. LOAD_AS_DIRECTORY(DIR/X)

NODE_MODULES_PATHS(START)
1. let PARTS = path split(START)
2. let I = count of PARTS - 1
3. let DIRS = []
4. while I >= 0,
   a. if PARTS[I] = "node_modules" CONTINUE
   b. DIR = path join(PARTS[0 .. I] + "node_modules")
   c. DIRS = DIRS + DIR
   d. let I = I - 1
5. return DIRS