node.js - 基础之module

1. node.js模块概述

为了让node.js的文件可以相互调用，node.js提供了一个简单的模块系统。模块是node.js应用程序基本的组成部分，文件和模块是一一对应的。换言之，一个node.js文件就是一个模块，这个文件可能是javascript代码、json或者编译过的c/c++扩展。

其中http、fs、net等都是node.js提供的核心模块，使用c/c++实现，外部用javascript封装。

2. 创建模块的两种方式

创建模块有两种方式，

• 通过exports创建
• 通过module.exports创建

2.1 通过exports创建模块

node.js中，创建一个模块非常简单，我们创建一个main.js文件，它引用了hello模块，代码如下，

var hello = require('./hello')
hello.world()

在上面的代码中，require('./hello')引入了当前目录下的hello.js文件。

./代表当前目录，node.js默认后缀为js。

node.js提供了exports和require两个对象，其中exports是模块公开的接口，require用于从外部获取一个模块的接口，即所获取模块的exports对象。

接下来我们创建hello.js文件，如下代码所示，

exports.world = function() {
  console.log('hello world')
}

以上示例中，hello.js通过exports对象把world作为模块的访问接口，在main.js中通过require('./hello')加载这个模块，然后就可以直接访问hello.js中exports对象的成员函数了。

2.2 通过module.exports创建模块

有时候我们只是想把一个对象封装到模块中，如下格式，

module.exports = function() {
    
}

以上面的格式，来写一个模块，如下hello.js代码，

function Hello() {
    var name;
    this.setName = function(thyName) {
        name = thyName
    }
    
    this.sayHello = function() {
        console.log('hello ' + name)
    }
}

module.exports = Hello

这样就可以直接获取这个对象了，如下main.js代码，

// main.js
var Hello = require('./hello')
hello = new Hello()
hello.setName('BYVoid')
hello.sayHello()

模块接口的唯一变化是使用module.exports = Hello代替了exports.world = function() {}。在外部引用该模块时，其接口对象就是要输出的Hello对象本身，而不是原先的exports。

2.3 exports和module.exports区别

为了更好地解释exports和module.exports之间的关系，先通过一个简单的js示例来做一个说明，如下代码，

var a = {name: 1}
var b = a

console.log(a)
console.log(b)

b.name = 2
console.log(a)
console.log(b)

b = {name: 3}
console.log(a)
console.log(b)

运行test.js结果为，

{ name: 1 }
{ name: 1 }
{ name: 2 }
{ name: 2 }
{ name: 2 }
{ name: 3 }

简单解释一下上面的代码：a是一个对象，b是对a对象的引用，此时a和b只想同一块内存，所以前两个输出一样；当对b做修改时，则a和b只想同一块内存地址的内容发生了改变，所以a的值改变也体现了出来；当b被覆盖时，b只想了一块新的内存，而a还是只想原来的内存，所以最后两个输出不一样。

明白了上面的例子之后，只需要指点3点就能了解exports和module.exports的区别了，

1. module.exports初始值为一个空对象{}
2. exports是只想module.exports的引用
3. require()返回的是module.exports而不是exports

也就是说，module.exports才是真正的接口，exports只不过是它的一个辅助工具。最攻返回给调用者的是module.exports而不是exports。

再强调一点，在node.js中，一个文件对应一个模块。为了方便，模块中会有一个exports对象，它和module.exports指向同一个变量，所以我们修改exports对象的时候也会修改module.exports对象；当我们通过赋值方式为module.exports赋值时候，此时module.exports与exports对象指向的变量就不同了，所以无论exports对象怎么改，都和module.exports对象没有任何关系了。

加粗！加粗！加粗！一般来说，推荐使用module.exports，尽量少使用exports。

3. require搜索module的方式

在node.js中模块有两种类型，即，

• 核心模块
• 文件模块

3.1 搜索核心模块

核心模块直接使用名称获取，例如经常使用的http模块，使用如下代码获取，

var http = require('http')
...
http.createServer()

简要描述一下上面的代码，node.js中自带了一个叫做http的模块，在上述代码中我们请求它并把返回的值赋值给一个本地变量，这样本地变量就编程了一个拥有所有http模块所提供的公共方法的对象。

3.2 搜索文件模块

在前面创建模块的demo中，通过require('./hello')语法，如下代码，

var Hello = require('./hello')
hello = new Hello()
hello.setName('BYVoid')
...
...

这里，我们使用./test来获取自定义文件模块，这种通过相对路径或绝对路径是文件模块的搜索方式。

3.3 搜索模块的规则

node.js加载模块时，遵循了如下的加载规则，

1. 核心模块优先级最高，直接使用名字加载，再有命名冲突的时候首先加载核心模块
2. 文件模块只能按照路径加载 -- 相对路径或绝对路径，并且可以省略默认的.js后缀名
3. 查找node_modules目录，当我们在调用npm install <name>命令的时候，会在当前目录下创建node_module目录来安装模块，当require遇到一个既不是核心模块，又不是以路径形式表示的模块名称时，会试图在当前目录下的node_modules目录中查找是不是有这样一个模块。如果没有找到，则会在当前目录的上一层的node_modules目录中继续查找，反复执行这一过程，知道遇到根目录位置。

相对路径 - 例如: ./hello表示同级目录，../hello表示上层目录 绝对路径 - 例如: /Users/user/Desktop/js/hello