在学习node.js的时候模块系统往往是我们第一个要接触的内容点。在浏览器上运行javascript的时候是没有模块的，想要拥有模块系统我们必须自己去实现或者借助一些例如webpack之类的打包工具,而node.js则天生具备模块系统，下面我们就来学习相关的知识吧。
node.js遵循commonJs规范
在node.js如果我们需要导出一个模块得话，我们可以使用
exports.xxx=xxx
module.exports={
xxx:xxx
}
这样的语法进行导入，例如
exports.test1 = 'test1'
exports.test2 = 'test2'
或者
module.exports = {
test3: 't3'
}
这样就会导出一个对象,而我们就可以通过这个对象,来调用它导出来的方法
而导入一个对象 我们可以使用require
例如
const lib = require('./lib')
console.log('index test1', lib.test1);
而通过模块系统，我们可以有效的避免全局变量污染的情况,不用担心在协作的时候会出现因为别人修改了不相干的代码，使用了一个同名的全局变量，最终导致自己的代码出现问题的情况。
通过以上的例子我们可以看到node.js的模块规范是非常的简单易懂好使用的，但是假如我们不注意，也会产生问题
首先要提到的是
node.js模块是单例的
怎么来理解这句话呢？
我们下面来看一段代码
修改lib.js的代码为
exports.test1 = 'test1'
exports.test2 = 'test2'
setTimeout(() => {
console.log(exports);
}, 1000)
或者
module.exports = {
test3: 't3'
}
setTimeout(() => {
console.log(module.exports);
}, 1000)
index.js中的代码为
const lib = require('./lib')
console.log('index test1', lib.test1);
console.log('index test2', lib.test2);
lib.test4 = 'test4'
运行index.js
最终我们可以发现在2s后，打印出来的结果存在test4
也就是说
导出的内容是引用
我们对导出的内容进行修改，会影响到最原始的对象，这也就是一个单例
加入存在多个模块引入了同一个lib模块，那么不管是在里面还是在外面，对这个lib模块的修改会影响到所有的引用模块
因此，我们应该尽量不去修改我们引入的模块
当然也有的时候，我们引入的模块提供了一些方法，可以让我们对这个模块进行修改修改，也就可以用来，增强原有的模块的特性
exports与module.exports的关系？
我们既可以使用module.exports进行导出，也可以使用exports进行导出，那么他们之间的关系是什么呢？这两种导出方式有区别吗？
其实exports是一个在最开始的时候指向module.exports的引用
我们可以看下面的代码
lib.js
exports.test1 = 'test1'
exports.test2 = 'test2'
console.log('lib exports', exports);
console.log('lib module.exports', module.exports);
console.log(module.exports === exports);
module.exports = {
test3: 't3'
}
setTimeout(() => {
console.log(exports);
console.log(module.exports);
}, 1000)
index.js
const lib = require('./lib')
console.log('index test1', lib.test1);
console.log('index test2', lib.test2);
console.log('index test3', lib.test3);
lib.test4 = 'test4'
运行index.js
最终打印结果如下
lib exports { test1: 'test1', test2: 'test2' }
lib module.exports { test1: 'test1', test2: 'test2' }
true
index test1 undefined
index test2 undefined
index test3 t3
2s后
{ test1: 'test1', test2: 'test2' }
{ test3: 't3', test4: 'test4' }
可见
module.exports最终将exports.xx中的内容给覆盖了
所以说
最终导出内容其实是module.exports
这里我们其实可以这样理解
在我们编写的模块代码之前与之后有一段这样的代码
let module={}
module.exports={}
let exports=module.exports
xxxx
// 这里是我们编写的代码
xxxx
export(return) module.exports
可见在一开始的时候exports这个变量其实就是module.exports的别名，但是在后面的时候假如我们进行了手动修改，也就是修改了对应的地址，那么我们做的修改自然也就没作用了
关于这点，我们可以使用webpack进行一次打包，因为webpack实现 了commonJS规范，我们可以通过打包后的内容进行观察最终得到结论
执行
webpack --devtool none --mode development --target node index.js
我们将最终的打包后的代码删除一些注释可以看到如下的代码
/******/ function __webpack_require__(moduleId) {
/******/ var module = installedModules[moduleId] = {
/******/ exports: {}
/******/ };
/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
// ----
/***/ "./index.js":
/***/ (function(module, exports, __webpack_require__) {
const lib = __webpack_require__(/*! ./lib */ "./lib.js")
console.log('index test1', lib.test1);
console.log('index test2', lib.test2);
console.log('index test3', lib.test3);
lib.test4 = 'test4'
/***/ }),
可见结果却是是如同我们前面所提到的一样
因此我们在导出模块的时候，应该确保使用
module.exports={}
进行导出
这样可以确保不出错
总结
- node.js使用commonJS作为模块规范
- 使用module.exports进行导出，require进行导出
- exports是module.exports的一个别名或者说引用，假如我们使用了module.exports那么exports中的内容就都不会导出了，因此我们应该确保使用module.exports进行导出
- 关于commonjs的规范学习，假如你不想看node.js的源代码得话，可以参考webpack等打包工具的实现
额外
现在node.js也支持es module的使用，但是其使用还是很麻烦的事情，而在最新的13.2.0版本中，但是这个版本不是稳定的版本，相信在以后我们就可以更好的使用ES Module来进行模块化了
网友评论