JS 中怎么重构 CommonJS 项目为纯 ES Modules

大静君_7815

大静君_7815

2026-10-21

495人浏览

原创

核心是重建模块解析逻辑和运行约束:先在package.json中设"type": "module",再将require/module.exports改为import/export、__dirname改为import.meta.url、动态require改为await import,并确保所有导入路径含.js扩展名。

js 中怎么重构 commonjs 项目为纯 es modules

直接把 CommonJS 项目改成纯 ES Modules,核心不是“改语法”,而是重建模块解析逻辑和运行约束。Node.js 从 v14.13 起已稳定支持 ESM,v16+ 是推荐基线,无需 polyfill 或构建工具即可原生运行。

第一步:明确项目入口与模块类型边界

在 package.json 中添加 "type": "module"。这会让所有 .js 文件默认按 ESM 解析——这是最干净的起点。注意:加了这一行后,require()、module.exports、__dirname、__filename 就全部失效,不能再混用。

  • 如果项目里有大量 __dirname 用途(比如读取本地 JSON 配置),要换成 import.meta.url + new URL('./config.json', import.meta.url)
  • 动态 require('xxx') 场景,必须改用 await import('xxx')(顶层 await 在 Node.js v14.8+ 支持)
  • 原来用 fs.readFileSync(__dirname + '/data.txt') 的地方,需同步改为 fs.readFileSync(new URL('./data.txt', import.meta.url), 'utf8')

第二步:逐文件迁移导出/导入语法

CommonJS 的 module.exports 和 require 不是简单替换成 export 和 import 就能跑通的,关键在语义对齐:

chartjs-reporter
chartjs-reporter

此技能用于在用户需要将结构化数据(查询结果、CSV 摘要、JSON 记录或 Python 字典/列表)转换为独立的 HTML 页面时使用。

下载
  • 原来 module.exports = { foo, bar } → 改为 export { foo, bar }
  • 原来 module.exports = function() {}(默认导出单个值)→ 改为 export default function() {}
  • 原来 const utils = require('./utils') → 改为 import utils from './utils.js'(注意:ESM 要求路径带扩展名 .js)
  • 原来 const { a, b } = require('./lib') → 若 lib.js 用 export default 导出对象,需写成 import lib from './lib.js'; const { a, b } = lib

第三步:处理第三方依赖兼容性

不是所有 npm 包都提供 ESM 入口。遇到报错如 “The requested module does not provide an export named 'default'”,说明该包仍是 CommonJS 格式:

  • 优先查包文档,看是否提供 ESM 版本(如 crypto-js@4.x 默认不支持 ESM,需用 import('crypto-js').then(...) 动态加载)
  • 若包只支持 CommonJS,且你又必须静态 import,可用 Node.js 内置的 --experimental-loader 配合 esm-loader 等过渡方案,但不推荐长期使用
  • 更稳妥的做法:保留部分 .cjs 文件(如专门封装 legacy 包调用),并在 package.json 中用 exports 字段精确控制入口

第四步:验证与清理残留

迁移完成后,检查三类典型问题:

  • 启动时报 SyntaxError: Cannot use import statement outside a module → 检查是否漏删了某个 .js 文件里的 require,或 package.json 缺少 "type": "module"
  • 运行时报 ReferenceError: __dirname is not defined → 所有 __dirname 都需替换为 import.meta.url 方案
  • 导入后得到 undefined → 多半是 export/default 不匹配,用 console.log(Object.keys(module)) 查看实际导出结构

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

5046

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1249

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4964

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

960

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1896

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3565

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4613

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

3040

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

968

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.2万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.7万人学习