今天咱们来深度分析一下 Commonjs
和 Es Module
,但愿经过本文的学习,可以让你们完全明白 Commonjs
和 Es Module
原理,可以一次性搞定面试中遇到的大部分有关 Commonjs
和 Es Module
的问题。html
老规矩咱们带上疑问开始今天的分析🤔🤔🤔:前端
exports
,为什么又出了 module.exports
? 既生瑜,何生亮 ?require
模块查找机制 ?exports = {}
这种写法为什么无效 ?import()
的动态引入 ?ps:因为做者前一段时间在写《React进阶实践指南》小册,没有时间持续输出高质量文章,接下来我会回归创做高质量技术文章,送人玫瑰,手有余香,但愿阅读的朋友能给做者点个赞👍,鼓励我持续创做。vue
早期 JavaScript 开发很容易存在全局污染和依赖管理混乱问题。这些问题在多人开发前端应用的状况下变得更加棘手。我这里例举一个很常见的场景:node
<body>
<script src="./index.js"></script>
<script src="./home.js"></script>
<script src="./list.js"></script>
</body>
复制代码
如上在没有模块化的前提下,若是在 html
中这么写,那么就会暴露一系列问题。webpack
没有模块化,那么 script
内部的变量是能够相互污染的。好比有一种场景,如上 ./index.js
文件和 ./list.js
文件为小 A 开发的,./home.js
为小 B 开发的。web
小 A 在 index.js
中声明 name 属性是一个字符串。面试
var name = '我不是外星人'
复制代码
而后小 A 在 list.js
中,引用 name 属性,npm
console.log(name)
复制代码
打印却发现 name 居然变成了一个函数。刚开始小 A 不知所措,后来发如今小 B 开发的 home.js
文件中这么写道:json
function name(){
//...
}
复制代码
并且这个 name 方法被引用了屡次,致使一系列的连锁反应。segmentfault
上述例子就是没有使用模块化开发,形成的全局污染的问题,每一个加载的 js 文件都共享变量。固然在实际的项目开发中,可使用匿名函数自执行的方式,造成独立的块级做用域解决这个问题。
只须要在 home.js 中这么写道:
(function (){
function name(){
//...
}
})()
复制代码
这样小 A 就能正常在 list.js
中获取 name 属性。可是这只是一个 demo
,咱们不能保证在实际开发中状况会更加复杂。因此不使用模块开发会暴露出不少风险。
依赖管理也是一个难以处理的问题。仍是如上的例子,正常状况下,执行 js 的前后顺序就是 script 标签排列的先后顺序。那么如何三个 js 之间有依赖关系,那么应该如何处理呢?
假设三个 js 中,都有一个公共方法 fun1
, fun2
, fun3
。三者之间的依赖关系以下图所示。
因此就须要模块化来解决上述的问题,今天咱们就重点讲解一下前端模块化的两个重要方案:Commonjs 和 Es Module
Commonjs
的提出,弥补 Javascript 对于模块化,没有统一标准的缺陷。nodejs 借鉴了 Commonjs
的 Module ,实现了良好的模块化管理。
目前 commonjs
普遍应用于如下几个场景:
Node
是 CommonJS 在服务器端一个具备表明性的实现;Browserify
是 CommonJS 在浏览器中的一种实现;webpack
打包工具对 CommonJS 的支持和转换;也就是前端应用也能够在编译以前,尽情使用 CommonJS 进行开发。在使用 规范下,有几个显著的特色。
commonjs
中每个 js 文件都是一个单独的模块,咱们能够称之为 module;导出:咱们先尝试这导出一个模块:
hello.js
中
let name = '《React进阶实践指南》'
module.exports = function sayName (){
return name
}
复制代码
导入:接下来简单的导入:
home.js
const sayName = require('./hello.js')
module.exports = function say(){
return {
name:sayName(),
author:'我不是外星人'
}
}
复制代码
如上就是 Commonjs 最简单的实现,那么暴露出两个问题:
首先从上述得知每一个模块文件上存在 module
,exports
,require
三个变量,然而这三个变量是没有被定义的,可是咱们能够在 Commonjs 规范下每个 js 模块上直接使用它们。在 nodejs 中还存在 __filename
和 __dirname
变量。
如上每个变量表明什么意思呢:
module
记录当前模块信息。require
引入模块的方法。exports
当前模块导出的属性在编译的过程当中,实际 Commonjs 对 js 的代码块进行了首尾包装, 咱们以上述的 home.js 为例子🌰,它被包装以后的样子以下:
(function(exports,require,module,__filename,__dirname){
const sayName = require('./hello.js')
module.exports = function say(){
return {
name:sayName(),
author:'我不是外星人'
}
}
})
复制代码
require
,exports
,module
本质上是经过形参的方式传递到包装函数中的。那么包装函数本质上是什么样子的呢?
function wrapper (script) {
return '(function (exports, require, module, __filename, __dirname) {' +
script +
'\n})'
}
复制代码
包装函数执行。
const modulefunction = wrapper(` const sayName = require('./hello.js') module.exports = function say(){ return { name:sayName(), author:'我不是外星人' } } `)
复制代码
runInThisContext(modulefunction)(module.exports, require, module, __filename, __dirname)
复制代码
modulefunction
,传入require
,exports
,module
等参数。最终咱们写的 nodejs 文件就这么执行了。到此为止,完成了整个模块执行的原理。接下来咱们来分析如下 require 文件加载的流程。
上述说了 commonjs 规范大体的实现原理,接下来咱们分析一下, require
如何进行文件的加载的。
咱们仍是以 nodejs 为参考,好比以下代码片断中:
const fs = require('fs') // ①核心模块
const sayName = require('./hello.js') //② 文件模块
const crypto = require('crypto-js') // ③第三方自定义模块
复制代码
如上代码片断中:
sayName
crypto-js
。当 require 方法执行的时候,接收的惟一参数做为一个标识符 ,Commonjs 下对不一样的标识符,处理流程不一样,可是目的相同,都是找到对应的模块。
首先咱们看一下 nodejs
中对标识符的处理原则。
./
和 ../
做为相对路径的文件模块, /
做为绝对路径的文件模块。核心模块的处理:
核心模块的优先级仅次于缓存加载,在 Node
源码编译中,已被编译成二进制代码,因此加载核心模块,加载过程当中速度最快。
路径形式的文件模块处理:
已 ./
,../
和 /
开始的标识符,会被看成文件模块处理。require()
方法会将路径转换成真实路径,并以真实路径做为索引,将编译后的结果缓存起来,第二次加载的时候会更快。至于怎么缓存的?咱们稍后会讲到。
自定义模块处理: 自定义模块,通常指的是非核心的模块,它多是一个文件或者一个包,它的查找会遵循如下原则:
node_modules
目录查找。node_modules
查找,若是没有在父级目录的父级目录的 node_modules
中查找。node_modules
目录。package.json
下 main 属性指向的文件,若是没有 package.json
,在 node 环境下会以此查找 index.js
,index.json
,index.node
。查找流程图以下所示:
CommonJS 模块同步加载并执行模块文件,CommonJS 模块在执行阶段分析模块依赖,采用深度优先遍历(depth-first traversal),执行顺序是父 -> 子 -> 父;
为了搞清除 require 文件引入流程。咱们接下来再举一个例子,这里注意一下细节:
a.js文件
const getMes = require('./b')
console.log('我是 a 文件')
exports.say = function(){
const message = getMes()
console.log(message)
}
复制代码
b.js
文件const say = require('./a')
const object = {
name:'《React进阶实践指南》',
author:'我不是外星人'
}
console.log('我是 b 文件')
module.exports = function(){
return object
}
复制代码
main.js
const a = require('./a')
const b = require('./b')
console.log('node 入口文件')
复制代码
接下来终端输入 node main.js
运行 main.js
,效果以下:
从上面的运行结果能够得出如下结论:
main.js
和 a.js
模块都引用了 b.js
模块,可是 b.js
模块只执行了一次。a.js
模块 和 b.js
模块互相引用,可是没有形成循环引用的状况。那么 Common.js
规范是如何实现上述效果的呢?
首先为了弄清楚上述两个问题。咱们要明白两个感念,那就是 module
和 Module
。
module
:在 Node 中每个 js 文件都是一个 module ,module 上保存了 exports 等信息以外,还有一个 loaded
表示该模块是否被加载。
false
表示尚未加载;true
表示已经加载Module
:以 nodejs 为例,整个系统运行以后,会用 Module
缓存每个模块加载的信息。
require 的源码大体长以下的样子:
// id 为路径标识符
function require(id) {
/* 查找 Module 上有没有已经加载的 js 对象*/
const cachedModule = Module._cache[id]
/* 若是已经加载了那么直接取走缓存的 exports 对象 */
if(cachedModule){
return cachedModule.exports
}
/* 建立当前模块的 module */
const module = { exports: {} ,loaded: false , ...}
/* 将 module 缓存到 Module 的缓存属性中,路径标识符做为 id */
Module._cache[id] = module
/* 加载文件 */
runInThisContext(wrapper('module.exports = "123"'))(module.exports, require, module, __filename, __dirname)
/* 加载完成 *//
module.loaded = true
/* 返回值 */
return module.exports
}
复制代码
从上面咱们总结出一次 require
大体流程是这样的;
require 会接收一个参数——文件标识符,而后分析定位文件,分析过程咱们上述已经讲到了,加下来会从 Module 上查找有没有缓存,若是有缓存,那么直接返回缓存的内容。
若是没有缓存,会建立一个 module 对象,缓存到 Module 上,而后执行文件,加载完文件,将 loaded 属性设置为 true ,而后返回 module.exports 对象。借此完成模块加载流程。
模块导出就是 return 这个变量的其实跟 a = b 赋值同样, 基本类型导出的是值, 引用类型导出的是引用地址。
exports 和 module.exports 持有相同引用,由于最后导出的是 module.exports, 因此对 exports 进行赋值会致使 exports 操做的再也不是 module.exports 的引用。
从上面咱们能够直接得出,require 如何避免重复加载的,首先加载以后的文件的 module
会被缓存到 Module
上,好比一个模块已经 require 引入了 a 模块,若是另一个模块再次引用 a ,那么会直接读取缓存值 module ,因此无需再次执行模块。
对应 demo 片断中,首先 main.js
引用了 a.js
,a.js
中 require 了 b.js
此时 b.js
的 module 放入缓存 Module
中,接下来 main.js
再次引用 b.js
,那么直接走的缓存逻辑。因此 b.js 只会执行一次,也就是在 a.js 引入的时候。
那么接下来这个循环引用问题,也就很容易解决了。为了让你们更清晰明白,那么咱们接下来一块儿分析整个流程。
node main.js
,那么开始执行第一行 require(a.js)
;a.js
有没有缓存,由于没有缓存,先加入缓存,而后执行文件 a.js (须要注意 是先加入缓存, 后执行模块内容);b.js
有没有缓存,由于没有缓存,因此加入缓存,而后执行 b.js 文件。require(a.js)
此时的 a.js 已经加入缓存,直接读取值。接下来打印 console.log('我是 b 文件')
,导出方法。console.log('我是 a 文件')
,导出方法。main.js
,打印 console.log('node 入口文件')
完成这个流程。不过这里咱们要注意问题:
say
方法,因此 b.js 同步上下文中,获取不到 say。我用一幅流程图描述上述过程:
为了进一步验证上面所说的,咱们改造一下 b.js
以下:
const say = require('./a')
const object = {
name:'《React进阶实践指南》',
author:'我不是外星人'
}
console.log('我是 b 文件')
console.log('打印 a 模块' , say)
setTimeout(()=>{
console.log('异步打印 a 模块' , say)
},0)
module.exports = function(){
return object
}
复制代码
打印结果:
那么如何获取到 say 呢,有两种办法:
咱们注意到 a.js 是用 exports.say
方式导出的,若是 a.js 用 module.exports 结果会有所不一样。至于有什么不一样,为何?我接下来会讲到。
上述咱们讲了 require
查找文件和加载流程。接下来介绍 commonjs
规范下的 require 的另一个特性——动态加载。
require 能够在任意的上下文,动态加载模块。我对上述 a.js 修改。
a.js
:
console.log('我是 a 文件')
exports.say = function(){
const getMes = require('./b')
const message = getMes()
console.log(message)
}
复制代码
main.js
:
const a = require('./a')
a.say()
复制代码
打印结果以下:
require 本质上就是一个函数,那么函数能够在任意上下文中执行,来自由地加载其余模块的属性方法。
系统分析完 require
,接下来咱们分析一下,exports
和 module.exports
,首先看一下两个的用法。
第一种方式:exports a.js
exports.name = `《React进阶实践指南》`
exports.author = `我不是外星人`
exports.say = function (){
console.log(666)
}
复制代码
引用
const a = require('./a')
console.log(a)
复制代码
打印结果:
module.exports
。问题:为何 exports={} 直接赋值一个对象就不能够呢? 好比咱们将如上 a.js
修改一下:
exports={
name:'《React进阶实践指南》',
author:'我不是外星人',
say(){
console.log(666)
}
}
复制代码
打印结果:
理想状况下是经过 exports = {}
直接赋值,不须要在 exports.a = xxx
每个属性,可是如上咱们看到了这种方式是无效的。为何会这样?实际这个是 js 自己的特性决定的。
经过上述讲解都知道 exports , module 和 require 做为形参的方式传入到 js 模块中。咱们直接 exports = {}
修改 exports ,等于从新赋值了形参,那么会从新赋值一份,可是不会在引用原来的形参。举一个简单的例子
function wrap (myExports){
myExports={
name:'我不是外星人'
}
}
let myExports = {
name:'alien'
}
wrap(myExports)
console.log(myExports)
复制代码
打印:
咱们指望修改 myExports ,可是没有任何做用。
假设 wrap
就是 Commonjs 规范下的包装函数,咱们的 js 代码就是包装函数内部的内容。当咱们把 myExports 对象传进去,可是直接赋值 myExports = { name:'我不是外星人' }
没有任何做用,相等于内部从新声明一份 myExports
而和外界的 myExports 断绝了关系。因此解释了为何不能 exports={...}
直接赋值。
那么解决上述也容易,只须要函数中像 exports.name 这么写就能够了。
function wrap (myExports){
myExports.name='我不是外星人'
}
复制代码
打印:
module.exports 本质上就是 exports ,咱们用 module.exports 来实现如上的导出。
module.exports ={
name:'《React进阶实践指南》',
author:'我不是外星人',
say(){
console.log(666)
}
}
复制代码
module.exports 也能够单独导出一个函数或者一个类。好比以下:
module.exports = function (){
// ...
}
复制代码
从上述 require
原理实现中,咱们知道了 exports 和 module.exports 持有相同引用,由于最后导出的是 module.exports 。那么这就说明在一个文件中,咱们最好选择 exports
和 module.exports
二者之一,若是二者同时存在,极可能会形成覆盖的状况发生。好比以下状况:
exports.name = 'alien' // 此时 exports.name 是无效的
module.exports ={
name:'《React进阶实践指南》',
author:'我不是外星人',
say(){
console.log(666)
}
}
复制代码
module.exports
覆盖。1 那么问题来了? 既然有了 exports
,为什么又出了 module.exports
?
答:若是咱们不想在 commonjs 中导出对象,而是只导出一个类或者一个函数再或者其余属性的状况,那么 module.exports
就更方便了,如上咱们知道 exports
会被初始化成一个对象,也就是咱们只能在对象上绑定属性,可是咱们能够经过 module.exports
自定义导出出对象外的其余类型元素。
let a = 1
module.exports = a // 导出函数
module.exports = [1,2,3] // 导出数组
module.exports = function(){} //导出方法
复制代码
2 与 exports
相比,module.exports
有什么缺陷 ?
答:module.exports
当导出一些函数等非对象属性的时候,也有一些风险,就好比循环引用的状况下。对象会保留相同的内存地址,就算一些属性是后绑定的,也能间接经过异步形式访问到。可是若是 module.exports 为一个非对象其余属性类型,在循环引用的时候,就容易形成属性丢失的状况发生了。
Nodejs
借鉴了 Commonjs
实现了模块化 ,从 ES6
开始, JavaScript
才真正意义上有本身的模块化规范,
Es Module 的产生有不少优点,好比:
Es Module
的静态导入导出的优点,实现了 tree shaking
。Es Module
还能够 import()
懒加载方式实现代码分割。在 Es Module
中用 export
用来导出模块,import
用来导入模块。可是 export
配合 import
会有不少种组合状况,接下来咱们逐一分析一下。
全部经过 export 导出的属性,在 import 中能够经过结构的方式,解构出来。
export 正常导出,import 导入
导出模块:a.js
const name = '《React进阶实践指南》'
const author = '我不是外星人'
export { name, author }
export const say = function (){
console.log('hello , world')
}
复制代码
导入模块:main.js
// name , author , say 对应 a.js 中的 name , author , say
import { name , author , say } from './a.js'
复制代码
module
的命名导出 ,module 为如上的 ./a.js
默认导出 export default
导出模块:a.js
const name = '《React进阶实践指南》'
const author = '我不是外星人'
const say = function (){
console.log('hello , world')
}
export default {
name,
author,
say
}
复制代码
导入模块:main.js
import mes from './a.js'
console.log(mes) //{ name: '《React进阶实践指南》',author:'我不是外星人', say:Function }
复制代码
export default anything
导入 module 的默认导出。 anything
能够是函数,属性方法,或者对象。import anyName from 'module'
, anyName 能够是自定义名称。混合导入|导出
ES6 module 可使用 export default 和 export 导入多个属性。
导出模块:a.js
export const name = '《React进阶实践指南》'
export const author = '我不是外星人'
export default function say (){
console.log('hello , world')
}
复制代码
导入模块:main.js
中有几种导入方式:
第一种:
import theSay , { name, author as bookAuthor } from './a.js'
console.log(
theSay, // ƒ say() {console.log('hello , world') }
name, // "《React进阶实践指南》"
bookAuthor // "我不是外星人"
)
复制代码
第二种:
import theSay, * as mes from './a'
console.log(
theSay, // ƒ say() { console.log('hello , world') }
mes // { name:'《React进阶实践指南》' , author: "我不是外星人" ,default: ƒ say() { console.log('hello , world') } }
)
复制代码
mes
属性上, export
被导入到对应的属性上,export default
导出内容被绑定到 default
属性上。 theSay
也能够做为被 export default
导出属性。重属名导入
import { name as bookName , say, author as bookAuthor } from 'module'
console.log( bookName , bookAuthor , say ) //《React进阶实践指南》 我不是外星人
复制代码
重定向导出
能够把当前模块做为一个中转站,一方面引入 module 内的属性,而后把属性再给导出去。
export * from 'module' // 第一种方式
export { name, author, ..., say } from 'module' // 第二种方式
export { name as bookName , author as bookAuthor , ..., say } from 'module' //第三种方式
复制代码
module
内的 default
属性。无需导入模块,只运行模块
import 'module'
复制代码
module
只运行一次。动态导入
const promise = import('module')
复制代码
import('module')
,动态导入返回一个 Promise
。为了支持这种方式,须要在 webpack 中作相应的配置处理。接下来咱们重点分析一下 ES6 module 一些重要特性。
ES6 module 的引入和导出是静态的,import
会自动提高到代码的顶层 ,import
, export
不能放在块级做用域或条件语句中。
🙅错误写法一:
function say(){
import name from './a.js'
export const author = '我不是外星人'
}
复制代码
🙅错误写法二:
isexport && export const name = '《React进阶实践指南》'
复制代码
这种静态语法,在编译过程当中肯定了导入和导出的关系,因此更方便去查找依赖,更方便去 tree shaking
(摇树) , 可使用 lint 工具对模块依赖进行检查,能够对导入导出加上类型信息进行静态的类型检查。
import 的导入名不能为字符串或在判断语句,下面代码是错误的
🙅错误写法三:
import 'defaultExport' from 'module'
let name = 'Export'
import 'default' + name from 'module'
复制代码
ES6 module 和 Common.js 同样,对于相同的 js 文件,会保存静态属性。
可是与 Common.js 不一样的是 ,CommonJS
模块同步加载并执行模块文件,ES6 模块提早加载并执行模块文件,ES6 模块在预处理阶段分析模块依赖,在执行阶段执行模块,两个阶段都采用深度优先遍历,执行顺序是子 -> 父。
为了验证这一点,看一下以下 demo。
main.js
console.log('main.js开始执行')
import say from './a'
import say1 from './b'
console.log('main.js执行完毕')
复制代码
a.js
import b from './b'
console.log('a模块加载')
export default function say (){
console.log('hello , world')
}
复制代码
b.js
console.log('b模块加载')
export default function sayhello(){
console.log('hello,world')
}
复制代码
main.js
和 a.js
都引用了 b.js
模块,可是 b 模块也只加载了一次。效果以下:
不能修改import导入的属性
a.js
export let num = 1
export const addNumber = ()=>{
num++
}
复制代码
main.js
中
import { num , addNumber } from './a'
num = 2
复制代码
若是直接修改,那么会报错。以下所示:
属性绑定
因此能够在 main.js
中这么修改。
import { num , addNumber } from './a'
console.log(num) // num = 1
addNumber()
console.log(num) // num = 2
复制代码
接下来对 import 属性做出总结:
import()
返回一个 Promise
对象, 返回的 Promise
的 then 成功回调中,能够获取模块的加载成功信息。咱们来简单看一下 import()
是如何使用的。
main.js
setTimeout(() => {
const result = import('./b')
result.then(res=>{
console.log(res)
})
}, 0);
复制代码
b.js
export const name ='alien'
export default function sayhello(){
console.log('hello,world')
}
复制代码
打印以下:
从打印结果能够看出 import()
的基本特性。
import()
能够动态使用,加载模块。import()
返回一个 Promise
,成功回调 then 中能够获取模块对应的信息。 name
对应 name 属性, default
表明 export default
。__esModule
为 es module 的标识。动态加载
import()
动态加载一些内容,能够放在条件语句或者函数执行上下文中。if(isRequire){
const result = import('./b')
}
复制代码
懒加载
import()
能够实现懒加载,举个例子 vue 中的路由懒加载;[
{
path: 'home',
name: '首页',
component: ()=> import('./home') ,
},
]
复制代码
React中动态加载
const LazyComponent = React.lazy(()=>import('./text'))
class index extends React.Component{
render(){
return <React.Suspense fallback={ <div className="icon"><SyncOutlinespin/></div> } > <LazyComponent /> </React.Suspense>
}
复制代码
React.lazy
和 Suspense
配合一块儿用,可以有动态加载组件的效果。React.lazy
接受一个函数,这个函数须要动态调用 import()
。
import()
这种加载效果,能够很轻松的实现代码分割。避免一次性加载大量 js 文件,形成首次加载白屏时间过长的状况。
Tree Shaking 在 Webpack 中的实现,是用来尽量的删除没有被使用过的代码,一些被 import 了但其实没有被使用的代码。好比如下场景:
a.js
:
export let num = 1
export const addNumber = ()=>{
num++
}
export const delNumber = ()=>{
num--
}
复制代码
main.js
:
import { addNumber } from './a'
addNumber()
复制代码
a.js
中暴露两个方法,addNumber
和 delNumber
,可是整个应用中,只用到了 addNumber
,那么构建打包的时候,delNumber
将做为没有引用的方法,不被打包进来。接下来贯穿全文,讲一下 Commonjs
和 Es Module
的特性。
Commonjs
的特性以下:
Es module
的特性以下:
本文详细讲解了 Commonjs 和 Es Module ,但愿阅读的同窗能对前端模块化的实现有更深刻的认识。吃透本文,可以轻松应付 Commonjs 和 Es Module 的面试知识点。
若是这篇文章对你有帮助,但愿能给笔者 点赞+收藏 以此鼓励做者继续创做前端硬核文章。也能够关注做者公众号 前端Sharing 第一时间推送前端好文。
系统学习 React 的掘金小册——《React进阶实践指南》已经完结啦~
是终点亦是起点, 小册内容将持续更新,随着 React 版本升级持续维护,并有持续更新章节~
提早透露,小册接下来会补充:React context
原理部分,内容补充到第八章。
奉上几个小册 7 折 优惠码 F3Z1VXtv ,先到先得哦~