NodeJS 模块

模块

编写稍大一点的程序时一般都会将代码模块化。在 NodeJS 中，一般将代码合理拆分到不同的 JS 文件中，每一个文件就是一个模块，而文件路径就是模块名。

在编写每个模块时，都有 require、exports、module 三个预先定义好的变量可供使用。

require

require 函数用于在当前模块中加载和使用别的模块，传入一个模块名，返回一个模块导出对象。模块名可使用相对路径（以./开头），或者是绝对路径（以/或C:之类的盘符开头）。另外，模块名中的.js扩展名可以省略。以下是一个例子。

var foo1 = require('./foo');
var foo2 = require('./foo.js');
var foo3 = require('/home/user/foo');
var foo4 = require('/home/user/foo.js');

// foo1 至 foo4 中保存的是同一个模块的导出对象。另外，可以使用以下方式加载和使用一个 JSON 文件。

var data = require('./data.json');

exports

exports 对象是当前模块的导出对象，用于导出模块公有方法和属性。别的模块通过 require 函数使用当前模块时得到的就是当前模块的 exports 对象。以下例子中导出了一个公有方法。

exports.hello = function () {
    console.log('Hello World!');
};

module

通过 module 对象可以访问到当前模块的一些相关信息，但最多的用途是替换当前模块的导出对象。例如模块导出对象默认是一个普通对象，如果想改成一个函数的话，可以使用以下方式。

module.exports = function () {
    console.log('Hello World!');
};

以上代码中，模块默认导出对象被替换为一个函数。

模块初始化

一个模块中的 JS 代码仅在模块第一次被使用时执行一次，并在执行过程中初始化模块的导出对象。之后，缓存起来的导出对象被重复利用。

主模块

通过命令行参数传递给 NodeJS 以启动程序的模块被称为主模块。主模块负责调度组成整个程序的其它模块完成工作。例如通过以下命令启动程序时，main.js 就是主模块。

$ node main.js

完整示例

例如有以下目录。

- /home/user/hello/
    - util/
        counter.js
    main.js

其中 counter.js 内容如下：

var i = 0;

function count() {
    return ++i;
}

exports.count = count;

该模块内部定义了一个私有变量 i，并在 exports 对象导出了一个公有方法 count。

主模块 main.js 内容如下：

var counter1 = require('./util/counter');
var    counter2 = require('./util/counter');

console.log(counter1.count());
console.log(counter2.count());
console.log(counter2.count());

运行该程序的结果如下：

$ node main.js
1
2
3

可以看到，counter.js 并没有因为被 require 了两次而初始化两次。