CommonJS模块 和 ECMAScript模块

更新日期: 2022-09-07阅读: 645标签: 模块
CommonJS模块(下面简称 cjs) 是为Node.js打包JavaScript代码的原始方法。使用 require 和 exports(module.exports的简写) 语句定义模块。 参见 nodejs cjs
ECMAScript模块(下面简称 esm)是ecma262标准下封装的JavaScript代码重用的官方标准格式。使用 import 和export 语句定义模块。参见node esm

-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.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

动态导入

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.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变了,拿的缓存里的

多次导入,避免缓存

//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没变,重新加载的文件

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不行

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

以上文章来自官方文档

链接: https://www.fly63.com/article/detial/12096

ES6模块功能:export和import的加载方式

ES6之前已经出现了js模块加载的方案,最主要的是CommonJS和AMD规范。commonjs主要应用于服务器,实现同步加载,如nodejs。AMD规范应用于浏览器,如requirejs,为异步加载。

Node的https模块_创建HTTPS服务器

Node的https模块:HTTPS服务器使用HTTPS协议,需要证书授权,SSL安全加密后传输,使用443端口

如何让 node 运行 es6 模块文件,及其原理

最新版的 node 支持最新版 ECMAScript 几乎所有特性,但有一个特性却一直到现在都还没有支持,那就是从 ES2015 开始定义的模块化机制。而现在我们很多项目都是用 es6 的模块化规范来写代码的,包括 node 项目

module、export、require、import的使用

module每个文件就是一个模块。文件内定义的变量、函数等等都是在自己的作用域内,都是自身所私有的,对其它文件不可见。在module中有一个属性exports,即:module.exports。它是该模块对外的输出值,是一个对象。

Node.js - 模块系统

模块是Node.js 应用程序的基本组成部分,文件和模块是一一对应的。换言之,一个 Node.js 文件就是一个模块,这个文件可能是JavaScript 代码、JSON 或者编译过的C/C++ 扩展。Node.js 提供了 exports 和 require 两个对象

ES模块基础用法及常见使用问题

ES6中引入了模块(Modules)的概念,相信大家都已经挺熟悉的了,在日常的工作中应该也都有使用。本文会简单介绍一下ES模块的优点、基本用法以及常见问题。

ES6 export 和 export default的区别

ES6中 export 和 export default 与 import使用的区别,使用 react native 代码详解,现在流行的前端框架,angular+ 主要使用 export 导出模块,react native 中使用 export default 导出模块,如今编辑器非常强大,安装插件会自动弹出模块名称,知道其导出怎么使用就可以了

export和export default的区别

export与export default均可用于导出常量、函数、文件、模块;你可以在其它文件或模块中通过import+(常量 | 函数 | 文件 | 模块)名的方式,将其导入,以便能够对其进行使用;

关于export和export default你不知道的事

网上有很多关于export和export default的文章,他们大部门都是只讲了用法,但是没有提到性能,打包等关键的东西。大家应该应该能理解import * from xxx会把文件中export default的内容都打包到文件中,而import {func} from xxx只会把文件中的func导入

最全的前端模块化方案

模块化主要是用来抽离公共代码,隔离作用域,避免变量冲突等。将一个复杂的系统分解为多个模块以方便编码。会讲述以下内容:CommonJS、AMD 及 核心原理实现、CMD 及 核心原理实现

点击更多...

内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!