罗罗编程学习记录
本页内容 展开查看

04.2.2.1 CommonJS 与 ESM 模块机制

所属:全栈开发面试题库 / 04 后端语言与运行时 / 04.2 Node.js / 04.2.2 工程化与性能诊断

04.2.2.1-001 CommonJS 与 ESM 分别是什么,解决什么问题?

一句话结论

CommonJS(CJS)是 Node 早期模块规范,用 require 同步加载、module.exports 导出;ESM 是语言标准模块,用 import/export,支持静态分析与异步加载。

概念解释

模块机制解决代码拆分、依赖复用与命名空间隔离。CJS 为服务端同步文件加载设计;ESM 统一浏览器与服务端,支持静态树摇、顶层 await 和浏览器原生加载。

原理流程

  1. 入口模块按依赖图加载。
  2. CJS 同步读取并执行模块,缓存导出对象。
  3. ESM 先解析链接建立绑定,再执行模块体。

代码或图示

// CJS
const m = require('./m');
module.exports = { m };

// ESM
import m from './m.js';
export default m;

常见误区

  • 认为两者只是语法不同:加载时机、绑定语义、缓存模型都有差异。
  • ESM 也在运行时同步读文件:ESM 解析阶段建立链接,模块执行可异步。

追问

  • 为什么需要 ESM?答:统一跨端模块标准,支持静态分析、tree-shaking 与顶层 await。
  • CJS 加载是同步还是异步?答:require 同步加载并执行模块;ESM 解析可异步,支持顶层 await。

04.2.2.1-002 CJS 的 require 加载与缓存机制是什么?

一句话结论

require 按路径解析后同步执行模块文件,导出挂到 module.exports;模块按解析绝对路径缓存,第二次 require 直接返回缓存对象。

概念解释

每个模块包在函数作用域内,拥有 require/module/exports/__dirname 等局部变量。模块体只执行一次,后续复用导出对象引用。

原理流程

  1. 解析模块路径得到绝对路径。
  2. 查缓存,命中则返回 exports。
  3. 未命中则包装执行模块体,写入缓存。

代码或图示

// 第二次返回同一对象
const a = require('./x');
const b = require('./x');
console.log(a === b); // true

常见误区

  • require 每次重新执行模块:只执行一次,之后读缓存。
  • 改了导出文件不用重启即可生效:进程内缓存不会自动失效。

追问

  • 缓存 key 是什么?答:解析后的绝对路径;内置模块按模块名。
  • 缓存何时失效?答:进程内缓存直到模块引用解除且进程退出;手动删 require.cache 可清,但有分叉风险。

04.2.2.1-003 CJS 导出的是值还是引用?

一句话结论

导出的是 module.exports 对象引用;属性修改在缓存对象上可见,但基本类型重新赋值不会影响已导出的绑定。

概念解释

exports 只是 module.exports 的初始引用。给 exports.foo 赋值改的是同一对象;整体替换必须改 module.exports。

原理流程

  1. 模块执行时填充 exports 对象。
  2. 调用方拿到对象引用。
  3. 后续修改对象属性双方可见;重新绑定变量不可见。

代码或图示

// x.js
let count = 0;
module.exports = {
  inc: () => count++,
  get: () => count,
};

常见误区

  • 给 exports = {} 整体替换生效:exports 指向被改,module.exports 仍是原对象。
  • 导出基本类型后外部可改回内部变量:导出时已拷贝值。

追问

  • 怎么整体替换导出?答:module.exports = { ... }。
  • 导出对象属性呢?答:对象/数组导出的是引用,外部修改属性会反映到内部;基本类型导出时拷贝值。

04.2.2.1-004 ESM 的 live binding 是什么?

一句话结论

ESM 导出的是活绑定:导入方读取的是绑定本身,导出方后续修改变量,导入方看到最新值,而不是导入时拷贝的快照。

概念解释

CJS 拿到的是导出对象快照引用;ESM 在模块间建立命名绑定,变量值随导出模块变化。这也是 ESM 循环依赖可正确工作的基础之一。

原理流程

  1. 链接阶段建立导入导出绑定。
  2. 执行阶段导出模块修改变量。
  3. 导入方通过绑定读取当前值。

代码或图示

// counter.js
export let n = 0;
export const inc = () => n++;

// main.js
import { n, inc } from './counter.js';
inc();
console.log(n); // 1

常见误区

  • 把 ESM 当 CJS 快照拷贝:live binding 读取的是最新值。
  • 导入后重新赋值导入变量:导入绑定只读,赋值会报错。

追问

  • live binding 对循环依赖的意义?答:绑定指向变量而非已完成对象,未初始化阶段访问会有 TDZ 限制。
  • 导入变量为何只读?答:ESM 导入绑定指向导出模块的变量槽位,重新赋值导入方会抛 TypeError。

04.2.2.1-005 package.json 的 type 字段如何决定模块格式?

一句话结论

"type": "module" 把 .js 按 ESM 解析;省略或 "commonjs" 按 CJS 解析;.mjs 恒为 ESM,.cjs 恒为 CJS,不受 type 影响。

概念解释

扩展名与 type 共同决定加载器如何解析文件。混用时按文件扩展名显式标注,避免依赖目录 type 推断出错。

原理流程

  1. 查找最近 package.json 的 type。
  2. .js 按 type 判定;.mjs/.cjs 覆盖判定。
  3. 加载器按对应格式执行。

代码或图示

{ "type": "module" }

常见误区

  • .js 在 ESM 项目里天然是 ESM:还取决于最近 package.json 的 type。
  • .cjs 也受 type 影响:扩展名专用格式优先。

追问

  • 待确认:当前版本对未带扩展名导入的解析规则,以官方文档为准。
  • type 取值有哪些?答:"commonjs" 与 "module";.cjs 强制 CJS、.mjs 强制 ESM,不受 type 影响。

04.2.2.1-006 ESM 中为什么导入路径要写全扩展名?

一句话结论

ESM 不做 CJS 式目录/扩展名自动补全,相对导入通常需要写明 .js 扩展名与完整路径,加载器按文件 URL 解析。

概念解释

ESM 基于 URL 解析,不像 CJS 那样尝试 .js/.json/node 与目录 index。浏览器与服务端共用这一显式解析模型。

原理流程

  1. 解析相对/裸说明符。
  2. 按文件 URL 定位真实文件。
  3. 未命中直接解析失败。

代码或图示

import './utils/index.js'; // 显式扩展名

常见误区

  • 沿用 CJS 省略扩展名习惯:ESM 下解析失败。
  • 目录导入自动找 index:需显式写到 index.js。

追问

  • 裸包名怎么解析?答:按 node_modules 与包 exports 字段解析(见下条)。
  • 目录导入怎么办?答:ESM 需显式写 ./dir/index.js,不像 CJS 自动解析目录与 index。

04.2.2.1-007 包的 exports 字段如何限制导出子路径?

一句话结论

package.json 的 exports 定义包对外暴露的子路径映射与条件导出,未列出的内部路径无法被外部导入,可区分生产/开发/Node 条件。

概念解释

exports 取代旧的 main 字段,精确控制公开入口。条件导出按运行环境(node/browser/development)返回不同文件,同时隐藏内部目录。

原理流程

  1. 外部导入包路径。
  2. 加载器匹配 exports 映射与条件。
  3. 命中则解析到对应文件,未命中报错。

代码或图示

{
  "exports": {
    ".": "./index.js",
    "./utils": "./src/utils.js"
  }
}

常见误区

  • 有 main 就能导入任意内部文件:exports 未映射的子路径被阻断。
  • 条件导出只按扩展名区分:还可按运行时环境与开发/生产条件。

追问

  • 待确认:条件名称与通配符语法随版本演进,以当前文档为准。
  • exports 与 main 什么关系?答:有 exports 时以其映射为准,未映射子路径不可导入;main 作为兜底或兼容。

04.2.2.1-008 循环依赖在 CJS 下表现为什么?

一句话结论

CJS 模块尚未执行完时被 require,拿到的是当前已填充的半成品 exports;后续属性在调用时才可能可见,提前解构会拿到 undefined。

概念解释

CJS 同步加载遇到环回到已开始但未完成的模块,返回部分导出。顶层解构取值只取当时快照,函数调用时再读对象属性才安全。

原理流程

  1. A require B,B 又 require A。
  2. A 返回半成品 exports。
  3. B 执行完回 A 继续,属性逐步补齐。

代码或图示

// 反例:顶层解构可能为 undefined
const { foo } = require('./a');

常见误区

  • 循环依赖必然报错:CJS 不直接抛错,但可能拿到不完整导出。
  • 把导出属性挂函数体内访问:调用时读取最新对象属性可规避半成品问题。

追问

  • 怎么消除环?答:抽出共享下层模块,调整依赖方向,避免顶层相互引用。
  • 常见半成品现象是什么?答:require 回来的对象某属性还是 undefined,因为循环回到时模块未执行完。

04.2.2.1-009 循环依赖在 ESM 下有什么不同?

一句话结论

ESM 用 live binding,模块未初始化阶段绑定存在但访问未初始化变量受暂时性死区限制;函数体内延迟访问通常安全,顶层立即读取未就绪绑定会报错。

概念解释

链接先于执行完成,绑定关系已建立。执行顺序按依赖图展开,环上模块可能先执行到一半。顶层立即用未初始化值触发 TDZ 错误。

原理流程

  1. 建立模块链接与绑定。
  2. 按顺序执行模块体。
  3. 未初始化绑定在函数调用时读取,规避顶层访问。

代码或图示

// 在被调函数内使用导入,而不是顶层立即取值
export function use() { return otherValue; }

常见误区

  • ESM 循环依赖完全无害:顶层访问未初始化绑定仍会抛错。
  • 把 CJS 半成品快照结论套到 ESM:绑定语义不同。

追问

  • 怎么定位环?答:用依赖分析工具或启动警告定位循环链路,再拆分模块。
  • 访问未初始化绑定报什么?答:访问 TDZ 中的绑定抛 ReferenceError: Cannot access ... before initialization。

04.2.2.1-010 CJS 与 ESM 如何相互导入?

一句话结论

ESM 可导入 CJS(默认导出为 module.exports);CJS 不能直接 require 异步 ESM,需要用动态 import() 或重构为 ESM。

概念解释

互操作方向不对称:ESM 加载 CJS 有转换层;CJS 的 require 是同步的,无法等待 ESM 异步执行完成。

原理流程

  1. ESM import CJS:转换层把 exports 作为默认/具名导出。
  2. CJS 想用 ESM:在异步函数内 await import('esm-pkg')。
  3. 长期方案:整体迁移到 ESM。

代码或图示

// CJS 内加载 ESM
(async () => {
  const mod = await import('esm-pkg');
})();

常见误区

  • 在 CJS 顶层 require('esm-pkg') 可行:同步 require 无法处理 ESM。
  • ESM 导入 CJS 具名导出都能静态识别:部分具名导出靠运行时推断。

追问

  • 待确认:当前版本互操作边界与警告,以官方文档为准。
  • ESM 导入 CJS 怎么做?答:可默认导入 CJS 模块;具名导出通常由运行时从 module.exports 推断,静态识别不全。

04.2.2.1-011 顶层 await 解决什么问题,有什么限制?

一句话结论

ESM 顶层 await 让模块在导出前等待异步初始化(如加载配置、建立连接),导入方会等待该模块完成;仅 ESM 支持,CJS 无此语法。

概念解释

没有顶层 await 时,模块导出空对象,异步结果后续填充,调用方要订阅就绪事件。顶层 await 把初始化等待纳入模块加载图。

原理流程

  1. 模块体执行到 await。
  2. 模块加载挂起,等待异步完成。
  3. 完成后导出绑定就绪,再继续下游模块。

代码或图示

const config = await fetchConfig();
export default config;

常见误区

  • 顶层 await 会阻塞整个进程:只阻塞依赖该模块的加载链。
  • 在 CJS 函数外使用 await:CJS 不支持顶层 await。

追问

  • 注意点:顶层 await 过长会延迟所有下游模块加载,应把重初始化放到按需调用。
  • 哪些模块支持顶层 await?答:仅 ESM 模块;CJS 与 CommonJS 包装环境不支持顶层 await。

04.2.2.1-012 __dirname/__filename 在 ESM 中怎么获取?

一句话结论

ESM 没有 __dirname/__filename 局部变量,需用 import.meta.url 配合 url.fileURLToPath 与 path.dirname 推导。

概念解释

ESM 模块基于 URL,路径信息挂在 import.meta.url。CJS 局部变量是加载器注入的,ESM 模型不同。

原理流程

  1. 读取 import.meta.url。
  2. 转成文件路径。
  3. 取目录名拼装相对路径。

代码或图示

import { fileURLToPath } from 'node:url';
import { dirname } from 'node:path';
const __dirname = dirname(fileURLToPath(import.meta.url));

常见误区

  • ESM 直接用 __dirname:未定义会报错。
  • 把 URL 字符串直接当磁盘路径拼接:跨平台需先 fileURLToPath。

追问

  • 读取同级文件推荐?答:用 new URL('./x.json', import.meta.url) 定位。
  • ESM 等价写法是什么?答:const __dirname = path.dirname(fileURLToPath(import.meta.url))。

04.2.2.1-013 动态 import() 与静态 import 有什么区别?

一句话结论

静态 import 在加载阶段解析并纳入依赖图;动态 import() 返回 Promise,可在运行时按条件加载,用于代码分割与按需加载。

概念解释

静态导入提升到模块顶部,构建期可分析;动态导入推迟到调用点,支持条件分支、懒加载与减少首屏加载量。

原理流程

  1. 静态:链接阶段确定依赖并加载。
  2. 动态:运行时调用 import() 才解析加载。
  3. 完成后得到模块命名空间对象。

代码或图示

if (needHeavy) {
  const heavy = await import('./heavy.js');
}

常见误区

  • 动态 import 是 CJS require 的别名:它返回 Promise,语义是异步模块加载。
  • 动态导入不进依赖图:工具链仍会扫描,但可做分包。

追问

  • 服务端按需加载场景?答:按路由/条件加载大模块,缩短启动时间。
  • 动态 import 返回什么?答:Promise,resolve 为模块命名空间对象;可在条件分支与路由级懒加载使用。

04.2.2.1-014 模块缓存可以手动清除吗?有什么风险?

一句话结论

CJS 可删除 require.cache[path] 强制下次重新加载,但生产环境不应依赖;会产生重复模块实例、单例状态分叉与副作用重复执行。

概念解释

缓存清除主要用于开发热重载测试。删除后新旧实例并存,持旧引用的模块看不到新状态,单例被破坏。

原理流程

  1. 删除缓存条目。
  2. 下次 require 重新执行模块体。
  3. 已持有旧 exports 的模块仍引用旧实例。

代码或图示

delete require.cache[require.resolve('./m')];

常见误区

  • 清缓存即可热更新线上代码:实例分叉与重复副作用风险高。
  • 清缓存后所有引用自动更新:旧引用仍指向旧对象。

追问

  • 生产重载方案?答:进程重启或进程管理器滚动替换,不靠运行时清缓存。
  • 怎么清 require 缓存?答:遍历 require.cache 删除对应路径条目;但已持有旧引用的地方不会更新。

04.2.2.1-015 模块作用域里有哪些隐式变量?

一句话结论

CJS 每个模块被包装在函数作用域内,注入 require/module/exports/__dirname/__filename;ESM 作用域不同,通过 import.meta 暴露元信息。

概念解释

这些变量不是全局对象属性,而是模块局部注入,避免模块间污染。理解注入边界才能判断变量为何不能跨模块直接访问。

原理流程

  1. 加载器包裹模块代码。
  2. 注入局部绑定。
  3. 模块内访问局部变量,外部不可见。

代码或图示

// CJS 包装示意
(function (exports, require, module, __filename, __dirname) { /* 模块体 */ });

常见误区

  • 把 module 当全局对象:它是模块局部变量。
  • 顶层 var 挂到 global:模块作用域内不自动成为全局属性。

追问

  • ESM 局部元信息?答:import.meta 携带 url 等加载元数据。
  • CJS 局部变量有哪些?答:module、exports、require、__dirname、__filename、arguments。

04.2.2.1-016 内置模块如何导入,版本前缀有什么约定?

一句话结论

内置模块用模块名导入;node: 前缀显式标识内置模块,避免与同名第三方包冲突,CJS 与 ESM 都支持。

概念解释

不带前缀时加载器先找内置模块;node: 前缀让意图明确,防止本地/ node_modules 出现同名包导致解析歧义。

原理流程

  1. 导入说明符以 node: 开头。
  2. 直接定位内置模块。
  3. 返回内置模块导出对象。

代码或图示

import fs from 'node:fs';
const path = require('node:path');

常见误区

  • 内置模块必须先安装:随 Node 运行时自带。
  • 第三方包也能用 node: 前缀:前缀仅用于内置模块。

追问

  • 待确认:个别内置模块的稳定性状态,以当前版本 API 文档为准。
  • node: 前缀作用是什么?答:显式标识内置模块,避免与同名第三方包混淆;不带前缀也可解析内置模块。

04.2.2.1-017 混合 CJS/ESM 项目迁移要注意什么?

一句话结论

按依赖边界分批迁移:先确定 type 与扩展名策略,处理循环依赖、动态导入与互操作测试,避免同一文件两种格式混用。

概念解释

迁移风险集中在解析规则、互操作与单例假设。逐模块切换并跑通测试,比一次性改写可控。

原理流程

  1. 盘点依赖与模块格式。
  2. 选扩展名策略(.mjs/.cjs 显式标注)。
  3. 逐文件迁移、补测试、处理互操作边界。

代码或图示

盘点 → 定 type/扩展名 → 逐文件迁移 → 互操作测试 → 全量切换

常见误区

  • 同一目录混用却不显式标注扩展名:解析行为依赖推断,易出错。
  • 迁移后仍假设单例全局共享:模块实例边界需重新核对。

追问

  • 待确认:当前版本对混用场景的报错与建议,以官方迁移文档为准。
  • 迁移步骤建议?答:先固定 type 与扩展名,逐个转 ESM 并验证互操作,再清理 CJS 残留,避免一次性大改。

04.2.2.1-018 如何排查“模块导出 undefined”类问题?

一句话结论

按顺序检查:导出方式(module.exports 还是 exports.)、循环依赖半成品、互操作默认/具名导出、导入路径与扩展名解析,以及缓存实例是否分叉。

概念解释

undefined 通常是绑定方向或加载时机问题,不是逻辑计算错误。先复现最小模块,再沿导出链路逐层核对。

原理流程

  1. 在导出方打印 exports 内容。
  2. 检查导入方取值时机(顶层解构 vs 函数内读取)。
  3. 核对路径解析、循环依赖与互操作转换。

代码或图示

导出方对象 → 绑定方向 → 循环依赖 → 互操作 → 路径解析

常见误区

  • 看到 undefined 就改默认导出:根因可能是循环依赖或路径未解析。
  • 忽略 CJS/ESM 互操作:具名导出在转换层可能识别不全。

追问

  • 最小复现怎么做?答:剥离到两个文件复现取值时机问题,再逐步加回依赖。
  • 先检查哪几项?答:导出方式(module.exports vs exports)、导入路径与扩展名、循环依赖取值时机、互操作层具名识别。
  • 最小复现怎么做?答:剥离到两个文件复现取值时机问题,再逐步加回依赖。