2016-07-03

NodeJS Module 模块原理

热度 ℃

JavaScript 中实现“模块”这个功能，并不需要语法层面的支持。 Node.js 并不会增加任何 JavaScript 语法。实现“模块”功能的奥妙就在于 JavaScript 是一种函数式编程语言，它支持闭包。如果我们把一段 JavaScript 代码用一个函数包装起来，这段代码的所有“全局”变量就变成了函数内部的局部变量。

当我们编写 JavaScript 代码时，我们可以申明全局变量：var s = 'global'; 在浏览器中，大量使用全局变量不好。如果你在 a.js 中使用了全局变量 s ，那么，在 b.js 中也使用全局变量 s，将造成冲突， b.js 中对 s 赋值会改变 a.js 的运行逻辑。也就是说，JavaScript 语言本身并没有一种模块机制来保证不同模块可以使用相同的变量名。

1
2
3

var s = 'Hello';
var name = 'world';
console.log(s + ' ' + name + '!');

Node.js 加载了 hello.js 后，它可以把代码包装一下，变成这样执行：

(function () {
    // 读取的hello.js代码:
    var s = 'Hello';
    var name = 'world';
    console.log(s + ' ' + name + '!');
    // hello.js代码结束
})();

这样一来，原来的全局变量 s 现在变成了匿名函数内部的局部变量。如果 Node.js 继续加载其他模块，这些模块中定义的“全局”变量s也互不干扰。所以 Node.js 利用 JavaScript 的函数式编程的特性，实现了模块的隔离。

module.exports 原理

Node 先准备一个对象 module

// 准备module对象:
var module = {
    id: 'greet', // 模块名
    exports: {}
};
// 加载函数
var load = function (module) {
    // greet.js代码:
    function greet(name) {
        console.log('Hello, ' + name + '!');
    }
    module.exports = greet;
    // greet.js代码结束
    return module.exports;
};
var exported = load(module);
// 保存module
save(module, exported);

可见，变量 module 是 Node 在加载 js 文件前准备的一个变量，并将其传入加载函数，我们在 greet.js 中可以直接使用变量 module 原因就在于它实际上是函数的一个参数：

1	module.exports = greet;

通过把参数 module 传递给 load() 函数，greet.js 就顺利地把一个变量传递给了 Node 执行环境，Node 会把 module 变量保存到某个地方。

由于 Node 保存了所有导入的 module ，当我们用 require() 获取 module 时， Node 找到对应的 module ，把这个 module 的 exports 变量返回，这样，另一个模块就顺利拿到了模块的输出：

1	var greet = require('./greet');

以上是 Node 实现 JavaScript 模块的一个简单的原理。

module.exports vs exports

在 Node 环境中，有两种方法可以在一个模块中输出变量：

module.exports

function hello() {
    console.log('Hello, world!');
}
function greet(name) {
    console.log('Hello, ' + name + '!');
}
module.exports = {
    hello: hello,
    greet: greet
};

exports

function hello() {
    console.log('Hello, world!');
}
function greet(name) {
    console.log('Hello, ' + name + '!');
}
exports.hello = hello;
exports.greet = greet;

但是不可以直接对 exports 赋值：

// 代码可以执行，但是模块并没有输出任何变量:
exports = {
    hello: hello,
    greet: greet
};

结合Node 的加载机制来分析原因：

首先，Node 会把整个待加载的 hello.js 文件放入一个包装函数 load() 中执行。在执行这个 load() 函数前，Node 准备好了 module 变量

var module = {
    id: 'hello',
    exports: {}
};

load() 函数最终返回的是 module.exports

var load = function (exports, module) {
    // hello.js的文件内容
    ...
    // load函数返回:
    return module.exports;
};
var exported = load(module.exports, module);

也就是说，默认情况下， Node 准备的 exports 变量和 module.exports 变量实际上是同一个变量，并且初始化为空对象{}，于是，我们可以写：

exports.foo = function () { return 'foo'; };
exports.bar = function () { return 'bar'; };
// 或者
module.exports.foo = function () { return 'foo'; };
module.exports.bar = function () { return 'bar'; };

也就是说， Node 默认准备了一个空对象 {} ，这样你可以直接往里面加东西。

如果我们要输出的是一个函数或数组，那么，只能给 module.exports 赋值：

1	module.exports = function () { return 'foo'; };

给 exports 赋值是无效的，因为赋值后，module.exports 仍然是空对象{}。

结论

如果要输出一个键值对象 {}，可以利用 exports 这个已存在的空对象 {} ，并继续在上面添加新的键值；
如果要输出一个函数或数组，必须直接对 module.exports 对象赋值。

所以我们可以得出结论：直接对 module.exports 赋值，可以应对任何情况：

1
2
3

module.exports = {
    foo: function () { return 'foo'; }
};

或者：

1	module.exports = function () { return 'foo'; };

最终，我们强烈建议使用 module.exports = xxx 的方式来输出模块变量，这样，你只需要记忆一种方法。

模块是 Node.js 应用程序的基本组成部分，文件和模块是一一对应的。换言之，一个 Node.js 文件就是一个模块，这个文件可能是 JavaScript 代码、 JSON 或者编译过的 C/C++ 扩展。

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

require 查找策略

Node.js 的 require 方法中的文件查找策略如下：

Node.js 中存在4类模块（原生模块和3种文件模块），尽管 require 方法极其简单，但是内部的加载却是十分复杂的，其加载优先级也各自不同。

1. require -> 是否在文件模块缓存区中 
1.1 是 -> 返回exports
1.2 否 -> 2是否原生模块
2.1 是 -> 是否在原生模块缓存区中 
2.1.1 是 -> 返回exports
2.1.2 否 -> 加载原生模块 -> 缓存原生模块 -> 返回exports
2.2 否 -> 查找文件模块 -> 根据扩展名转入文件模块 -> 缓存文件模块 -> 返回exports

从文件模块缓存中加载

尽管原生模块与文件模块的优先级不同，但是都不会优先于从文件模块的缓存中加载已经存在的模块。

从原生模块加载

原生模块的优先级仅次于文件模块缓存的优先级。require 方法在解析文件名之后，优先检查模块是否在原生模块列表中。以 http 模块为例，尽管在目录下存在一个 http/http.js/http.node/http.json 文件，require(“http”)都不会从这些文件中加载，而是从原生模块中加载。
原生模块也有一个缓存区，同样也是优先从缓存区加载。如果缓存区没有被加载过，则调用原生模块的加载方式进行加载和执行。

从文件加载

当文件模块缓存中不存在，而且不是原生模块的时候， Node.js 会解析 require 方法传入的参数，并从文件系统中加载实际的文件。

require 方法接受以下几种参数的传递：

http、fs、path等，原生模块。
./mod或../mod，相对路径的文件模块。
/pathtomodule/mod，绝对路径的文件模块。
mod，非原生模块的文件模块。