CommonJS模块(上面简称 cjs) 是为Node.js打包JavaScript代码的原始办法。应用 require 和 exports(module.exports的简写) 语句定义模块。
ECMAScript模块(上面简称 esm)是ecma262规范下封装的JavaScript代码重用的官网规范格局。应用 import 和export 语句定义模块。
-cjs只有在node.js环境应用。
-esm在node.js和浏览器环境都能够应用
1、commonjs
在node.js中,每个文件都被视为一个独自的模块。模块的局部变量是公有的,只有exports进来的变量,能力被外界拜访。
默认状况下,node.js会将以下情景视为 cjs模块:
- 扩大名为.cjs的文件;
- 扩大名为.js的文件,且离本人最近的package.json文件蕴含一个顶级字段“type”,其值为“commonjs”;
- 扩大名为.js的文件,且离本人最近的package.json文件不蕴含一个顶级字段“type”(倡议明确指定 type值,而不是不定义);
- 扩展名不为.mjs, .cjs, .json, .node, .js的文件,且离本人最近的package.json文件蕴含一个顶级字段“type”,其值为“module”,然而这些文件通过require引入。
调用require()时,始终应用cjs模块加载器,
require采纳同步形式加载,能够在代码的任意地位应用。
因为require()的同步个性,无奈应用它加载ECMAScript模块文件。尝试这样做将抛出ERR_REQUIRE_ESM谬误。请改用import()。
要获取调用require()时将加载的确切文件名,请应用require.resolve()函数。
1)、对于一个文件,导出的是对象的援用。如果外部的属性变动了,内部也会变动。
2)、对于再次引入同一个文件,如果文件名截然不同,则从缓存外面取
3)、还有种形式,要使模块屡次执行代码,请导出函数并调用该函数。
导出一个原始值
//child.jsvar counter = 3;function incCounter() { counter++;}module.exports = { counter: counter, incCounter: incCounter,};//parent.jslet child = require('./child.js')console.log(child.counter); // 3child.incCounter();console.log(child.counter); // 3没变
导出一个对象
//child.jsvar obj = { counter:3};function incCounter() { obj.counter++;}module.exports = { obj: obj, incCounter: incCounter,};//parent.jslet child = require('./child.js')console.log(child.obj.counter); // 3test.incCounter();console.log(child.obj.counter); // 4 变了
导出一个对象,多个文件,会从缓存里获取
//child.jsvar obj = { counter:3};function incCounter() { obj.counter++;}module.exports = { obj: obj, incCounter: incCounter,};//parent.jslet child = require('./child.js')let child1 = require('./child.js')console.log(child.obj.counter); // 3test.incCounter();console.log(child.obj.counter); // 4 变了console.log(child1.obj.counter); // 4 变了
如果require加载的是个文件夹,那么node.js默认会尝试加载 index.js 或者 index.node
动静导入
import() 既反对cjs,又反对 esm
import('./lib.js').then((res)=>{ //res.default })
2、es module
调用 import()时,始终应用esm模块加载器,
默认状况下,node.js会将以下情景视为 esm 模块:
扩大名为 .mjs 的文件;
扩大名为.js的文件,且离本人最近的package.json文件蕴含一个顶级字段“type”,其值为“module”;
1)、对于一个文件,导出的是对象的援用。如果外部的属性变动了,内部也会变动。
2)、对于再次引入同一个文件,如果文件名截然不同,则从缓存外面取。如果文件名加了query,则从新加载文件,不会缓存里取
3)、还有种形式,要使模块屡次执行代码,请导出函数并调用该函数。
单次导入,导入根本类型
//child.mjsvar counter = 3;function incCounter() { counter++;}export default { counter: counter, incCounter: incCounter,};//index.mjsimport child from "./lib.mjs";console.log(child.counter); // 3child.incCounter();console.log(child.counter); // 3没变
屡次导入,导入援用类型
//child.mjsvar obj = { counter: 3,};function incCounter() { obj.counter++;}export default { obj: obj, incCounter: incCounter,};//index.mjsimport child from "./lib.mjs";import child1 from "./lib.mjs"; //从缓存外面取console.log(child.obj.counter); // 3child.incCounter();console.log(child.obj.counter); // 4变了console.log(child1.obj.counter); // 4变了,拿的缓存里的
屡次导入,防止缓存
//child.mjsvar obj = { counter: 3,};function incCounter() { obj.counter++;}export default { obj: obj, incCounter: incCounter,};//index.mjsimport child from "./lib.mjs?time=1";import child1 from "./lib.mjs?time=2"; //减少query防止缓存console.log(child.obj.counter); // 3child.incCounter();console.log(child.obj.counter); // 4变了console.log(child1.obj.counter); // 3没变,从新加载的文件
import.meta.url
以后文件文件模块的 url地址。
import { readFileSync } from 'node:fs';const buffer = readFileSync(new URL('./data.proto', import.meta.url));
import.meta.resolve 试验性能
await import.meta.resolve('./dep', import.meta.url);const dependencyAsset = await import.meta.resolve('component-lib/asset.css');
在esm中应用 require
import { createRequire } from 'node:module'; const require = createRequire(import.meta.url);// sibling-module.js is a CommonJS module.const siblingModule = require('./sibling-module');
留神: 从node.js v16当前,应用node内置外围模块都采纳node:xx, 比方 node:fs,它和fs的区别是,不能被require缓存,而fs能被缓存,能够查看 v16 changeLog-issue
const path = require('node:path'); //不被缓存const path = require('path'); //能够被缓存
3、esm模块与cjs模块之间的差别
- esm应用import/export, 而cjs应用require/exports
- cjs能够应用 __filename 或者 __dirname, 而esm不行,esm只能应用 import.meta.url
- esm不反对本机模块。 ith module.createRequire() or process.dlopen.
- cjs应用 require.resolve, 而esm应用new URL(), import.meta.resolve
- cjs能够通过环境变量指定的门路,去查找本机上对应地位的模块,而esm不行,
- cjs 是在运行时确定,而esm则在动态编译时确定。
- cjs能够同步执行,esm不行
共同点:模块导出的都是援用。