CommonJS模块和ECMAScript模块

发布时间 2023-11-28 18:54:35作者: 心意12

CommonJS(简称cjs),为node.js打包javaScript的原始方法,使用require和imports(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引入。
//child.js
var counter = 3;
function incCounter() {
  counter++;
}
module.exports = {
  counter: counter,
  incCounter: incCounter,
};

//parent.js
let child = require('./child.js')
console.log(child.counter);  // 3
child.incCounter();
console.log(child.counter); // 3没变
//child.js
var obj = {
    counter:3
};
function incCounter() {
    obj.counter++;
}
module.exports = {
  obj: obj,
  incCounter: incCounter,
};
//parent.js
let child = require('./child.js')
console.log(child.obj.counter);  // 3
test.incCounter();
console.log(child.obj.counter); // 4 变了
//child.js
var obj = {
    counter:3
};
function incCounter() {
    obj.counter++;
}
module.exports = {
  obj: obj,
  incCounter: incCounter,
};
//parent.js
let child = require('./child.js')
let child1 = require('./child.js')
console.log(child.obj.counter);  // 3
test.incCounter();
console.log(child.obj.counter); // 4 变了
console.log(child1.obj.counter); // 4 变了

如果require加载的是个文件夹,那么node.js默认会尝试加载 index.js 或者 index.node

require采用同步方式加载,可以在代码的任意位置使用。

动态导入

import() 既支持cjs,又支持 esm

import('./lib.js').then((res)=>{
    //res.default  
}) 

2、es module

默认情况下,node.js会将以下情形视为 esm 模块:

  • 扩展名为 .mjs 的文件;
  • 扩展名为.js的文件,且离自己最近的package.json文件包含一个顶级字段“type”,其值为“module”;

1)、对于一个文件,导出的是对象的引用。如果内部的属性变化了,外部也会变化。
2)、对于再次引入同一个文件,如果文件名一模一样,则从缓存里面取。如果文件名加了query,则重新加载文件,不会缓存里取
3)、还有种方式,要使模块多次执行代码,请导出函数并调用该函数。

//child.mjs
var counter = 3;
function incCounter() {
  counter++;
}
export default {
  counter: counter,
  incCounter: incCounter,
};

//index.mjs
import child from "./lib.mjs";
console.log(child.counter); // 3
child.incCounter();
console.log(child.counter); // 3没变
//child.mjs
var obj = {
  counter: 3,
};
function incCounter() {
  obj.counter++;
}
export default {
  obj: obj,
  incCounter: incCounter,
};

//index.mjs
import child from "./lib.mjs";
import child1 from "./lib.mjs";  //从缓存里面取
console.log(child.obj.counter); // 3
child.incCounter();
console.log(child.obj.counter); // 4变了

console.log(child1.obj.counter); // 4变了,拿的缓存里的

多次导入,避免缓存(query):

//child.mjs
var obj = {
  counter: 3,
};
function incCounter() {
  obj.counter++;
}
export default {
  obj: obj,
  incCounter: incCounter,
};

//index.mjs
import child from "./lib.mjs?time=1";
import child1 from "./lib.mjs?time=2";  //增加query避免缓存
console.log(child.obj.counter); // 3
child.incCounter();
console.log(child.obj.counter); // 4变了
console.log(child1.obj.counter); // 3没变,重新加载的文件

注意: 从node.js v16以后,使用node内置核心模块都采用node:xx, 比如 node:fs,它和fs的区别是,不能被require缓存,而fs能被缓存

 

3、esm模块与cjs模块之间的差异

  • esm使用import/export, 而cjs使用require/exports
  • cjs可以使用 __filename 或者 __dirname,process, 而esm不行,esm只能使用 import.meta.url
  • esm不支持本机模块。 但是可以改为通过 module.createRequire() or process.dlopen.加载
  • cjs使用 require.resolve, 而esm使用new URL(), import.meta.resolve
  • cjs可以通过环境变量指定的路径,去查找本机上对应位置的模块,而esm不行,
  • cjs 是在运行时确定,而esm则在静态编译时确定。
  • cjs可以同步执行,esm不行

共同点:模块导出的都是引用。

注意:在esm中使用process,可以导入
import process from 'node:process';

 

内容摘自:https://segmentfault.com/a/1190000042443391?sort=votes

commonjs:https://nodejs.org/dist/latest-v16.x/docs/api/modules.html

ecmascript module: https://nodejs.org/dist/latest-v16.x/docs/api/esm.html