当前位置: 首页 > 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.jsqmd.com/news/118131/

相关文章:

  • 15、安全描述符的创建、转换与解析
  • 掌握Open-AutoGLM路线优化技巧(99%工程师忽略的关键参数)
  • CCF GESP C++ G5核心知识点题库(含解析)
  • 零基础也能掌握,Open-AutoGLM实现门票预约自动化全流程解析
  • Excalidraw内存占用优化技巧
  • 《Linux系统编程之进程基础》【进程切换 + 进程调度】
  • 每次见面都有收获,下次见
  • Open-AutoGLM智能购票实战指南(从零搭建高并发抢票系统)
  • Excalidraw缩放和平移操作优化建议
  • 2025年PTE培训机构排行榜:羊驼PTE口碑好吗、羊驼PTE的课程价格贵吗 - 工业推荐榜
  • AI与大数据:如何赋能零售行业的个性化营销与精准预测 - 教程
  • Excalidraw能否用于商业项目?合规性解答
  • 31、脚本编码、打包与安全防护
  • 为什么顶尖开发者都在用Open-AutoGLM做交通查询?真相令人震惊
  • 32、脚本安全与 HTML 应用程序入门
  • 人工智能与物联网:智能家居生态的崛起与未来 - 教程
  • 2025年抖音短视频代运营哪家可靠?五大靠谱服务商推荐 - mypinpai
  • 从0到1搭建智能预约系统,Open-AutoGLM在共享单车中的5个关键应用
  • Excalidraw如何助力产品经理快速输出PRD原型?
  • Excalidraw数据库选型建议(SQLite/PostgreSQL)
  • Excalidraw Docker镜像快速启动命令
  • 现代嵌入式C++教程:快速的C语言复习Part
  • Open-AutoGLM生活缴费自动化方案(基于大模型的智能提醒架构解析)
  • Excalidraw背景网格自定义配置
  • 21、深入探索ADSI:管理Windows目录服务的利器
  • Excalidraw源码解读:前端开发者的学习宝典
  • Open-AutoGLM实战应用(景区门票预约自动化大揭秘)
  • 22、域、组织单位及用户组管理操作指南
  • Excalidraw roadmap路线图解读
  • 24、深入了解 WMI:功能、使用与脚本编写指南