ES Module 和 CommonJS 学习笔记(二) —— NodeJS 中使用 ESM 和 CJS

本文介绍了在 NodeJS 中如何使用 ES6 模块(ESM)和 CommonJS(CJS)模块,包括在文件中标识 ES6 模块、修改模块规范、两种模块的相互引用、加载规则以及配置入口文件和路径别名。同时,讨论了同时支持两种模块格式的方法和 ES6 模块的注意事项。
摘要由CSDN通过智能技术生成

在 NodeJS 中使用 ES6 模块

当前较新版本的 NodeJS 支持 ESM 和 CJS ,但默认使用的是 CJS 规范去解析 JS 代码,直接使用 CJS 是没有任何问题的,而使用 ESM 需要做一些处理

.mjs文件

在 NodeJS 中用.mjs后缀的文件名表示这个文件为 ES6 模快文件,可以在.mjs文件中直接使用 ESM 语法(使用import/export指令)。在执行含 ES6 模块的脚本时,由于不同 NodeJS 版本的支持程度不一样,需要按照不同方式执行

v16.4.0 完全支持
v13.2.0 试验性支持,可省略 --experimental-modules 
更老的版本需要显式使用参数 --experimental-modules 执行 或 甚至不支持该试验特性

node --experimental-modules <path/to/file>

修改模块规范

可以通过修改 NodeJS 解析 JS 代码时的模块规范,使得 ESM 可以直接在.js文件中使用(不修改的话直接使用会报错)。在需要修改默认解析规范的模块文件根目录下创建一个package.json文件(可以在要创建的目录下执行npm init -y生成package.json),并将"type"设置为"module"

// ./package.json
{
   
  "type": "module"
}

// 当不设置 type 或设置为 "commonjs" 则采用的是 CJS 规范

做了以上配置之后,如果要使用 CJS 语法(使用module.exports/require()),则需要在.cjs文件中使用,否则会报未定义的错误

当被认为时 ES6 模块时,就会自动采用严格模式(浏览器端也一样)

ES6 模块 和 CommonJS 模块的相互引用

ESM 是编译时加载(静态加载),有一个独立的模块依赖的解析阶段,模块输出的是接口(引用),它的加载、解析、执行都是异步的;CJS 是运行时加载(动态加载),模块输出的是值(模块对象),值会被缓存,它的加载、解析、执行都是同步的(require()为一个同步方法)。

由上述对两种规范的描述可见, ESM 和 CJS 规范的实现是不一样的,如果想在 ES6 模块中引入 CJS 模块或在 CJS 模块中引入 ES6 模块,则需要遵循以下规则

CJS 模块加载 ES6 模块

由于 ES6 为异步加载,CJS为同步加载,不能直接用require()去加载 ES6 模块,只能利用同样是异步加载且 CJS 和 ESM 都支持的import()来加载

// import() 返回一个 promise
import('....').then(res => {
   });

(async () => {
   
  await import('....');
}())

ES6 模块加载 CJS 模块

ESM 的import可以直接加载 CJS 模块,但只能整体加载。因为 ES6 模块需要支持静态代码分析,而 CommonJ

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值