exports

Node.js模块系统
为了让Node.js的文件可以相互调用，Node.js提供了一个简单的模块系统。

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

创建模块
在 Node.js 中，创建一个模块非常简单，如下我们创建一个 main.js 文件，代码如下:

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 对象的成员函数了。

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

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
var Hello = require(‘./hello’);
hello = new Hello();
hello.setName(‘BYVoid’);
hello.sayHello();
模块接口的唯一变化是使用 module.exports = Hello 代替了exports.world = function(){}。 在外部引用该模块时，其接口对象就是要输出的 Hello 对象本身，而不是原先的 exports。

服务端的模块放在哪里
也许你已经注意到，我们已经在代码中使用了模块了。像这样：

var http = require(“http”);

…

http.createServer(…);
Node.js 中自带了一个叫做 http 的模块，我们在我们的代码中请求它并把返回值赋给一个本地变量。

这把我们的本地变量变成了一个拥有所有 http 模块所提供的公共方法的对象。

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

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

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

从原生模块加载
原生模块的优先级仅次于文件模块缓存的优先级。require 方法在解析文件名之后，优先检查模块是否在原生模块列表中。以http模块为例，尽管在目录下存在一个 http/http.js/http.node/http.json 文件，require(“http”) 都不会从这些文件中加载，而是从原生模块中加载。

原生模块也有一个缓存区，同样也是优先从缓存区加载。如果缓存区没有被加载过，则调用原生模块的加载方式进行加载和执行。

从文件加载
当文件模块缓存中不存在，而且不是原生模块的时候，Node.js 会解析 require 方法传入的参数，并从文件系统中加载实际的文件，加载过程中的包装和编译细节在前一节中已经介绍过，这里我们将详细描述查找文件模块的过程，其中，也有一些细节值得知晓。

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

http、fs、path等，原生模块。
./mod或../mod，相对路径的文件模块。
/pathtomodule/mod，绝对路径的文件模块。
mod，非原生模块的文件模块。
在路径 Y 下执行 require(X) 语句执行顺序：

1. 如果 X 是内置模块
   a. 返回内置模块
   b. 停止执行


2. 如果 X 以 ‘/’ 开头
   a. 设置 Y 为文件根路径


3. 如果 X 以 ‘./’ 或 ‘/’ or ‘../’ 开头
   a. LOAD_AS_FILE(Y + X)
   b. LOAD_AS_DIRECTORY(Y + X)


4. LOAD_NODE_MODULES(X, dirname(Y))


5. 抛出异常 “not found”

LOAD_AS_FILE(X)

1. 如果 X 是一个文件, 将 X 作为 JavaScript 文本载入并停止执行。


2. 如果 X.js 是一个文件, 将 X.js 作为 JavaScript 文本载入并停止执行。


3. 如果 X.json 是一个文件, 解析 X.json 为 JavaScript 对象并停止执行。


4. 如果 X.node 是一个文件, 将 X.node 作为二进制插件载入并停止执行。

LOAD_INDEX(X)

1. 如果 X/index.js 是一个文件, 将 X/index.js 作为 JavaScript 文本载入并停止执行。


2. 如果 X/index.json 是一个文件, 解析 X/index.json 为 JavaScript 对象并停止执行。


3. 如果 X/index.node 是一个文件, 将 X/index.node 作为二进制插件载入并停止执行。

LOAD_AS_DIRECTORY(X)

1. 如果 X/package.json 是一个文件,
   a. 解析 X/package.json, 并查找 “main” 字段。
   b. let M = X + (json main 字段)
   c. LOAD_AS_FILE(M)
   d. LOAD_INDEX(M)


2. LOAD_INDEX(X)

LOAD_NODE_MODULES(X, START)

1. let DIRS=NODE_MODULES_PATHS(START)


2. for each DIR in DIRS:
   a. LOAD_AS_FILE(DIR/X)
   b. LOAD_AS_DIRECTORY(DIR/X)

NODE_MODULES_PATHS(START)

1. let PARTS = path split(START)


2. let I = count of PARTS - 1


3. let DIRS = []


4. while I >= 0,
   a. if PARTS[I] = “node_modules” CONTINUE
   b. DIR = path join(PARTS[0 .. I] + “node_modules”)
   c. DIRS = DIRS + DIR
   d. let I = I - 1


5. return DIRS
   exports 和 module.exports 的使用

如果要对外暴露属性或方法，就用 exports 就行，要暴露对象(类似class，包含了很多属性和方法)，就用 module.exports。

Node.js StreamNode.js 函数
1 篇笔记 写笔记
mapbar_front

619***632@qq.com

0
不建议同时使用 exports 和 module.exports。

如果先使用 exports 对外暴露属性或方法，再使用 module.exports 暴露对象，会使得 exports 上暴露的属性或者方法失效。

原因在于，exports 仅仅是 module.exports 的一个引用。在 nodejs 中，是这么设计 require 函数的：

function require(…){
var module = {exports: {}};

((module, exports) => {
function myfn () {}
// 这个myfn就是我们自己的代码
exports.myfn = myfn; // 这里是在原本的对象上添加了一个myfn方法。
module.exports = myfn;// 这个直接把当初的对象进行覆盖。
})(module,module.exports)
return module.exports;
}

Node.js 路由
我们要为路由提供请求的 URL 和其他需要的 GET 及 POST 参数，随后路由需要根据这些数据来执行相应的代码。

因此，我们需要查看 HTTP 请求，从中提取出请求的 URL 以及 GET/POST 参数。这一功能应当属于路由还是服务器（甚至作为一个模块自身的功能）确实值得探讨，但这里暂定其为我们的HTTP服务器的功能。

我们需要的所有数据都会包含在 request 对象中，该对象作为 onRequest() 回调函数的第一个参数传递。但是为了解析这些数据，我们需要额外的 Node.JS 模块，它们分别是 url 和 querystring 模块。

               url.parse(string).query

                                       |

       url.parse(string).pathname      |

                   |                   |

                   |                   |

                 ------ ------------------- http://localhost:8888/start?foo=bar&hello=world

                            ---       -----

                             |          |

                             |          |

          querystring.parse(queryString)["foo"]    |

                                        |

                     querystring.parse(queryString)["hello"] 当然我们也可以用 querystring 模块来解析 POST 请求体中的参数，稍后会有演示。

现在我们来给 onRequest() 函数加上一些逻辑，用来找出浏览器请求的 URL 路径：

server.js 文件代码：
var http = require(“http”);
var url = require(“url”);

function start() {
function onRequest(request, response) {
var pathname = url.parse(request.url).pathname;
console.log(“Request for “ + pathname + “ received.”);
response.writeHead(200, {“Content-Type”: “text/plain”});
response.write(“Hello World”);
response.end();
}

http.createServer(onRequest).listen(8888);
console.log(“Server has started.”);
}

exports.start = start;
好了，我们的应用现在可以通过请求的 URL 路径来区别不同请求了–这使我们得以使用路由（还未完成）来将请求以 URL 路径为基准映射到处理程序上。

在我们所要构建的应用中，这意味着来自 /start 和 /upload 的请求可以使用不同的代码来处理。稍后我们将看到这些内容是如何整合到一起的。

现在我们可以来编写路由了，建立一个名为 router.js 的文件，添加以下内容：

router.js 文件代码：
function route(pathname) {
console.log(“About to route a request for “ + pathname);
}

exports.route = route;
如你所见，这段代码什么也没干，不过对于现在来说这是应该的。在添加更多的逻辑以前，我们先来看看如何把路由和服务器整合起来。

我们的服务器应当知道路由的存在并加以有效利用。我们当然可以通过硬编码的方式将这一依赖项绑定到服务器上，但是其它语言的编程经验告诉我们这会是一件非常痛苦的事，因此我们将使用依赖注入的方式较松散地添加路由模块。

首先，我们来扩展一下服务器的 start() 函数，以便将路由函数作为参数传递过去，server.js 文件代码如下

server.js 文件代码：
var http = require(“http”);
var url = require(“url”);

function start(route) {
function onRequest(request, response) {
var pathname = url.parse(request.url).pathname;
console.log(“Request for “ + pathname + “ received.”);

route(pathname);

 

response.writeHead(200, {"Content-Type": "text/plain"});

response.write("Hello World");

response.end();   }

http.createServer(onRequest).listen(8888);
console.log(“Server has started.”);
}

exports.start = start;
同时，我们会相应扩展 index.js，使得路由函数可以被注入到服务器中：

index.js 文件代码：
var server = require(“./server”);
var router = require(“./router”);

server.start(router.route);
在这里，我们传递的函数依旧什么也没做。

如果现在启动应用（node index.js，始终记得这个命令行），随后请求一个URL，你将会看到应用输出相应的信息，这表明我们的HTTP服务器已经在使用路由模块了，并会将请求的路径传递给路由：

$ node index.js
Server has started.
以上输出已经去掉了比较烦人的 /favicon.ico 请求相关的部分。

浏览器访问 http://127.0.0.1:8888/，输出结果如下：

Node.js 全局对象
JavaScript 中有一个特殊的对象，称为全局对象（Global Object），它及其所有属性都可以在程序的任何地方访问，即全局变量。

在浏览器 JavaScript 中，通常 window 是全局对象， 而 Node.js 中的全局对象是 global，所有全局变量（除了 global 本身以外）都是 global 对象的属性。

在 Node.js 我们可以直接访问到 global 的属性，而不需要在应用中包含它。

全局对象与全局变量
global 最根本的作用是作为全局变量的宿主。按照 ECMAScript 的定义，满足以下条 件的变量是全局变量：

在最外层定义的变量；
全局对象的属性；
隐式定义的变量（未定义直接赋值的变量）。
当你定义一个全局变量时，这个变量同时也会成为全局对象的属性，反之亦然。需要注 意的是，在 Node.js 中你不可能在最外层定义变量，因为所有用户代码都是属于当前模块的， 而模块本身不是最外层上下文。

注意： 最好不要使用 var 定义变量以避免引入全局变量，因为全局变量会污染命名空间，提高代码的耦合风险。

__filename
__filename 表示当前正在执行的脚本的文件名。它将输出文件所在位置的绝对路径，且和命令行参数所指定的文件名不一定相同。 如果在模块中，返回的值是模块文件的路径。

实例
创建文件 main.js ，代码如下所示：

// 输出全局变量 __filename 的值
console.log( __filename );
执行 main.js 文件，代码如下所示:

$ node main.js
/web/com/runoob/nodejs/main.js
__dirname
__dirname 表示当前执行脚本所在的目录。

实例
创建文件 main.js ，代码如下所示：

// 输出全局变量 __dirname 的值
console.log( __dirname );
执行 main.js 文件，代码如下所示:

$ node main.js
/web/com/runoob/nodejs
setTimeout(cb, ms)
setTimeout(cb, ms) 全局函数在指定的毫秒(ms)数后执行指定函数(cb)。：setTimeout() 只执行一次指定函数。

返回一个代表定时器的句柄值。

实例
创建文件 main.js ，代码如下所示：

function printHello(){
console.log( “Hello, World!”);
}
// 两秒后执行以上函数
setTimeout(printHello, 2000);
执行 main.js 文件，代码如下所示:

$ node main.js
Hello, World!
clearTimeout(t)
clearTimeout( t ) 全局函数用于停止一个之前通过 setTimeout() 创建的定时器。 参数 t 是通过 setTimeout() 函数创建的定时器。

实例
创建文件 main.js ，代码如下所示：

function printHello(){
console.log( “Hello, World!”);
}
// 两秒后执行以上函数
var t = setTimeout(printHello, 2000);

// 清除定时器
clearTimeout(t);
执行 main.js 文件，代码如下所示:

$ node main.js
setInterval(cb, ms)
setInterval(cb, ms) 全局函数在指定的毫秒(ms)数后执行指定函数(cb)。

返回一个代表定时器的句柄值。可以使用 clearInterval(t) 函数来清除定时器。

setInterval() 方法会不停地调用函数，直到 clearInterval() 被调用或窗口被关闭。

实例
创建文件 main.js ，代码如下所示：

function printHello(){
console.log( “Hello, World!”);
}
// 两秒后执行以上函数
setInterval(printHello, 2000);
执行 main.js 文件，代码如下所示:

$ node main.jsHello, World! Hello, World! Hello, World! Hello, World! Hello, World! ……
以上程序每隔两秒就会输出一次”Hello, World!”，且会永久执行下去，直到你按下 ctrl + c 按钮。

console
console 用于提供控制台标准输出，它是由 Internet Explorer 的 JScript 引擎提供的调试工具，后来逐渐成为浏览器的实施标准。

Node.js 沿用了这个标准，提供与习惯行为一致的 console 对象，用于向标准输出流（stdout）或标准错误流（stderr）输出字符。

console 方法
以下为 console 对象的方法:

序号 方法 & 描述
1 console.log([data][, …])
向标准输出流打印字符并以换行符结束。该方法接收若干 个参数，如果只有一个参数，则输出这个参数的字符串形式。如果有多个参数，则 以类似于C 语言 printf() 命令的格式输出。
2 console.info([data][, …])
该命令的作用是返回信息性消息，这个命令与console.log差别并不大，除了在chrome中只会输出文字外，其余的会显示一个蓝色的惊叹号。
3 console.error([data][, …])
输出错误消息的。控制台在出现错误时会显示是红色的叉子。
4 console.warn([data][, …])
输出警告消息。控制台出现有黄色的惊叹号。
5 console.dir(obj[, options])
用来对一个对象进行检查（inspect），并以易于阅读和打印的格式显示。
6 console.time(label)
输出时间，表示计时开始。
7 console.timeEnd(label)
结束时间，表示计时结束。
8 console.trace(message[, …])
当前执行的代码在堆栈中的调用路径，这个测试函数运行很有帮助，只要给想测试的函数里面加入 console.trace 就行了。
9 console.assert(value[, message][, …])
用于判断某个表达式或变量是否为真，接收两个参数，第一个参数是表达式，第二个参数是字符串。只有当第一个参数为false，才会输出第二个参数，否则不会有任何结果。
console.log()：向标准输出流打印字符并以换行符结束。
console.log 接收若干 个参数，如果只有一个参数，则输出这个参数的字符串形式。如果有多个参数，则 以类似于C 语言 printf() 命令的格式输出。

第一个参数是一个字符串，如果没有 参数，只打印一个换行。

console.log(‘Hello world’);
console.log(‘byvoid%diovyb’);
console.log(‘byvoid%diovyb’, 1991);
运行结果为：

Hello world
byvoid%diovyb
byvoid1991iovyb
console.error()：与console.log() 用法相同，只是向标准错误流输出。
console.trace()：向标准错误流输出当前的调用栈。
console.trace();
运行结果为：

Trace:
at Object. (/home/byvoid/consoletrace.js:1:71)
at Module._compile (module.js:441:26)
at Object..js (module.js:459:10)
at Module.load (module.js:348:31)
at Function._load (module.js:308:12)
at Array.0 (module.js:479:10)
at EventEmitter._tickCallback (node.js:192:40)
实例
创建文件 main.js ，代码如下所示：

console.info(“程序开始执行：”);

var counter = 10;
console.log(“计数: %d”, counter);

console.time(“获取数据”);
//
// 执行一些代码
//
console.timeEnd(‘获取数据’);

console.info(“程序执行完毕。”)
执行 main.js 文件，代码如下所示:

$ node main.js
程序开始执行：
计数: 10
获取数据: 0ms
程序执行完毕
process
process 是一个全局变量，即 global 对象的属性。

它用于描述当前Node.js 进程状态的对象，提供了一个与操作系统的简单接口。通常在你写本地命令行程序的时候，少不了要 和它打交道。下面将会介绍 process 对象的一些最常用的成员方法。

序号 事件 & 描述
1 exit
当进程准备退出时触发。
2 beforeExit
当 node 清空事件循环，并且没有其他安排时触发这个事件。通常来说，当没有进程安排时 node 退出，但是 ‘beforeExit’ 的监听器可以异步调用，这样 node 就会继续执行。
3 uncaughtException
当一个异常冒泡回到事件循环，触发这个事件。如果给异常添加了监视器，默认的操作（打印堆栈跟踪信息并退出）就不会发生。
4 Signal 事件
当进程接收到信号时就触发。信号列表详见标准的 POSIX 信号名，如 SIGINT、SIGUSR1 等。
实例
创建文件 main.js ，代码如下所示：

process.on(‘exit’, function(code) {

// 以下代码永远不会执行
setTimeout(function() {
console.log(“该代码不会执行”);
}, 0);

console.log(‘退出码为:’, code);
});
console.log(“程序执行结束”);
执行 main.js 文件，代码如下所示:

$ node main.js
程序执行结束
退出码为: 0
退出状态码
退出状态码如下所示：

状态码 名称 & 描述
1 Uncaught Fatal Exception
有未捕获异常，并且没有被域或 uncaughtException 处理函数处理。
2 Unused
保留
3 Internal JavaScript Parse Error
JavaScript的源码启动 Node 进程时引起解析错误。非常罕见，仅会在开发 Node 时才会有。
4 Internal JavaScript Evaluation Failure
JavaScript 的源码启动 Node 进程，评估时返回函数失败。非常罕见，仅会在开发 Node 时才会有。
5 Fatal Error
V8 里致命的不可恢复的错误。通常会打印到 stderr ，内容为： FATAL ERROR
6 Non-function Internal Exception Handler
未捕获异常，内部异常处理函数不知为何设置为on-function，并且不能被调用。
7 Internal Exception Handler Run-Time Failure
未捕获的异常， 并且异常处理函数处理时自己抛出了异常。例如，如果 process.on(‘uncaughtException’) 或 domain.on(‘error’) 抛出了异常。
8 Unused
保留
9 Invalid Argument
可能是给了未知的参数，或者给的参数没有值。
10 Internal JavaScript Run-Time Failure
JavaScript的源码启动 Node 进程时抛出错误，非常罕见，仅会在开发 Node 时才会有。
12 Invalid Debug Argument
设置了参数–debug 和/或 –debug-brk，但是选择了错误端口。
128 Signal Exits
如果 Node 接收到致命信号，比如SIGKILL 或 SIGHUP，那么退出代码就是128 加信号代码。这是标准的 Unix 做法，退出信号代码放在高位。
Process 属性
Process 提供了很多有用的属性，便于我们更好的控制系统的交互：

序号. 属性 & 描述
1 stdout
标准输出流。
2 stderr
标准错误流。
3 stdin
标准输入流。
4 argv
argv 属性返回一个数组，由命令行执行脚本时的各个参数组成。它的第一个成员总是node，第二个成员是脚本文件名，其余成员是脚本文件的参数。
5 execPath
返回执行当前脚本的 Node 二进制文件的绝对路径。
6 execArgv
返回一个数组，成员是命令行下执行脚本时，在Node可执行文件与脚本文件之间的命令行参数。
7 env
返回一个对象，成员为当前 shell 的环境变量
8 exitCode
进程退出时的代码，如果进程优通过 process.exit() 退出，不需要指定退出码。
9 version
Node 的版本，比如v0.10.18。
10 versions
一个属性，包含了 node 的版本和依赖.
11 config
一个包含用来编译当前 node 执行文件的 javascript 配置选项的对象。它与运行 ./configure 脚本生成的 “config.gypi” 文件相同。
12 pid
当前进程的进程号。
13 title
进程名，默认值为”node”，可以自定义该值。
14 arch
当前 CPU 的架构：’arm’、’ia32’ 或者 ‘x64’。
15 platform
运行程序所在的平台系统 ‘darwin’, ‘freebsd’, ‘linux’, ‘sunos’ 或 ‘win32’
16 mainModule
require.main 的备选方法。不同点，如果主模块在运行时改变，require.main可能会继续返回老的模块。可以认为，这两者引用了同一个模块。
实例
创建文件 main.js ，代码如下所示：

// 输出到终端
process.stdout.write(“Hello World!” + “\n”);

// 通过参数读取
process.argv.forEach(function(val, index, array) {
console.log(index + ‘: ‘ + val);
});

// 获取执行路径
console.log(process.execPath);

// 平台信息
console.log(process.platform);
执行 main.js 文件，代码如下所示:

$ node main.js
Hello World!
0: node
1: /web/www/node/main.js
/usr/local/node/0.10.36/bin/node
darwin
方法参考手册
Process 提供了很多有用的方法，便于我们更好的控制系统的交互：

序号 方法 & 描述
1 abort()
这将导致 node 触发 abort 事件。会让 node 退出并生成一个核心文件。
2 chdir(directory)
改变当前工作进程的目录，如果操作失败抛出异常。
3 cwd()
返回当前进程的工作目录
4 exit([code])
使用指定的 code 结束进程。如果忽略，将会使用 code 0。
5 getgid()
获取进程的群组标识（参见 getgid(2)）。获取到得时群组的数字 id，而不是名字。
注意：这个函数仅在 POSIX 平台上可用(例如，非Windows 和 Android)。
6 setgid(id)
设置进程的群组标识（参见 setgid(2)）。可以接收数字 ID 或者群组名。如果指定了群组名，会阻塞等待解析为数字 ID 。
注意：这个函数仅在 POSIX 平台上可用(例如，非Windows 和 Android)。
7 getuid()
获取进程的用户标识(参见 getuid(2))。这是数字的用户 id，不是用户名。
注意：这个函数仅在 POSIX 平台上可用(例如，非Windows 和 Android)。
8 setuid(id)
设置进程的用户标识（参见setuid(2)）。接收数字 ID或字符串名字。果指定了群组名，会阻塞等待解析为数字 ID 。
注意：这个函数仅在 POSIX 平台上可用(例如，非Windows 和 Android)。
9 getgroups()
返回进程的群组 iD 数组。POSIX 系统没有保证一定有，但是 node.js 保证有。
注意：这个函数仅在 POSIX 平台上可用(例如，非Windows 和 Android)。
10 setgroups(groups)
设置进程的群组 ID。这是授权操作，所以你需要有 root 权限，或者有 CAP_SETGID 能力。
注意：这个函数仅在 POSIX 平台上可用(例如，非Windows 和 Android)。
11 initgroups(user, extra_group)
读取 /etc/group ，并初始化群组访问列表，使用成员所在的所有群组。这是授权操作，所以你需要有 root 权限，或者有 CAP_SETGID 能力。
注意：这个函数仅在 POSIX 平台上可用(例如，非Windows 和 Android)。
12 kill(pid[, signal])
发送信号给进程. pid 是进程id，并且 signal 是发送的信号的字符串描述。信号名是字符串，比如 ‘SIGINT’ 或 ‘SIGHUP’。如果忽略，信号会是 ‘SIGTERM’。
13 memoryUsage()
返回一个对象，描述了 Node 进程所用的内存状况，单位为字节。
14 nextTick(callback)
一旦当前事件循环结束，调用回调函数。
15 umask([mask])
设置或读取进程文件的掩码。子进程从父进程继承掩码。如果mask 参数有效，返回旧的掩码。否则，返回当前掩码。
16 uptime()
返回 Node 已经运行的秒数。
17 hrtime()
返回当前进程的高分辨时间，形式为 [seconds, nanoseconds]数组。它是相对于过去的任意事件。该值与日期无关，因此不受时钟漂移的影响。主要用途是可以通过精确的时间间隔，来衡量程序的性能。
你可以将之前的结果传递给当前的 process.hrtime() ，会返回两者间的时间差，用来基准和测量时间间隔。
实例
创建文件 main.js ，代码如下所示：

// 输出当前目录
console.log(‘当前目录: ‘ + process.cwd());

// 输出当前版本
console.log(‘当前版本: ‘ + process.version);

// 输出内存使用情况
console.log(process.memoryUsage());
执行 main.js 文件，代码如下所示:

$ node main.js
当前目录: /web/com/runoob/nodejs
当前版本: v0.10.36
{ rss: 12541952, heapTotal: 4083456, heapUsed: 2157056 }

Node.js 常用工具
util 是一个Node.js 核心模块，提供常用函数的集合，用于弥补核心 JavaScript 的功能 过于精简的不足。

使用方法如下：

const util = require(‘util’);
util.callbackify
util.callbackify(original) 将 async 异步函数（或者一个返回值为 Promise 的函数）转换成遵循异常优先的回调风格的函数，例如将 (err, value) => … 回调作为最后一个参数。 在回调函数中，第一个参数为拒绝的原因（如果 Promise 解决，则为 null），第二个参数则是解决的值。

实例
const util = require(‘util’);

async function fn() {
return ‘hello world’;
}
const callbackFunction = util.callbackify(fn);

callbackFunction((err, ret) => {
if (err) throw err;
console.log(ret);
});
以上代码输出结果为：

hello world
回调函数是异步执行的，并且有异常堆栈错误追踪。 如果回调函数抛出一个异常，进程会触发一个 ‘uncaughtException’ 异常，如果没有被捕获，进程将会退出。

null 在回调函数中作为一个参数有其特殊的意义，如果回调函数的首个参数为 Promise 拒绝的原因且带有返回值，且值可以转换成布尔值 false，这个值会被封装在 Error 对象里，可以通过属性 reason 获取。

function fn() {
return Promise.reject(null);
}
const callbackFunction = util.callbackify(fn);

callbackFunction((err, ret) => {
// 当 Promise 被以 null 拒绝时，它被包装为 Error 并且原始值存储在 reason 中。
err && err.hasOwnProperty(‘reason’) && err.reason === null; // true
});
original 为 async 异步函数。该函数返回传统回调函数。

util.inherits
util.inherits(constructor, superConstructor) 是一个实现对象间原型继承的函数。

JavaScript 的面向对象特性是基于原型的，与常见的基于类的不同。JavaScript 没有提供对象继承的语言级别特性，而是通过原型复制来实现的。

在这里我们只介绍 util.inherits 的用法，示例如下：

var util = require(‘util’);
function Base() {
this.name = ‘base’;
this.base = 1991;
this.sayHello = function() {
console.log(‘Hello ‘ + this.name);
};
}
Base.prototype.showName = function() {
console.log(this.name);
};
function Sub() {
this.name = ‘sub’;
}
util.inherits(Sub, Base);
var objBase = new Base();
objBase.showName();
objBase.sayHello();
console.log(objBase);
var objSub = new Sub();
objSub.showName();
//objSub.sayHello();
console.log(objSub);
我们定义了一个基础对象 Base 和一个继承自 Base 的 Sub，Base 有三个在构造函数内定义的属性和一个原型中定义的函数，通过util.inherits 实现继承。运行结果如下：

base
Hello base
{ name: ‘base’, base: 1991, sayHello: [Function] }
sub
{ name: ‘sub’ }
注意：Sub 仅仅继承了Base 在原型中定义的函数，而构造函数内部创造的 base 属 性和 sayHello 函数都没有被 Sub 继承。

同时，在原型中定义的属性不会被 console.log 作 为对象的属性输出。如果我们去掉 objSub.sayHello(); 这行的注释，将会看到：

node.js:201
throw e; // process.nextTick error, or ‘error’ event on first tick

TypeError: Object #<Sub> has no method ‘sayHello’
at Object.<anonymous> (/home/byvoid/utilinherits.js:29:8)
at Module._compile (module.js:441:26)
at Object..js (module.js:459:10)
at Module.load (module.js:348:31)
at Function._load (module.js:308:12)
at Array.0 (module.js:479:10)
at EventEmitter._tickCallback (node.js:192:40)
util.inspect
util.inspect(object,[showHidden],[depth],[colors]) 是一个将任意对象转换 为字符串的方法，通常用于调试和错误输出。它至少接受一个参数 object，即要转换的对象。

showHidden 是一个可选参数，如果值为 true，将会输出更多隐藏信息。

depth 表示最大递归的层数，如果对象很复杂，你可以指定层数以控制输出信息的多 少。如果不指定depth，默认会递归 2 层，指定为 null 表示将不限递归层数完整遍历对象。 如果 colors 值为 true，输出格式将会以 ANSI 颜色编码，通常用于在终端显示更漂亮 的效果。

特别要指出的是，util.inspect 并不会简单地直接把对象转换为字符串，即使该对 象定义了 toString 方法也不会调用。

var util = require(‘util’);
function Person() {
this.name = ‘byvoid’;
this.toString = function() {
return this.name;
};
}
var obj = new Person();
console.log(util.inspect(obj));
console.log(util.inspect(obj, true));
运行结果是：

Person { name: ‘byvoid’, toString: [Function] }
Person {
name: ‘byvoid’,
toString:
{ [Function]
[length]: 0,
[name]: ‘’,
[arguments]: null,
[caller]: null,
[prototype]: { [constructor]: [Circular] } } }
util.isArray(object)
如果给定的参数 “object” 是一个数组返回 true，否则返回 false。

var util = require(‘util’);

util.isArray([])
// true
util.isArray(new Array)
// true
util.isArray({})
// false
util.isRegExp(object)
如果给定的参数 “object” 是一个正则表达式返回true，否则返回false。

var util = require(‘util’);

util.isRegExp(/some regexp/)
// true
util.isRegExp(new RegExp(‘another regexp’))
// true
util.isRegExp({})
// false
util.isDate(object)
如果给定的参数 “object” 是一个日期返回true，否则返回false。

var util = require(‘util’);

util.isDate(new Date())
// true
util.isDate(Date())
// false (without ‘new’ returns a String)
util.isDate({})
// false
更多详情可以访问 http://nodejs.org/api/util.html 了解详细内容。

Node.js 文件系统
Node.js 提供一组类似 UNIX（POSIX）标准的文件操作API。 Node 导入文件系统模块(fs)语法如下所示：

var fs = require(“fs”)
异步和同步
Node.js 文件系统（fs 模块）模块中的方法均有异步和同步版本，例如读取文件内容的函数有异步的 fs.readFile() 和同步的 fs.readFileSync()。

异步的方法函数最后一个参数为回调函数，回调函数的第一个参数包含了错误信息(error)。

建议大家使用异步方法，比起同步，异步方法性能更高，速度更快，而且没有阻塞。

实例
创建 input.txt 文件，内容如下：

菜鸟教程官网地址：www.runoob.com
文件读取实例
创建 file.js 文件, 代码如下：

var fs = require(“fs”);

// 异步读取
fs.readFile(‘input.txt’, function (err, data) {
if (err) {
return console.error(err);
}
console.log(“异步读取: “ + data.toString());
});

// 同步读取
var data = fs.readFileSync(‘input.txt’);
console.log(“同步读取: “ + data.toString());

console.log(“程序执行完毕。”);
以上代码执行结果如下：

$ node file.js
同步读取: 菜鸟教程官网地址：www.runoob.com
文件读取实例

程序执行完毕。
异步读取: 菜鸟教程官网地址：www.runoob.com
文件读取实例
接下来，让我们来具体了解下 Node.js 文件系统的方法。

打开文件
语法
以下为在异步模式下打开文件的语法格式：

fs.open(path, flags[, mode], callback)
参数
参数使用说明如下：

path - 文件的路径。

flags - 文件打开的行为。具体值详见下文。

mode - 设置文件模式(权限)，文件创建默认权限为 0666(可读，可写)。

callback - 回调函数，带有两个参数如：callback(err, fd)。

flags 参数可以是以下值：

Flag 描述
r 以读取模式打开文件。如果文件不存在抛出异常。
r+ 以读写模式打开文件。如果文件不存在抛出异常。
rs 以同步的方式读取文件。
rs+ 以同步的方式读取和写入文件。
w 以写入模式打开文件，如果文件不存在则创建。
wx 类似 ‘w’，但是如果文件路径存在，则文件写入失败。
w+ 以读写模式打开文件，如果文件不存在则创建。
wx+ 类似 ‘w+’， 但是如果文件路径存在，则文件读写失败。
a 以追加模式打开文件，如果文件不存在则创建。
ax 类似 ‘a’， 但是如果文件路径存在，则文件追加失败。
a+ 以读取追加模式打开文件，如果文件不存在则创建。
ax+ 类似 ‘a+’， 但是如果文件路径存在，则文件读取追加失败。
实例
接下来我们创建 file.js 文件，并打开 input.txt 文件进行读写，代码如下所示：

var fs = require(“fs”);

// 异步打开文件
console.log(“准备打开文件！”);
fs.open(‘input.txt’, ‘r+’, function(err, fd) {
if (err) {
return console.error(err);
}
console.log(“文件打开成功！”);

});
以上代码执行结果如下：

$ node file.js
准备打开文件！
文件打开成功！
获取文件信息
语法
以下为通过异步模式获取文件信息的语法格式：

fs.stat(path, callback)
参数
参数使用说明如下：

path - 文件路径。

callback - 回调函数，带有两个参数如：(err, stats), stats 是 fs.Stats 对象。

fs.stat(path)执行后，会将stats类的实例返回给其回调函数。可以通过stats类中的提供方法判断文件的相关属性。例如判断是否为文件：

var fs = require(‘fs’);

fs.stat(‘/Users/liuht/code/itbilu/demo/fs.js’, function (err, stats) {
console.log(stats.isFile()); //true
})
stats类中的方法有：

方法 描述
stats.isFile() 如果是文件返回 true，否则返回 false。
stats.isDirectory() 如果是目录返回 true，否则返回 false。
stats.isBlockDevice() 如果是块设备返回 true，否则返回 false。
stats.isCharacterDevice() 如果是字符设备返回 true，否则返回 false。
stats.isSymbolicLink() 如果是软链接返回 true，否则返回 false。
stats.isFIFO() 如果是FIFO，返回true，否则返回 false。FIFO是UNIX中的一种特殊类型的命令管道。
stats.isSocket() 如果是 Socket 返回 true，否则返回 false。
实例
接下来我们创建 file.js 文件，代码如下所示：

var fs = require(“fs”);

console.log(“准备打开文件！”);
fs.stat(‘input.txt’, function (err, stats) {
if (err) {
return console.error(err);
}
console.log(stats);
console.log(“读取文件信息成功！”);

// 检测文件类型
console.log(“是否为文件(isFile) ? “ + stats.isFile());
console.log(“是否为目录(isDirectory) ? “ + stats.isDirectory());

});
以上代码执行结果如下：

$ node file.js
准备打开文件！
{ dev: 16777220,
mode: 33188,
nlink: 1,
uid: 501,
gid: 20,
rdev: 0,
blksize: 4096,
ino: 40333161,
size: 61,
blocks: 8,
atime: Mon Sep 07 2015 17:43:55 GMT+0800 (CST),
mtime: Mon Sep 07 2015 17:22:35 GMT+0800 (CST),
ctime: Mon Sep 07 2015 17:22:35 GMT+0800 (CST) }
读取文件信息成功！
是否为文件(isFile) ? true
是否为目录(isDirectory) ? false
写入文件
语法
以下为异步模式下写入文件的语法格式：

fs.writeFile(file, data[, options], callback)
writeFile 直接打开文件默认是 w 模式，所以如果文件存在，该方法写入的内容会覆盖旧的文件内容。

参数
参数使用说明如下：

file - 文件名或文件描述符。

data - 要写入文件的数据，可以是 String(字符串) 或 Buffer(缓冲) 对象。

options - 该参数是一个对象，包含 {encoding, mode, flag}。默认编码为 utf8, 模式为 0666 ， flag 为 ‘w’

callback - 回调函数，回调函数只包含错误信息参数(err)，在写入失败时返回。