先给 module 在网上找个自己感觉妥当的定义,module: 开发者将程序分解成离散功能块,这些功能块就称为 module。
在 Node.js 里每个 .js/.json/.node 文件就是一个 module(后面专指 .js 的 module),每个 module 通过 module.exports
来导出;在其他 module 里通过 require(modulePath)
来引入别的 module 的 module.exports
。
这里厘下原先让自己疑惑的几个点:
- module 运行的机制是什么:当在一个 module 第一次被 require 时,会经历 Resolution --> Loading --> Wrapping --> Evaluation --> Caching 这一系列过程,先通过传入 require 的参数来确定目标 module 到底在哪里,是什么;找到 module 后,将 module 文件(比如是个 js 文件)里的内容读到内存;下一步是将这些内容放到
function (exports, require, module, __filename, __dirname) {...// 引入的 module 的内容}
,并执行这个函数,也就是说会执行引入的 module 的代码,同时这个 wrapper 函数为每个 module 提供了exports
,require
,module
,__filename
,__dirname
五个参数,这也是为什么我们在每个 module 可以直接访问这些变量,就好像他们是全局变量一样;在执行完这个 wrapper 函数之后被 require 的 module 会被缓存起来,以便在当前运行周期里再被 require 的时候不必再历经上面重重步骤,而是直接返回这个 module 的exports
即可。 - 在命令行窗口被 node 命令直接的运行的 module 会被所有当前运行周期里被引用的 module 的
require.main
字段所引用,也就是说可以通过require.main === module
来判断某个 module 在被运行时是被 require 的还是直接由 node 的。 -
module.exports
和exports
的关系是什么?在一个 module 里如果不对这两个东西做任何操作的话,console.log
出他们,会发现他们的指向的都是一个{}
,而且是同一个,也就是说默认情况下module.exports === exports
是返回true
的,所以在给exports
添加某个属性时,比如exports.a = any
就等于执行了module.exports.a = any
,也就等同于将a
导出,因为 require 某个 module 的本质就是获取这个 module 的module.exports
;同时也说明exports = { a: any }
这样的赋值方式是不会导出a
的,因为exports
本质上只是module.exports
的一个 copy,上面的赋值只是把exports
指向了一个新的对象,而不会对module.exports
有影响,所以会看到有的库里面这样写module.exports = exports = { a: any }
,这样保持了exports
和module.exports
的引用始终相同。 - 循环引用怎么解决?Node.js 的做法是如果一个 module A require 了 module B,同时 module B 里又 require 了 module A,假设 A 是 main module,那么在执行到
require(moduleB)
后再执行 module B 里的代码的时候,遇到require(moduleA)
时会返回一个 module A 执行到require(moduleB)
这一行时module.exports
的值的 copy 给 module B,也就是说,module A 里在require(moduleB)
之后的导出不会体现在 module B 里require(moduleA)
的返回值中。
ES6 的 module,与 Node.js 里的 module 的概念基本相同,都是一个文件对应一个 module,只不过这里的文件只包含 .js 的文件。这里只简单介绍 import 和 export 的基本用法,其余冗杂或稍微者深层次的东西,下次。
-
export:一个 ES6 module 有两种形式的 export,一种是 named export,另一种是 default export,两者可同时存在于一个 module,在一个 module 中前者只能有一个,后者可以多个
- named export:可以在定义的时候就 export,此时大致写法为
export const b = any export const a = any
也可以先定义,然后统一 export,此时大致写法为
const a = any const b = any export { a, b }
- default export:同上面一样:
export default function() {}
或者
function A() {} export default A
此外,可以在 named export 的统一 export 中指定一个 default export(前提是当前 module 没有明确指定另外的 default export),比如
export { a as default, b }
,此时 a 就成了 module 的 default export;其实这里的 as 的本质不过是重命名,既然可以重命名为default
(当把一个 named export 重命名为 default 的时候,这个 named default 就变成了当前 module 的 export default),也可以把一个 named export 的 name 重命名为另一个 name。 -
import:import 与 export 一样,也有 named import 和 default import,但除此之外多出一个 namespace import 和 empty import
- named import: 与 named export 对应
import { a, b } from 'B'
,当然也有import { default as a, b } from 'B'
,即将 module B 中的 default export 重命名为a
。其实 named import 的这个{}
起作用的机制和对象的结构赋值差不多,module B,导出一个对象,对象里的东西都有各自的 key,其中 default export 对应的 key 为default
,其余 named default 的 key 为她们在被 named export 时制定的 name。 - default import:只需要
import a from 'B'
就可以了,这样取得的a
就是 module B 的 default export。 - namespace import:named import 适用于只想 import 目标 module 里的部分 export,如果想一下子把 module B 里的众多 export 全都 import,那么挨个写出那些 export 的 name,未免有点太傻,这时候就可以用 namespace import。写法为
import * as namespaceName from 'B'
,这里 'as nameSpaceName' 是必须的,必须为 import 的对象重新命名,这样nameSpaceName
就是一个包含 module B 所有 export 的对象啦。 - empty import:写法为
import 'B'
,作用是当 B 为当前运行周期的第一次被 import 的时候,执行 module B 里的代码。
- named import: 与 named export 对应
import 和 export 的基本用法就是上面这些。除此之外,export 还有些简便的写法,称之为 Re-exporting,这适用于一个文件里将所有 module 的 export 统一到这个文件夹下的 index.js 的文件中的情形,这有利于确定一个模块的边界,所有的对外提供的东西只在文件夹下的 index.js 文件中呈现。比如我们现在一个 util 文件夹,里面有 moduleA export { a },moduleB export { b } 和一个 index.js 文件,为了把 a 和 b 对外呈现,那我们在 index.js 中会这样写
import { a } from './moduleA'
import { b } from './moduleB'
export { a ,b }
那有了 Re-exporting 之后,可以写成
export { a } from './moduleA'
export { b } from './moduleB'
这样会少些一行,但我想好处应该不只是少些一行这么简单吧,我记得在哪里看到两者好像是有点区别的。当然不止是 named export/import 可以这样, default import/export 也可以这样,这样除了上面的 named import -> named export 的组合之外还有三种组合
- default import -> default export:
export a from 'moduleA'
- default import -> named export:
export { default as a } from 'moduleA'
- named import -> default export:
export { a as default } 'moduleA'
关于 ES6 import/export 的基本用法就这些了,掌握了应该就差不多能应付日常的需要,但是如果想知道一些「为什么」以及「有什么用」的知识,这点肯定不够的,比如 ES6 module 和 Node.js module 的异同、各自产生的历史原因也就是 JavaScript 模块化的演进、了解关于 dynamic import 的提案、webpack 的 Tree Shaking 和 dynamic load 的原理等等等等就要花更多功夫啦。
参考链接: