Node.js学习九（模块化module）

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

---

      Node应用是由模块组成的，Node遵循了CommonJS的模块规范，来隔离每个模块的作用域，使每个模块在它自身的命名空间中执行。

一、CommonJS规范

1、什么是CommonJS规范

      CommonJS 是一套代码规范, 目的是为了构建 JavaScript 在浏览器之外的生态系统 (服务器端, 桌面端). JavaScript 诞生之初只是为了写网页小脚本, 并不作为开发大型复杂应用的语言, 其自身有很多不足. 并且, 官方规范 (ECMAScript) 制定的时间较早, 涵盖范围较小, 对于后端开发而言, 例如文件系统, I/O 流, 模块系统, 等等方面都没有相应的标准. 基于种种的不足, CommonJS 规范致力于弥补 JavaScript 没有标准的缺陷, 让 JavaScript 有能力去开发复杂应用, 同时具备跨平台能力。

2、CommonJS规范的主要内容

      模块必须通过 module.exports 导出对外的变量或接口，通过 require() 来导入其他模块的输出到当前模块作用域中。

3、CommonJS模块的特点

（1）所有代码运行在当前模块作用域中，不会污染全局作用域；
（2）模块同步加载，根据代码中出现的顺序依次加载；
（3）模块可以多次加载，但是只会在第一次加载时运行一次，然后运行结果就被缓存了，以后再加载，就直接读取缓存结果。要想让模块再次运行，必须清除缓存。

二、模块

      模块化：是指解决一个复杂问题时，自顶向下逐层把系统划分为若干模块的过程。对于整个系统来说，模块是可组合、分解和更换的单元。
      模块：就是一个独立的功能体。
      在NodeJS下，模块分为：
      自定义模块：用户创建的每个.js文件。
      核心模块（也叫内置模块）：由Node.js官方提供，如fs等。
      第三方模块：由第三方开发出来的模块，并非官方提供的内置模块，也不是用户创建的自定义模块，使用前需要先下载。
      在NodeJS下，每一个文件都是一个模块。
      如果我们现在建立一个主文件（main.js），以及主文件需要引用的文件（second.js），即建立了两个模块。
      NodeJS自动为每个文件添加了构造函数，所有的代码被构造函数包含：

(function(exports,require,module,__filename,__dirname){
   
	程序员自己写的代码
})

1、require导入模块

（1）require()

      require命令的基本功能是，读入并执行一个JavaScript文件，然后返回该模块的exports对象。如果没有发现指定模块，会报错。同一级目录写路径./，后缀名.js可以省略。

      我们在second.js里写入如下代码：

console.log('haha')
var a = 1;
function fn(){
   
    console.log(2);
}

      然后在main.js里首先使用require引入secons.js，然后打印出它的结果，再打印一下它里面的创建的变量。


      结果如上图：打印second.js里定义的变量时会报错，此时就需要用到另一个模块module。
注意：使用require()方法加载其他模块时，会执行被加载模块中的代码。

（2）参数的加载规则

      根据参数的不同格式，require命令去不同路径寻找模块文件。
      1如果参数字符串以“/”开头，则表示加载的是一个位于绝对路径的模块文件。比如，require(’/home/marco/foo.js’)将加载/home/marco/foo.js。
      2如果参数字符串以“./”开头，则表示加载的是一个位于相对路径（跟当前执行脚本的位置相比）的模块文件。比如，require(’./circle’)将加载当前脚本同一目录的circle.js。
      3如果参数字符串不以“./“或”/“开头，则表示加载的是一个默认提供的核心模块（位于Node的系统安装目录中，如http，fs），或者一个位于各级node_modules目录的已安装模块（全局安装或局部安装）。例如，脚本/home/user/projects/foo.js执行了require(‘bar.js’)命令，Node会依次搜索以下文件。

/user/local/lib/node/bar.js
/home/user/projects/node_modules/bar.js
/home/user/node_modules/bar.js
/home/node_modules/bar.js
/node_modules/bar.js

      这样设计的目的是，使得不同的模块可以将所依赖的模块本地化。
      4如果参数字符串不以“./“或”/“开头，而且是一个路径，比如require(‘example-module/path/to/file’)，则将先找到example-module的位置，然后再以它为参数，找到后续路径。
      5如果指定的模块文件没有发现，Node会尝试为文件名添加.js、.json、.node后，再去搜索。.js件会以文本格式的JavaScript脚本文件解析，.json文件会以JSON格式的文本文件解析，.node文件会以编译后的二进制文件解析。
      6如果想得到require命令加载的确切文件名，使用require.resolve()方法。

（3）目录的加载规则

      通常，我们会把相关的文件会放在一个目录里面，便于组织。这时，最好为该目录设置一个入口文件，让require方法可以通过这个入口文件，加载整个目录。在目录中放置一个package.json文件，并且将入口文件写入main字段。例如：

// package.json
{
   
	 "name" : "some-library",
     "main" : "./lib/some-library.js"
 }

      require发现参数字符串指向一个目录以后，会自动查看该目录的package.json文件，然后加载main字段指定的入口文件。如果package.json文件没有main字段，或者根本就没有package.json文件，则会加载该目录下的index.js文件或index.node文件。

2、module导出模块

      指代当前所在的模块对象。Node内部提供一个Module构建函数。所有模块都是Module的实例。
      每个模块内部，都有一个module对象，它里面储存了和当前模块有关的信息，代表当前模块。它有以下属性：

module.id：
模块的识别符，通常是带有绝对路径的模块文件名。 module.filename：
模块的文件名，带有绝对路径。
module.loaded：
返回一个布尔值，表示模块是否已经完成加载。
module.parent：
返回一个对象，表示调用该模块的模块。
module.children：
返回一个数组，表示该模块要用到的其他模块。
module.exports：
当前模块的导出对象，公开的属性和方法。表示当前模块对外输出的接口，其他文件加载该模块，实际上就是读取module.exports变量。外界用require()方法导入自定义模块时，得到的就是module.exports所指向的对象。在一个自定义模块中，默认情况下它是空对象。
module.paths：
从当前文件目录开始查找node_modules目录；然后依次进入父目录，查找父目录下的node_modules目录；依次迭代，直到根目录下的node_modules目录。

如：

console.log(module.id);
console.log(module.filename);

下面这些模块都是我们自己写的，就是自定义模块。
我们在second.js里写入如下代码：

console.log('haha')
var a = 1;
function fn(){
   
    console.log(2);
}
//使用module公开变量或者函数
//module.exports意思是要导出的对象
module.exports.vname = 'bear6';
module.exports.mya = a;
module.exports.fn = fn;

      此时module导出了vname，mya，fn这些变量，main.js接收后就可以使用它们了。