「Node.js」ESModule 与 CommonJS 的 区别

2024-05-05 02:52
文章标签 js 区别 node commonjs esmodule

本文主要是介绍「Node.js」ESModule 与 CommonJS 的 区别,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

前言

Node.js支持两种模块系统:CommonJS 和 ESModules(ESM),它们在语法和功能上有一些不同。
在这里插入图片描述

CommonJS (CJS)

CommonJS 是 Node.js 最早支持的模块规范,由于它的出现在ES6之前,因此采取的是同步加载模块的方式。这在服务端是可接受的,因为文件都在本地,同步加载不会引起明显的延迟问题。但是这样的加载方式不适合用在客户端,因为它会导致浏览器在等待模块下载和解析的期间挂起。

  • CommonJS 通过 require 函数来导入模块,如 const module = require('module_name')
  • 模块导出使用 module.exports 对象,如 module.exports = valueexports.value = value

ESModules (ESM)

ESModules 是ES6引入的官方标准化模块系统,支持静态导入和导出。静态模块结构允许JavaScript引擎优化加载和解析。

  • 使用 import 关键字导入模块,例如 import { something } from 'module_name'
  • 使用 export 关键字导出模块,例如 export function doSomething() { ... }export default class MyClass{ ... }

ESModules设计为可以异步加载,这使其更适合于用在浏览器环境中,不过Node.js现在也支持ESModules。

区别

  1. 加载机制:

    • CommonJS:同步加载。
    • ESModules:可以异步加载,支持静态分析,预测性地进行代码的分割和按需加载。
  2. 模块解析:

    • CommonJS 中,require 路径解析算法基于文件系统运作,并且可以省略文件后缀或指向文件夹。
    • ESModules 使用更为严格的路径,通常需要文件后缀,遵循 URL 语法。
  3. 导出值:

    • CommonJS 导出的是值的拷贝,也就是说,一旦 require() 执行完毕,模块内部的变化不会影响这个值。
    • ESModules 导出的是绑定的引用,模块外部能够实时观察到模块内部的变化。
  4. 模块上下文:

    • CommonJS 每个文件都是其模块的顶层作用域。
    • ESModules 顶层 thisundefined

应用场景

CommonJS 和 ESModules 由于它们各自的特点,在不同的应用场景下会有所偏好。下面列举了它们的典型应用场景:

CommonJS 的应用场景:
  • Node.js服务端开发:由于服务端代码不需要考虑浏览器端的下载和延迟问题,CommonJS 的同步加载特性在服务端是完全可行的。同时,绝大多数Node.js的生态系统(npm上的包)都是基于CommonJS规范的。
  • 旧项目维护:早期的Node.js项目都是基于CommonJS规范的,所以维护旧项目往往意味着继续使用CommonJS。
  • 需要动态计算或条件加载模块的情况:由于CommonJS 支持运行时同步加载,你可以根据某些运行时计算的条件来要求模块。
ESModules 的应用场景:
  • 现代化前端开发:如使用框架(例如React、Vue、Angular)和工具(如Webpack、Rollup、Parcel)构建项目。ESModules 支持动态导入(import())和静态代码分析,这有利于前端工具进行代码拆分,以懒加载的方式优化应用加载性能。
  • 跨环境的代码共享:比如同时在Node.js和现代浏览器中运行的库或工具。ESModules是JavaScript官方的模块系统,现代浏览器原生支持。
  • 新项目开发:创建新的Node.js项目时,倾向于使用ESModules,因为它是ECMAScript规范的一部分,并且Node.js及其生态系统正在向ESModules过渡。
  • 需要利用静态分析来进行Tree-shaking优化的项目:Tree-shaking是一种只打包必要模块代码的方法,它依赖于ESModules的静态结构。
混合场景:
  • 迁移的项目:如果你的项目计划从CommonJS迁移到ESModules,你可能会临时进入混合状态,这时要注意不同模块系统间的互操作。
  • 使用第三方库:当需要在ESModules项目中使用仅提供CommonJS模块的第三方库时,也会出现混合使用。

Node.js已经提供了某些语法糖和特性来平滑CommonJS到ESModules的过渡,如import()动态导入语法来异步加载CommonJS模块等。

选择使用CommonJS还是ESModules很大程度上依赖于项目的目标环境、工具链支持、代码库的现状以及个人或团队的偏好。随着技术演进,社区正在向ESModules靠拢,但在稳定性、交付和兼容性要求很高的情况下,CommonJS仍然是一个合理而且可靠的选择。

使用示例

CommonJS

导出示例:

// myModule.js
const myFunction = () => {console.log('Hello, CommonJS!');
}
// 给exports对象添加属性
exports.myFunction = myFunction;

导入示例:

// app.js
const myModule = require('./myModule.js');
myModule.myFunction(); // 输出: 'Hello, CommonJS!'
ESModules

导出示例:

// myModule.js
export const myFunction = () => {console.log('Hello, ESModules!');
}

导入示例:

// app.js
import { myFunction } from './myModule.js';
myFunction(); // 输出: 'Hello, ESModules!'

此外,下面的示例说明了CommonJS如何在运行时加载模块,而ESModules则在编译时加载模块。

CommonJS 运行时加载
// 假设我们在运行代码之前并不知道我们需要加载的模块版本,我们可以在运行时动态地确定。
let version = 'v1';
if (someCondition) {version = 'v2';
}
const module = require(`./module${version}.js`);
ESModules 编译时加载
// 在ESModules中,不能这样动态加载模块,因为所有的import都会在编译时被处理。
// 下面的代码无法运行,会提示错误。
let version = 'v1';
if (someCondition) {version = 'v2';
}
// 报错
import module from `./module${version}.js`;
ESModules 动态加载

但是,ESModules 提供了一种动态导入的方法,可以在运行时异步加载模块:

let version = 'v1';
if (someCondition) {version = 'v2';
}
import(`./module${version}.js`) .then(module => {// 使用模块}).catch(err => {// 处理加载错误});

在这个例子中,import() 返回一个 Promise,加载完模块后会被解析,因此动态导入必须在 Promise 或 async/await 上下文中处理。

这篇关于「Node.js」ESModule 与 CommonJS 的 区别的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/960665

相关文章

JS常用组件收集

收集了一些平时遇到的前端比较优秀的组件,方便以后开发的时候查找!!! 函数工具: Lodash 页面固定: stickUp、jQuery.Pin 轮播: unslider、swiper 开关: switch 复选框: icheck 气泡: grumble 隐藏元素: Headroom

在JS中的设计模式的单例模式、策略模式、代理模式、原型模式浅讲

1. 单例模式(Singleton Pattern) 确保一个类只有一个实例,并提供一个全局访问点。 示例代码: class Singleton {constructor() {if (Singleton.instance) {return Singleton.instance;}Singleton.instance = this;this.data = [];}addData(value)

native和static native区别

本文基于Hello JNI  如有疑惑,请看之前几篇文章。 native 与 static native java中 public native String helloJni();public native static String helloJniStatic();1212 JNI中 JNIEXPORT jstring JNICALL Java_com_test_g

Node.js学习记录(二)

目录 一、express 1、初识express 2、安装express 3、创建并启动web服务器 4、监听 GET&POST 请求、响应内容给客户端 5、获取URL中携带的查询参数 6、获取URL中动态参数 7、静态资源托管 二、工具nodemon 三、express路由 1、express中路由 2、路由的匹配 3、路由模块化 4、路由模块添加前缀 四、中间件

EasyPlayer.js网页H5 Web js播放器能力合集

最近遇到一个需求,要求做一款播放器,发现能力上跟EasyPlayer.js基本一致,满足要求: 需求 功性能 分类 需求描述 功能 预览 分屏模式 单分屏(单屏/全屏) 多分屏(2*2) 多分屏(3*3) 多分屏(4*4) 播放控制 播放(单个或全部) 暂停(暂停时展示最后一帧画面) 停止(单个或全部) 声音控制(开关/音量调节) 主辅码流切换 辅助功能 屏

Node Linux相关安装

下载经编译好的文件cd /optwget https://nodejs.org/dist/v10.15.3/node-v10.15.3-linux-x64.tar.gztar -xvf node-v10.15.3-linux-x64.tar.gzln -s /opt/node-v10.15.3-linux-x64/bin/npm /usr/local/bin/ln -s /opt/nod

Android fill_parent、match_parent、wrap_content三者的作用及区别

这三个属性都是用来适应视图的水平或者垂直大小,以视图的内容或尺寸为基础的布局,比精确的指定视图的范围更加方便。 1、fill_parent 设置一个视图的布局为fill_parent将强制性的使视图扩展至它父元素的大小 2、match_parent 和fill_parent一样,从字面上的意思match_parent更贴切一些,于是从2.2开始,两个属性都可以使用,但2.3版本以后的建议使

Collection List Set Map的区别和联系

Collection List Set Map的区别和联系 这些都代表了Java中的集合,这里主要从其元素是否有序,是否可重复来进行区别记忆,以便恰当地使用,当然还存在同步方面的差异,见上一篇相关文章。 有序否 允许元素重复否 Collection 否 是 List 是 是 Set AbstractSet 否

javascript中break与continue的区别

在javascript中,break是结束整个循环,break下面的语句不再执行了 for(let i=1;i<=5;i++){if(i===3){break}document.write(i) } 上面的代码中,当i=1时,执行打印输出语句,当i=2时,执行打印输出语句,当i=3时,遇到break了,整个循环就结束了。 执行结果是12 continue语句是停止当前循环,返回从头开始。

使用JS/Jquery获得父窗口的几个方法(笔记)

<pre name="code" class="javascript">取父窗口的元素方法:$(selector, window.parent.document);那么你取父窗口的父窗口的元素就可以用:$(selector, window.parent.parent.document);如题: $(selector, window.top.document);//获得顶级窗口里面的元素 $(