common js

nodejs端模块化方式comomjs详解

nodejs端实现模块化的方式通常是通过commonjs，使用模块化可以复用js代码，使得逻辑结构更为清晰。

commonjs的语法规则如下
通过 module.exports 或者 exports 导出，通过 require函数来导入

// a.js 导出内容
const name = 'alice'
const age = 16
module.exports = {
  name,
  age
}
// b.js 导入

const obj = require('./a.js')

console.log(obj) // { name: 'alice', age: 16}

module.exports和exports 导出不同的书写方式

// a.js
const name = 'alice'
const age = 16
exports.age = age
module.exports.name = name
// b.js

const obj = require('./a.js')

console.log(obj) // { name: 'kiki', age: 16 }

两者的不同之处在于，即使通过 exports.xxx 导出，其实最终也是通过 module.exports 这样的方式进行导出的，因为在node内部，初始化时先将一个空对象赋值给 exports，然后再将exports赋值给module.exports，所以通过 exports.xxx 这样的形式就相当于在 module.exports 这个对象里面追加子元素

如果直接给module.exports赋值为一个新的对象，那么结果就不一样了

// a.js
const name = 'alice'
const age = 16
const hobby = 'singing'
exports.name = name

exports.age = age
module.exports = {

hobby

}
// b.js

const obj = require('./a.js')

console.log(obj) // { hobby: 'singing' }

重新将一个对象赋值给了 module.exports，module.exports 指向的内存空间已经和 exports 不是同一个指向，所以最终的导出只有 module.exports 部分

​

为什么说是exports赋值给module.exports而不是反向赋值呢，一方面可以从源码中看到赋值的过程，另一方面改变一下导出方式也能看到，如果 require 最终导入的内容由 exports 决定的话，那么此时输出应该为一个函数

// a.js
const sayHi = function(){
  console.log('hi')
}
exports = {

sayHi

}
// b.js

const obj = require('./a.js')

console.log(obj) // {}

此时只输出了一个空对象，所以说 require的导出内容并不是 exports 而是 module.exports。

初始化的时候 exports 与 module.exports 都是指向了一个空对象的内存地址，当 exports 直接添加空对象的属性时，内存地址没有发生改变，modulex.exports 能随着exports的赋值导出的内容发生变化。
但是这里当 exports 重新指向了另外的对象时，module.exports 还是指向原来的那个对象，module.exports没有发生变化，所以导出的内容还是空对象。

​

了解完了 导出 这一部分，我们来看看 require 导入，通过require来查找资源时，会有如下规则

1、导入是内置模块，比如 fs、http, 此时就会直接查找内置的模块
2、导入的模块包含路径, 比如 ./ 或 ../ 或 /
    ./ 表示当前路径，../ 表示上一层路径，/ 表示电脑的根目录
    如果有路径时，就会按照路径去查找
    此时分为两种情况，一种是当成文件，一种是文件夹
    (1) 文件
         如果文件写了后缀名，就会查找有该后缀名的文件，如果没有后缀名，就会按照 文件/文件.js / 文件.json/文件.node 的次序查找
    (2) 文件夹
        依次找查找文件夹的 index.js / index.json / index.node 
    如果通过路径没有找到，则会报错 Not Find
3、导出既不是内置模块也没有路径
    那么会从当前目录的 node_modules 开始，一层一层往上查找有没有对应的导入文件，如果没有找到 则报错 Not Find

那么require的模块加载过程是怎么样的呢~ 

首先来说, 只要使用了 require 函数来加载资源，一定会被执行一次

// a.js
let name = 'kiki'
exports.name = name
console.log('a.js文件被执行')
// b.js

require('./a.js')

// a.js文件被执行

如果多个文件都导入同一个文件，也并不会让该文件多次加载，在module内有一个 loaded 字段，来判断该资源是否被加载。

下图在 b.js 中打印的 module，可以看到子元素 a.js文件的loaded 已经变成了 true，因为打印语句在 require 之后，而 commonjs 是同步执行，所以 a.js 已经被加载完成，而打印的时候 b.js 还没有加载完成，所以loaded为false

​

如果多次循环调用也不需要担心，如果出现了以下嵌套调用的情况，会按照深度优先算法来对文件进行执行。

 

​

首先从 main 对应的第一个顶点开始，一层一层往下找，找到底了之后，再往上一层查找，把上一层的元素查找完之后，再往上一层查找，也就是 main-->aaa-->ccc-->ddd--->eee。
此时eee没有指向的顶点，就退回到ddd，ddd除了eee也没有指向的顶点，再退回到ccc，依此类推，一直退到main，发现main还指向了另外一个顶点 bbb，所以执行bbb，bbb指向ccc和eee，但因为这两个已经加载过，所以不会重新加载，最后的执行顺序为

main aaa ccc ddd eee bbb

此外，commonjs的执行还有几个特点

1、同步加载，每次执行js代码都是需要将js文件下载下来，服务端处理文件通常都是执行本地文件，不会对性能造成很大的影响，但是如果用于浏览器端，同步执行代码就会对后续的js执行造成阻塞，使加载资源的时间变得更长，所以commonjs大多都被用在服务端。

// a.js
let name = 'kiki'
exports.name = name
console.log('a.js文件被执行')
// b.js

require('./a.js')

console.log('b.js文件被执行') // a.js文件被执行 b.js文件被执行

2、运行时解析，这里就要说到v8引擎的执行流程，简单来说js的执行需要通过两个阶段，首先需要将javascript代码解析成字节码，然后再通过编译器执行，运行时解析就意味当函数调用之后，才会执行commonjs的代码，导入导出就可以使用一些条件判断语句或者动态的路径

// a.js
let name = 'kiki'
module.exports = {
  name
}
// b.js

const path = './a.js'

const flag = true

if(flag){

const { name } = require(path)

console.log(name) // kiki

}

3、module.exports 与 require 的是同一个对象，也就是说如果直接更改 module.exports.xxx 的时候，require 的内容也会发生更改，修改require，module.exports的内容也会变化，下面演示一下修改导出的内容

// a.js
let name = 'kiki'
setTimeout(()=>{

module.exports.name = 'hi'

},1000)
module.exports = {

name

}
// b.js

const obj = require('./a.js')

console.log(obj)
setTimeout(()=>{

console.log(obj)

}, 2000)
// 执行顺序为 { name: 'kiki' } { name: 'hi' }

以上就是commonjs在nodejs中的使用详解，commonjs是node实现模块化中非常重要的一部分内容，把它理解透才能更好的应用~

下一篇会介绍在浏览器端常用的模块化方式 es module

转载自： https://www.cnblogs.com/vigourice/p/14883517.html