当前位置: 首页 > news >正文

【node.js】node.js 两种模块规范 CommonJS 和 ESM 如何选择?

在 Node.js 的生态系统中,存在两种主要的模块规范:CommonJS (CJS)ES Modules (ESM)

理解它们的区别对于现代前端和后端开发至关重要,因为 Node.js 正在从 CJS 全面转向 ESM。


1. CommonJS (CJS)

CommonJS 是 Node.js 诞生的默认模块系统,已经存在了十多年。

  • 语法:使用require()导入模块,使用module.exports导出模块。
  • 加载方式同步加载。这意味着当你调用require()时,Node.js 会阻塞后续代码的执行,直到模块加载完成。
  • 适用场景:传统 Node.js 项目、服务器端脚本。

示例代码:

// 导出 (math.js)constadd=(a,b)=>a+b;module.exports={add};// 导入 (main.js)const{add}=require('./math.js');console.log(add(2,3));

2. ES Modules (ESM)

ESM 是 JavaScript 在 2015 年(ES6)确立的标准官方模块系统,旨在让浏览器和服务器通用一套标准。

  • 语法:使用import导入,使用export导出。
  • 加载方式异步加载。它分为三个阶段:构建(解析)、链接、求值。这种机制支持“静态分析”。
  • 适用场景:现代前端框架(Vue, React)、浏览器环境、现代 Node.js 项目。

示例代码:

// 导出 (math.js)exportconstadd=(a,b)=>a+b;// 导入 (main.js)import{add}from'./math.js';console.log(add(2,3));

3. 核心区别对比

特性CommonJS (CJS)ES Modules (ESM)
关键字require/module.exportsimport/export
加载时机运行时加载。编译时加载(静态分析)。
加载方式同步。异步。
顶层变量__dirname,__filename没有这些变量(需用import.meta.url模拟)。
this 指向指向当前模块。undefined
Tree Shaking不支持(因为是动态加载)。支持(可以删除未使用的代码)。
严格模式默认不开启。强制开启(“use strict”)。

4. 关键差异深度解析

(1) 静态分析 vs 动态加载
  • ESM 是静态的import语句必须放在文件顶部。因为它是静态的,打包工具(如 Webpack, Rollup, Vite)可以在代码运行前知道哪些代码被使用了,从而进行Tree Shaking(剔除无效代码),缩小包体积。
  • CJS 是动态的:你可以在if语句或函数内部写require()。这使得它很灵活,但也无法在编译阶段进行优化。
(2) 值的拷贝 vs 值的引用
  • CJS:导出的是值的拷贝。一旦输出一个值,模块内部的变化不会影响到已加载的值。
  • ESM:导出的是值的动态只读引用(Live Bindings)。如果模块内部修改了变量,外部引用的地方也会同步更新(但外部不能修改它)。
(3) 环境变量(__dirname)

在 CJS 中,你可以直接使用__dirname获取当前目录。在 ESM 中,这些全局变量不存在,你需要这样操作:

// ESM 获取 __dirname 的方法import{fileURLToPath}from'url';import{dirname}from'path';const__filename=fileURLToPath(import.meta.url);const__dirname=dirname(__filename);

5. 如何在 Node.js 中选择?

现在 Node.js 同时支持两者,判断规则如下:

  1. 文件名后缀
    • .cjs总是被视为 CommonJS。
    • .mjs总是被视为 ES Modules。
    • .js取决于最近的package.json
  2. package.json
    • 设置"type": "module",则.js文件被视为ESM
    • 设置"type": "commonjs"或不设置,则.js文件被视为CJS

6. 互操作性(能不能混用?)

  • ESM 导入 CJS:可以。import cjs from './file.cjs'通常能工作,但只能默认导入,不能通过解构导入(因为 CJS 是运行时生成的)。
  • CJS 导入 ESM不可以使用require()。因为 ESM 是异步的,而require是同步的。如果必须在 CJS 中用 ESM,只能使用异步的import()函数:
    // 在 CJS 文件中import('./esm-file.mjs').then(module=>{// 使用模块});

总结

  • 如果你正在开发新项目,建议优先使用ESM,因为它是未来的标准,且支持更好的性能优化。
  • 如果你在维护老旧项目或使用大量仅支持 CJS 的老旧库,则继续使用CommonJS
http://www.cnnetsun.cn/news/171056.html

相关文章:

  • Excalidraw在Chrome/Firefox/Safari上的表现差异
  • 19、Windows Server 2003 WMI:安全改进与服务管理
  • Excalidraw群组与锁定功能使用场景解析
  • Excalidraw反向代理Nginx配置样例
  • 21、深入探索ADSI:管理Windows目录服务的利器
  • 24、深入了解 WMI:功能、使用与脚本编写指南
  • Excalidraw PWA安装教程:变成桌面应用
  • 18、深入探究文件系统对象(FSO)的使用与实践
  • 27、深入探索WMI关联查询及脚本编写
  • 36、高效管理Windows系统:脚本助力用户与系统信息处理
  • Excalidraw高可用集群架构设想
  • 青少年近视率超50%!全方位守护孩子明亮视界
  • 在SAP系统中创建物料 860000000000000082(物料描述为“8680月球广寒宫坦克车”)时,系统报出了一个错误
  • 在 SAP SD(销售与分销)模块中,销售合同 / 订单的抬头(Header) 和行项目(Item) 核心数据表如下,按 “核心表 + 扩展表” 分类说明,同时区分销售合同(Contract,类型 W
  • Excalidraw手绘白板神器:AI赋能下的技术设计新体验
  • Excalidraw在教育场景的应用:教师也能轻松上手
  • 海思芯片OpenHarmony系统移植:Sensor传感器模块HDF驱动配置HCS文件详解
  • 《Python == 与 is 的真相:从基础语义到底层机制,一篇让新手顿悟、老手沉默的深度解析》
  • Excalidraw HTTPS加密传输:保障通信安全
  • Excalidraw容器化部署:Kubernetes集群完美适配
  • 7、脚本开发与使用全攻略
  • 14、ADSI数据访问与对象枚举全解析
  • 必须精通了hyperf才算学会了swoole吗?
  • Excalidraw与Figma对比:哪个更适合早期原型设计?
  • 02.03.01.快速开始篇(Astra-SDK案例 使用Eclise开发工具:创建Makefile项目方式 DepthReaderEventCPP)
  • Excalidraw二维码分享:移动端访问一键直达
  • 基于Springboot粮仓管理系统【附源码+文档】
  • 基于Springboot笔记本分享平台【附源码+文档】
  • 浩瀚宇宙,2025正是引力场文场的起点
  • Excalidraw热键大全:高手都是这样快速操作的