大家好,我是速冻鱼🐟,一条水系前端💦,喜欢花里胡哨💐,持续沙雕🌲,是隔壁寒草🌿的好兄弟,刚开始写文章。 如果喜欢我的文章,可以关注➕点赞,为我注入能量,与我一同成长吧~
阅读本文🦀
1.您将了解到什么是CommonJS规范
2.您将了解到什么是ESM模块化规范
3.如何在NodeJs中使用ESM规范
如果你正在学习如何制作CLI工具
,那么我建议你可以看一下我的这篇文章🐬。
「100%提高开发效率🔥」从零到一带你快速实现企业级CLI工具🐬
前言🌵
我们知道,在NodeJS之前,由于没有过于复杂的开发场景,前端是不存在模块化的,后端才有模块化。NodeJS诞生之后,它使用CommonJS的模块化规范。从此,js模块化开始快速发展。模块化的开发方式可以提供代码复用率,方便进行代码的管理。通常来说,一个文件就是一个模块,有自己的作用域,只向外暴露特定的变量和函数。目前流行的js模块化规范有CommonJS以及ES6的模块化规范。🕶
正文 🦁
什么是CommonJS规范 💚
NodeJS
是CommonJS规范
的主要实践者,它有四个重要的环境变量为模块化的实现提供支持:module
、exports
、require
、global
。实际使用时,用module.exports
定义当前模块对外输出的接口(不推荐直接用exports
),用require
加载模块。
// 定义模块math.js var basicNum = 0; function add(a, b) { return a + b; } module.exports = { //在这里写上需要向外暴露的函数、变量 add: add, basicNum: basicNum } /** 必须加./路径,不加的话只会去node_modules文件找 **/ // 引用自定义的模块时,参数包含路径,可省略.js var math = require('./math'); math.add(2, 5); // 引用核心模块时,不需要带路径 var http = require('http'); http.createService(...).listen(3000);
CommonJS
用同步的方式加载模块
。在服务端,模块文件都存放在本地磁盘,读取非常快,所以这样做不会有问题。但是在浏览器端,限于网络原因,更合理的方案是使用异步加载。
什么是ESM模块化规范 🌽
ESM模块化规范也叫ES6模块化规范,在语言标准的层面上,实现了模块功能,而且实现得相当简单,旨在成为浏览器和服务器通用的模块解决方案。其模块功能主要由两个命令构成:export
和import
。export
命令用于规定模块的对外接口,import
命令用于输入其他模块提供的功能。
/** 定义模块 math.js **/ var basicNum = 0; var add = function (a, b) { return a + b; }; export { basicNum, add }; /** 引用模块 **/ import { basicNum, add } from './math'; function test(ele) { ele.textContent = add(99 + basicNum); }
如上例所示,使用import
命令的时候,用户需要知道所要加载的变量名或函数名。其实ES6还提供了export default
命令,为模块指定默认输出,对应的import
语句不需要使用大括号。
ES6的模块不是对象,import
命令会被 JavaScript 引擎静态分析,在编译时就引入模块代码,而不是在代码运行时加载,所以无法实现条件加载。也正因为这个,使得静态分析成为可能。
ES6 模块的特征:
- 严格模式:ES6 的模块自动采用严格模式
import
read-only特性:import
的属性是只读的,不能赋值,类似于const
的特性export/import
提升:import/export
必须位于模块顶级,不能位于作用域内;其次对于模块内的import/export
会提升到模块顶部,这是在编译阶段完成的
ESM 模块与 CommonJS 模块的差异 🍪
1. CommonJS 模块输出的是一个值的拷贝,ES6 模块输出的是值的引用。🐀
- CommonJS 模块输出的是值的拷贝,也就是说,一旦输出一个值,模块内部的变化就影响不到这个值。
- ES6 模块的运行机制与 CommonJS 不一样。JS 引擎对脚本静态分析的时候,遇到模块加载命令
import
,就会生成一个只读引用。等到脚本真正执行时,再根据这个只读引用,到被加载的那个模块里面去取值。换句话说,ES6 的import
有点像 Unix 系统的“符号连接”,原始值变了,import
加载的值也会跟着变。因此,ES6 模块是动态引用,并且不会缓存值,模块里面的变量绑定其所在的模块。
2. CommonJS 模块是运行时加载,ES6 模块是编译时输出接口。🕊
- 运行时加载: CommonJS 模块就是对象;即在输入时是先加载整个模块,生成一个对象,然后再从这个对象上面读取方法,这种加载称为“运行时加载”。
- 编译时加载: ES6 模块不是对象,而是通过
export
命令显式指定输出的代码,import
时采用静态命令的形式。即在import
时可以指定加载某个输出值,而不是加载整个模块,这种加载称为“编译时加载”。
CommonJS 加载的是一个对象(即module.exports
属性),该对象只有在脚本运行完才会生成。而 ES6 模块不是对象,它的对外接口只是一种静态定义,在代码静态解析阶段就会生成。
如何在NodeJs中使用ESM呢 🐳
1.使用mjs作文文件后缀(不推荐) 🍀
hi.msj
// Code of hi.mjs export function sayHi(name) { return "Hi, " + name + "!" } 复制代码
main.mjs
// Code of main.mjs import { sayHi } from './hi.mjs' console.log(sayHi('Sudongyu')) 复制代码
shell
node runner.mjs 复制代码
2.使用ESM library(新版本NodeJs不推荐) 🐩
此方法仅适用于较老版本的Node,最新版本的节点支持开箱即用的ES模块
shell
安装ESM library
npm init -y npm install --save esm 复制代码
在package.json 中指定的入口文件为index.js
// index.js code require = require("esm")(module); module.exports = require("./main.js"); 复制代码
3.在package.json中配置module(推荐) 🐡
package.json
"type": "module", "main": "src/index.js", 复制代码
指定type为module
配置好以后就可以直接在项目中使用ESM模块化规范了
4.如何在ESM规范下使用CommonJs规范 🍿
导入createRequire从module模块(自带的)
import {createRequire} from "module"; const require = createRequire(import.meta.url); //获取PackgeJson文件信息 let pkgManifest = require(path.join(cwd(), 'package.json'));
参考文献 📚
收获 🍁
在这篇文章中我们了解到了什么是CommonJs规范
和ESM模块
化规范,以及如何在NodeJs
中使用ESM模块化
规范,这样可以让我们的开发更加简单快捷
,相信在不久的将来模块化规范能够大一统,也希望您能在这篇文章中有所收获,如果你正在使用NodeJs
开发CLI工具
可以看一下我的这篇文章或许对你有所帮助
「100%提高开发效率🔥」从零到一带你快速实现企业级CLI工具🐬
结束语 🌞
那么我的第N篇文章
就结束了,文章的目的其实很简单,就是对日常工作的总结和输出
,输出一些觉得对大家有用的东西,菜不菜不重要,但是热爱🔥,希望大家能够喜欢我的文章,我真的很用心在写,也希望通过文章认识更多志同道合的朋友,如果你也喜欢折腾
,欢迎加我好友
,一起沙雕
,一起进步
。