以前写过一篇ES6模块化的使用,可以横向参考。本编是在Node环境下的补充。
一、Node 的模块化是CommonJS的Node实践
在Node环境下,每一个JS文件都是模块化的。
模块化的意思是既可以使当前文件中的变量作用域只在当前文件中,也可以通过某些方式将其导出以供别人使用(在别的JS文件中使用)。
二、Node的导出直接将需要导出的对象赋值给exports对象即可。
其本质是每个模块(即每个JS文件)都有一个exports
对象,默认的是空对象{}
,给其赋值后便可以导出。
注意:
只能用exports.attr1 = 'value'
这样的方式,而不能用exports={'attr':'value'}
这样的方式,原因见下文的本质。
三、Node 中的exports和 module.exports的本质
在CommonJS规范中其实并没有module.exports的说法。
3.1 Node中如何让每一个JS都是一个模块
通过Module
类,让其每一个JS文件
都是一个module
对象(或者说一个JS文件
可以用一个module
对象去代表), 通过这种一个文件 -> 一个对象
的映射做到模块化。
代码层面仍然是将一个js文件直接放到一个函数中去执行以达到隔离作用域的效果。
3.2 Node中JS都是模块的具体实现
在每一个JS文件
中都有一个module
对象(这个是Node自行生成的,读者可以自行打印看其内容),此module对象即是这个JS文件的映射.
3.3 exports和 module.exports的关系(重点)
module对象中也有一个exports属性,源码中module.exports = exports
,可以看出二者默认是同一个对象,但是本质上是导出的module.exports。即如果有export={a=1} 又有module.exports = {b=1},则导出是{b=1},exports失效!
这样就解释只能用exports.attr1 = 'value'这样的方式,如果用exports={'attr':'value'}
,那么意味着exports对象被重新赋值,module.exports并没有重新赋值,这样module.exports还是原来的值(源码中的module.exports = exports
是执行在js文件的最上面,所以也不会覆盖)。
3.4 module.exports使用注意
导出时注意是引用类型还是值类型,如果是引用类型,那么别人再修改这个引用的内容时,那么导入的地方再去访问也是变化后的值。如果是值类型,存放的是值,别人修改则不会影响。
四、Node 使用require('....Path...') 引入
本质上是对导出对象的引用。即引用的是导出的module.exports
对象。
和对象引用是一样的,所以我们甚至可以在引用处去修改该原模块中的内容(对象引用的本质是指针指向相同的堆地址)。
例子:
在A文件中导出一个值和一个对象,定时器1后修改a和att
let a = '000'
let b = {
att:'111'
}
setTimeout(()=>{
a = '222'
b.att = '333'
},1000)
module.exports.a = a
module.exports.b = b
在B文件中导入A,定时器2秒后重新打印a的值和att的值
const obj = require('./a.js')
// 此时打印的值是 111
console.log(b.att);
setTimeout(()=>{
// 此时打印的值是 000
console.log(obj.a);
// 此时打印的值是 333
console.log(b.att);
},2000)
由此可见,导出的如果是值的修改则不会传递到导入方,因为exporst是赋值、引用传递。这一点和ES6中的是完全不同的,ES6中的原理是绑定,即值的修改也会传递(即这里的a会变成222)。
注意,require加载文件是同步的,其查找加载有严格的顺序。官方文档
由于node加载的文件都在项目中,不存在需要下载的问题,所以同步加载并不会影响多少效率。同步加载即执行,加载即是执行加载文件中的全部代码。node本身通过深度优先算法去加载文件,并对文件进行缓存,这样即是require多次也只会加载一次。
五、module.exports,require 和 import ,export的区别
5.1 二者是不同的东西, module.exports
和 require
是node中使用CommonJS模块化的具体实践。而import
,export
是ES6中模块化的方法。准确的讲import
,export
并不是实践,而是语法(关键字),是浏览器中的特殊解析。
5.2 加载方式不同,Node中使用的是同步加载,ES6中的是异步加载
5.3 node中ES6默认是不支持的,需要通过以下的设置。
方式1:在package.json中添加属性 type
:'module'
方式2:使用.mjs作为文件后缀名(导入和导出的文件都需要改为这样的后缀),最新版的Node支持这样,LTS版和一些旧版这样写会有警告(实验性质的功能),还有一些老版本必须使用 --experimental-modules才能正常运行。