关于本文档#

本文档的目标是从参考和概念的角度全面解释 Node.js 的 API，每章节描述一个内置模块或高级概念。

在某些情况下，属性类型、方法参数以及事件处理过程（handler）参数 会被列在主标题下的列表中。

每一个 .html 文件都对应一份内容相同的结构化 .json 文档。这个特性现在还是实验性质的，希望能够为一些需要对文档进行操作的IDE或者其他工具提供帮助。

每个 .html 和 .json 文件都是基于源码的 doc/api/ 目录下的 .markdown 文件生成的。本文档使用 tools/doc/generate.js 这个程序来生产的。 HTML 模板文件为 doc/template.html。

稳定度#

在文档中，您可以了解每一个小节的稳定性。Node.js的API会有一些小的改变，当它成熟的时候，会有些部分相比另外一些来说更加可靠。有一部分接受过严格验证，被大量依赖的API几乎是不会改变的。也有一些是新增的、实验性的或者因被证实具有危险性而在重新设计中。

稳定度定义如下

稳定度: 5 - 已锁定
除非发现严重缺陷，该代码不会被更改。请不要对此区域提出更改，更改提议将被拒绝。

JSON 输出#

稳定度: 1 - 实验性

每个通过 markdown 生成的 HTML 文件都对应于一个具有相同数据的 JSON 文件。

该特性引入于 node v0.6.12。当前是测试性功能。

概述#

一个输出 “Hello World” 的简单 Web 服务器例子：

console.log('服务器已运行，请打开 http://127.0.0.1:8124/');

要运行这个服务器，先将程序保存为文件 “example.js”，并使用 node 命令来执行：

> node example.js
服务器已运行，请打开 http://127.0.0.1:8124/

所有的文档中的例子均使用相同的方式运行。

全局对象#

这些对象在所有模块中都是可用的。有些对象实际上并非在全局作用域内而是在模块作用域内——这种情况在以下文档中会特别指出。

global#

• {Object} 全局命名空间对象。

在浏览器中，顶级作用域就是全局作用域。这就是说，在浏览器中，如果当前是在全局作用域内，var something将会声明一个全局变量。在Node中则不同。顶级作用域并非全局作用域，在Node模块里的var something只属于那个模块。

process#

• {Object}

进程对象。见 进程对象章节。

console#

• {Object}

用于打印标准输出和标准错误。见控制台章节。

类: Buffer#

• {Function}

用于处理二进制数据。见Buffer章节。

require()#

• {Function}

引入模块。见Modules章节。require实际上并非全局的而是各个模块本地的。

require.resolve()#

使用内部的require()机制查找模块的位置，但不加载模块，只返回解析过的模块文件路径。

require.cache#

• {Object}

模块在引入时会缓存到该对象。通过删除该对象的键值，下次调用require时会重新加载相应模块。

require.extensions#

稳定度：0 - 已废弃

• {Object}

指导require方法如何处理特定的文件扩展名。

将.sjs文件作为.js文件处理：

require.extensions['.sjs'] = require.extensions['.js'];

已废弃 之前，该列表用于按需编译非JavaScript模块并加载进Node。然而，实践中有更好的方式实现该功能，如通过其他Node程序加载模块，或提前将他们编译成JavaScript代码。

由于模块系统的API已锁定，该功能可能永远不会去掉。改动它可能会产生细微的错误和复杂性，所以最好保持不变。

__filename#

• {String}

当前所执行代码文件的文件路径。这是该代码文件经过解析后的绝对路径。对于主程序来说，这和命令行中使用的文件路径未必是相同的。在模块中此变量值是该模块文件的路径。

例子：在/Users/mjr下运行node example.js

console.log(__filename);
// /Users/mjr/example.js

__filename实际上并非全局的而是各个模块本地的。

__dirname#

• {String}

当前执行脚本所在目录的目录名。

例子：在/Users/mjr下运行node example.js

console.log(__dirname);
// /Users/mjr

__dirname实际上并非全局的而是各个模块本地的。

module#

• {Object}

当前模块的引用。特别地，module.exports和exports指向同一个对象。module实际上并非全局的而是各个模块本地的。

详情可见模块系统文档。

exports#

module.exports对象的引用，该对象被当前模块的所有实例所共享，通过require()可访问该对象。 何时使用exports以及何时使用module.exports的详情可参见模块系统文档。 exports实际上并非全局的而是各个模块本地的。

详情可见模块系统文档。

关于模块系统的更多信息可参见模块 。

setTimeout(cb, ms)#

在至少ms毫秒后调用回调cb。实际延迟取决于外部因素，如操作系统定时器粒度及系统负载。

超时值必须在1-2147483647的范围内（包含1和2147483647）。如果该值超出范围，则该值被当作1毫秒处理。一般来说，一个定时器不能超过24.8天。

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

clearTimeout(t)#

停止一个之前通过setTimeout()创建的定时器。回调不会再被执行。

setInterval(cb, ms)#

每隔ms毫秒重复调用回调cb。注意，取决于外部因素，如操作系统定时器粒度及系统负载，实际间隔可能会改变。它不会少于ms但可能比ms长。

间隔值必须在1-2147483647的范围内（包含1和2147483647）。如果该值超出范围，则该值被当作1毫秒处理。一般来说，一个定时器不能超过24.8天。

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

clearInterval(t)#

停止一个之前通过setInterval()创建的定时器。回调不会再被执行。

定制器函数是全局变量。见定时器章节。

控制台#

稳定度: 4 - 冻结

• {Object}

用于向 stdout 和 stderr 打印字符。类似于大部分 Web 浏览器提供的 console 对象函数，在这里则是输出到 stdout 或 stderr。

当输出目标是一个终端或者文件时,console函数是同步的(为了防止过早退出时丢失信息).当输出目标是一个管道时它们是异步的(防止阻塞过长时间).

也就是说，在下面的例子中，stdout 是非阻塞的，而 stderr 则是阻塞的。

$ node script.js 2> error.log | tee info.log

在日常使用中，您不需要太担心阻塞/非阻塞的差别，除非您需要记录大量数据。

console.log([data], [...])#

向 stdout 打印并新起一行。这个函数可以像 printf() 那样接受多个参数，例如：

console.log('count: %d', count);

如果在第一个字符串中没有找到格式化元素，那么 util.inspect 将被应用到各个参数。详见 util.format()。

console.info([data], [...])#

同 console.log。

console.error([data], [...])#

同 console.log，但输出到 stderr。

console.warn([data], [...])#

同 console.error。

console.dir(obj)#

对 obj 使用 util.inspect 并将结果字符串输出到 stdout。这个函数会忽略 obj 上的任何自定义 inspect()。

console.time(label)#

标记一个时间点。

console.timeEnd(label)#

结束计时器，记录输出。例如：

console.time('100-elements');
for (var i = 0; i < 100; i++) {
  ;
}
console.timeEnd('100-elements');

console.trace(label)#

打印当前位置的栈跟踪到 stderr。

console.assert(expression, [message])#

与 assert.ok() 相同，如果 expression 执行结果为 false 则抛出一个带上 message 的 AssertionError。

定时器#

稳定度: 5 - 已锁定

所有的定时器函数都是全局变量. 你使用这些函数时不需要 require()模块.

setTimeout(callback, delay, [arg], [...])#

调度 delay 毫秒后的一次 callback 执行。返回一个可能被 clearTimeout() 用到的 timeoutId。可选地，您还能给回调传入参数。

请务必注意，您的回调有可能不会在准确的 delay 毫秒后被调用。Node.js 不保证回调被触发的精确时间和顺序。回调会在尽可能接近所指定时间上被调用。

clearTimeout(timeoutId)#

阻止一个 timeout 被触发。

setInterval(callback, delay, [arg], [...])#

调度每隔 delay 毫秒执行一次的 callback。返回一个可能被 clearInterval() 用到的 intervalId。可选地，您还能给回调传入参数。

clearInterval(intervalId)#

停止一个 interval 的触发。

unref()#

setTimeout 和 setInterval 所返回的值同时具有 timer.unref() 方法，允许您创建一个活动的、但当它是事件循环中仅剩的项目时不会保持程序运行的定时器。如果定时器已被 unref，再次调用 unref 不会产生其它影响。

在 setTimeout 的情景中当您 unref 您会创建另一个定时器，并唤醒事件循环。创建太多这种定时器可能会影响事件循环的性能，慎用。

ref()#

如果您之前 unref() 了一个定时器，您可以调用 ref() 来明确要求定时器让程序保持运行。如果定时器已被 ref 那么再次调用 ref 不会产生其它影响。

setImmediate(callback, [arg], [...])#

调度在所有 I/O 事件回调之后、setTimeout 和 setInterval 之前“立即”执行 callback。返回一个可能被 clearImmediate() 用到的 immediateId。可选地，您还能给回调传入参数。

immediate 的回调以它们创建的顺序被加入队列。整个回调队列会在每个事件循环迭代中被处理。如果您在一个正被执行的回调中添加 immediate，那么这个 immediate 在下一个事件循环迭代之前都不会被触发。

clearImmediate(immediateId)#

停止一个 immediate 的触发。

Modules#

稳定度: 5 - 已锁定

Node有一个简易的模块加载系统。在node中，文件和模块是一一对应的。下面示例是foo.js加载同一目录下的circle.js。

foo.js的内容：

var circle = require('./circle.js');
console.log( 'The area of a circle of radius 4 is '
           + circle.area(4));

circle.js的内容:

var PI = Math.PI;
exports.area = function (r) {
    return PI * r * r;
};
exports.circumference = function (r) {
    return 2 * PI * r;
};

circle.js模块输出了area()和circumference()两个函数。要输出某个对象，把它加到exports这个特殊对象下即可。

注意，exports是module.exports的一个引用，只是为了用起来方便。当你想输出的是例如构造函数这样的单个项目，那么需要使用module.exports。

// 正确输出构造函数
module.exports = MyConstructor;

模块内的本地变量是私有的。在这里例子中，PI这个变量就是circle.js私有的。

模块系统的实现在require("module")中。

循环#

当存在循环的require()调用时，一个模块可能在返回时并不会被执行。

考虑这样一种情形:

a.js:

console.log('a starting');
exports.done = false;
var b = require('./b.js');
console.log('in a, b.done = %j', b.done);
exports.done = true;
console.log('a done');

b.js:

console.log('b starting');
exports.done = false;
var a = require('./a.js');
console.log('in b, a.done = %j', a.done);
exports.done = true;
console.log('b done');

main.js:

console.log('main starting');
var a = require('./a.js');
var b = require('./b.js');
console.log('in main, a.done=%j, b.done=%j', a.done, b.done);

首先main.js加载a.js,接着a.js又去加载b.js。这时，b.js会尝试去加载a.js。为了防止无限的循环，a.js会返回一个unfinished copy给b.js。然后b.js就会停止加载，并将其exports对象返回给a.js模块。

这样main.js就把这两个模块都加载完成了。这段程序的输出如下：

$ node main.js
main starting
a starting
b starting
in b, a.done = false
b done
in a, b.done = true
a done
in main, a.done=true, b.done=true

如果你的程序中有循环的模块依赖，请确保工作正常。

核心模块#

Node中有一些模块是编译成二进制的。这些模块在本文档的其他地方有更详细的描述。

核心模块定义在node源代码的lib/目录下。

require()总是会优先加载核心模块。例如，require('http')总是返回编译好的HTTP模块，而不管是否有这个名字的文件。

文件模块#

如果按文件名没有查找到，那么node会添加 .js和 .json后缀名，再尝试加载，如果还是没有找到，最后会加上.node的后缀名再次尝试加载。

.js 会被解析为Javascript纯文本文件，.json 会被解析为JSON格式的纯文本文件. .node 则会被解析为编译后的插件模块，由dlopen进行加载。

模块以'/'为前缀，则表示绝对路径。例如，require('/home/marco/foo.js') ，加载的是/home/marco/foo.js这个文件。

模块以'./'为前缀，则路径是相对于调用require()的文件。 也就是说，circle.js必须和foo.js在同一目录下，require('./circle')才能找到。

当没有以'/'或者'./'来指向一个文件时，这个模块要么是"核心模块"，要么就是从node_modules文件夹加载的。

如果指定的路径不存在，require()会抛出一个code属性为'MODULE_NOT_FOUND'的错误。

从node_modules文件夹中加载#

如果require()中的模块名不是一个本地模块，也没有以'/', '../', 或是 './'开头，那么node会从当前模块的父目录开始，尝试在它的/node_modules文件夹里加载相应模块。

如果没有找到，那么就再向上移动到父目录，直到到达顶层目录位置。

例如，如果位于'/home/ry/projects/foo.js'的文件调用了require('bar.js')，那么node查找的位置依次为：

• /home/ry/projects/node_modules/bar.js
• /home/ry/node_modules/bar.js
• /home/node_modules/bar.js
• /node_modules/bar.js

这就要求程序员应尽量把依赖放在就近的位置，以防崩溃。

Folders as Modules#

可以把程序和库放到一个单独的文件夹里，并提供单一入口来指向它。有三种方法，使一个文件夹可以作为require()的参数来加载。

首先是在文件夹的根目录创建一个叫做package.json的文件，它需要指定一个main模块。下面是一个package.json文件的示例。

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

示例中这个文件，如果是放在./some-library目录下面，那么require('./some-library')就将会去加载./some-library/lib/some-library.js。

This is the extent of Node's awareness of package.json files.

如果目录里没有package.json这个文件，那么node就会尝试去加载这个路径下的index.js或者index.node。例如，若上面例子中，没有package.json，那么require('./some-library')就将尝试加载下面的文件：

• ./some-library/index.js
• ./some-library/index.node

Caching#

模块在第一次加载后会被缓存。这意味着（类似其他缓存）每次调用require('foo')的时候都会返回同一个对象，当然，必须是每次都解析到同一个文件。

多次调用 require(foo) 未必会导致模块中的代码执行多次. 这是一个重要的功能. 借助这个功能, 可以返回部分完成的对象; 这样, 传递依赖也能被加载, 即使它们可能导致循环依赖

如果你希望一个模块多次执行，那么就输出一个函数，然后调用这个函数。

Module Caching Caveats#

模块的缓存是依赖于解析后的文件名。由于随着调用的位置不同，可能解析到不同的文件（比如需从node_modules文件夹加载的情况），所以，如果解析到其他文件时，就不能保证require('foo')总是会返回确切的同一对象。

The module Object#

• {Object}

在每一个模块中，变量 module 是一个代表当前模块的对象的引用。 特别地，module.exports 可以通过全局模块对象 exports 获取到。 module 不是事实上的全局对象，而更像是每个模块内部的。

module.exports#

• {Object}

module.exports 对象是通过模块系统产生的。有时候这是难以接受的，许多人想让他们的模块是某个类的实例。 因此，将要导出的对象赋值给 module.exports 。例如，假设我们有一个模块称之为 a.js

// Do some work, and after some time emit
// the 'ready' event from the module itself.
setTimeout(function() {
  module.exports.emit('ready');
}, 1000);

那么，在另一个文件中我们可以这样写

var a = require('./a');
a.on('ready', function() {
  console.log('module a is ready');
});

注意: 给module.expors赋值必须立即生效, 不能在回调中执行, 这样不工作.

x.js:

setTimeout(function() {
  module.exports = { a: "hello" };
}, 0);

y.js:

var x = require('./x');
console.log(x.a);

module.require(id)#

• id {String}
• Return: {Object} 已解析模块的 module.exports

module.require 方法提供了一种像 require() 一样从最初的模块加载一个模块的方法。

注意，为了这样做，你必须取得一个对 module 对象的引用。 require() 返回 module.exports，并且 module 是一个典型的只能在特定模块作用域内有效的变量，如果要使用它，就必须明确的导出。

module.id#

• {String}

用于区别模块的标识符。通常是完全解析后的文件名。

module.filename#

• {String}

模块完全解析后的文件名。

module.loaded#

• {Boolean}

不论该模块是否加载完毕，或者正在加载的过程中。

module.parent#

• {Module Object}

引入这个模块的模块。

module.children#

• {Array}

这个模块引入的所有模块对象。

总体来说...#

为了获取调用 require 加载的确切的文件名，使用 require.resolve() 函数。

综上所述，下面用伪代码的高级算法形式表达了 require.resolve 是如何工作的：

NODE_MODULES_PATHS(START)
1. let PARTS = path split(START)
2. let ROOT = index of first instance of "node_modules" in PARTS, or 0
3. let I = count of PARTS - 1
4. let DIRS = []
5. while I > ROOT,
   a. if PARTS[I] = "node_modules" CONTINUE
   c. DIR = path join(PARTS[0 .. I] + "node_modules")
   b. DIRS = DIRS + DIR
   c. let I = I - 1
6. return DIRS

从全局文件夹加载#

如果 NODE_PATH 环境变量设置为一个以冒号分割的绝对路径的列表， 找不到模块时 node 将会从这些路径中搜索模块。 （注意：在 windows 操作系统上，NODE_PATH 是以分号间隔的）

此外，node 将会搜索以下地址：

• 1: $HOME/.node_modules
• 2: $HOME/.node_libraries
• 3: $PREFIX/lib/node

$HOME 是用户的主目录，$PREFIX 是 node 里配置的 node_prefix 。

这些大多是由于历史原因。强烈建议读者将所依赖的模块放到 node_modules 文件夹里。 这样加载的更快也更可靠。

访问主模块#

当 Node 直接运行一个文件时，require.main 就被设置为它的 module 。 也就是说你可以判断一个文件是否是直接被运行的

require.main === module

对于一个 foo.js 文件，如果通过 node foo.js 运行是 true ，但是通过 require('./foo') 运行却是 false 。

因为 module 提供了一个 filename 属性（通常等于 __filename）， 所以当前程序的入口点可以通过 require.main.filename 来获取。

附录： 包管理技巧#

Node 的 require() 函数的语义被设计的足够通用化，以支持各种常规目录结构。 包管理程序如 dpkg，rpm 和 npm 将不用修改就能够从 Node 模块构建本地包。

接下来我们将给你一个可行的目录结构建议：

假设我们希望将一个包的指定版本放在 /usr/lib/node/<some-package>/<some-version> 目录中。

包可以依赖于其他包。为了安装包 foo，可能需要安装包 bar 的一个指定版本。 包 bar 也可能有依赖关系，在某些情况下依赖关系可能发生冲突或者形成循环。

因为 Node 会查找它所加载的模块的真实路径（也就是说会解析符号链接）， 然后按照上文描述的方式在 node_modules 目录中寻找依赖关系，这种情形跟以下体系结构非常相像：

• /usr/lib/node/foo/1.2.3/ - foo 包 1.2.3 版本的内容
• /usr/lib/node/bar/4.3.2/ - foo 包所依赖的 bar 包的内容
• /usr/lib/node/foo/1.2.3/node_modules/bar - 指向 /usr/lib/node/bar/4.3.2/ 的符号链接
• /usr/lib/node/bar/4.3.2/node_modules/* - 指向 bar 包所依赖的包的符号链接

因此即便存在循环依赖或依赖冲突，每个模块还是可以获得他所依赖的包的一个可用版本。

当 foo 包中的代码调用 require('bar')，将获得符号链接 /usr/lib/node/foo/1.2.3/node_modules/bar 指向的版本。 然后，当 bar 包中的代码调用 require('queue')，将会获得符号链接 /usr/lib/node/bar/4.3.2/node_modules/quux 指向的版本。

此外，为了进一步优化模块搜索过程，不要将包直接放在 /usr/lib/node 目录中，而是将它们放在 /usr/lib/node_modules/<name>/<version> 目录中。 这样在依赖的包找不到的情况下，就不会一直寻找 /usr/node_modules 目录或 /node_modules 目录了。

为了使模块在 node 的 REPL 中可用，你可能需要将 /usr/lib/node_modules 目录加入到 $NODE_PATH 环境变量中。 由于在 node_modules 目录中搜索模块使用的是相对路径，基于调用 require() 的文件所在真实路径，因此包本身可以放在任何位置。

Addons插件#

Addons插件就是动态连接库。它类似胶水，将c、c++和Node粘贴起来。它的API（目前来说）相当复杂，涉及到了几个类库的知识。

• V8 JavaScript引擎,一个 C++ 类库. 用于和JavaScript进行交互的接口。 创建对象, 调用函数等. 文档大部分在这里： v8.h 头文件 (deps/v8/include/v8.h在Node源代码目录里), 也有可用的线上文档 线上. （译者：想要学习c++的addons插件编写，必须先了解v8的接口）

• libuv, C语言编写的事件循环类库。任何时候需要等待一个文件描述符变为可读状态，等待一个定时器，或者等待一个接受信号都需要使用libuv类库的接口。也就是说，如果你执行任何I/O操作，libuv类库将会被用到。

• 内部 Node 类库.最重要的接口就是 node::ObjectWrap 类，这个类你应该是最可能想要派生的。

• 其他.请参阅 deps/ 获得更多可用类库。

Node 静态编译了所有依赖到它的可执行文件中去了。当编译你的模块时，你不必担心无法连接上述那些类库。 （译者：换而言之，你在编译自己的addons插件时，只管在头部 #include <uv.h>，不必在binding.gyp中声明）

下面所有的例子都可以下载到： 下载 这或许能成为你学习和创作自己addon插件的起点。

Hello world（世界你好）#

作为开始，让我们用编写一个小的addon插件，这个addon插件的c++代码相当于下面的JavaScript代码。

module.exports.hello = function() { return 'world'; };

首先我们创建一个 hello.cc文件:

NODE_MODULE(hello, init)//译者：将addon插件名hello和上述init函数关联输出

注意所有Node的addons插件都必须输出一个初始化函数：

void Initialize (Handle<Object> exports);
NODE_MODULE(module_name, Initialize)

在NODE_MODULE之后没有分号，因为它不是一个函数（请参阅node.h）

这个module_name（模块名）需要和最后编译生成的2进制文件名（减去.node后缀名）相同。

源代码需要生成在hello.node，这个2进制addon插件中。 需要做到这些，我们要创建一个名为binding.gyp的文件，它描述了创建这个模块的配置，并且它的格式是类似JSON的。 文件将被命令：node-gyp 编译。

{
  "targets": [
    {
      "target_name": "hello", //译者：addon插件名，注意这里的名字必需和上面NODE_MODULE中的一致
      "sources": [ "hello.cc" ]  //译者：这是需要编译的源文件
    }
  ]
}

下一步是根据当前的操作系统平台，利用node-gyp configure命令，生成合适的项目文件。

现在你会有一个Makefile (在Unix平台) 或者一个 vcxproj file (在Windows上)，它们都在build/ 文件夹中. 然后执行命令 node-gyp build进行编译。 （译者：当然你可以执行 node-gyp rebuild一步搞定）

现在你已经有了编译好的 .node 文件了，这个编译好的绑定文件会在目录 build/Release/下

现在你可以使用这个2进制addon插件在Node项目hello.js 中了，通过指明require这个刚刚创建的hello.node模块使用它。

console.log(addon.hello()); // 'world'

请阅读下面的内容获得更多详情或者访问https://github.com/arturadib/node-qt获取一个生产环境的例子。

Addon patterns（插件方式）#

下面是一些帮助你开始编写addon插件的方式。参考这个在线的v8 手册用来帮助你调用各种v8接口， 然后是v8的 嵌入式开发向导 ，解释几个概念，如 handles, scopes,function templates等。

为了能跑起来这些例子，你必须用 node-gyp 来编译他们。 创建一个binding.gyp 文件：

{
  "targets": [
    {
      "target_name": "addon",
      "sources": [ "addon.cc" ]
    }
  ]
}

事实上可以有多个 .cc 文件, 就简单的在 sources 数组里加上即可，例子：

"sources": ["addon.cc", "myexample.cc"]

现在你有了你的binding.gyp文件了，你可要开始执行configure 和 build 命令构建你的addon插件了

$ node-gyp configure build

Function arguments（函数参数）#

下面的部分说明了如何从JavaScript的函数调用获得参数然后返回一个值。这是主要的内容并且仅需要源代码addon.cc。

NODE_MODULE(addon, Init)

你可以使用下面的JavaScript代码片段来测试它

console.log( 'This should be eight:', addon.add(3,5) );

Callbacks（回调）#

你可以传递JavaScript functions 到一个C++ function 并且执行他们，这里是 addon.cc文件:

NODE_MODULE(addon, Init)

注意这个例子对Init()使用了两个参数，将完整的 module 对象作为第二个参数传入。这允许addon插件完全的重写 exports，这样就可以用一个函数代替多个函数作为exports的属性了。

你可以使用下面的JavaScript代码片段来测试它

addon(function(msg){
  console.log(msg); // 'hello world'
});

Object factory（对象工厂）#

在这个addon.cc文件里用一个c++函数，你可以创建并且返回一个新的对象，这个新的对象拥有一个msg的属性，它的值是通过createObject()方法传入的

NODE_MODULE(addon, Init)

在js中测试如下:

var obj1 = addon('hello');
var obj2 = addon('world');
console.log(obj1.msg+' '+obj2.msg); // 'hello world'

Function factory（函数工厂）#

这次将展示如何创建并返回一个JavaScript function函数，这个函数其实是通过c++包装的。

NODE_MODULE(addon, Init)

测试它:

var fn = addon();
console.log(fn()); // 'hello world'

Wrapping C++ objects（包装c++对象）#

这里将创建一个被c++包裹的对象或类MyObject，它是可以在JavaScript中通过new操作符实例化的。 首先我们要准备主要的模块文件addon.cc:

NODE_MODULE(addon, InitAll)

然后在myobject.h文件中创建你的包装类，它继承自 node::ObjectWrap:

#endif

在文件 myobject.cc 可以实施各种你想要暴露给js的方法。 这里我们暴露方法名为 plusOne给就是，它表示将构造函数的属性加1.

  return scope.Close(Number::New(obj->counter_));
}

测试它:

var obj = new addon.MyObject(10);
console.log( obj.plusOne() ); // 11
console.log( obj.plusOne() ); // 12
console.log( obj.plusOne() ); // 13

Factory of wrapped objects（工厂包装对象）#

这是非常有用的，当你想创建原生的JavaScript对象时，又不想明确的使用JavaScript的new操作符。

var obj = addon.createObject();
// 用上面的方式代替下面的:
// var obj = new addon.Object();

让我们注册在 addon.cc 文件中注册createObject方法:

NODE_MODULE(addon, InitAll)

在myobject.h文件中，我们现在介绍静态方法NewInstance，它能够实例化对象（举个例子，它的工作就像是 在JavaScript中的new` 操作符。）

#endif

这里的处理方式和上面的 myobject.cc很像:

  return scope.Close(Number::New(obj->counter_));
}

测试它:

var obj2 = createObject(20);
console.log( obj2.plusOne() ); // 21
console.log( obj2.plusOne() ); // 22
console.log( obj2.plusOne() ); // 23

Passing wrapped objects around（传递包装的对象）#

除了包装和返回c++对象以外，你可以传递他们并且通过Node的node::ObjectWrap::Unwrap帮助函数解包装他们。 在下面的addon.cc 文件中，我们介绍了一个函数add()，它能够获取2个MyObject对象。

NODE_MODULE(addon, InitAll)

为了使事情变得有趣，我们在 myobject.h 采用一个公共的方法，所以我们能够在unwrapping解包装对象之后使用私有成员的值。

#endif

myobject.cc文件的处理方式和前面类似

  return scope.Close(instance);
}

测试它:

var obj1 = addon.createObject(10);
var obj2 = addon.createObject(20);
var result = addon.add(obj1, obj2);

console.log(result); // 30

process#

process对象是一个全局对象，可以在任何地方访问到它。 它是EventEmitter的一个实例。

Exit Codes#

Node 执行程序正常情况下会返回 0，这也意味着，包括所有“异步”在内的操作都已结束。（笔者注：linux terminal 下使用 echo $? 查看，win cmd 下使用 echo %ERRORLEVEL% 查看）除此之外的其他返回状态如下：

• 1 未捕获的致命异常(Uncaught Fatal Exception) - There was an uncaught exception, and it was not handled by a domain or an uncaughtException event handler.
• 2 - 未使用(Unused) (reserved by Bash for builtin misuse)
• 3 解析错误(Internal JavaScript Parse Error) - The JavaScript source code internal in Node's bootstrapping process caused a parse error. This is extremely rare, and generally can only happen during development of Node itself.
• 4 评估失败(Internal JavaScript Evaluation Failure) - The JavaScript source code internal in Node's bootstrapping process failed to return a function value when evaluated. This is extremely rare, and generally can only happen during development of Node itself.
• 5 致命错误(Fatal Error) - There was a fatal unrecoverable error in V8. Typically a message will be printed to stderr with the prefix FATAL ERROR.
• 6 未正确的异常处理(Non-function Internal Exception Handler) - There was an uncaught exception, but the internal fatal exception handler function was somehow set to a non-function, and could not be called.
• 7 异常处理函数运行时失败(Internal Exception Handler Run-Time Failure) - There was an uncaught exception, and the internal fatal exception handler function itself threw an error while attempting to handle it. This can happen, for example, if a process.on('uncaughtException') or domain.on('error') handler throws an error.
• 8 - 未使用(Unused). In previous versions of Node, exit code 8 sometimes indicated an uncaught exception.
• 9 - 无效的参数(Invalid Argument) - Either an unknown option was specified, or an option requiring a value was provided without a value.
• 10 运行时失败(Internal JavaScript Run-Time Failure) - The JavaScript source code internal in Node's bootstrapping process threw an error when the bootstrapping function was called. This is extremely rare, and generally can only happen during development of Node itself.
• 12 无效的调试参数(Invalid Debug Argument) - The --debug and/or --debug-brk options were set, but an invalid port number was chosen.
• >128 信号退出(Signal Exits) - If Node receives a fatal signal such as SIGKILL or SIGHUP, then its exit code will be 128 plus the value of the signal code. This is a standard Unix practice, since exit codes are defined to be 7-bit integers, and signal exits set the high-order bit, and then contain the value of the signal code.

事件: 'exit'#

当进程将要退出时触发。这是一个在固定时间检查模块状态（如单元测试）的好时机。需要注意的是 'exit' 的回调结束后，主事件循环将不再运行，所以计时器也会失效。

监听 exit 事件的例子：

process.on('exit', function() {
  // 设置一个延迟执行
  setTimeout(function() {
    console.log('主事件循环已停止，所以不会执行');
  }, 0);
  console.log('退出前执行');
});

事件: 'uncaughtException'（未捕获错误）#

当一个异常冒泡回归到事件循环中就会触发这个事件，如果建立了一个监听器来监听这个异常，默认的行为（打印堆栈跟踪信息并退出）就不会发生。

监听 uncaughtException 示例:

// 故意制造一个异常，而且不catch捕获它.
nonexistentFunc();
console.log('This will not run.');

注意，uncaughtException未捕获异常是一个非常粗略的异常处理。

尽量不要使用它，使用 domains 来代替它，如果你已经使用了，请在不处理这个异常之后重启你的应用。

请 不要 象使用node.js的有错误回复执行这样使用.一个未处理异常意味着你的应用和你的扩展Node.js自身是有未知状态的。盲目的恢复意味着任何事情都可能发生。

你在升级的系统时拉掉了电源线，然后恢复了。可能10次里有9次每一偶问题，但是第10次，你的系统就会崩溃。

你已经被警告。

Signal Events#

当进程接收到信号时触发。信号列表详见 POSIX 标准的 sigaction（2）如 SIGINT、SIGUSR1 等。

监听 SIGINT 信号的示例：

// 设置 'SIGINT' 信号触发事件
process.on('SIGINT', function() {
  console.log('收到 SIGINT 信号。  退出请使用 Ctrl + D ');
});

在大多数终端下，一个发送 SIGINT 信号的简单方法是按下 ctrl + c 。

process.stdout#

一个指向标准输出流(stdout)的 可写的流(Writable Stream)。

举例: console.log 的实现

console.log = function(d) {
  process.stdout.write(d + '\n');
}; 

process.stderr 和 process.stdout 不像 Node 中其他的流(Streams) 那样，他们通常是阻塞式的写入。当其引用指向 普通文件 或者 TTY文件描述符 时他们就是阻塞的（注：TTY 可以理解为终端的一种，可联想 PuTTY，详见百科）。当他们引用指向管道(pipes)时，他们就同其他的流(Streams)一样是非阻塞的。

要检查 Node 是否正在运行一个 TTY上下文 中（注：linux 中没有运行在 tty 下的进程是 守护进程 ），可以用使用 process.stderr、process.stdout 或 process.stdin 的 isTTY 属性：

$ node -p "Boolean(process.stdout.isTTY)"
true
$ node -p "Boolean(process.stdout.isTTY)" | cat
false 

更多信息，请查看 tty 文档。

process.stderr#

一个指向标准错误流(stderr)的 可写的流(Writable Stream)。

process.stderr 和 process.stdout 不像 Node 中其他的流(Streams) 那样，他们通常是阻塞式的写入。当其引用指向 普通文件 或者 TTY文件描述符 时他们就是阻塞的（注：TTY 可以理解为终端的一种，可联想 PuTTY，详见百科）。当他们引用指向管道(pipes)时，他们就同其他的流(Streams)一样是非阻塞的。

process.stdin#

一个指向 标准输入流(stdin) 的可读流(Readable Stream)。标准输入流默认是暂停 (pause) 的，所以必须要调用 process.stdin.resume() 来恢复 (resume) 接收。

打开标准输入流，并监听两个事件的示例：

process.stdin.on('end', function() {
  process.stdout.write('end');
});


// gets 函数的简单实现
function gets(cb){
  process.stdin.resume();
  process.stdin.setEncoding('utf8');

  process.stdin.on('data', function(chunk) {
     process.stdin.pause();
     cb(chunk);
  });
}

gets(function(reuslt){
  console.log("["+reuslt+"]");
});

process.argv#

一个包含命令行参数的数组。第一个元素会是 'node'， 第二个元素将是 .Js 文件的名称。接下来的元素依次是命令行传入的参数。

// 打印 process.argv
process.argv.forEach(function(val, index, array) {
  console.log(index + ': ' + val);
});

输出将会是：

$ node process-2.js one two=three four
0: node
1: /Users/mjr/work/node/process-2.js
2: one
3: two=three
4: four 

process.execPath#

开启当前进程的这个可执行文件的绝对路径。

实例：

/usr/local/bin/node 

process.execArgv#

与 process.argv 类似，不过是用于保存 node特殊(node-specific) 的命令行选项（参数）。这些特殊的选项不会出现在 process.argv 中，而且 process.execArgv 不会保存 process.argv 中保存的参数（如 0:node 1:文件名 2.3.4.参数 等）， 所有文件名之后的参数都会被忽视。这些选项可以用于派生与与父进程相同执行环境的子进程。

实例：

$ node --harmony script.js --version 

process.execArgv 中的特殊选项:

['--harmony'] 

process.argv 接收到的参数:

['/usr/local/bin/node', 'script.js', '--version'] 

process.abort()#

这将导致 Node 触发一个abort事件，这会导致Node退出并且创建一个核心文件。

process.chdir(directory)#

改变进程的当前进程的工作目录，若操作失败则抛出异常。

console.log('当前目录：' + process.cwd());
try {
  process.chdir('/tmp');
  console.log('新目录：' + process.cwd());
}
catch (err) {
  console.log('chdir: ' + err);
}

process.cwd()#

返回进程当前的工作目录。

console.log('当前目录：' + process.cwd());

process.env#

一个包括用户环境的对象。详细参见 environ(7)。

process.exit([code])#

终止当前进程并返回给定的 code。如果省略了 code，退出是会默认返回成功的状态码('success' code) 也就是 0。

退出并返回失败的状态 ('failure' code):

process.exit(1); 

执行上述代码，用来执行 node 的 shell 就能收到值为 1 的 exit code

process.exitCode#

当进程既正常退出，或者通过未指定 code 的 process.exit() 退出时，这个属性中所存储的数字将会成为进程退出的错误码 (exit code)。

如果指名了 process.exit(code) 中退出的错误码 (code)，则会覆盖掉 process.exitCode 的设置。

process.getgid()#

注意： 该函数仅适用于遵循 POSIX 标准的系统平台如 Unix、Linux等 而 Windows、 Android 等则不适用。

获取进程的群组标识（详见getgid(2)）。获取到的是群组的数字ID，不是群组名称。

if (process.getgid) {
  console.log('当前 gid: ' + process.getgid());
}

process.setgid(id)#

注意： 该函数仅适用于遵循 POSIX 标准的系统平台如 Unix、Linux等 而 Windows、 Android 等则不适用。

设置进程的群组标识（详见getgid(2)）。参数可以是一个数字ID或者群组名字符串。如果指定了一个群组名，这个方法会阻塞等待将群组名解析为数字ID。

if (process.getgid && process.setgid) {
  console.log('当前 gid: ' + process.getgid());
  try {
    process.setgid(501);
    console.log('新 gid: ' + process.getgid());
  }
  catch (err) {
    console.log('设置 gid 失败: ' + err);
  }
}

process.getuid()#

注意： 该函数仅适用于遵循 POSIX 标准的系统平台如 Unix、Linux等 而 Windows、 Android 等则不适用。

获取执行进程的用户ID（详见getgid(2)）。这是用户的数字ID，不是用户名。

if (process.getuid) {
  console.log('当前 uid: ' + process.getuid());
}

process.setuid(id)#

注意： 该函数仅适用于遵循 POSIX 标准的系统平台如 Unix、Linux等 而 Windows、 Android 等则不适用。

设置执行进程的用户ID（详见getgid(2)）。参数可以使一个数字ID或者用户名字符串。如果指定了一个用户名，那么该方法会阻塞等待将用户名解析为数字ID。

if (process.getuid && process.setuid) {
  console.log('当前 uid: ' + process.getuid());
  try {
    process.setuid(501);
    console.log('新 uid: ' + process.getuid());
  }
  catch (err) {
    console.log('设置 uid 失败: ' + err);
  }
}

process.getgroups()#

注意： 该函数仅适用于遵循 POSIX 标准的系统平台如 Unix、Linux等 而 Windows、 Android 等则不适用。

返回一个保存补充组ID(supplementary group ID)的数组。POSIX 标准没有指名 如果有效组 ID（effective group ID）被包括在内的情况，而在 node.js 中则确保它始终是。（POSIX leaves it unspecified if the effective group ID is included but node.js ensures it always is. ）

process.setgroups(groups)#

注意： 该函数仅适用于遵循 POSIX 标准的系统平台如 Unix、Linux等 而 Windows、 Android 等则不适用。

设置补充分组的ID标识. 这是一个特殊的操作, 意味着你必须拥有root或者CAP_SETGID权限才可以。（译者：CAP_SETGID表示设定程序允许普通用户使用setgid函数,这与文件的setgid权限位无关）

这个列表可以包括分组的ID表示，或分组名或两者都有。

process.initgroups(user, extra_group)#

注意： 该函数仅适用于遵循 POSIX 标准的系统平台如 Unix、Linux等 而 Windows、 Android 等则不适用。

读取 /etc/group 并且初始化group分组访问列表，使用改成员所在的所有分组， 这是一个特殊的操作, 意味着你必须拥有root或者CAP_SETGID权限才可以。

user 是一个用户名或者用户ID. extra_group是分组的组名或者分组ID。

有时候，当你在注销权限 (dropping privileges) 的时候需要注意。例如：

console.log(process.getgroups());         // [ 0 ]
process.initgroups('bnoordhuis', 1000);   // switch user
console.log(process.getgroups());         // [ 27, 30, 46, 1000, 0 ]
process.setgid(1000);                     // drop root gid
console.log(process.getgroups());         // [ 27, 30, 46, 1000 ]

process.version#

一个暴露编译时存储版本信息的内置变量 NODE_VERSION 的属性。

console.log('版本: ' + process.version);

process.versions#

一个暴露存储 node 以及其依赖包 版本信息的属性。

console.log(process.versions); 

输出：

{ http_parser: '1.0',
  node: '0.10.4',
  v8: '3.14.5.8',
  ares: '1.9.0-DEV',
  uv: '0.10.3',
  zlib: '1.2.3',
  modules: '11',
  openssl: '1.0.1e' }

process.config#

一个包含用来编译当前 node.exe 的配置选项的对象。内容与运行 ./configure 脚本生成的 "config.gypi" 文件相同。

最可能的输出示例如下：

{ target_defaults:
   { cflags: [],
     default_configuration: 'Release',
     defines: [],
     include_dirs: [],
     libraries: [] },
  variables:
   { host_arch: 'x64',
     node_install_npm: 'true',
     node_prefix: '',
     node_shared_cares: 'false',
     node_shared_http_parser: 'false',
     node_shared_libuv: 'false',
     node_shared_v8: 'false',
     node_shared_zlib: 'false',
     node_use_dtrace: 'false',
     node_use_openssl: 'true',
     node_shared_openssl: 'false',
     strict_aliasing: 'true',
     target_arch: 'x64',
     v8_use_snapshot: 'true' } }

process.kill(pid, [signal])#

向进程发送一个信号。 pid 是进程的 id 而 signal 则是描述信号的字符串名称。信号的名称都形似 'SIGINT' 或者 'SIGUSR1'。如果没有指定参数则会默认发送 'SIGTERM' 信号，更多信息请查看 kill(2) 。

值得注意的是，这个函数的名称虽然是 process.kill， 但就像 kill 系统调用（详见《Unix高级编程》）一样，它仅仅只是一个信号发送器。而信号的发送不仅仅只是用来杀死（kill）目标进程。

向当前进程发送信号的示例：

process.kill(process.pid, 'SIGHUP'); 

process.pid#

当前进程的 PID

console.log('当前进程 id: ' + process.pid);

process.title#

获取/设置 (Getter/setter) 'ps' 中显示的进程名。

当设置该属性时，所能设置的字符串最大长度视具体平台而定，如果超过的话会自动截断。

在 Linux 和 OS X 上，它受限于名称的字节长度加上命令行参数的长度，因为它有覆盖参数内存(argv memory)。

v0.8 版本允许更长的进程标题字符串，也支持覆盖环境内存，但是存在潜在的不安全和混乱（很难说清楚）。

process.arch#

返回当前 CPU 处理器的架构：'arm'、'ia32' 或者 'x64'.

console.log('当前CPU架构是：' + process.arch);

process.platform#

返回当前程序运行的平台：'darwin', 'freebsd', 'linux', 'sunos' 或者 'win32'

console.log('当前系统平台是： ' + process.platform);

process.memoryUsage()#

返回一个对象，它描述了Node进程的内存使用情况单位是bytes。

console.log(util.inspect(process.memoryUsage())); 

输出将会是：

{ rss: 4935680,
  heapTotal: 1826816,
  heapUsed: 650472 } 

heapTotal 和 heapUsed 是根据 V8引擎的内存使用情况来的

process.nextTick(callback)#

• callback {Function}

在事件循环的下一次循环中调用 callback 回调函数。

这 不是 setTimeout(fn, 0) 函数的一个简单别名，因为它的效率高多了。该函数能在任何 I/O 事前之前调用我们的回调函数。但是这个函数在层次超过某个限制的时候，也会出现瑕疵，详细见 process.maxTickDepth。

console.log('开始');
process.nextTick(function() {
  console.log('nextTick 回调');
});
console.log('已设定');
// 输出:
// 开始
// 已设定
// nextTick 回调

如果你想要在【对象创建】之后而【I/O 操作】发生之前执行某些操作，那么这个函数对你而言就十分重要了。

// thing.startDoingStuff() 现在被调用了, 而不是之前.

【注意！！】保证你的函数一定是同步执行或者一定是异步执行，这非常重要！！参考如下的例子：

  fs.stat('file', cb);
} 

这样执行是很危险。如果你还不清楚上述行为的危害请看下面的例子：

maybeSync(true, function() {
  foo();
});
bar(); 

那么，使用刚才那个不知道是同步还是异步的操作，在编程的时候你就会发现，你不能确定到底是 foo() 先执行，还是 bar() 先执行。

用下面的方法就可以更好的解决：

  fs.stat('file', cb);
} 

注意：nextTick 的队列会在完全执行完毕之后才调用 I/O 操作 (the nextTick queue is completely drained on each pass of the event loop before additional I/O is processed.) 。因此，递归设置 nextTick 的回调就像一个 while(true) ; 循环一样，将会阻止任何 I/O 操作的发生。

process.umask([mask])#

设置或者读取进程的文件模式的创建掩码。子进程从父进程中继承这个掩码。如果设定了参数 mask 那么返回旧的掩码，否则返回当前的掩码。

oldmask = process.umask(newmask);
console.log('原掩码: ' + oldmask.toString(8) + '\n'
            '新掩码: ' + newmask.toString(8));

process.uptime()#

返回 Node 程序已运行的秒数。

process.hrtime()#

返回当前的高分辨时间，形式为 [秒，纳秒] 的元组数组。它是相对于在过去的任意时间。该值与日期无关，因此不受时钟漂移的影响。主要用途是可以通过精确的时间间隔，来衡量程序的性能。

你可以将前一个 process.hrtime() 的结果传递给当前的 process.hrtime() 函数，结果会返回一个比较值，用于基准和衡量时间间隔。

  console.log('基准相差 %d 纳秒', diff[0] * 1e9 + diff[1]);
  // 基准相差 1000000527 纳秒
}, 1000);

utils#

稳定度: 4 - 冻结

如果你想使用模块 'util'中已定义的方法. 只需 require('util') 即可使用.

util模块设计的主要目的是为了满足Node内部API的需求 。这个模块中的很多方法在你编写Node程序的时候都是很有帮助的。如果你觉得提供的这些方法满足不了你的需求，那么我们鼓励你编写自己的实用工具方法。我们 不希望util模块中添加任何对于Node的内部功能非必要的扩展。

util.debuglog(section)#

• section {String} 被调试的程序节点部分
• 返回值: {Function} 日志处理函数

这个方法是在存在NODE_DEBUG环境变量的基础上，创建一个有条件写到stderr里的函数。如果“节点”的名字出现在这个环境变量里,那么就返回一个功能类似于console.error()的函数.如果不是,那么返回一个空函数.

例如：

var bar = 123; debuglog('hello from foo [%d]', bar);

<!-- endsection -->

<!-- section:841c12a486aeca12985eeae2d550044e -->

如果这个程序以`NODE_DEBUG=foo` 的环境运行，那么它将会输出：

<!-- endsection -->

<!-- section:cefee92825ed4220569779223fcc49f3 -->

    FOO 3245: hello from foo [123]

<!-- endsection -->

<!-- section:17ef1e93428ebec32b98fa8fe18e7807 -->

`3245`是进程的ID, 如果程序不以刚才那样设置的环境变量运行，那么将不会输出任何东西。

<!-- endsection -->

<!-- section:fb8af07a0bc0e884ec481501fb9ee17d -->

多个`NODE_DEBUG`环境变量,你可以用逗号进行分割。例如，`NODE_DEBUG= fs, net, tls`。

<!-- endsection -->

<!-- section:1785afa5e0b057aea818cd8bc131248a -->

## util.format(format, [...])

<!-- endsection -->

<!-- section:91ee7971cb6dbe7c7841d5c0357a625a -->

根据第一个参数，返回一个格式化字符串，类似`printf`的格式化输出。

<!-- endsection -->

<!-- section:eed068a3508e3b9cc687607e97338b9f -->

第一个参数是一个字符串，包含零个或多个*占位符*。
每一个占位符被替换为与其对应的转换后的值。
支持的占位符有:

<!-- endsection -->

<!-- section:da9b014604572a67a757e892ddd36dd3 -->

* `%s` - 字符串.
* `%d` - 数字 (整型和浮点型).
* `%j` - JSON. 如果这个参数包含循环对象的引用，将会被替换成字符串 `'[Circular]'`。
* `%%` - 单独一个百分号(`'%'`)。不会消耗一个参数。

<!-- endsection -->

<!-- section:c2996cb0cabc702cd8d2bf9d2410599b -->

如果占位符没有相对应的参数，占位符将不会被替换。

<!-- endsection -->

<!-- section:8b6a9f474a82c2495887bf9fe6602308 -->

    util.format('%s:%s', 'foo'); // 'foo:%s'

<!-- endsection -->

<!-- section:1e95291ba804f022549694a216ac10c6 -->

如果有多个参数占位符，额外的参数将会调用`util.inspect()`转换为字符串。这些字符串被连接在一起，并且以空格分隔。

<!-- endsection -->

<!-- section:ba9ecf5f8b441a986c81bee295e7f5f6 -->

    util.format('%s:%s', 'foo', 'bar', 'baz'); // 'foo:bar baz'

<!-- endsection -->

<!-- section:f34f71da627ffc546bb170512e2ffa99 -->

如果第一个参数是一个非格式化字符串，那么`util.format()`将会把所有的参数转成字符串，以空格隔开，拼接在一块，并返回该字符串。`util.inspect()`会把每个参数都转成一个字符串。

<!-- endsection -->

<!-- section:25dcc02c2222a4275231d90579c8598e -->

    util.format(1, 2, 3); // '1 2 3'

<!-- endsection -->

<!-- section:f695fcc4f18f5c6e339ccce4e3389dcf -->

## util.log(string)

<!-- endsection -->

<!-- section:726d139874d57d83bf5da6c193940e4d -->

在控制台进行输出，并带有时间戳。

<!-- endsection -->

<!-- section:ba5cd1d0dee4eb1d7de5808ac9c816b8 -->

    示例：require('util').log('Timestamped message.');

<!-- endsection -->

<!-- section:49290ff385e98b889e7199f35d8fdd82 -->

## util.inspect(object, [options])

<!-- endsection -->

<!-- section:1109f4d3eef77037e85144a6ac35edb4 -->

返回一个对象的字符串表现形式, 在代码调试的时候非常有用.

<!-- endsection -->

<!-- section:258dc184e5a4c8130e86a263acb47331 -->

可以通过加入一些可选选项，来改变对象的格式化输出形式：

<!-- endsection -->

<!-- section:e8f8d3d45f5ea0449c8466bcc7d1aef5 -->

 - `showHidden` - 如果设为 `true`，那么该对象的不可枚举的属性将会被显示出来。默认为`false`.

<!-- endsection -->

<!-- section:961283759790f15496ef9cfd71e80da0 -->

 - `depth` - 告诉 `inspect` 格式化对象的时候递归多少次。这个选项在格式化复杂对象的时候比较有用。 默认为
   `2`。如果想无穷递归下去，则赋值为`null`即可。

<!-- endsection -->

<!-- section:87002282463d3e4ae824462785cdb97f -->

 - `colors` - 如果设为`true`，将会以`ANSI`颜色代码风格进行输出.
   默认是`false`。颜色是可定制的，请看下面：

<!-- endsection -->

<!-- section:e58f864e5d78935059b0d82a0de99ac5 -->

 - `customInspect` - 如果设为 `false`，那么定义在被检查对象上的`inspect(depth, opts)` 方法将不会被调用。 默认为`true`。

<!-- endsection -->

<!-- section:ba2e5c5a48d29e5af4a12604012adbed -->

示例：检查`util`对象上的所有属性

<!-- endsection -->

<!-- section:b18c78721710be6505a368795090fa2a -->

    console.log(util.inspect(util, { showHidden: true, depth: null }));

<!-- endsection -->

<!-- section:861c779d7e06e5793e09df841bcb961e -->

当被调用的时候，参数值可以提供自己的自定义`inspect(depth, opts)`方法。该方法会接收当前的递归检查深度，以及传入`util.inspect()`的其他参数。

<!-- endsection -->

<!-- section:4a6133be34b7ea241e0ca2c1f1352b67 -->

### 自定义 `util.inspect` 颜色

<!-- endsection -->

<!-- type=misc -->

<!-- section:e67331593b47e5b33c512bdb1b0ff48a -->

`util.inspect`彩色输出(如果启用的话) ，可以通过`util.inspect.styles` 和 `util.inspect.colors` 来全局定义。

<!-- endsection -->

<!-- section:a54599adbca30a4d73b7f925966c5603 -->

`util.inspect.styles`是通过`util.inspect.colors`分配给每个风格颜色的一个映射。
高亮风格和它们的默认值:
 * `number` (黄色)
 * `boolean` (黄色)
 * `string` (绿色)
 * `date` (洋红色)
 * `regexp` (红色)
 * `null` (粗体)
 * `undefined` (灰色)
 * `special` - 在这个时候的唯一方法 (青绿色)
 * `name` (无风格)

<!-- endsection -->

<!-- section:3ee112e8f48b058b8ad29568e75ef607 -->

预定义的颜色代码: `white`, `grey`, `black`, `blue`, `cyan`, 
`green`, `magenta`, `red` 和 `yellow`。
还有 `bold`, `italic`, `underline` 和 `inverse` 代码。

<!-- endsection -->

<!-- section:440be6fb8aa71354fef5dea7fc96943d -->

### 自定义对象的`inspect()`方法

<!-- endsection -->

<!-- type=misc -->

<!-- section:3e669407dab4df9d4b8bb939bd6a2ae8 -->

对象可以定义自己的 `inspect(depth)`方法；当使用`util.inspect()`检查该对象的时候，将会执行对象自定义的检查方法。

<!-- endsection -->

<!-- section:2f67cef2dc14fcc47a091e9b18eda982 -->

    util.inspect(obj);
      // "{nate}"

<!-- endsection -->

<!-- section:53e8daad6eb7817fc7dd12eec07bcb31 -->

您也可以返回完全不同的另一个对象，而且返回的字符串将被根据返回的对象格式化。它和`JSON.stringify()`工作原理类似:

<!-- endsection -->

<!-- section:237e76b838a128a2faf99212684fa8b9 -->

    util.inspect(obj);
      // "{ bar: 'baz' }"

<!-- endsection -->

<!-- section:f7540c4eb10d670a568d050db1ea2bb5 -->

## util.isArray(object)

<!-- endsection -->

<!-- section:ea6ec473af78d910796c4ff2f4beba6d -->

如果给定的对象是`数组`类型，就返回`true`，否则返回`false`

<!-- endsection -->

<!-- section:d54b11adadfb753c5dc492ca11c2be6c -->

    util.isArray([])
      // true
    util.isArray(new Array)
      // true
    util.isArray({})
      // false

<!-- endsection -->

<!-- section:d93077c7b296f1169872fefca84c9be9 -->

## util.isRegExp(object)

<!-- endsection -->

<!-- section:4e189cb02b2cbad06d09d47e35f806cb -->

如果给定的对象是`RegExp`类型，就返回`true`，否则返回`false`。

<!-- endsection -->

<!-- section:8d9463d7c3b441728cdaee8c6995c91e -->

    util.isRegExp(/some regexp/)
      // true
    util.isRegExp(new RegExp('another regexp'))
      // true
    util.isRegExp({})
      // false

<!-- endsection -->

<!-- section:931161fabda5cc5e34b8b244fa3a1739 -->

## util.isDate(object)

<!-- endsection -->

<!-- section:0e10fe8824ec08d1a4604ec484b4ee75 -->

如果给定的对象是`Date`类型，就返回`true`，否则返回`false`。

<!-- endsection -->

<!-- section:a18b5ed95ee84e4dd2f4f0edce689916 -->

    util.isDate(new Date())
      // true
    util.isDate(Date())
      // false (没有关键字 'new' 返回一个字符串)
    util.isDate({})
      // false

<!-- endsection -->

<!-- section:8d36aedca50abcc1df1990d2e2bee19a -->

## util.isError(object)

<!-- endsection -->

<!-- section:4e7d0ccda0f08bf4e2499e2529303237 -->

如果给定的对象是`Error`类型，就返回`true`，否则返回`false`。

<!-- endsection -->

<!-- section:e2ac9e8dc03345e5cb9a55f6a9d340f3 -->

    util.isError(new Error())
      // true
    util.isError(new TypeError())
      // true
    util.isError({ name: 'Error', message: 'an error occurred' })
      // false

<!-- endsection -->

<!-- section:81fdd6c58be9d08b05ff8f7756b39195 -->

## util.inherits(constructor, superConstructor)

<!-- endsection -->

<!-- section:4477c32b0656b2610fd0d5967137862f -->

通过[构造函数](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object/constructor)，继承原型对象上的方法。构造函数的`原型`将被设置为一个新的
从`超类`创建的对象。

<!-- endsection -->

<!-- section:d27d3ddf50111db4f9c6bf7796b6c7cd -->

你可以很方便的通过 `constructor.super_`来访问到`superConstructor` 

<!-- endsection -->

<!-- section:bb768700b523e98319d92c95c8f3c055 -->

    stream.on("data", function(data) {
        console.log('Received data: "' + data + '"');
    })
    stream.write("It works!"); // 输出结果：Received data: "It works!"

<!-- endsection -->

<!-- section:a3f76941a46977219d729ec32e53c169 -->

## util.debug(string)

<!-- endsection -->

<!-- section:082abafa227eefa4d2d293287dde4ffc -->

    稳定度: 0 - 已过时: 请使用 console.error() 代替

<!-- endsection -->

<!-- section:70aa4fdc0ad82574f81cea79a9524c49 -->

`console.error`的已过时的前身

<!-- endsection -->

<!-- section:107d1fd1ab87080f18dfba53fe1973d0 -->

## util.error([...])

<!-- endsection -->

<!-- section:8470c9173b3022a3aaa5c99b573d1213 -->

    稳定度: 0 - 已过时: 请使用 console.error() 代替

<!-- endsection -->

<!-- section:70aa4fdc0ad82574f81cea79a9524c49 -->

`console.error`的已过时的前身

<!-- endsection -->

<!-- section:14669ebe2f4fa3a034d5c8324b84ba0e -->

## util.puts([...])

<!-- endsection -->

<!-- section:292d0ba9e4d38fca3ad39db7b0576fc4 -->

   稳定度: 0 - 已过时: 请使用 console.log() 代替

<!-- endsection -->

<!-- section:fc6c6925ce3665fbb2e48ca90bb64632 -->

`console.log`的已过时的前身

<!-- endsection -->

<!-- section:65a5b8c03e11e172f9755a1f81e3a745 -->

## util.print([...])

<!-- endsection -->

<!-- section:34d7799b56a10685b5e6afa53049eb41 -->

   稳定度: 0 - 已过时: 请使用 console.log() 代替

<!-- endsection -->

<!-- section:fc6c6925ce3665fbb2e48ca90bb64632 -->

`console.log`的已过时的前身

<!-- endsection -->

<!-- section:11c756a231f455e357545d47573db5aa -->

## util.pump(readableStream, writableStream, [callback])

<!-- endsection -->

<!-- section:697b95943d8e32d1b3c8126d4c2464d3 -->

   稳定度: 0 - 已过时: 请使用readableStream.pipe(writableStream)代替

<!-- endsection -->

<!-- section:d10aa97ce6544f151e627e28f34da150 -->

`stream.pipe()`的已过时的前身


<!-- endsection -->
<!-- section:50067abc5ffa11c9b47cc886357867f3 -->

# 事件 (Events)

<!-- endsection -->

<!-- section:050a2049458b1f3dbf3e3f111adcfb22 -->

    稳定度: 4 - 冻结

<!-- endsection -->

<!--type=module-->

<!-- section:7f7a3ddc542d9af4dc52c2424c9b3372 -->

Node里面的许多对象都会分发事件：一个`net.Server`对象会在每次有新连接时分发一个事件， 一个`fs.readStream`对象会在文件被打开的时候发出一个事件。
所有这些产生事件的对象都是 `events.EventEmitter` 的实例。
你可以通过`require("events");`来访问该模块

<!-- endsection -->

<!-- section:6d51594acab94889caec68537bcbda17 -->

通常，事件名是驼峰命名 (camel-cased) 的字符串。不过也没有强制的要求，任何字符串都是可以使用的。

<!-- endsection -->

<!-- section:e4b58d5a58cc1f95ee6e57ac0c291aab -->

为了处理发出的事件，我们将函数 (Function) 关联到对象上。
我们把这些函数称为 _监听器 (listeners)_。
在监听函数中 `this` 指向当前监听函数所关联的 `EventEmitter` 对象。

<!-- endsection -->

<!-- section:2b8a6e164096f811fa8bf664e7e472c7 -->

## 类: events.EventEmitter

<!-- endsection -->

<!-- section:e645ea46cb2c41306cbe95cedc37e779 -->

通过 `require('events').EventEmitter` 获取 EventEmitter 类。

<!-- endsection -->

<!-- section:2055e28a1e68af4b8eccb472c83c9405 -->

当 `EventEmitter` 实例遇到错误，通常的处理方法是产生一个 `'error'` 事件，node 对错误事件做特殊处理。
如果程序没有监听错误事件，程序会按照默认行为在打印出 栈追踪信息 (stack trace) 后退出。

<!-- endsection -->

<!-- section:ed8b0d43e3f5764e2e59d882b03e9455 -->

EventEmitter 会在添加 listener 时触发 `'newListener'` 事件，删除 listener 时触发 `'removeListener'` 事件

<!-- endsection -->

<!-- section:913dcf12a24c31ab548b614f25f45423 -->

### emitter.addListener(event, listener)
### emitter.on(event, listener)

<!-- endsection -->

<!-- section:a67bc20697622a368255913731414b90 -->

添加一个 listener 至特定事件的 listener 数组尾部。

<!-- endsection -->

<!-- section:19dcc396a5e6e364ee6fdc2ac4d9ce91 -->

    server.on('connection', function (stream) {
      console.log('someone connected!');
    });

<!-- endsection -->

<!-- section:f8a794bb5a470673ac332f06e02697b0 -->

返回 emitter，方便链式调用。

<!-- endsection -->

<!-- section:8337b32ac40477f65b612c80b9ff98f5 -->

### emitter.once(event, listener)

<!-- endsection -->

<!-- section:7bc0510dd38534106967c6989bb37f65 -->

添加一个 **一次性** listener，这个 listener 只会在下一次事件发生时被触发一次，触发完成后就被删除。

<!-- endsection -->

<!-- section:e2ce327df5ffc2bc634f8ad41b64736f -->

    server.once('connection', function (stream) {
      console.log('Ah, we have our first user!');
    });

<!-- endsection -->

<!-- section:f8a794bb5a470673ac332f06e02697b0 -->

返回 emitter，方便链式调用。

<!-- endsection -->

<!-- section:d9f647871d1a7bbb46b69321cfd81c08 -->

### emitter.removeListener(event, listener)

<!-- endsection -->

<!-- section:af2e0a30ab565a277fa00e119ae7822e -->

从一个事件的 listener 数组中删除一个 listener
**注意**：此操作会改变 listener 数组中在当前 listener 后的listener 的位置下标

<!-- endsection -->

<!-- section:990e0558498e767e51f7ea0c0c5cb042 -->

    var callback = function(stream) {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);

<!-- endsection -->

<!-- section:f8a794bb5a470673ac332f06e02697b0 -->

返回 emitter，方便链式调用。

<!-- endsection -->

<!-- section:4d8352cda5b3eb935d3152752ba71c91 -->

### emitter.removeAllListeners([event])

<!-- endsection -->

<!-- section:a339aa62a2f3910e917b30c2a51f60b9 -->

删除所有 listener，或者删除某些事件 (event) 的 listener

<!-- endsection -->

<!-- section:f8a794bb5a470673ac332f06e02697b0 -->

返回 emitter，方便链式调用。

<!-- endsection -->

<!-- section:a36c89f2ca78381d065f3bc64f63c4af -->

### emitter.setMaxListeners(n)

<!-- endsection -->

<!-- section:6144a744b6f9ee4d42048fd453b00cb8 -->

在默认情况下，EventEmitter 会在多于 10 个 listener 监听某个事件的时候出现警告，此限制在寻找内存泄露时非常有用。
显然，也不是所有的 Emitter 事件都要被限制在 10 个 listener 以下，在这种情况下可以使用这个函数来改变这个限制。设置0这样可以没有限制。

<!-- endsection -->

<!-- section:f8a794bb5a470673ac332f06e02697b0 -->

返回 emitter，方便链式调用。

<!-- endsection -->

<!-- section:3cbb5b1cdc26b98048d02ee59e200085 -->

### EventEmitter.defaultMaxListeners

<!-- endsection -->

<!-- section:3f8697f74741fb77dc105c396c369118 -->

`emitter.setMaxListeners(n)` 设置每个 emitter 实例的最大监听数。
这个类属性为 **所有** `EventEmitter` 实例设置最大监听数（对所有已创建的实例和今后创建的实例都将立即生效）。
使用时请注意。

<!-- endsection -->

<!-- section:ade73e4b7792e2b08162712ddbbbf6a6 -->

请注意，`emitter.setMaxListeners(n)` 优先于 `EventEmitter.defaultMaxListeners`。

<!-- endsection -->

<!-- section:ba73b4320fe912daf900d9b75575b092 -->

### emitter.listeners(event)

<!-- endsection -->

<!-- section:f118af568a602d164a3c9bc8abd2f113 -->

返回指定事件的 listener 数组

<!-- endsection -->

<!-- section:b9fc5400d3bf978204af2becda716c84 -->

    server.on('connection', function (stream) {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection'))); // [ [Function] ]

<!-- endsection -->

<!-- section:c7e909a1c6559cf990730664daa95727 -->

### emitter.emit(event, [arg1], [arg2], [...])

<!-- endsection -->

<!-- section:32a896a1670303a11ddf018be68a05b8 -->

使用提供的参数按顺序执行指定事件的 listener

<!-- endsection -->

<!-- section:97f7fcb289631ff8b970f572f5fc23a3 -->

若事件有 listeners 则返回 `true` 否则返回 `false`。

<!-- endsection -->

<!-- section:a6b3da0a0acb015accda9106a1ed5914 -->

### 类方法: EventEmitter.listenerCount(emitter, event)

<!-- endsection -->

<!-- section:f5c8597bec06973f818d385f56871f57 -->

返回指定事件的 listeners 个数

<!-- endsection -->

<!-- section:a7c55b76049b86734b2943f83acc833f -->

### 事件: 'newListener'

<!-- endsection -->

<!-- section:a8e2a4f5abdec4d8a52bacf1dee9f2e7 -->

* `event` {String} 事件名
* `listener` {Function} 事件处理函数

<!-- endsection -->

<!-- section:7815a60313e081a7ba22c61f63437710 -->

在添加 listener 时会发生该事件。
此时无法确定 `listener` 是否在 `emitter.listeners(event)` 返回的列表中。

<!-- endsection -->

<!-- section:689154e61bde2e8fc9df9e19d1139ec6 -->

### 事件: 'removeListener'

<!-- endsection -->

<!-- section:a8e2a4f5abdec4d8a52bacf1dee9f2e7 -->

* `event` {String} 事件名
* `listener` {Function} 事件处理函数

<!-- endsection -->

<!-- section:72d198d24c91e07c4927b53c4b2fa2f5 -->

在移除 listener 时会发生该事件。
此时无法确定 `listener` 是否在 `emitter.listeners(event)` 返回的列表中。


<!-- endsection -->
<!-- section:02cca00571635b304013bb0f1929d602 -->

# 域

<!-- endsection -->

<!-- section:14ae3b8a1560651cf34fa2e5562e7f27 -->

    稳定度: 2 - 不稳定

<!-- endsection -->

<!-- section:4518ebd75856bc13fa183ae778a0f8cf -->

Domains 提供了一种方式，即以一个单一的组的形式来处理多个不同的IO操作。如果任何一个注册到domain的事件触发器或回调触发了一个‘error’事件，或者抛出一个错误，那么domain对象将会被通知到。而不是直接让这个错误的上下文从`process.on（'uncaughtException'）'处理程序中丢失掉，也不会致使程序因为这个错误伴随着错误码立即退出。

<!-- endsection -->

<!-- section:9f7e65c02ceb7847e9d1b089fd9045db -->

## 警告: 不要忽视错误!

<!-- endsection -->

<!-- type=misc -->

<!-- section:0e9443611b77944922566c8d53e84ffb -->

Domain error处理程序不是一个在错误发生时，关闭你的进程的替代品

<!-- endsection -->

<!-- section:d2e33c9dd4cbc57096f58347b126fd5e -->

基于'抛出（throw）'在JavaScript中工作的方式，几乎从来没有任何方式能够在‘不泄露引用，不造成一些其他种类的未定义的脆弱状态’的前提下，安全的“从你离开的地方重新拾起（pick up where you left off）”，

<!-- endsection -->

<!-- section:48116c9b8f54166db432d18a336ea5ed -->

响应一个被抛出错误的最安全方式就是关闭进程。当然，在一个正常的Web服务器中，你可能会有很多活跃的连接。由于其他触发的错误你去突然关闭这些连接是不合理。

<!-- endsection -->

<!-- section:31e72d6174069a5067433645717c9973 -->

更好的方法是发送错误响应给那个触发错误的请求，在保证其他人正常完成工作时，停止监听那个触发错误的人的新请求。

<!-- endsection -->

<!-- section:3bc705aac660bdeab33e0469f620025f -->

在这种方式中，`域`使用伴随着集群模块，由于主过程可以叉新工人时，一个工人发生了一个错误。节点程序规模的多
机，终止代理或服务注册可以注意一下失败，并做出相应的反应。

<!-- endsection -->

<!-- section:697acd8be310c559e6f31ebfef28a638 -->

举例来说，以下就不是一个好想法：

<!-- endsection -->

<!-- section:3b5ceef23f6efb9bf6390967ac13d044 -->

var d = require('domain').create();
d.on('error', function(er) {
  // 这个错误不会导致进程崩溃，但是情况会更糟糕！
  // 虽然我们阻止了进程突然重启动，但是我们已经发生了资源泄露
  // 这种事情的发生会让我们发疯。
  // 不如调用 process.on('uncaughtException')!
  console.log('error, but oh well', er.message);
});
d.run(function() {
  require('http').createServer(function(req, res) {
    handleRequest(req, res);
  }).listen(PORT);
});

通过对域的上下文的使用，以及将我们的程序分隔成多个工作进程的反射，我们可以做出更加恰当的反应和更加安全的处理。

// 好一些的做法！

<!-- endsection -->

<!-- section:1002b470aa3001d212344187000af555 -->

var cluster = require('cluster');
var PORT = +process.env.PORT || 1337;

<!-- endsection -->

<!-- section:2f82bd01f23b2a29fbda6b4d88878ba5 -->

if (cluster.isMaster) {
  // 在工作环境中，你可能会使用到不止一个工作分支
  // 而且可能不会把主干和分支放在同一个文件中
  //
  //你当然可以通过日志进行猜测，并且对你需要防止的DoS攻击等不良行为实施自定义的逻辑
  //
  // 看集群文件的选项
  //
  // 最重要的是主干非常小，增加了我们抵抗以外错误的可能性。

<!-- endsection -->

<!-- section:cb647d887934b4f503df68aec3e5bb82 -->

  cluster.fork();
  cluster.fork();

<!-- endsection -->

<!-- section:73e4dad498a584605744c08e8889acd2 -->

  cluster.on('disconnect', function(worker) {
    console.error('disconnect!');
    cluster.fork();
  });

<!-- endsection -->

<!-- section:1eb9320833f0f4735c2a02437b831763 -->

} else {
  // 工作进程
  //
  // 这是我们出错的地方

<!-- endsection -->

<!-- section:4e5957024feac866ed9559ec321d9348 -->

  var domain = require('domain');

<!-- endsection -->

<!-- section:3eb2409b6e7d143f8eea5a1e547278b1 -->

  //看集群文件对于使用工作进程处理请求的更多细节，它是如何工作的，它的警告等等。

<!-- endsection -->

<!-- section:dd3bdd23463afb9f443cd297ec716fb5 -->

  var server = require('http').createServer(function(req, res) {
    var d = domain.create();
    d.on('error', function(er) {
      console.error('error', er.stack);

<!-- endsection -->

<!-- section:e614fa9e1583991a0d9b352d554182ba -->

    // 因为req和res在这个域存在之前就被创建，
    // 所以我们需要显式添加它们。
    // 详见下面关于显式和隐式绑定的解释。
    d.add(req);
    d.add(res);

<!-- endsection -->

<!-- section:ec427556232abea87deeffa7ae5a5830 -->

    // 现在在域里面运行处理器函数。
    d.run(function() {
      handleRequest(req, res);
    });
  });
  server.listen(PORT);
}

<!-- endsection -->

<!-- section:8792f2c8a87d64cd7a3893d4f03b9c89 -->

    // 这个部分不是很重要。只是一个简单的路由例子。
    // 你会想把你的超级给力的应用逻辑放在这里。
    function handleRequest(req, res) {
      switch(req.url) {
        case '/error':
          // 我们干了一些异步的东西，然后。。。
          setTimeout(function() {
            // 呃。。。
            flerb.bark();
          });
          break;
        default:
          res.end('ok');
      }
    }

对Error(错误)对象的内容添加#

每一次一个Error对象被导向经过一个域，它会添加几个新的字段。

• error.domain 第一个处理这个错误的域。
• error.domainEmitter 用这个错误对象触发'error'事件的事件分发器。
• error.domainBound 回调函数，该回调函数被绑定到域，并且一个错误会作为第一参数传递给这个回调函数。
• error.domainThrown 一个布尔值表明这个错误是否被抛出，分发或者传递给一个绑定的回调函数。

隐式绑定#

如果多个域正在被使用，那么所有的新EventEmitter对象（包括Stream对象，请求，应答等等）会被隐式绑定到它们被创建时的有效域。

而且，被传递到低层事件分发请求的回调函数（例如fs.open，或者其它接受回调函数的函数）会自动绑定到有效域。如果这些回调函数抛出错误，那么这个域会捕捉到这个错误。

为了防止内存的过度使用，Domain对象自己不会作为有效域的子对象被隐式添加到有效域。因为如果这样做的话，会很容易影响到请求和应答对象的正常垃圾回收。

如果你想在一个父Domain对象里嵌套子Domain对象，那么你需要显式地添加它们。

隐式绑定将被抛出的错误和'error'事件导向到Domain对象的error事件，但不会注册到Domain对象上的EventEmitter对象，所以domain.dispose()不会令EventEmitter对象停止运作。隐式绑定只关心被抛出的错误和 'error'事件。

显式绑定#

有时，正在使用的域并不是某个事件分发器所应属的域。又或者，事件分发器在一个域内被创建，但是应该被绑定到另一个域。

例如，对于一个HTTP服务器，可以有一个正在使用的域，但我们可能希望对每一个请求使用一个不同的域。

这可以通过显示绑定来达到。

例如：

serverDomain.run(function() {
  // 服务器在serverDomain的作用域内被创建
  http.createServer(function(req, res) {
    // req和res同样在serverDomain的作用域内被创建
    // 但是，我们想对于每一个请求使用一个不一样的域。
    // 所以我们首先创建一个域，然后将req和res添加到这个域上。
    var reqd = domain.create();
    reqd.add(req);
    reqd.add(res);
    reqd.on('error', function(er) {
      console.error('Error', er, req.url);
      try {
        res.writeHead(500);
        res.end('Error occurred, sorry.');
      } catch (er) {
        console.error('Error sending 500', er, req.url);
      }
    });
  }).listen(1337);    
});
```

domain.create()#

• return: {Domain}

返回一个新的Domain对象。

类: Domain#

Domain类封装了将错误和没有被捕捉的异常导向到有效对象的功能。

Domain是 EventEmitter类的一个子类。监听它的error事件来处理它捕捉到的错误。

domain.run(fn)#

• fn {Function}

在域的上下文里运行提供的函数，隐式地绑定所有该上下文里创建的事件分发器，计时器和低层请求。

这是使用一个域的最基本的方式。

实例：

var d = domain.create();
d.on('error', function(er) {
  console.error('Caught error!', er);
});
d.run(function() {
  process.nextTick(function() {
    setTimeout(function() { // 模拟几个不同的异步的东西
      fs.open('non-existent file', 'r', function(er, fd) {
        if (er) throw er;
        // 继续。。。
      });
    }, 100);
  });
});

在这个例子里， d.on('error') 处理器会被触发，而不是导致程序崩溃。

domain.members#

• {Array}

一个数组，里面的元素是被显式添加到域里的计时器和事件分发器。

domain.add(emitter)#

• emitter {EventEmitter | Timer} 被添加到域里的时间分发器或计时器

显式地将一个分发器添加到域。如果这个分发器调用的任意一个事件处理器抛出一个错误，或是这个分发器分发了一个error事，那么它会被导向到这个域的error事件，就像隐式绑定所做的一样。

这对于从setInterval和setTimeout返回的计时器同样适用。如果这些计时器的回调函数抛出错误，它将会被这个域的error处理器捕捉到。

如果这个Timer或EventEmitter对象已经被绑定到另外一个域，那么它将会从那个域被移除，然后绑定到当前的域。

domain.remove(emitter)#

• emitter {EventEmitter | Timer} 要从域里被移除的分发器或计时器

与domain.add(emitter)函数恰恰相反，这个函数将域处理从指明的分发器里移除。

domain.bind(callback)#

• callback {Function} 回调函数
• return: {Function} 被绑定的函数

返回的函数会是一个对于所提供的回调函数的包装函数。当这个被返回的函数被调用时，所有被抛出的错误都会被导向到这个域的error事件。

例子#

d.on('error', function(er) {
  // 有个地方发生了一个错误。
  // 如果我们现在抛出这个错误，它会让整个程序崩溃
  // 并给出行号和栈信息。
});

domain.intercept(callback)#

• callback {Function} 回调函数
• return: {Function} 被拦截的函数

这个函数与domain.bind(callback)几乎一模一样。但是，除了捕捉被抛出的错误外，它还会拦截作为第一参数被传递到这个函数的Error对象。

在这种方式下，常见的'if(er) return callback(er);'的方式可以被一个单独地方的单独的错误处理所取代。

例子#

d.on('error', function(er) {
  // 有个地方发生了一个错误。
  // 如果我们现在抛出这个错误，它会让整个程序崩溃
  // 并给出行号和栈信息。
});

domain.enter()#

enter函数对于run，bind和intercept来说就像它们的管道系统：它们使用enter函数来设置有效域。enter函数对于域设定了domain.active和 process.domain ，还隐式地将域推入了由域模块管理的域栈（关于域栈的细节详见domain.exit()）。enter函数的调用，分隔了异步调用链以及绑定到一个域的I/O操作的结束或中断。

调用enter仅仅改变活动的域，而不改变域本身。 Enter 和 exit在一个单独的域可以被调用任意多次。

如果域的enter已经设置，enter将不设置域就返回。

domain.exit()#

exit函数退出当前的域，将当前域从域的栈里移除。每当当程序的执行流程准要切换到一个不同的异步调用链的上下文时，要保证退出当前的域。exit函数的调用，分隔了异步调用链以及绑定到一个域的I/O操作的结束或中断。

如果有多个嵌套的域绑定到当前的执行上下文， 退出将退出在这个域里的所有的嵌套。

调用exit只会改变有效域，而不会改变域自身。在一个单一域上，Enter和exit可以被调用任意次。

如果在这个域名下exit 已经被设置，exit 将不退出域返回。

domain.dispose()#

稳定度: 0 - 已过时。请通过设置在域上的错误事件处理器，显式地东失败的IO操作中恢复。

一旦dispose被调用，通过run，bind或intercept绑定到这个域的回调函数将不再使用这个域，并且一个dispose事件会被分发。

Buffer#

稳定度: 3 - 稳定

纯 JavaScript 对 Unicode 友好但是无法很好地处理二进制数据。当我们面对类似 TCP 流或文件系统时，是需要处理八位流的。Node 有几种操作、创建以及消费八位流的策略。

原始数据保存在 Buffer 类的实例中。一个 Buffer 实例类似于一个整数数组，但对应着 V8 堆之外的一个原始内存分配区域。一个 Buffer 的大小不可变。

Buffer 类是一个全局的类，是一个比较罕见的不需要 require('buffer') 就可以使用的类。

在Buffers和JavaScript string转换时，需要明确的一个编码方法。下面是一些不同的string编码。

• 'ascii' - 仅适用 7 bit ASCII 格式数据。这个编码方式非常快速，而且会剥离设置过高的bit。

• 'utf8' - 多字节编码 Unicode字符。很多网页或者其他文档的编码格式都是使用 UTF-8的。

• 'utf16le' - 2 或者 4 字节, Little Endian (LE) 编码Unicode字符。 代理对 (U+10000 to U+10FFFF) 是支持的.（BE和LE表示大端和小端，Little-Endian就是低位字节排放在内存的低地址端，高位字节排放在内存的高地址端；Big-Endian就是高位字节排放在内存的低地址端，低位字节排放在内存的高地址端；下同）

• 'ucs2' - 'utf16le'的别名.

• 'base64' - Base64 字符串编码。

• 'binary' - 一个将原始2进制数据编码为字符串的方法，仅使用每个字符的前8bits。 这个编码方式已经被弃用而且应该被避免，尽可能的使用Buffer对象。这个编码方式将会在未来的Node版本中移除。

• 'hex' - 把每个byte编码成2个十六进制字符

类: Buffer#

Buffer 类是一个全局变量类型，用来直接处理2进制数据的。 它能够使用多种方式构建。

new Buffer(size)#

• size Number

分配一个新的 buffer 大小是 size 的8位字节.

new Buffer(array)#

• array Array

分配一个新的 buffer 使用一个8位字节 array 数组.

new Buffer(str, [encoding])#

• str String类型 - 需要存入buffer的string字符串.
• encoding String类型 - 使用什么编码方式，参数可选.

分配一个新的 buffer ，其中包含着给定的 str字符串. encoding 编码方式默认是：'utf8'.

类方法: Buffer.isEncoding(encoding)#

• encoding {String} 用来测试给定的编码字符串

如果给定的编码 encoding 是有效的，返回 true，否则返回 false。

类方法: Buffer.isBuffer(obj)#

• obj Object
• 返回: Boolean

测试这个 obj 是否是一个 Buffer.

类方法: Buffer.byteLength(string, [encoding])#

• string String类型
• encoding String类型, 可选参数, 默认是: 'utf8'
• Return: Number类型

将会返回这个字符串真实byte长度。 encoding 编码默认是： 'utf8'. 这个和 String.prototype.length 是不一样的，因为那个方法返回这个字符串中有几个字符的数量。 （译者：当用户在写http响应头Cotent-Length的时候，千万记得一定要用 Buffer.byteLength 方法，不要使用 String.prototype.length ）

实例：

// ½ + ¼ = ¾: 9 characters, 12 bytes

类方法: Buffer.concat(list, [totalLength])#

• list {Array}数组类型，Buffer数组，用于被连接。
• totalLength {Number}类型 上述Buffer数组的所有Buffer的总大小。（译者：注意这里的totalLength不是数组长度是数组里Buffer实例的大小总和）

返回一个保存着将传入buffer数组中所有buffer对象拼接在一起的buffer对象。（译者：有点拗口，其实就是将数组中所有的buffer实例通过复制拼接在一起）

如果传入的数组没有内容，或者 totalLength 参数是0，那将返回一个zero-length的buffer。

如果数组中只有一项，那么这第一项就会被返回。

如果数组中的项多于一个，那么一个新的Buffer实例将被创建。

如果 totalLength 参数没有提供，虽然会从buffer数组中计算读取，但是会增加一个额外的循环来计算它，所以提供一个明确的 totalLength 参数将会更快。

buf.length#

• Number类型

这个buffer的bytes大小。注意这未必是这buffer里面内容的大小。length 的依据是buffer对象所分配的内存数值，它不会随着这个buffer对象内容的改变而改变。

// 1234
// 1234

buf.write(string, [offset], [length], [encoding])#

• string String类型 - 将要被写入 buffer 的数据
• offset Number类型, 可选参数, 默认: 0
• length Number类型, 可选参数, 默认: buffer.length - offset
• encoding String类型, 可选参数, 默认: 'utf8'

根据参数 offset 偏移量和指定的encoding编码方式，将参数 string 数据写入buffer。 offset偏移量 默认是 0, encoding编码方式默认是 'utf8'。 length长度是将要写入的字符串的bytes大小。 返回number类型，表示多少8位字节流被写入了。如果buffer 没有足够的空间来放入整个string，它将只会写入部分的字符串。 length 默认是 buffer.length - offset。 这个方法不会出现写入部分字符。

buf = new Buffer(256);
len = buf.write('\u00bd + \u00bc = \u00be', 0);
console.log(len + " bytes: " + buf.toString('utf8', 0, len));

buf.toString([encoding], [start], [end])#

• encoding String类型, 可选参数, 默认: 'utf8'
• start Number类型, 可选参数, 默认: 0
• end Number类型, 可选参数, 默认: buffer.length

根据 encoding参数（默认是 'utf8'）返回一个解码的 string 类型。还会根据传入的参数 start (默认是0) 和 end (默认是 buffer.length)作为取值范围。

查看上面buffer.write() 的例子.

buf.toJSON()#

返回一个 JSON表示的Buffer实例。JSON.stringify将会默认调用来字符串序列化这个Buffer实例。

实例：

console.log(copy);
// <Buffer 74 65 73 74>

buf[index]#

获取或者设置在指定index索引位置的8位字节。这个值是指单个字节，所以这个值必须在合法的范围，16进制的0x00 到0xFF，或者0 到255。

例子: 拷贝一个 ASCII 编码的 string 字符串到一个 buffer, 一次一个 byte 进行拷贝:

// node.js

buf.copy(targetBuffer, [targetStart], [sourceStart], [sourceEnd])#

• targetBuffer Buffer 类型对象 - 将要进行拷贝的Buffer
• targetStart Number类型, 可选参数, 默认: 0
• sourceStart Number类型, 可选参数, 默认: 0
• sourceEnd Number类型, 可选参数, 默认: buffer.length

进行buffer的拷贝，源和目标可以是重叠的。 targetStart 目标开始偏移 和sourceStart源开始偏移 默认都是 0. sourceEnd 源结束位置偏移默认是源的长度 buffer.length.

如果传递的值是undefined/NaN 或者是 out of bounds 超越边界的，就将设置为他们的默认值。（译者：这个默认值下面有的例子有说明）

例子: 创建2个Buffer，然后把将buf1的16位到19位 拷贝到 buf2中，并且从buf2的第8位开始拷贝。

// !!!!!!!!qrst!!!!!!!!!!!!!

buf.slice([start], [end])#

• start Number类型, 可选参数, 默认: 0
• end Number类型, 可选参数, 默认: buffer.length

返回一个新的buffer，这个buffer将会和老的buffer引用相同的内存地址，只是根据 start (默认是 0) 和end (默认是buffer.length) 偏移和裁剪了索引。 负的索引是从buffer尾部开始计算的。

修改这个新的buffer实例slice切片，也会改变原来的buffer

例子: 创建一个ASCII 字母的 Buffer，对它slice切片，然后修改源Buffer上的一个byte。

// abc
// !bc

buf.readUInt8(offset, [noAssert])#

• offset Number类型
• noAssert Boolean类型, 可选参数, 默认: false
• Return: Number类型

从这个buffer对象里，根据指定的偏移量，读取一个 unsigned 8 bit integer整形。

设置参数 noAssert为true表示忽略验证offset偏移量参数。 这意味着 offset可能会超出buffer的末尾。默认是 false。

实例：

// 0x3
// 0x4
// 0x23
// 0x42

buf.readUInt16LE(offset, [noAssert])#

buf.readUInt16BE(offset, [noAssert])#

• offset Number类型
• noAssert Boolean类型, 可选参数, 默认: false
• Return: Number类型

从这个buffer对象里，根据指定的偏移量，使用特殊的 endian字节序格式读取一个 unsigned 16 bit integer。

设置参数 noAssert为true表示忽略验证offset偏移量参数。 这意味着 offset可能会超出buffer的末尾。默认是 false。

实例：

// 0x0304
// 0x0403
// 0x0423
// 0x2304
// 0x2342
// 0x4223

buf.readUInt32LE(offset, [noAssert])#

buf.readUInt32BE(offset, [noAssert])#

• offset Number类型
• noAssert Boolean类型, 可选参数, 默认: false
• Return: Number类型

从这个buffer对象里，根据指定的偏移量，使用指定的 endian字节序格式读取一个 unsigned 32 bit integer。

设置参数 noAssert为true表示忽略验证offset偏移量参数。 这意味着 offset可能会超出buffer的末尾。默认是 false。

实例：

// 0x03042342
// 0x42230403

buf.readInt8(offset, [noAssert])#

• offset Number类型
• noAssert Boolean类型, 可选参数, 默认: false
• Return: Number类型

从这个buffer对象里，根据指定的偏移量，读取一个 signed 8 bit integer。

设置参数 noAssert为true表示忽略验证offset偏移量参数。 这意味着 offset可能会超出buffer的末尾。默认是 false。

和 buffer.readUInt8一样的返回，除非buffer中包含了有作为2的补码的有符号值。

buf.readInt16LE(offset, [noAssert])#

buf.readInt16BE(offset, [noAssert])#

• offset Number类型
• noAssert Boolean类型, 可选参数, 默认: false
• Return: Number类型

从这个buffer对象里，根据指定的偏移量，使用特殊的 endian字节序格式读取一个 signed 16 bit integer。

设置参数 noAssert为true表示忽略验证offset偏移量参数。 这意味着 offset可能会超出buffer的末尾。默认是 false。

和 buffer.readUInt16一样返回，除非buffer中包含了有作为2的补码的有符号值。

buf.readInt32LE(offset, [noAssert])#

buf.readInt32BE(offset, [noAssert])#

• offset Number类型
• noAssert Boolean类型, 可选参数, 默认: false
• Return: Number类型

从这个buffer对象里，根据指定的偏移量，使用指定的 endian字节序格式读取一个 signed 32 bit integer。

设置参数 noAssert为true表示忽略验证offset偏移量参数。 这意味着 offset可能会超出buffer的末尾。默认是 false。

和 buffer.readUInt32一样返回，除非buffer中包含了有作为2的补码的有符号值。

buf.readFloatLE(offset, [noAssert])#

buf.readFloatBE(offset, [noAssert])#

• offset Number类型
• noAssert Boolean类型, 可选参数, 默认: false
• Return: Number类型

从这个buffer对象里，根据指定的偏移量，使用指定的 endian字节序格式读取一个 32 bit float。

设置参数 noAssert为true表示忽略验证offset偏移量参数。 这意味着 offset可能会超出buffer的末尾。默认是 false。

实例：

// 0x01

buf.readDoubleLE(offset, [noAssert])#

buf.readDoubleBE(offset, [noAssert])#

• offset Number类型
• noAssert Boolean类型, 可选参数, 默认: false
• Return: Number类型

从这个buffer对象里，根据指定的偏移量，使用指定的 endian字节序格式读取一个 64 bit double。

设置参数 noAssert为true表示忽略验证offset偏移量参数。 这意味着 offset可能会超出buffer的末尾。默认是 false。

实例：

// 0.3333333333333333

buf.writeUInt8(value, offset, [noAssert])#

• value Number类型
• offset Number类型
• noAssert Boolean类型, 可选参数, 默认: false

根据指定的offset偏移量将value写入buffer。注意：value 必须是一个合法的unsigned 8 bit integer.

设置参数 noAssert为true表示忽略验证value和offset参数。 这意味着 value可能过大，或者offset可能会超出buffer的末尾造成value被丢弃。 这个参数除了你非常有把握，否则不应该使用它。默认是 false。`.

实例：

// <Buffer 03 04 23 42>

buf.writeUInt16LE(value, offset, [noAssert])#

buf.writeUInt16BE(value, offset, [noAssert])#

• value Number类型
• offset Number类型
• noAssert Boolean类型, 可选参数, 默认: false

根据指定的offset偏移量和指定的 endian字节序格式将value写入buffer。注意：value 必须是一个合法的unsigned 16 bit integer.

设置参数 noAssert为true表示忽略验证value和offset参数。 这意味着 value可能过大，或者offset可能会超出buffer的末尾造成value被丢弃。 这个参数除了你非常有把握，否则不应该使用它。默认是 false。`.

实例：

// <Buffer de ad be ef>
// <Buffer ad de ef be>

buf.writeUInt32LE(value, offset, [noAssert])#

buf.writeUInt32BE(value, offset, [noAssert])#

• value Number类型
• offset Number类型
• noAssert Boolean类型, 可选参数, 默认: false

根据指定的offset偏移量和指定的 endian字节序格式将value写入buffer。注意：value 必须是一个合法的unsigned 32 bit integer。

设置参数 noAssert为true表示忽略验证value和offset参数。 这意味着 value可能过大，或者offset可能会超出buffer的末尾造成value被丢弃。 这个参数除了你非常有把握，否则不应该使用它。默认是 false。`.

实例：

// <Buffer fe ed fa ce>
// <Buffer ce fa ed fe>

buf.writeInt8(value, offset, [noAssert])#

• value Number类型
• offset Number类型
• noAssert Boolean类型, 可选参数, 默认: false

根据指定的offset偏移量将value写入buffer。注意：value 必须是一个合法的 signed 8 bit integer。

设置参数 noAssert为true表示忽略验证value和offset参数。 这意味着 value可能过大，或者offset可能会超出buffer的末尾造成value被丢弃。 这个参数除了你非常有把握，否则不应该使用它。默认是 false。`.

和 buffer.writeUInt8 一样工作，除非是把有2的补码的 signed integer 有符号整形写入buffer。

buf.writeInt16LE(value, offset, [noAssert])#

buf.writeInt16BE(value, offset, [noAssert])#

• value Number类型
• offset Number类型
• noAssert Boolean类型, 可选参数, 默认: false

根据指定的offset偏移量和指定的 endian字节序格式将value写入buffer。注意：value 必须是一个合法的 signed 16 bit integer。

设置参数 noAssert为true表示忽略验证value和offset参数。 这意味着 value可能过大，或者offset可能会超出buffer的末尾造成value被丢弃。 这个参数除了你非常有把握，否则不应该使用它。默认是 false。`.

和 buffer.writeUInt16* 一样工作，除非是把有2的补码的 signed integer 有符号整形写入buffer。

buf.writeInt32LE(value, offset, [noAssert])#

buf.writeInt32BE(value, offset, [noAssert])#

• value Number类型
• offset Number类型
• noAssert Boolean类型, 可选参数, 默认: false

根据指定的offset偏移量和指定的 endian字节序格式将value写入buffer。注意：value 必须是一个合法的 signed 32 bit integer。

设置参数 noAssert为true表示忽略验证value和offset参数。 这意味着 value可能过大，或者offset可能会超出buffer的末尾造成value被丢弃。 这个参数除了你非常有把握，否则不应该使用它。默认是 false。`.

和 buffer.writeUInt32* 一样工作，除非是把有2的补码的 signed integer 有符号整形写入buffer。

buf.writeFloatLE(value, offset, [noAssert])#

buf.writeFloatBE(value, offset, [noAssert])#

• value Number类型
• offset Number类型
• noAssert Boolean类型, 可选参数, 默认: false

根据指定的offset偏移量和指定的 endian字节序格式将value写入buffer。注意：当value 不是一个 32 bit float 类型的值时，结果将是不确定的。

设置参数 noAssert为true表示忽略验证value和offset参数。 这意味着 value可能过大，或者offset可能会超出buffer的末尾造成value被丢弃。 这个参数除了你非常有把握，否则不应该使用它。默认是 false。`.

实例：

// <Buffer 4f 4a fe bb>
// <Buffer bb fe 4a 4f>

buf.writeDoubleLE(value, offset, [noAssert])#

buf.writeDoubleBE(value, offset, [noAssert])#

• value Number类型
• offset Number类型
• noAssert Boolean类型, 可选参数, 默认: false

根据指定的offset偏移量和指定的 endian字节序格式将value写入buffer。注意：value 必须是一个有效的 64 bit double 类型的值。

设置参数 noAssert为true表示忽略验证value和offset参数。 这意味着 value可能过大，或者offset可能会超出buffer的末尾造成value被丢弃。 这个参数除了你非常有把握，否则不应该使用它。默认是 false。`.

实例：

// <Buffer 43 eb d5 b7 dd f9 5f d7>
// <Buffer d7 5f f9 dd b7 d5 eb 43>

buf.fill(value, [offset], [end])#

• value
• offset Number类型, 可选参数
• end Number类型, 可选参数

使用指定的value来填充这个buffer。如果 offset (默认是 0) 并且 end (默认是 buffer.length) 没有明确给出，就会填充整个buffer。 （译者：buf.fill调用的是C语言的memset函数非常高效）

var b = new Buffer(50);
b.fill("h");

buffer.INSPECT_MAX_BYTES#

• Number类型, 默认: 50

设置当调用buffer.inspect()方法后，多少bytes将会返回。这个值可以被用户模块重写。 （译者：这个值主要用在当我们打印console.log(buf)时，设置返回多少长度内容）

注意这个属性是require('buffer')模块返回的。这个属性不是在全局变量Buffer中，也不再buffer的实例里。

类: SlowBuffer#

返回一个不被池管理的 Buffer。

为了避免创建大量独立分配的 Buffer 带来的垃圾回收开销，默认情况下小于 4KB 的空间都是切割自一个较大的独立对象。这种策略既提高了性能也改善了内存使用，因为 V8 不需要跟踪和清理很多 Persistent 对象。

当开发者需要将池中一小块数据保留不确定的一段时间，较为妥当的办法是用 SlowBuffer 创建一个不被池管理的 Buffer 实例并将相应数据拷贝出来。

socket.on('readable', function() {
  var data = socket.read();
  // 为需要保留的数据分配内存
  var sb = new SlowBuffer(10);
  // 将数据拷贝到新的空间中
  data.copy(sb, 0, 0, 10);
  store.push(sb);
});

请谨慎使用，仅作为开发者频繁观察到他们的应用中过度的内存保留时的最后手段。

流#

稳定度: 2 - 不稳定

流是一个抽象接口，被 Node 中的很多对象所实现。比如对一个 HTTP 服务器的请求是一个流，stdout 也是一个流。流是可读、可写或兼具两者的。所有流都是 EventEmitter 的实例。

您可以通过 require('stream') 加载 Stream 基类，其中包括了 Readable 流、Writable 流、Duplex 流和 Transform 流的基类。

本文档分为三个章节。第一章节解释了您在您的程序中使用流时需要了解的那部分 API，如果您不打算自己实现一个流式 API，您可以只阅读这一章节。

第二章节解释了当您自己实现一个流时需要用到的那部分 API，这些 API 是为了方便您这么做而设计的。

第三章节深入讲解了流的工作方式，包括一些内部机制和函数，除非您明确知道您在做什么，否则尽量不要改动它们。

面向流消费者的 API#

流可以是可读（Readable）或可写（Writable），或者兼具两者（Duplex，双工）的。

所有流都是 EventEmitter，但它们也具有其它自定义方法和属性，取决于它们是 Readable、Writable 或 Duplex。

如果一个流既可读（Readable）也可写（Writable），则它实现了下文所述的所有方法和事件。因此，这些 API 同时也涵盖了 Duplex 或 Transform 流，即便它们的实现可能有点不同。

为了消费流而在您的程序中自己实现 Stream 接口是没有必要的。如果您确实正在您自己的程序中实现流式接口，请同时参考下文面向流实现者的 API。

几乎所有 Node 程序，无论多简单，都在某种途径用到了流。这里有一个使用流的 Node 程序的例子：

var http = require('http');

<!-- endsection -->

<!-- section:5dd53fb86ef5aa2fb0a6e831e46cc135 -->

var server = http.createServer(function (req, res) {
  // req 为 http.IncomingMessage，是一个可读流（Readable Stream）
  // res 为 http.ServerResponse，是一个可写流（Writable Stream）

<!-- endsection -->

<!-- section:fd5e086becb475ded97300c6e8b1f889 -->

  var body = '';
  // 我们打算以 UTF-8 字符串的形式获取数据
  // 如果您不设置编码，您将得到一个 Buffer 对象
  req.setEncoding('utf8');

<!-- endsection -->

<!-- section:bb5a4bf69e5c71de2331fe85918ed96b -->

  // 一旦监听器被添加，可读流会触发 'data' 事件
  req.on('data', function (chunk) {
    body += chunk;
  })

<!-- endsection -->

<!-- section:5768f3afd395c860ba272f79026a6799 -->

  // 'end' 事件表明您已经得到了完整的 body
  req.on('end', function () {
    try {
      var data = JSON.parse(body);
    } catch (er) {
      // uh oh!  bad json!
      res.statusCode = 400;
      return res.end('错误: ' + er.message);
    }

<!-- endsection -->

<!-- section:812496c72ef4682c63a7ba8837f9610a -->

    // 向用户回写一些有趣的信息
    res.write(typeof data);
    res.end();
  })
})

<!-- endsection -->

<!-- section:3bbc30d951532659ecc70a505ea1e985 -->

server.listen(1337);

<!-- endsection -->

<!-- section:f0dea661693acf21ed203ec804a4f05a -->

// $ curl localhost:1337 -d '{}'
// object
// $ curl localhost:1337 -d '"foo"'
// string
// $ curl localhost:1337 -d 'not json'
// 错误: Unexpected token o

类: stream.Readable#

Readable（可读）流接口是对您正在读取的数据的来源的抽象。换言之，数据出自一个 Readable 流。

在您表明您就绪接收之前，Readable 流并不会开始发生数据。

Readable 流有两种“模式”：流动模式和暂停模式。当处于流动模式时，数据由底层系统读出，并尽可能快地提供给您的程序；当处于暂停模式时，您必须明确地调用 stream.read() 来取出若干数据块。流默认处于暂停模式。

注意：如果没有绑定 data 事件处理器，并且没有 pipe() 目标，同时流被切换到流动模式，那么数据会流失。

您可以通过下面几种做法切换到流动模式：

• 添加一个 'data' 事件处理器来监听数据。
• 调用 resume() 方法来明确开启数据流。
• 调用 pipe() 方法将数据发送到一个 Writable。

您可以通过下面其中一种做法切换回暂停模式：

• 如果没有导流目标，调用 pause() 方法。
• 如果有导流目标，移除所有 ['data' 事件][] 处理器、调用 unpipe() 方法移除所有导流目标。

请注意，为了向后兼容考虑，移除 'data' 事件监听器并不会自动暂停流。同样的，当有导流目标时，调用 pause() 并不能保证流在那些目标排空并请求更多数据时维持暂停状态。

一些可读流的例子：

• 客户端上的 HTTP 响应
• 服务器上的 HTTP 请求
• fs 读取流
• zlib 流
• crypto 流
• TCP 嵌套字
• 子进程的 stdout 和 stderr
• process.stdin

事件: 'readable'#

当一个数据块可以从流中被读出时，它会触发一个 'readable' 事件。

在某些情况下，假如未准备好，监听一个 'readable' 事件会使得一些数据从底层系统被读出到内部缓冲区中。

var readable = getReadableStreamSomehow();
readable.on('readable', function() {
  // 现在有数据可以读了
})

当内部缓冲区被排空后，一旦更多数据时，一个 readable 事件会被再次触发。

事件: 'data'#

• chunk {Buffer | String} 数据块。

绑定一个 data 事件监听器到一个未被明确暂停的流会将流切换到流动模式，数据会被尽可能地传递。

如果您想从流尽快取出所有数据，这是最理想的方式。

var readable = getReadableStreamSomehow();
readable.on('data', function(chunk) {
  console.log('得到了 %d 字节的数据', chunk.length);
})

事件: 'end'#

该事件会在没有更多数据能够提供时被触发。

请注意，end 事件在数据被完全消费之前不会被触发。这可通过切换到流动模式，或者在到达末端前不断调用 read() 来实现。

var readable = getReadableStreamSomehow();
readable.on('data', function(chunk) {
  console.log('得到了 %d 字节的数据', chunk.length);
})
readable.on('end', function() {
  console.log('读取完毕。');
});

事件: 'close'#

当底层数据源（比如，源头的文件描述符）被关闭时触发。并不是所有流都会触发这个事件。

事件: 'error'#

当数据接收时发生错误时触发。

readable.read([size])#

• size {Number} 可选参数，指定要读取多少数据。
• 返回 {String | Buffer | null}

read() 方法从内部缓冲区中拉取并返回若干数据。当没有更多数据可用时，它会返回 null。

若您传入了一个 size 参数，那么它会返回相当字节的数据；当 size 字节不可用时，它则返回 null。

若您没有指定 size 参数，那么它会返回内部缓冲区中的所有数据。

该方法仅应在暂停模式时被调用。在流动模式中，该方法会被自动调用直到内部缓冲区排空。

var readable = getReadableStreamSomehow();
readable.on('readable', function() {
  var chunk;
  while (null !== (chunk = readable.read())) {
    console.log('得到了 %d 字节的数据', chunk.length);
  }
});

当该方法返回了一个数据块，它同时也会触发 'data' 事件。

readable.setEncoding(encoding)#

• encoding {String} 要使用的编码。
• 返回: this

调用此函数会使得流返回指定编码的字符串而不是 Buffer 对象。比如，当您 readable.setEncoding('utf8')，那么输出数据会被作为 UTF-8 数据解析，并以字符串返回。如果您 readable.setEncoding('hex')，那么数据会被编码成十六进制字符串格式。

该方法能正确处理多字节字符。假如您不这么做，仅仅直接取出 Buffer 并对它们调用 buf.toString(encoding)，很可能会导致字节错位。因此如果您打算以字符串读取数据，请总是使用这个方法。

var readable = getReadableStreamSomehow();
readable.setEncoding('utf8');
readable.on('data', function(chunk) {
  assert.equal(typeof chunk, 'string');
  console.log('得到了 %d 个字符的字符串数据', chunk.length);
})

readable.resume()#

• 返回: this

该方法让可读流继续触发 data 事件。

该方法会将流切换到流动模式。如果您不想从流中消费数据，但您想得到它的 end 事件，您可以调用 readable.resume() 来启动数据流。

var readable = getReadableStreamSomehow();
readable.resume();
readable.on('end', function(chunk) {
  console.log('到达末端，但并未读取任何东西');
})

readable.pause()#

• 返回: this

该方法会使一个处于流动模式的流停止触发 data 事件，切换到非流动模式，并让后续可用数据留在内部缓冲区中。

var readable = getReadableStreamSomehow();
readable.on('data', function(chunk) {
  console.log('取得 %d 字节数据', chunk.length);
  readable.pause();
  console.log('接下来 1 秒内不会有数据');
  setTimeout(function() {
    console.log('现在数据会再次开始流动');
    readable.resume();
  }, 1000);
})

readable.pipe(destination, [options])#

• destination {Writable Stream} 写入数据的目标
• options {Object} 导流选项
  • end {Boolean} 在读取者结束时结束写入者。缺省为 true

该方法从可读流中拉取所有数据，并写入到所提供的目标。该方法能自动控制流量以避免目标被快速读取的可读流所淹没。

可以导流到多个目标。

var readable = getReadableStreamSomehow();
var writable = fs.createWriteStream('file.txt');
// 所有来自 readable 的数据会被写入到 'file.txt'
readable.pipe(writable);

该函数返回目标流，因此您可以建立导流链：

var r = fs.createReadStream('file.txt');
var z = zlib.createGzip();
var w = fs.createWriteStream('file.txt.gz');
r.pipe(z).pipe(w);

例如，模拟 Unix 的 cat 命令：

process.stdin.pipe(process.stdout);

缺省情况下当来源流触发 end 时目标的 end() 会被调用，所以此时 destination 不再可写。传入 { end: false } 作为 options 可以让目标流保持开启状态。

这将让 writer 保持开启，因此最后可以写入 "Goodbye"。

reader.pipe(writer, { end: false });
reader.on('end', function() {
  writer.end('Goodbye\n');
});

请注意 process.stderr 和 process.stdout 在进程结束前都不会被关闭，无论是否指定选项。

readable.unpipe([destination])#

• destination {Writable Stream} 可选，指定解除导流的流

该方法会移除之前调用 pipe() 所设定的钩子。

如果不指定目标，所有导流都会被移除。

如果指定了目标，但并没有与之建立导流，则什么事都不会发生。

var readable = getReadableStreamSomehow();
var writable = fs.createWriteStream('file.txt');
// 来自 readable 的所有数据都会被写入 'file.txt',
// 但仅发生在第 1 秒
readable.pipe(writable);
setTimeout(function() {
  console.log('停止写入到 file.txt');
  readable.unpipe(writable);
  console.log('自行关闭文件流');
  writable.end();
}, 1000);

readable.unshift(chunk)#

• chunk {Buffer | String} 要插回读取队列开头的数据块

该方法在许多场景中都很有用，比如一个流正在被一个解析器消费，解析器可能需要将某些刚拉取出的数据“逆消费”回来源，以便流能将它传递给其它消费者。

如果您发现您需要在您的程序中频繁调用 stream.unshift(chunk)，请考虑实现一个 Transform 流。（详见下文面向流实现者的 API。）

// 取出以 \n\n 分割的头部并将多余部分 unshift() 回去
// callback 以 (error, header, stream) 形式调用
var StringDecoder = require('string_decoder').StringDecoder;
function parseHeader(stream, callback) {
  stream.on('error', callback);
  stream.on('readable', onReadable);
  var decoder = new StringDecoder('utf8');
  var header = '';
  function onReadable() {
    var chunk;
    while (null !== (chunk = stream.read())) {
      var str = decoder.write(chunk);
      if (str.match(/\n\n/)) {
        // 找到头部边界
        var split = str.split(/\n\n/);
        header += split.shift();
        var remaining = split.join('\n\n');
        var buf = new Buffer(remaining, 'utf8');
        if (buf.length)
          stream.unshift(buf);
        stream.removeListener('error', callback);
        stream.removeListener('readable', onReadable);
        // 现在可以从流中读取消息的主体了
        callback(null, header, stream);
      } else {
        // 仍在读取头部
        header += str;
      }
    }
  }
}

readable.wrap(stream)#

• stream {Stream} 一个“旧式”可读流

Node v0.10 版本之前的流并未实现现今所有流 API。（更多信息详见下文“兼容性”章节。）

如果您正在使用早前版本的 Node 库，它触发 'data' 事件并且有一个仅作查询用途的 pause() 方法，那么您可以使用 wrap() 方法来创建一个使用旧式流作为数据源的 Readable 流。

您可能很少需要用到这个函数，但它会作为与旧 Node 程序和库交互的简便方法存在。

例如：

myReader.on('readable', function() {
myReader.read(); // etc.
});

类: stream.Writable#

Writable（可写）流接口是对您正在写入数据至一个目标的抽象。

一些可写流的例子：

• http requests, on the client
• http responses, on the server
• fs write streams
• zlib streams
• crypto streams
• tcp sockets
• child process stdin
• process.stdout, process.stderr

writable.write(chunk, [encoding], [callback])#

• chunk {String | Buffer} 要写入的数据
• encoding {String} 编码，假如 chunk 是一个字符串
• callback {Function} 数据块写入后的回调
• 返回: {Boolean} 如果数据已被全部处理则 true。

该方法向底层系统写入数据，并在数据被处理完毕后调用所给的回调。

返回值表明您是否应该立即继续写入。如果数据需要滞留在内部，则它会返回 false；否则，返回 true。

返回值所表示的状态仅供参考，您【可以】在即便返回 false 的时候继续写入。但是，写入的数据会被滞留在内存中，所以最好不要过分地这么做。最好的做法是等待 drain 事件发生后再继续写入更多数据。

事件: 'drain'#

如果一个 writable.write(chunk) 调用返回 false，那么 drain 事件则表明可以继续向流写入更多数据。

// 向所给可写流写入 1000000 次数据。
// 注意后端压力。
function writeOneMillionTimes(writer, data, encoding, callback) {
  var i = 1000000;
  write();
  function write() {
    var ok = true;
    do {
      i -= 1;
      if (i === 0) {
        // 最后一次！
        writer.write(data, encoding, callback);
      } else {
        // 检查我们应该继续还是等待
        // 不要传递回调，因为我们还没完成。
        ok = writer.write(data, encoding);
      }
    } while (i > 0 && ok);
    if (i > 0) {
      // 不得不提前停止！
      // 一旦它排空，继续写入数据
      writer.once('drain', write);
    }
  }
}

writable.cork()#

强行滞留所有写入。

滞留的数据会在 .uncork() 或 .end() 调用时被写入。

writable.uncork()#

写入所有 .cork() 调用之后滞留的数据。

writable.end([chunk], [encoding], [callback])#

• chunk {String | Buffer} 可选，要写入的数据
• encoding {String} 编码，假如 chunk 是一个字符串
• callback {Function} 可选，流结束后的回调

当没有更多数据会被写入到流时调用此方法。如果给出，回调会被用作 finish 事件的监听器。

在调用 end() 后调用 write() 会产生错误。

// 写入 'hello, ' 然后以 'world!' 结束
http.createServer(function (req, res) {
  res.write('hello, ');
  res.end('world!');
  // 现在不允许继续写入了
});

事件: 'finish'#

当 end() 方法被调用，并且所有数据已被写入到底层系统，此事件会被触发。

var writer = getWritableStreamSomehow();
for (var i = 0; i < 100; i ++) {
  writer.write('hello, #' + i + '!\n');
}
writer.end('this is the end\n');
write.on('finish', function() {
  console.error('已完成所有写入。');
});

事件: 'pipe'#

• src {Readable Stream} 导流到本可写流的来源流

该事件发生于可读流的 pipe() 方法被调用并添加本可写流作为它的目标时。

var writer = getWritableStreamSomehow();
var reader = getReadableStreamSomehow();
writer.on('pipe', function(src) {
  console.error('某些东西正被导流到 writer');
  assert.equal(src, reader);
});
reader.pipe(writer);

事件: 'unpipe'#

• src {Readable Stream} unpiped 本可写流的来源流

该事件发生于可读流的 unpipe() 方法被调用并将本可写流从它的目标移除时。

var writer = getWritableStreamSomehow();
var reader = getReadableStreamSomehow();
writer.on('unpipe', function(src) {
  console.error('某写东西停止导流到 writer 了');
  assert.equal(src, reader);
});
reader.pipe(writer);
reader.unpipe(writer);

类: stream.Duplex#

双工（Duplex）流同时实现了 Readable 和 Writable 的接口。详见下文用例。

一些双工流的例子：

• TCP 嵌套字
• zlib 流
• crypto 流

类: stream.Transform#

转换（Transform）流是一种输出由输入计算所得的双工流。它们同时实现了 Readable 和 Writable 的接口。详见下文用例。

一些转换流的例子：

• zlib 流
• crypto 流

面向流实现者的 API#

无论实现任何形式的流，模式都是一样的：

1. 在您的子类中扩充适合的父类。（util.inherits 方法对此很有帮助。）
2. 在您的构造函数中调用父类的构造函数，以确保内部的机制被正确初始化。
3. 实现一个或多个特定的方法，参见下面的细节。

所扩充的类和要实现的方法取决于您要编写的流类的形式：

在您的实现代码中，十分重要的一点是绝对不要调用上文面向流消费者的 API 中所描述的方法，否则可能在消费您的流接口的程序中产生潜在的副作用。

类: stream.Readable#

stream.Readable 是一个可被扩充的、实现了底层方法 _read(size) 的抽象类。

请阅读前文面向流消费者的 API 章节了解如何在您的程序中消费流。文将解释如何在您的程序中自己实现 Readable 流。

例子: 一个计数流#

这是一个 Readable 流的基本例子。它将从 1 至 1,000,000 递增地触发数字，然后结束。

var Readable = require('stream').Readable;
var util = require('util');
util.inherits(Counter, Readable);

<!-- endsection -->

<!-- section:82b9ddf426e8c00c9a49e4152bdc17fa -->

function Counter(opt) {
  Readable.call(this, opt);
  this._max = 1000000;
  this._index = 1;
}

<!-- endsection -->

<!-- section:e0793f568ad1ff897e49e65b3ddff560 -->

Counter.prototype._read = function() {
  var i = this._index++;
  if (i > this._max)
    this.push(null);
  else {
    var str = '' + i;
    var buf = new Buffer(str, 'ascii');
    this.push(buf);
  }
};

例子: SimpleProtocol v1 (Sub-optimal)#

这个有点类似上文提到的 parseHeader 函数，但它被实现成一个自定义流。同样地，请注意这个实现并未将传入数据转换成字符串。

实际上，更好的办法是将它实现成一个 Transform 流。更好的实现详见下文。

// 简易数据协议的解析器。
// “header”是一个 JSON 对象，后面紧跟 2 个 \n 字符，以及
// 消息主体。
//
// 注意: 使用 Transform 流能更简单地实现这个功能！
// 直接使用 Readable 并不是最佳方式，详见 Transform
// 章节下的备选例子。

<!-- endsection -->

<!-- section:92b91fe4ba0943c599f1f6f05063281e -->

var Readable = require('stream').Readable;
var util = require('util');

<!-- endsection -->

<!-- section:e1dc23787e59139adcb6395217f4e3e5 -->

util.inherits(SimpleProtocol, Readable);

<!-- endsection -->

<!-- section:4d29aabd4a753ef32e5c07b5a795e855 -->

function SimpleProtocol(source, options) {
  if (!(this instanceof SimpleProtocol))
    return new SimpleProtocol(options);

<!-- endsection -->

<!-- section:71fff3ee938970a8129dae873d7bafb9 -->

  Readable.call(this, options);
  this._inBody = false;
  this._sawFirstCr = false;

<!-- endsection -->

<!-- section:799ee1f184ce83a81a18b06859ce3631 -->

  // source 是一个可读流，比如嵌套字或文件
  this._source = source;

<!-- endsection -->

<!-- section:82425d2c242c810d12229bc70dce5926 -->

  var self = this;
  source.on('end', function() {
    self.push(null);
  });

<!-- endsection -->

<!-- section:2a58126aa0311fb2147d855905f037f8 -->

  // 当 source 可读时做点什么
  // read(0) 不会消费任何字节
  source.on('readable', function() {
    self.read(0);
  });

<!-- endsection -->

<!-- section:97e4325ee1de1bff19f7360c6127de91 -->

  this._rawHeader = [];
  this.header = null;
}

<!-- endsection -->

<!-- section:d944bcef0e5bd7b58955e7c2e7640ca3 -->

SimpleProtocol.prototype._read = function(n) {
  if (!this._inBody) {
    var chunk = this._source.read();

<!-- endsection -->

<!-- section:7dd79fb9f97bbd18362b6ed55be8bb79 -->

    if (split === -1) {
      // 继续等待 \n\n
      // 暂存数据块，并再次尝试
      this._rawHeader.push(chunk);
      this.push('');
    } else {
      this._inBody = true;
      var h = chunk.slice(0, split);
      this._rawHeader.push(h);
      var header = Buffer.concat(this._rawHeader).toString();
      try {
        this.header = JSON.parse(header);
      } catch (er) {
        this.emit('error', new Error('invalid simple protocol data'));
        return;
      }
      // 现在，我们得到了一些多余的数据，所以需要 unshift
      // 将多余的数据放回读取队列以便我们的消费者能够读取
      var b = chunk.slice(split);
      this.unshift(b);

<!-- endsection -->

<!-- section:9cc80d286b7ec752e3ae5fb819e63392 -->

      // 并让它们知道我们完成了头部解析。
      this.emit('header', this.header);
    }
  } else {
    // 从现在开始，仅需向我们的消费者提供数据。
    // 注意不要 push(null)，因为它表明 EOF。
    var chunk = this._source.read();
    if (chunk) this.push(chunk);
  }
};

<!-- endsection -->

<!-- section:ab30c3ee01c1cd6af24cd93ee043216f -->

// 用法:
// var parser = new SimpleProtocol(source);
// 现在 parser 是一个会触发 'header' 事件并提供已解析
// 的头部的可读流。

new stream.Readable([options])#

• options {Object}
  • highWaterMark {Number} 停止从底层资源读取前内部缓冲区最多能存放的字节数。缺省为 16kb，对于 objectMode 流则是 16
  • encoding {String} 若给出，则 Buffer 会被解码成所给编码的字符串。缺省为 null
  • objectMode {Boolean} 该流是否应该表现为对象的流。意思是说 stream.read(n) 返回一个单独的对象，而不是大小为 n 的 Buffer

请确保在扩充 Readable 类的类中调用 Readable 构造函数以便缓冲设定能被正确初始化。

readable._read(size)#

• size {Number} 异步读取的字节数

注意：实现这个函数，但【不要】直接调用它。

这个函数【不应该】被直接调用。它应该被子类所实现，并仅被 Readable 类内部方法所调用。

所有 Readable 流的实现都必须提供一个 _read 方法来从底层资源抓取数据。

该方法以下划线开头是因为它对于定义它的类是内部的，并且不应该被用户程序直接调用。但是，你应当在您的扩充类中覆盖这个方法。

当数据可用时，调用 readable.push(chunk) 将它加入到读取队列。如果 push 返回 false，那么您应该停止读取。当 _read 被再次调用，您应该继续推出更多数据。

参数 size 仅作查询。“read”调用返回数据的实现可以通过这个参数来知道应当抓取多少数据；其余与之无关的实现，比如 TCP 或 TLS，则可忽略这个参数，并在可用时返回数据。例如，没有必要“等到” size 个字节可用时才调用 stream.push(chunk)。

readable.push(chunk, [encoding])#

• chunk {Buffer | null | String} 推入读取队列的数据块
• encoding {String} 字符串块的编码。必须是有效的 Buffer 编码，比如 utf8 或 ascii
• 返回 {Boolean} 是否应该继续推入

注意：这个函数应该被 Readable 实现者调用，【而不是】Readable 流的消费者。

函数 _read() 不会被再次调用，直到至少调用了一次 push(chunk)。

Readable 类的工作方式是，将数据读入一个队列，当 'readable' 事件发生、调用 read() 方法时，数据会被从队列中取出。

push() 方法会明确地向读取队列中插入一些数据。如果调用它时传入了 null 参数，那么它会触发数据结束信号（EOF）。

这个 API 被设计成尽可能地灵活。比如说，您可以包装一个低级别的具备某种暂停/恢复机制和数据回调的数据源。这种情况下，您可以通过这种方式包装低级别来源对象：

// source 是一个带 readStop() 和 readStart() 方法的类，
// 以及一个当有数据时会被调用的 `ondata` 成员、一个
// 当数据结束时会被调用的 `onend` 成员。

<!-- endsection -->

<!-- section:95e3ecd4260c781a6024a021bc68e57e -->

util.inherits(SourceWrapper, Readable);

<!-- endsection -->

<!-- section:6007ea5475e96279c2e93631f4336467 -->

function SourceWrapper(options) {
  Readable.call(this, options);

<!-- endsection -->

<!-- section:da7e608bbd3803cd4c5f822ebe9be93c -->

  this._source = getLowlevelSourceObject();
  var self = this;

<!-- endsection -->

<!-- section:2cf3dadadeb5f48299a1121bf6a40a8b -->

  // 每当有数据时，我们将它推入到内部缓冲区中
  this._source.ondata = function(chunk) {
    // 如果 push() 返回 false，我们就需要暂停读取 source
    if (!self.push(chunk))
      self._source.readStop();
  };

<!-- endsection -->

<!-- section:4d599b75f53a964c3f5d0db3a9ad12b0 -->

  // 当来源结束时，我们 push 一个 `null` 块以表示 EOF
  this._source.onend = function() {
    self.push(null);
  };
}

<!-- endsection -->

<!-- section:dab6a1aaf2a7fa07f84f58bfbd3f8a61 -->

// _read 会在流想要拉取更多数据时被调用
// 本例中忽略 size 参数
SourceWrapper.prototype._read = function(size) {
  this._source.readStart();
};

类: stream.Writable#

stream.Writable 是一个可被扩充的、实现了底层方法 _write(chunk, encoding, callback) 的抽象类。

请阅读前文面向流消费者的 API 章节了解如何在您的程序中消费可读流。下文将解释如何在您的程序中自己实现 Writable 流。

new stream.Writable([options])#

• options {Object}
  • highWaterMark {Number} write() 开始返回 false 的缓冲级别。缺省为 16kb，对于 objectMode 流则是 16
  • decodeStrings {Boolean} 是否在传递给 _write() 前将字符串解码成 Buffer。缺省为 true

请确保在扩充 Writable 类的类中调用构造函数以便缓冲设定能被正确初始化。

writable._write(chunk, encoding, callback)#

• chunk {Buffer | String} 要被写入的数据块。总会是一个 Buffer，除非 decodeStrings 选项被设定为 false。
• encoding {String} 如果数据块是字符串，则这里指定它的编码类型。如果数据块是 Buffer 则忽略此设定。请注意数据块总会是一个 Buffer，除非 decodeStrings 选项被明确设定为 false。
• callback {Function} 当您处理完所给数据块时调用此函数（可选地可附上一个错误参数）。

所有 Writable 流的实现必须提供一个 _write() 方法来将数据发送到底层资源。

注意：该函数【禁止】被直接调用。它应该被子类所实现，并仅被 Writable 内部方法所调用。

使用标准的 callback(error) 形式来调用回调以表明写入成功完成或遇到错误。

如果构造函数选项中设定了 decodeStrings 标志，则 chunk 可能会是字符串而不是 Buffer，并且 encoding 表明了字符串的格式。这种设计是为了支持对某些字符串数据编码提供优化处理的实现。如果您没有明确地将 decodeStrings 选项设定为 false，那么您可以安全地忽略 encoding 参数，并假定 chunk 总是一个 Buffer。

该方法以下划线开头是因为它对于定义它的类是内部的，并且不应该被用户程序直接调用。但是，你应当在您的扩充类中覆盖这个方法。

writable._writev(chunks, callback)#

• chunks {Array} 要写入的块。每个块都遵循这种格式：{ chunk: ..., encoding: ... }。
• callback {Function} 当您处理完所给数据块时调用此函数（可选地可附上一个错误参数）。

注意：该函数【禁止】被直接调用。它应该被子类所实现，并仅被 Writable 内部方法所调用。

该函数的实现完全是可选的，在大多数情况下都是不必要的。如果实现，它会被以所有滞留在写入队列中的数据块调用。

类: stream.Duplex#

“双工”（duplex）流同时兼具可读和可写特性，比如一个 TCP 嵌套字连接。

值得注意的是，stream.Duplex 是一个可以像 Readable 或 Writable 一样被扩充、实现了底层方法 _read(sise) 和 _write(chunk, encoding, callback) 的抽象类。

由于 JavaScript 并不具备多原型继承能力，这个类实际上继承自 Readable，并寄生自 Writable，从而让用户在双工类的扩充中能同时实现低级别的 _read(n) 方法和 _write(chunk, encoding, callback) 方法。

new stream.Duplex(options)#

• options {Object} Passed to both Writable and Readable constructors. Also has the following fields:
  • allowHalfOpen {Boolean} Default=true. If set to false, then the stream will automatically end the readable side when the writable side ends and vice versa.

请确保在扩充 Duplex 类的类中调用构造函数以便缓冲设定能被正确初始化。

类: stream.Transform#

“转换”（transform）流实际上是一个输出与输入存在因果关系的双工流，比如 zlib 流或 crypto 流。

输入和输出并无要求相同大小、相同块数或同时到达。举个例子，一个 Hash 流只会在输入结束时产生一个数据块的输出；一个 zlib 流会产生比输入小得多或大得多的输出。

转换类必须实现 _transform() 方法，而不是 _read() 和 _write() 方法。可选的，也可以实现 _flush() 方法。（详见下文。）

new stream.Transform([options])#

• options {Object} 传递给 Writable 和 Readable 构造函数。

请确保在扩充 Transform 类的类中调用了构造函数，以使得缓冲设定能被正确初始化。

transform._transform(chunk, encoding, callback)#

• chunk {Buffer | String} 要被转换的数据块。总是 Buffer，除非 decodeStrings 选项被设定为 false。
• encoding {String} 如果数据块是一个字符串，那么这就是它的编码类型。（数据块是 Buffer 则会忽略此参数。）
• callback {Function} 当您处理完所提供的数据块时调用此函数（可选地附上一个错误参数）。

注意：该函数【禁止】被直接调用。它应该被子类所实现，并仅被 Transform 内部方法所调用。

所有转换流的实现都必须提供一个 _transform 方法来接受输入并产生输出。

_transform 应当承担特定 Transform 类中所有处理被写入的字节、并将它们丢给接口的可写端的职责，进行异步 I/O，处理其它事情等等。

调用 transform.push(outputChunk) 0 或多次来从输入块生成输出，取决于您想从这个数据块输出多少数据。

仅当当前数据块被完全消费时调用回调函数。注意，任何特定的输入块都有可能或可能不会产生输出。

该方法以下划线开头是因为它对于定义它的类是内部的，并且不应该被用户程序直接调用。但是，你应当在您的扩充类中覆盖这个方法。

transform._flush(callback)#

• callback {Function} 当您写入完毕剩下的数据后调用此函数（可选地可附上一个错误对象）。

注意：该函数【禁止】被直接调用。它【可以】被子类所实现，并且如果实现，仅被 Transform 内部方法所调用。

在一些情景中，您的转换操作可能需要在流的末尾多发生一点点数据。例如，一个 Zlib 压缩流会储存一些内部状态以便更好地压缩输出，但在最后它需要尽可能好地处理剩下的东西以使数据完整。

在这种情况中，您可以实现一个 _flush 方法，它会在最后被调用，在所有写入数据被消费、但在触发 end 表示可读端到达末尾之前。和 _transform 一样，只需在写入操作完成时适当地调用 transform.push(chunk) 零或多次。

该方法以下划线开头是因为它对于定义它的类是内部的，并且不应该被用户程序直接调用。但是，你应当在您的扩充类中覆盖这个方法。

例子: SimpleProtocol 解析器 v2#

上文的简易协议解析器例子能够很简单地使用高级别 Transform 流类实现，类似于前文 parseHeader 和 SimpleProtocal v1 示例。

在这个示例中，输入会被导流到解析器中，而不是作为参数提供。这种做法更符合 Node 流的惯例。

var util = require('util');
var Transform = require('stream').Transform;
util.inherits(SimpleProtocol, Transform);

<!-- endsection -->

<!-- section:22418c0818055544bb6f8097f23bfeff -->

function SimpleProtocol(options) {
  if (!(this instanceof SimpleProtocol))
    return new SimpleProtocol(options);

<!-- endsection -->

<!-- section:d3b6e2613e286e415707007520ea9c3b -->

  Transform.call(this, options);
  this._inBody = false;
  this._sawFirstCr = false;
  this._rawHeader = [];
  this.header = null;
}

<!-- endsection -->

<!-- section:e0759f379211c5242519301000ad97b4 -->

SimpleProtocol.prototype._transform = function(chunk, encoding, done) {
  if (!this._inBody) {
    // 检查数据块是否有 \n\n
    var split = -1;
    for (var i = 0; i < chunk.length; i++) {
      if (chunk[i] === 10) { // '\n'
        if (this._sawFirstCr) {
          split = i;
          break;
        } else {
          this._sawFirstCr = true;
        }
      } else {
        this._sawFirstCr = false;
      }
    }

<!-- endsection -->

<!-- section:e97904f9981d2c5c074f860e23f24a1a -->

    if (split === -1) {
      // 仍旧等待 \n\n
      // 暂存数据块并重试。
      this._rawHeader.push(chunk);
    } else {
      this._inBody = true;
      var h = chunk.slice(0, split);
      this._rawHeader.push(h);
      var header = Buffer.concat(this._rawHeader).toString();
      try {
        this.header = JSON.parse(header);
      } catch (er) {
        this.emit('error', new Error('invalid simple protocol data'));
        return;
      }
      // 并让它们知道我们完成了头部解析。
      this.emit('header', this.header);

<!-- endsection -->

<!-- section:31bb3371c6edccf470ad2539a443e5a3 -->

      // 现在，由于我们获得了一些额外的数据，先触发这个。
      this.push(chunk.slice(split));
    }
  } else {
    // 之后，仅需向我们的消费者原样提供数据。
    this.push(chunk);
  }
  done();
};

<!-- endsection -->

<!-- section:49fb3d6151e897882f69ee67a4f301b4 -->

// 用法:
// var parser = new SimpleProtocol();
// source.pipe(parser)
// 现在 parser 是一个会触发 'header' 并带上解析后的
// 头部数据的可读流。

类: stream.PassThrough#

这是 Transform 流的一个简单实现，将输入的字节简单地传递给输出。它的主要用途是演示和测试，但偶尔要构建某种特殊流的时候也能派上用场。

流：内部细节#

缓冲#

无论 Writable 或 Readable 流都会在内部分别叫做 _writableState.buffer 和 _readableState.buffer 的对象中缓冲数据。

被缓冲的数据量取决于传递给构造函数的 highWaterMark（最高水位线）选项。

Readable 流的滞留发生于当实现调用 stream.push(chunk) 的时候。如果流的消费者没有调用 stream.read()，那么数据将会一直待在内部队列，直到它被消费。

Writable 流的滞留发生于当用户重复调用 stream.write(chunk) 即便此时 write() 返回 false 时。

流，尤其是 pipe() 方法的初衷，是将数据的滞留量限制到一个可接受的水平，以使得不同速度的来源和目标不会淹没可用内存。

stream.read(0)#

在某写情景中，您可能需要触发底层可读流机制的刷新，但不真正消费任何数据。在这中情况下，您可以调用 stream.read(0)，它总会返回 null。

如果内部读取缓冲低于 highWaterMark 水位线，并且流当前不在读取状态，那么调用 read(0) 会触发一个低级 _read 调用。

虽然几乎没有必要这么做，但您可以在 Node 内部的某些地方看到它确实这么做了，尤其是在 Readable 流类的内部。

stream.push('')#

推入一个零字节字符串或 Buffer（当不在 对象模式 时）有一个有趣的副作用。因为它是一个对 stream.push() 的调用，它会结束 reading 进程。然而，它没有添加任何数据到可读缓冲中，所以没有东西可以被用户消费。

在极少数情况下，您当时没有数据提供，但您的流的消费者（或您的代码的其它部分）会通过调用 stream.read(0) 得知何时再次检查。在这中情况下，您可以调用 stream.push('')。

到目前为止，这个功能唯一一个使用情景是在 tls.CryptoStream 类中，但它将在 Node v0.12 中被废弃。如果您发现您不得不使用 stream.push('')，请考虑另一种方式，因为几乎可以明确表明这是某种可怕的错误。

与 Node 早期版本的兼容性#

在 v0.10 之前版本的 Node 中，Readable 流的接口较为简单，同时功能和实用性也较弱。

• 'data' 事件会开始立即开始发生，而不会等待您调用 read() 方法。如果您需要进行某些 I/O 来决定如何处理数据，那么您只能将数据块储存到某种缓冲区中以防它们流失。
• pause() 方法仅起提议作用，而不保证生效。这意味着，即便当流处于暂停状态时，您仍然需要准备接收 'data' 事件。

在 Node v0.10 中，下文所述的 Readable 类被加入进来。为了向后兼容考虑，Readable 流会在添加了 'data' 事件监听器、或 resume() 方法被调用时切换至“流动模式”。其作用是，即便您不使用新的 read() 方法和 'readable' 事件，您也不必担心丢失 'data' 数据块。

大多数程序会维持正常功能，然而，这也会在下列条件下引入一种边界情况：

• 没有添加 'data' 事件处理器。
• resume() 方法从未被调用。
• 流未被导流到任何可写目标。

举个例子，请留意下面代码：

// 警告！不能用！
net.createServer(function(socket) {

<!-- endsection -->

<!-- section:08da922ddfb188b15f60f9d8d2751a66 -->

  // 我们添加了一个 'end' 事件，但从未消费数据
  socket.on('end', function() {
    // 它永远不会到达这里
    socket.end('我收到了您的来信（但我没看它）\n');
  });

<!-- endsection -->

<!-- section:15718ac0ffde3852abd2837cb5ffce33 -->

}).listen(1337);

在 Node v0.10 之前的版本中，传入消息数据会被简单地丢弃。然而在 Node v0.10 及之后，socket 会一直保持暂停。

对于这种情形的妥协方式是调用 resume() 方法来开启数据流：

// 妥协
net.createServer(function(socket) {

<!-- endsection -->

<!-- section:818557d4b3cecb62fa0a224bac43a894 -->

  socket.on('end', function() {
    socket.end('我收到了您的来信（但我没看它）\n');
  });

<!-- endsection -->

<!-- section:d3a1f09536e7ab650311327cd3264147 -->

  // 开启数据流，并丢弃它们。
  socket.resume();

<!-- endsection -->

<!-- section:15718ac0ffde3852abd2837cb5ffce33 -->

}).listen(1337);

额外的，对于切换到流动模式的新 Readable 流，v0.10 之前风格的流可以通过 wrap() 方法被包装成 Readable 类。

对象模式#

通常情况下，流只操作字符串和 Buffer。

处于对象模式的流除了 Buffer 和字符串外还能读出普通的 JavaScript 值。

一个处于对象模式的 Readable 流调用 stream.read(size) 时总会返回单个项目，无论传入什么 size 参数。

一个处于对象模式的 Writable 流总是会忽略传给 stream.write(data, encoding) 的 encoding 参数。

特殊值 null 在对象模式流中依旧保持它的特殊性。也就说，对于对象模式的可读流，stream.read() 返回 null 意味着没有更多数据，同时 stream.push(null) 会告知流数据到达末端（EOF）。

Node 核心不存在对象模式的流，这种设计只被某些用户态流式库所使用。

您应该在您的流子类构造函数的选项对象中设置 objectMode。在流的过程中设置 objectMode 是不安全的。

状态对象#

Readable 流有一个成员对象叫作 _readableState。 Writable 流有一个成员对象叫作 _writableState。 Duplex 流二者兼备。

这些对象通常不应该被子类所更改。然而，如果您有一个 Duplex 或 Transform 流，它的可读端应该是 objectMode，但可写端却又不是 objectMode，那么您可以在构造函数里明确地设定合适的状态对象的标记来达到此目的。

var util = require('util');
var StringDecoder = require('string_decoder').StringDecoder;
var Transform = require('stream').Transform;
util.inherits(JSONParseStream, Transform);

<!-- endsection -->

<!-- section:7123a6445c6afaf75360315f05cd5634 -->

// 获取以 \n 分隔的 JSON 字符串数据，并丢出解析后的对象
function JSONParseStream(options) {
  if (!(this instanceof JSONParseStream))
    return new JSONParseStream(options);

<!-- endsection -->

<!-- section:1ee7fdeecca2f4145faa196231702628 -->

  Transform.call(this, options);
  this._writableState.objectMode = false;
  this._readableState.objectMode = true;
  this._buffer = '';
  this._decoder = new StringDecoder('utf8');
}

<!-- endsection -->

<!-- section:e80bef7f89055305490b77af751dbaea -->

JSONParseStream.prototype._transform = function(chunk, encoding, cb) {
  this._buffer += this._decoder.write(chunk);
  // 以新行分割
  var lines = this._buffer.split(/\r?\n/);
  // 保留最后一行被缓冲
  this._buffer = lines.pop();
  for (var l = 0; l < lines.length; l++) {
    var line = lines[l];
    try {
      var obj = JSON.parse(line);
    } catch (er) {
      this.emit('error', er);
      return;
    }
    // 推出解析后的对象到可读消费者
    this.push(obj);
  }
  cb();
};

<!-- endsection -->

<!-- section:5327c37bec579bd884e1991cfe0d5226 -->

JSONParseStream.prototype._flush = function(cb) {
  // 仅仅处理剩下的东西
  var rem = this._buffer.trim();
  if (rem) {
    try {
      var obj = JSON.parse(rem);
    } catch (er) {
      this.emit('error', er);
      return;
    }
    // 推出解析后的对象到可读消费者
    this.push(obj);
  }
  cb();
};

状态对象包含了其它调试您的程序的流的状态时有用的信息。读取它们是可以的，但越过构造函数的选项来更改它们是不安全的。

加密（Crypto）#

稳定度: 2 - 不稳定；正在讨论未来版本的API变动。会尽量减少重大变动的发生。详见下文。

使用 require('crypto') 来调用该模块。

crypto模块提供在HTTPS或HTTP连接中封装安全凭证的方法.

它提供OpenSSL中的一系列哈希方法，包括hmac、cipher、decipher、签名和验证等方法的封装。

crypto.getCiphers()#

返回一个数组，包含支持的加密算法的名字。

实例：

var ciphers = crypto.getCiphers();
console.log(ciphers); // ['AES-128-CBC', 'AES-128-CBC-HMAC-SHA1', ...]

crypto.getHashes()#

返回一个包含所支持的哈希算法的数组。

实例：

var hashes = crypto.getHashes();
console.log(hashes); // ['sha', 'sha1', 'sha1WithRSAEncryption', ...]

crypto.createCredentials(details)#

创建一个加密凭证对象，接受一个可选的参数对象：

• pfx : 一个字符串或者buffer对象，代表经PFX或者PKCS12编码产生的私钥、证书以及CA证书
• key : 一个字符串，代表经PEM编码产生的私钥
• passphrase : 私钥或者pfx的密码
• cert : 一个字符串，代表经PEM编码产生的证书
• ca : 一个字符串或者字符串数组，表示可信任的经PEM编码产生的CA证书列表
• crl : 一个字符串或者字符串数组，表示经PEM编码产生的CRL（证书吊销列表 Certificate Revocation List）
• ciphers: 一个字符串，表示需要使用或者排除的加密算法 可以在 http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT 查看更多关于加密算法格式的资料。

如果没有指定ca，node.js会使用http://mxr.mozilla.org/mozilla/source/security/nss/lib/ckfw/builtins/certdata.txt提供的公共可信任的CA列表。

crypto.createHash(algorithm)#

创建并返回一个哈希对象，一个使用所给算法的用于生成摘要的加密哈希。

algorithm 取决与平台上所安装的 OpenSSL 版本所支持的算法。比如 'sha1'、'md5'、'sha256'、'sha512' 等等。在最近的发行版本中，openssl list-message-digest-algorithms 会显示可用的摘要算法。

例子：这段程序会计算出一个文件的 sha1 摘要值。

s.on('end', function() {
  var d = shasum.digest('hex');
  console.log(d + '  ' + filename);
});

类: Hash#

创建数据哈希摘要的类。

它是一个既可读又可写的流。所写入的数据会被用作计算哈希。当流的可写端终止后，使用 read() 方法来获取计算得的哈希摘要。同时也支持旧有的 update 和 digest 方法。

通过 crypto.createHash 返回。

hash.update(data, [input_encoding])#

通过提供的数据更新哈希对象，可以通过input_encoding指定编码为'utf8'、'ascii'或者 'binary'。如果没有指定编码，将作为二进制数据（buffer）处理。

因为它是流式数据，所以可以使用不同的数据调用很多次。

hash.digest([encoding])#

计算传入的所有数据的摘要值。encoding可以是'hex'、'binary'或者'base64'，如果没有指定，会返回一个buffer对象。

注意：hash 对象在 digest() 方法被调用后将不可用。

crypto.createHmac(algorithm, key)#

创建并返回一个hmac对象，也就是通过给定的加密算法和密钥生成的加密图谱（cryptographic）。

它是一个既可读又可写的流（stream）。写入的数据会被用于计算hmac。写入终止后，可以使用read()方法获取计算后的摘要值。之前版本的update和digest方法仍然支持。

algorithm在OpenSSL支持的算法列表中被抛弃了——见上方createHash部分。key是hmac算法用到的密钥。

Class: Hmac#

用于创建hmac加密图谱（cryptographic）的类。

由crypto.createHmac返回。

hmac.update(data)#

通过提供的数据更新hmac对象。因为它是流式数据，所以可以使用新数据调用很多次。

hmac.digest([encoding])#

计算传入的所有数据的hmac摘要值。encoding可以是'hex'、'binary'或者'base64'，如果没有指定，会返回一个buffer对象。

注意： hmac对象在调用digest()之后就不再可用了。

crypto.createCipher(algorithm, password)#

用给定的算法和密码，创建并返回一个cipher加密算法的对象。（译者：cipher 就是加密算法的意思， ssl 的 cipher 主要是对称加密算法和不对称加密算法的组合。）

algorithm算法是依赖OpenSSL库的, 例如: 'aes192'算法等。在最近发布的版本， 执行命令 openssl list-cipher-algorithms 就会显示出所有可用的加密算法，password是用来派生key和IV的，它必须是一个 'binary' 2进制格式的字符串或者是一个buffer。（译者：key表示密钥，IV表示向量在加密过程和解密过程都要使用）

它是一个既可读又可写的流。所写入的数据会被用作计算哈希。当流的可写端终止后，使用 read() 方法来获取计算得的哈希摘要。同时也支持旧有的 update 和 digest 方法。

crypto.createCipheriv(algorithm, key, iv)#

用给定的算法、密码和向量，创建并返回一个cipher加密算法的对象。

algorithm算法和createCipher() 方法的参数相同. key密钥是一个被算法使用的原始密钥，iv是一个初始化向量。

key密钥和iv向量必须是'binary'2进制格式的字符串或buffers.

Class: Cipher#

这个类是用来加密数据的。

这个类由 crypto.createCipher 和 crypto.createCipheriv 返回。

Cipher加密对象是 streams，他是具有 readable 可读和 writable 可写的。写入的纯文本数据是用来在可读流一侧加密数据的。 以前版本的update 和final方法也还是支持的。

cipher.update(data, [input_encoding], [output_encoding])#

用data参数更新cipher加密对象, 它的编码input_encoding必须是下列给定编码的 'utf8', 'ascii' or 'binary' 中一种。如果没有编码参数，那么打他参数必须是一个buffer。

参数 output_encoding输出编码指定了加密数据的输出格式，可以是'binary', 'base64' 或者'hex'，如果没有提供这个参数，buffer将会返回。

返回加密内容，并且Returns the enciphered contents, 用新数据作为流的话，它可以被调用多次。

cipher.final([output_encoding])#

返回剩余的加密内容，output_encoding为'binary', 'base64' 或 'hex'中的任意一个。 如果没有提供编码格式，则返回一个buffer对象。

注: 调用final()函数后cipher 对象不能被使用。

cipher.setAutoPadding(auto_padding=true)#

对于将输入数据自动填充到块大小的功能，你可以将其禁用。如果auto_padding是false， 那么整个输入数据的长度必须是加密器的块大小的整倍数，否则final会失败。这对非标准的填充很有用，例如使用0x0而不是PKCS的填充。这个函数必须在cipher.final之前调用。

crypto.createDecipher(algorithm, password)#

根据给定的算法和密钥，创建并返回一个解密器对象。这是上述createCipher()的一个镜像。

crypto.createDecipheriv(algorithm, key, iv)#

Creates and returns a decipher object, with the given algorithm, key and iv. This is the mirror of the createCipheriv() above. 根据给定的算法，密钥和初始化向量，创建并返回一个解密器对象。这是上述createCipheriv()的一个镜像。

Class: Decipher#

解密数据的类。

由crypto.createDecipher和crypto.createDecipheriv返回。

解密器对象是可读写的流对象。用被写入的加密数据生成可读的平文数据。解码器对象也支持The legacy update和 final函数。

decipher.update(data, [input_encoding], [output_encoding])#

用data来更新解密器，其中data以'binary', 'base64' 或 'hex'进行编码。如果没有指明编码方式，则默认data是一个buffer对象。

output_decoding指明了用以下哪种编码方式返回解密后的平文：'binary', 'ascii' 或 'utf8'。如果没有指明编码方式，则返回一个buffer对象。

decipher.final([output_encoding])#

返回剩余的加密内容，output_encoding为'binary', 'ascii' 或 'utf8'中的任意一个。如果没有指明编码方式，则返回一个buffer对象。

注: 调用final()函数后不能使用decipher 对象。

decipher.setAutoPadding(auto_padding=true)#

如果数据以非标准的块填充方式被加密，那么你可以禁用自动填充来防止decipher.final对数据进行检查和移除。这只有在输入数据的长度是加密器块大小的整倍数时才有效。这个函数必须在将数据流传递给decipher.update之前调用。

crypto.createSign(algorithm)#

根据给定的算法，创建并返回一个signing对象。在最近的OpenSSL发布版本中，openssl list-public-key-algorithms会列出可用的签名算法，例如'RSA-SHA256'。

Class: Sign#

生成数字签名的类

由crypto.createSign返回。

Sign对象是可写的流对象。被写入的数据用来生成数字签名。当所有的数据都被写入后，sign 函数会返回数字签名。Sign对象也支持The legacy update函数。

sign.update(data)#

用data来更新sign对象。 This can be called many times with new data as it is streamed.

sign.sign(private_key, [output_format])#

根据所有传送给sign的更新数据来计算电子签名。private_key是一个包含了签名私钥的字符串，而该私钥是用PEM编码的。

返回一个数字签名，该签名的格式可以是'binary', 'hex'或 'base64'. 如果没有指明编码方式，则返回一个buffer对象。

注：调用sign()后不能使用sign对象。

crypto.createVerify(algorithm)#

根据指明的算法，创建并返回一个验证器对象。这是上述签名器对象的镜像。

Class: Verify#

用来验证数字签名的类。

由 crypto.createVerify返回。

验证器对象是可写的流对象. 被写入的数据会被用来验证提供的数字签名。在所有的数据被写入后，如果提供的数字签名有效，verify函数会返回真。验证器对象也支持 The legacy update函数。

verifier.update(data)#

用数据更新验证器对象。This can be called many times with new data as it is streamed.

verifier.verify(object, signature, [signature_format])#

用object和signature来验证被签名的数据。 object是一个字符串，这个字符串包含了一个被PEM编码的对象，这个对象可以是RSA公钥，DSA公钥或者X.509 证书。 signature是之前计算出来的数字签名，其中的 signature_format可以是'binary', 'hex' 或 'base64'. 如果没有指明编码方式，那么默认是一个buffer对象。

根据数字签名对于数据和公钥的有效性，返回true或false。

注: 调用verify()函数后不能使用verifier对象。

crypto.createDiffieHellman(prime_length)#

创建一个迪菲－赫尔曼密钥交换(Diffie-Hellman key exchange)对象，并根据给定的位长度生成一个质数。所用的生成器是s。

crypto.createDiffieHellman(prime, [encoding])#

根据给定的质数创建一个迪菲－赫尔曼密钥交换(Diffie-Hellman key exchange)对象。 所用的生成器是2。编码方式可以是'binary', 'hex'或 'base64'。如果没有指明编码方式，则默认是一个buffer对象。

Class: DiffieHellman#

创建迪菲－赫尔曼密钥交换(Diffie-Hellman key exchanges)的类。

由crypto.createDiffieHellman返回。

diffieHellman.generateKeys([encoding])#

生成迪菲－赫尔曼(Diffie-Hellman)算法的公钥和私钥，并根据指明的编码方式返回公钥。这个公钥可以转交给第三方。编码方式可以是 'binary', 'hex'或 'base64'. 如果没有指明编码方式，则返回一个buffer对象。

diffieHellman.computeSecret(other_public_key, [input_encoding], [output_encoding])#

以other_public_key作为第三方公钥来计算共享秘密，并返回这个共享秘密。参数中的密钥会以input_encoding编码方式来解读，而共享密钥则会用output_encoding进行编码。编码方式可以是'binary', 'hex'或 'base64'。如果没有提供输入的编码方式，则默认为一个buffer对象。

如果没有指明输出的编码方式，则返回一个buffer对象。

diffieHellman.getPrime([encoding])#

根据指明的编码格式返回迪菲－赫尔曼(Diffie-Hellman)质数，其中编码方式可以是'binary', 'hex' 或 'base64'。如果没有指明编码方式，则返回一个buffer对象。

diffieHellman.getGenerator([encoding])#

根据指明的编码格式返回迪菲－赫尔曼(Diffie-Hellman)质数，其中编码方式可以是'binary', 'hex' 或 'base64'。如果没有指明编码方式，则返回一个buffer对象。

diffieHellman.getPublicKey([encoding])#

根据指明的编码格式返回迪菲－赫尔曼(Diffie-Hellman)公钥，其中编码方式可以是'binary', 'hex' 或 'base64'。 如果没有指明编码方式，则返回一个buffer对象。

diffieHellman.getPrivateKey([encoding])#

根据指明的编码格式返回迪菲－赫尔曼(Diffie-Hellman)私钥，其中编码方式可以是'binary', 'hex' 或 'base64'。如果没有指明编码方式，则返回一个buffer对象。

diffieHellman.setPublicKey(public_key, [encoding])#

设置迪菲－赫尔曼(Diffie-Hellman)公钥，编码方式可以是可以是'binary', 'hex' 或 'base64'。如果没有指明编码方式，则返回一个buffer对象。

diffieHellman.setPrivateKey(private_key, [encoding])#

设置迪菲－赫尔曼(Diffie-Hellman)私钥，编码方式可以是可以是'binary', 'hex' 或 'base64'。如果没有指明编码方式，则返回一个buffer对象。

crypto.getDiffieHellman(group_name)#

创建一个预定义的迪菲－赫尔曼密钥交换(Diffie-Hellman key exchanges)对象。支持以下的D-H组：'modp1', 'modp2', 'modp5' (在RFC 2412中定义) 和 'modp14', 'modp15', 'modp16', 'modp17', 'modp18' (在 RFC 3526中定义)。返回的对象模仿了上述 crypto.createDiffieHellman()方法所创建的对象的接口，但不会晕允许密钥交换 (例如像 diffieHellman.setPublicKey()那样)。执行这套流程的好处是双方不需要事先生成或交换组余数，节省了处理和通信时间。

例子 (获取一个共享秘密):

/* alice_secret和 bob_secret应该是一样的 */
console.log(alice_secret == bob_secret);

crypto.pbkdf2(password, salt, iterations, keylen, callback)#

异步PBKDF2提供了一个伪随机函数 HMAC-SHA1，根据给定密码的长度，salt和iterations来得出一个密钥。回调函数得到两个参数 (err, derivedKey)。

crypto.pbkdf2Sync(password, salt, iterations, keylen)#

同步 PBKDF2 函数。返回derivedKey或抛出一个错误。

crypto.randomBytes(size, [callback])#

生成密码学强度的伪随机数据。用法：

// 同步
try {
  var buf = crypto.randomBytes(256);
  console.log('有 %d 字节的随机数据： %s', buf.length, buf);
} catch (ex) {
  // handle error
}

crypto.pseudoRandomBytes(size, [callback])#

生成非密码学强度的伪随机数据。如果数据足够长的话会返回一个唯一的数据，但这个返回值不一定是不可预料的。基于这个原因，当不可预料性很重要时，这个函数的返回值永远都不应该被使用，例如在生成加密的密钥时。

用法与 crypto.randomBytes一模一样。

crypto.DEFAULT_ENCODING#

对于可以接受字符串或buffer对象的函数的默认编码方式。默认值是'buffer'，所以默认使用Buffer对象。这是为了让crypto模块与默认'binary'为编码方式的遗留程序更容易兼容。

要注意，新的程序会期待buffer对象，所以使用这个时请只作为暂时的手段。

Recent API Changes#

早在统一的流API概念出现，以及引入Buffer对象来处理二进制数据之前，Crypto模块就被添加到Node。

因为这样，与流有关的类中并没有其它Node类的典型函数，而且很多函数接受和返回默认的二进制编码的字符串，而不是Buffer对象。在最近的修改中，这些函数都被改成默认使用Buffer对象。

这对于某些(但不是全部)使用场景来讲是重大的改变。

例如，如果你现在使用Sign类的默认参数，然后在没有检查数据的情况下，将结果传递给Verify类，那么程序会照常工作。在以前，你会拿到一个二进制字符串，然后它传递给Verify对象；而现在，你会得到一个Buffer对象，然后把它传递给Verify对象。

但是，如果你以前是使用那些在Buffer对象上不能正常工作的字符串数据，或者以默认编码方式将二进制数据传递给加密函数的话，那你就要开始提供编码方式参数来指明你想使用的编码方式了。如果想准换回旧的风格默认使用二进制字符串，那么你需要把crypto.DEFAULT_ENCODING字段设为'binary'。但请注意，因为新的程序很可能会期望buffer对象，所以仅将此当做临时手段。

TLS (SSL)#

稳定度: 3 - 稳定

使用 require('tls') 来访问此模块。

tls 模块使用 OpenSSL 来提供传输层安全协议（Transport Layer Security）和/或安全套接层（Secure Socket Layer）：加密过的流通讯。

TLS/SSL 是一种公钥/私钥架构。每个客户端和服务器都必有一个私钥。一个私钥使用类似的方式创建：

openssl genrsa -out ryans-key.pem 1024

所有服务器和某些客户端需要具备证书。证书是证书办法机构签发或自签发的公钥。获取证书的第一步是创建一个“证书签发申请”（CSR）文件。使用这条命令完成：

openssl req -new -key ryans-key.pem -out ryans-csr.pem

像这样使用 CSR 创建一个自签名证书：

openssl x509 -req -in ryans-csr.pem -signkey ryans-key.pem -out ryans-cert.pem

又或者你可以将 CSR 发送给一个数字证书认证机构请求签名。

(TODO: 对于创建一个CA文档, 感兴趣的用户暂时只能看Node的源代码test/fixtures/keys/Makefile

像这样创建 .pfx 或 .p12：

openssl pkcs12 -export -in agent5-cert.pem -inkey agent5-key.pem \
    -certfile ca-cert.pem -out agent5.pfx

• in: certificate
• inkey: private key
• certfile: all CA certs concatenated in one file like cat ca1-cert.pem ca2-cert.pem > ca-cert.pem

客户端初始化的对缓解攻击的重新协商#

TLS协议会令客户端可以重新协商TLS会话的某些方面。但是，会话的重新协商是需要相应量的服务器端资源的，所以导致其变成一个阻断服务攻击（denial-of-service）的潜在媒介。

为了减低这种情况的发生，重新协商被限制在每10分钟三次。如果超过这个数目，那么在tls.TLSSocket实例上就会分发一个错误。这个限制是可设置的：

• tls.CLIENT_RENEG_LIMIT: 重新协商的次数限制，默认为3。

• tls.CLIENT_RENEG_WINDOW: 重新协商窗口的秒数，默认为600（10分钟）。

除非你完全理解整个机制和清楚自己要干什么，否则不要改变这个默认值。

要测试你的服务器的话，用命令 openssl s_client -connect 地址:端口连接上服务器，然后敲击R<CR>（字母键R加回车键）几次。

NPN 和 SNI#

NPN (Next Protocol Negotiation，下一个协议的协商)和SNI (Server Name Indication，服务器名称指示)是TLS握手扩展，它们允许你：

• NPN - 同一个TLS服务器使用多种协议 (HTTP, SPDY)
• SNI - 同一个TLS服务器使用多个主机名，与其相应的SSL证书。

tls.getCiphers()#

返回一个数组，其中包含了所支持的SSL加密器的名字。

实例：

var ciphers = tls.getCiphers();
console.log(ciphers); // ['AES128-SHA', 'AES256-SHA', ...]

tls.createServer(options, [secureConnectionListener])#

新建一个新的 tls.Server. The connectionListener 参数会自动设置为 secureConnection 事件的监听器. 这个 options 对象有这些可能性:

• pfx: 一个String 或Buffer包含了私钥, 证书和CA certs, 一般是 PFX 或者 PKCS12 格式. (Mutually exclusive with the key, cert and ca options.)

• key: 一个字符串或 Buffer对象，其中包含了PEF格式的服务器的私钥。 (必需)

• passphrase: 私钥或pfx密码的字符串。

• cert: 字符串或者 Buffer，包含PEM格式的服务器证书密码。（必选）

• ca: An array of strings or Buffers of trusted certificates. If this is omitted several well known "root" CAs will be used, like VeriSign. These are used to authorize connections.

• crl : Either a string or list of strings of PEM encoded CRLs (Certificate Revocation List)

• ciphers: 一个字符串，描述了使用或排除的cipher。

**NOTE**: Previous revisions of this section suggested `AES256-SHA` as an
acceptable cipher. Unfortunately, `AES256-SHA` is a CBC cipher and therefore
susceptible to BEAST attacks. Do *not* use it.

• handshakeTimeout: Abort the connection if the SSL/TLS handshake does not finish in this many milliseconds. The default is 120 seconds.

`tls.Server`对象在握手超时时，总会触发`'clientError'`事件。

• honorCipherOrder : 当选择cipher时，使用服务器设置，而不是客户端设置。

Although, this option is disabled by default, it is *recommended* that you
use this option in conjunction with the `ciphers` option to mitigate
BEAST attacks.

• requestCert: If true the server will request a certificate from clients that connect and attempt to verify that certificate. Default: false.

• rejectUnauthorized: If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true. Default: false.

• NPNProtocols: 一个数组或 Buffer，包含了可能的 NPN 协议。(协议应根据优先级排序）

• SNICallback(servername, cb): A function that will be called if client supports SNI TLS extension. Two argument will be passed to it: servername, and cb. SNICallback should invoke cb(null, ctx), where ctx is a SecureContext instance. (You can use crypto.createCredentials(...).context to get proper SecureContext). If SNICallback wasn't provided - default callback with high-level API will be used (see below).

• sessionTimeout: An integer specifying the seconds after which TLS session identifiers and TLS session tickets created by the server are timed out. See SSL_CTX_set_timeout for more details.

• sessionIdContext: A string containing a opaque identifier for session resumption. If requestCert is true, the default is MD5 hash value generated from command-line. Otherwise, the default is not provided.

• secureProtocol: The SSL method to use, e.g. SSLv3_method to force SSL version 3. The possible values depend on your installation of OpenSSL and are defined in the constant SSL_METHODS.

这是一个简单的应答服务器例子：

var server = tls.createServer(options, function(socket) {
  console.log('服务器已连接',
              socket.authorized ? '已授权' : '未授权');
  socket.write("欢迎！\n");
  socket.setEncoding('utf8');
  socket.pipe(socket);
});
server.listen(8000, function() {
  console.log('server bound');
});

或者

};

var server = tls.createServer(options, function(socket) {
  console.log('服务器已连接',
              socket.authorized ? '已授权' : '未授权');
  socket.write("欢迎！\n");
  socket.setEncoding('utf8');
  socket.pipe(socket);
});
server.listen(8000, function() {
  console.log('服务器已绑定');
});

您可以使用 openssl s_client 连接这个服务器来测试：

openssl s_client -connect 127.0.0.1:8000

tls.connect(options, [callback])#

tls.connect(port, [host], [options], [callback])#

Creates a new client connection to the given port and host (old API) or options.port and options.host. (If host is omitted, it defaults to localhost.) options should be an object which specifies:

• host: 客户端应连接到的主机

• port: 客户端应连接到的端口

• socket: Establish secure connection on a given socket rather than creating a new socket. If this option is specified, host and port are ignored.

• pfx: 字符串或者 Buffer，包含 PFX 或 PKCS12 格式的服务器私钥、证书和CA证书。

• key: 字符串或 Buffer，包含 PEM 格式的客户端私钥。

• passphrase: 私钥或pfx密码的字符串。

• cert: 字符串或 Buffer，包含PEM格式的客户端证书密码。

• ca: An array of strings or Buffers of trusted certificates. If this is omitted several well known "root" CAs will be used, like VeriSign. These are used to authorize connections.

• rejectUnauthorized: If true, the server certificate is verified against the list of supplied CAs. An 'error' event is emitted if verification fails. Default: true.

• NPNProtocols: An array of string or Buffer containing supported NPN protocols. Buffer should have following format: 0x05hello0x05world, where first byte is next protocol name's length. (Passing array should usually be much simpler: ['hello', 'world'].)

• servername: SNI (Server Name Indication) TLS 扩展的服务器名。

• secureProtocol: The SSL method to use, e.g. SSLv3_method to force SSL version 3. The possible values depend on your installation of OpenSSL and are defined in the constant SSL_METHODS.

callback参数会被作为监听器添加到'secureConnect'事件。

tls.connect()返回一个tls.TLSSocket对象。

下面是一个上述应答服务器的客户端的例子：

var socket = tls.connect(8000, options, function() {
  console.log('client connected',
              socket.authorized ? 'authorized' : 'unauthorized');
  process.stdin.pipe(socket);
  process.stdin.resume();
});
socket.setEncoding('utf8');
socket.on('data', function(data) {
  console.log(data);
});
socket.on('end', function() {
  server.close();
});

或者

var socket = tls.connect(8000, options, function() {
  console.log('client connected',
              socket.authorized ? 'authorized' : 'unauthorized');
  process.stdin.pipe(socket);
  process.stdin.resume();
});
socket.setEncoding('utf8');
socket.on('data', function(data) {
  console.log(data);
});
socket.on('end', function() {
  server.close();
});

Class: tls.TLSSocket#

Wrapper for instance of net.Socket, replaces internal socket read/write routines to perform transparent encryption/decryption of incoming/outgoing data.

new tls.TLSSocket(socket, options)#

Construct a new TLSSocket object from existing TCP socket.

socket是一个net.Socket示例。

options是一个可能包含以下属性的对象：

• credentials: 可选的，通过crypto.createCredentials( ... )得到的资格对象。

• isServer: 如果为真——TLS套接字将在服务器模式下实例化。

• server: 一个可选的net.Server实例

• requestCert: 可选的，见tls.createSecurePair

• rejectUnauthorized: 可选的，见tls.createSecurePair

• NPNProtocols: 可选的，见tls.createServer

• SNICallback: 可选的，见tls.createServer

tls.createSecurePair([credentials], [isServer], [requestCert], [rejectUnauthorized])#

稳定性: 0 - 已废弃。使用 tls.TLSSocket 替代。

Creates a new secure pair object with two streams, one of which reads/writes encrypted data, and one reads/writes cleartext data. Generally the encrypted one is piped to/from an incoming encrypted data stream, and the cleartext one is used as a replacement for the initial encrypted stream.

• credentials: 通过crypto.createCredentials( ... )得到的资格对象

• isServer: A boolean indicating whether this tls connection should be opened as a server or a client.

• requestCert: A boolean indicating whether a server should request a certificate from a connecting client. Only applies to server connections.

• rejectUnauthorized: A boolean indicating whether a server should automatically reject clients with invalid certificates. Only applies to servers with requestCert enabled.

tls.createSecurePair() returns a SecurePair object with cleartext and encrypted stream properties.

NOTE: cleartext has the same APIs as tls.TLSSocket

类: SecurePair#

由tls.createSecurePair返回。

事件: 'secure'#

The event is emitted from the SecurePair once the pair has successfully established a secure connection.

Similarly to the checking for the server 'secureConnection' event, pair.cleartext.authorized should be checked to confirm whether the certificate used properly authorized.

类: tls.Server#

This class is a subclass of net.Server and has the same methods on it. Instead of accepting just raw TCP connections, this accepts encrypted connections using TLS or SSL.

事件: 'secureConnection'#

function (tlsSocket) {}

This event is emitted after a new connection has been successfully handshaked. The argument is a instance of tls.TLSSocket. It has all the common stream methods and events.

socket.authorized is a boolean value which indicates if the client has verified by one of the supplied certificate authorities for the server. If socket.authorized is false, then socket.authorizationError is set to describe how authorization failed. Implied but worth mentioning: depending on the settings of the TLS server, you unauthorized connections may be accepted. socket.npnProtocol is a string containing selected NPN protocol. socket.servername is a string containing servername requested with SNI.

Event: 'clientError'#

function (exception, tlsSocket) { }

When a client connection emits an 'error' event before secure connection is established - it will be forwarded here.

tlsSocket就是[tls.TLSSocket][]，错误产生的地方。

事件: 'newSession'#

function (sessionId, sessionData) { }

Emitted on creation of TLS session. May be used to store sessions in external storage.

NOTE: adding this event listener will have an effect only on connections established after addition of event listener.

事件: 'resumeSession'#

function (sessionId, callback) { }

Emitted when client wants to resume previous TLS session. Event listener may perform lookup in external storage using given sessionId, and invoke callback(null, sessionData) once finished. If session can't be resumed (i.e. doesn't exist in storage) one may call callback(null, null). Calling callback(err) will terminate incoming connection and destroy socket.

NOTE: adding this event listener will have an effect only on connections established after addition of event listener.

server.listen(port, [host], [callback])#

Begin accepting connections on the specified port and host. If the host is omitted, the server will accept connections directed to any IPv4 address (INADDR_ANY).

This function is asynchronous. The last parameter callback will be called when the server has been bound.

更多信息见net.Server。

server.close()#

Stops the server from accepting new connections. This function is asynchronous, the server is finally closed when the server emits a 'close' event.

server.address()#

Returns the bound address, the address family name and port of the server as reported by the operating system. See net.Server.address() for more information.

server.addContext(hostname, credentials)#

Add secure context that will be used if client request's SNI hostname is matching passed hostname (wildcards can be used). credentials can contain key, cert and ca.

server.maxConnections#

Set this property to reject connections when the server's connection count gets high.

server.connections#

服务器的并发连接数.

类: CryptoStream#

稳定性: 0 - 已废弃。使用 tls.TLSSocket 替代。

这是一个被加密的流。

cryptoStream.bytesWritten#

A proxy to the underlying socket's bytesWritten accessor, this will return the total bytes written to the socket, including the TLS overhead.

Class: tls.TLSSocket#

This is a wrapped version of net.Socket that does transparent encryption of written data and all required TLS negotiation.

This instance implements a duplex Stream interfaces. It has all the common stream methods and events.

事件: 'secureConnect'#

This event is emitted after a new connection has been successfully handshaked. The listener will be called no matter if the server's certificate was authorized or not. It is up to the user to test tlsSocket.authorized to see if the server certificate was signed by one of the specified CAs. If tlsSocket.authorized === false then the error can be found in tlsSocket.authorizationError. Also if NPN was used - you can check tlsSocket.npnProtocol for negotiated protocol.

tlsSocket.authorized#

A boolean that is true if the peer certificate was signed by one of the specified CAs, otherwise false

tlsSocket.authorizationError#

The reason why the peer's certificate has not been verified. This property becomes available only when tlsSocket.authorized === false.

tlsSocket.getPeerCertificate()#

Returns an object representing the peer's certificate. The returned object has some properties corresponding to the field of the certificate.

实例：

{ subject: 
   { C: 'UK',
     ST: 'Acknack Ltd',
     L: 'Rhys Jones',
     O: 'node.js',
     OU: 'Test TLS Certificate',
     CN: 'localhost' },
  issuer: 
   { C: 'UK',
     ST: 'Acknack Ltd',
     L: 'Rhys Jones',
     O: 'node.js',
     OU: 'Test TLS Certificate',
     CN: 'localhost' },
  valid_from: 'Nov 11 09:52:22 2009 GMT',
  valid_to: 'Nov  6 09:52:22 2029 GMT',
  fingerprint: '2A:7A:C2:DD:E5:F9:CC:53:72:35:99:7A:02:5A:71:38:52:EC:8A:DF' }

如果节点没有提供证书, 它将返回 null 或者一个空对象.

tlsSocket.getCipher()#

返回一个对象，表示了当前连接的cipher名与SSL/TLS协议版本。

Example: { name: 'AES256-SHA', version: 'TLSv1/SSLv3' }

See SSL_CIPHER_get_name() and SSL_CIPHER_get_version() in http://www.openssl.org/docs/ssl/ssl.html#DEALING_WITH_CIPHERS for more information.

tlsSocket.renegotiate(options, callback)#

Initiate TLS renegotiation process. The options may contain the following fields: rejectUnauthorized, requestCert (See tls.createServer for details). callback(err) will be executed with null as err, once the renegotiation is successfully completed.

NOTE: Can be used to request peer's certificate after the secure connection has been established.

ANOTHER NOTE: When running as the server, socket will be destroyed with an error after handshakeTimeout timeout.

tlsSocket.address()#

Returns the bound address, the address family name and port of the underlying socket as reported by the operating system. Returns an object with three properties, e.g. { port: 12346, family: 'IPv4', address: '127.0.0.1' }

tlsSocket.remoteAddress#

远程IP地址的字符串表示。例如，'74.125.127.100'或 '2001:4860:a005::68'。

tlsSocket.remotePort#

远程端口的数值表示。例如， 443。

tlsSocket.localAddress#

本地IP地址的字符串表达。

tlsSocket.localPort#

本地端口的数值表示。

字符串解码器#

稳定度: 3 - 稳定

通过 require('string_decoder') 使用这个模块。这个模块将一个 Buffer 解码成一个字符串。他是 buffer.toString() 的一个简单接口，但提供对 utf8 的支持。

var euro = new Buffer([0xE2, 0x82, 0xAC]);
console.log(decoder.write(euro));

类: StringDecoder#

接受 encoding 一个参数，默认是 utf8。

decoder.write(buffer)#

返回解码后的字符串。

decoder.end()#

返回 Buffer 中剩下的末尾字节。

File System#

稳定度: 3 - 稳定

文件系统模块是一个简单包装的标准 POSIX 文件 I/O 操作方法集。您可以通过调用require('fs')来获取该模块。文件系统模块中的所有方法均有异步和同步版本。

文件系统模块中的异步方法需要一个完成时的回调函数作为最后一个传入形参。 回调函数的构成由您调用的异步方法所决定，通常情况下回调函数的第一个形参为返回的错误信息。 如果异步操作执行正确并返回，该错误形参则为null或者undefined。

如果您使用的是同步版本的操作方法，则一旦出现错误，会以通常的抛出错误的形式返回错误。 你可以用try和catch等语句来拦截错误并使程序继续进行。

这里是一个异步版本的例子：

fs.unlink('/tmp/hello', function (err) {
  if (err) throw err;
  console.log('successfully deleted /tmp/hello');
});

这是同步版本的例子:

fs.unlinkSync('/tmp/hello')
console.log('successfully deleted /tmp/hello');

当使用异步版本时不能保证执行顺序,因此下面这个例子很容易出错:

fs.rename('/tmp/hello', '/tmp/world', function (err) {
  if (err) throw err;
  console.log('renamed complete');
});
fs.stat('/tmp/world', function (err, stats) {
  if (err) throw err;
  console.log('stats: ' + JSON.stringify(stats));
});

fs.stat有可能在fs.rename前执行.要等到正确的执行顺序应该用下面的方法:

fs.rename('/tmp/hello', '/tmp/world', function (err) {
  if (err) throw err;
  fs.stat('/tmp/world', function (err, stats) {
    if (err) throw err;
    console.log('stats: ' + JSON.stringify(stats));
  });
});

在繁重的任务中,强烈推荐使用这些函数的异步版本.同步版本会阻塞进程,直到完成处理,也就是说会暂停所有的连接.

可以使用文件名的相对路径, 但是记住这个路径是相对于process.cwd()的.

大部分的文件系统(fs)函数可以忽略回调函数(callback)这个参数.如果忽略它,将会由一个默认回调函数(callback)来重新抛出(rethrow)错误.要获得原调用点的堆栈跟踪(trace)信息,需要在环境变量里设置NODE_DEBUG.

$ env NODE_DEBUG=fs node script.js
fs.js:66
        throw err;
              ^
Error: EISDIR, read
    at rethrow (fs.js:61:21)
    at maybeCallback (fs.js:79:42)
    at Object.fs.readFile (fs.js:153:18)
    at bad (/path/to/script.js:2:17)
    at Object.<anonymous> (/path/to/script.js:5:1)
    <etc.>

fs.rename(oldPath, newPath, callback)#

异步版本的rename函数(2).完成时的回调函数(callback)只接受一个参数:可能出现的异常信息.

fs.renameSync(oldPath, newPath)#

同步版本的rename(2).

fs.ftruncate(fd, len, callback)#

异步版本的ftruncate(2). 完成时的回调函数(callback)只接受一个参数:可能出现的异常信息.

fs.ftruncateSync(fd, len)#

同步版本的ftruncate(2).

fs.truncate(path, len, callback)#

异步版本的truncate(2). 完成时的回调函数(callback)只接受一个参数:可能出现的异常信息.

fs.truncateSync(path, len)#

同步版本的truncate(2).

异步版本的chown.完成时的回调函数(callback)只接受一个参数:可能出现的异常信息.

异步版本的chown(2).完成时的回调函数(callback)只接受一个参数:可能出现的异常信息.

fs.chownSync(path, uid, gid)#

同步版本的chown(2).

fs.fchown(fd, uid, gid, callback)#

异步版本的fchown(2)。回调函数的参数除了出现错误时有一个错误对象外，没有其它参数。

fs.fchownSync(fd, uid, gid)#

同步版本的fchown(2).

fs.lchown(path, uid, gid, callback)#

异步版的lchown(2)。完成时的回调函数(callback)只接受一个参数:可能出现的异常信息.

fs.lchownSync(path, uid, gid)#

同步版本的lchown(2).

fs.chmod(path, mode, callback)#

异步版的 chmod(2). 完成时的回调函数(callback)只接受一个参数:可能出现的异常信息.

fs.chmodSync(path, mode)#

同步版的 chmod(2).

fs.fchmod(fd, mode, callback)#

异步版的 fchmod(2). 完成时的回调函数(callback)只接受一个参数:可能出现的异常信息.

fs.fchmodSync(fd, mode)#

同步版的 fchmod(2).

fs.lchmod(path, mode, callback)#

异步版的 lchmod(2). 完成时的回调函数(callback)只接受一个参数:可能出现的异常信息.

仅在 Mac OS X 系统下可用。

fs.lchmodSync(path, mode)#

同步版的 lchmod(2).

fs.stat(path, callback)#

异步版的 stat(2). 回调函数（callback） 接收两个参数： (err, stats) ，其中 stats 是一个 fs.Stats 对象。 详情请参考 fs.Stats

fs.lstat(path, callback)#

异步版的 lstat(2). 回调函数（callback）接收两个参数： (err, stats) 其中 stats 是一个 fs.Stats 对象。 lstat() 与 stat() 相同，区别在于： 若 path 是一个符号链接时（symbolic link）,读取的是该符号链接本身，而不是它所 链接到的文件。

fs.fstat(fd, callback)#

异步版的 fstat(2). 回调函数（callback）接收两个参数： (err, stats) 其中 stats 是一个 fs.Stats 对象。 fstat() 与 stat() 相同，区别在于： 要读取的文件（译者注：即第一个参数）是一个文件描述符（file descriptor） fd 。

fs.statSync(path)#

同步版的 stat(2). 返回一个 fs.Stats 实例。

fs.lstatSync(path)#

同步版的 lstat(2). 返回一个 fs.Stats 实例。

fs.fstatSync(fd)#

同步版的 fstat(2). 返回一个 fs.Stats 实例。

fs.link(srcpath, dstpath, callback)#

异步版的 link(2). 完成时的回调函数（callback）只接受一个参数：可能出现的异常信息。

fs.linkSync(srcpath, dstpath)#

同步版的 link(2).

fs.symlink(srcpath, dstpath, [type], callback)#

异步版的 symlink(2). 完成时的回调函数（callback）只接受一个参数：可能出现的异常信息。 type 可以是 'dir', 'file', 或者'junction' (默认是 'file')，此参数仅用于 Windows 系统（其他系统平台会被忽略）。 注意： Windows 系统要求目标路径（译者注：即 dstpath 参数）必须是一个绝对路径，当使用 'junction' 时，dstpath 参数会自动转换为绝对路径。

fs.symlinkSync(srcpath, dstpath, [type])#

同步版的 symlink(2).

fs.readlink(path, callback)#

异步版的 readlink(2). 回调函数（callback）接收两个参数： (err, linkString).

fs.readlinkSync(path)#

同步版的 readlink(2). 返回符号链接（symbolic link）的字符串值。

fs.realpath(path, [cache], callback)#

异步版的 realpath(2). 回调函数（callback）接收两个参数： (err, resolvedPath). May use process.cwd to resolve relative paths. cache is an object literal of mapped paths that can be used to force a specific path resolution or avoid additional fs.stat calls for known real paths.

实例：

var cache = {'/etc':'/private/etc'};
fs.realpath('/etc/passwd', cache, function (err, resolvedPath) {
  if (err) throw err;
  console.log(resolvedPath);
});

fs.realpathSync(path, [cache])#

realpath(2) 的同步版本。返回解析出的路径。

fs.unlink(path, callback)#

异步版的 unlink(2). 完成时的回调函数（callback）只接受一个参数：可能出现的异常信息.

fs.unlinkSync(path)#

同步版的 unlink(2).

fs.rmdir(path, callback)#

异步版的 rmdir(2). 异步版的 link(2). 完成时的回调函数（callback）只接受一个参数：可能出现的异常信息。

fs.rmdirSync(path)#

同步版的 rmdir(2).

fs.mkdir(path, [mode], callback)#

异步版的 mkdir(2)。 异步版的 link(2). 完成时的回调函数（callback）只接受一个参数：可能出现的异常信息。文件 mode 默认为 0777。

fs.mkdirSync(path, [mode])#

同步版的 mkdir(2)。

fs.readdir(path, callback)#

异步版的 readdir(3)。 读取 path 路径所在目录的内容。 回调函数 (callback) 接受两个参数 (err, files) 其中 files 是一个存储目录中所包含的文件名称的数组，数组中不包括 '.' 和 '..'。

fs.readdirSync(path)#

同步版的 readdir(3). 返回文件名数组，其中不包括 '.' 和 '..' 目录.

fs.close(fd, callback)#

异步版 close(2). 完成时的回调函数(callback)只接受一个参数:可能出现的异常信息.

fs.closeSync(fd)#

同步版的 close(2).

fs.open(path, flags, [mode], callback)#

异步版的文件打开. 详见 open(2). flags 可以是:

• 'r' - 以【只读】的方式打开文件. 当文件不存在时产生异常.

• 'r+' - 以【读写】的方式打开文件. 当文件不存在时产生异常.

• 'rs' - 同步模式下，以【只读】的方式打开文件. 指令绕过操作系统的本地文件系统缓存.

该功能主要用于打开 NFS 挂载的文件, 因为它可以让你跳过默认使用的过时本地缓存. 但这实际上非常影响 I/O 操作的性能, 因此除非你确实有这样的需求, 否则请不要使用该标志.

注意: 这并不意味着 fs.open() 变成了一个同步阻塞的请求. 如果你想要一个同步阻塞的请求你应该使用 fs.openSync().

• 'rs+' - 同步模式下, 以【读写】的方式打开文件. 请谨慎使用该方式, 详细请查看 'rs' 的注释.

• 'w' - 以【只写】的形式打开文件. 文件会被创建 (如果文件不存在) 或者覆盖 (如果存在).

• 'wx' - 类似 'w' 区别是如果文件存在则操作会失败.

• 'w+' - 以【读写】的方式打开文件. 文件会被创建 (如果文件不存在) 或者覆盖 (如果存在).

• 'wx+' - 类似 'w+' 区别是如果文件存在则操作会失败.

• 'a' - 以【附加】的形式打开文件，即新写入的数据会附加在原来的文件内容之后. 如果文件不存在则会默认创建.

• 'ax' - 类似 'a' 区别是如果文件存在则操作会失败.

• 'a+' - 以【读取】和【附加】的形式打开文件. 如果文件不存在则会默认创建.

• 'ax+' - 类似 'a+' 区别是如果文件存在则操作会失败.

参数 mode 用于设置文件模式 (permission and sticky bits), 不过前提是这个文件是已存在的. 默认情况下是 0666, 有可读和可写权限.

该 callback 接收两个参数 (err, fd).

排除 (exclusive) 标识 'x' （对应 open(2) 的 O_EXCL 标识） 保证 path 是一个新建的文件。 POSIX 操作系统上，即使 path 是一个指向不存在位置的符号链接，也会被认定为文件存在。 排除标识在网络文件系统不能确定是否有效。

在 Linux 上，无法对以追加 (append) 模式打开的文件进行指定位置的写入操作。 内核会忽略位置参数并且总是将数据追加到文件尾部。

fs.openSync(path, flags, [mode])#

fs.open() 的同步版.

fs.utimes(path, atime, mtime, callback)#

fs.utimesSync(path, atime, mtime)#

更改 path 所指向的文件的时间戳。

fs.futimes(fd, atime, mtime, callback)#

fs.futimesSync(fd, atime, mtime)#

更改文件描述符 (file discriptor) 所指向的文件的时间戳。

fs.fsync(fd, callback)#

异步版本的 fsync(2)。回调函数仅含有一个异常 (exception) 参数。

fs.fsyncSync(fd)#

fsync(2) 的同步版本。

fs.write(fd, buffer, offset, length[, position], callback)#

通过文件标识fd，向指定的文件中写入buffer。

offset 和length 可以确定从哪个位置开始写入buffer。

position 是参考当前文档光标的位置，然后从该处写入数据。如果typeof position !== 'number'，那么数据会从当前文档位置写入，请看pwrite(2)。

回调中会给出三个参数 (err, written, buffer)，written 说明从buffer写入的字节数。

注意，fs.write多次地在同一个文件中使用而没有等待回调是不安全的。在这种情况下，强烈推荐使用fs.createWriteStream。

在 Linux 上，无法对以追加 (append) 模式打开的文件进行指定位置的写入操作。 内核会忽略位置参数并且总是将数据追加到文件尾部。

fs.write(fd, data[, position[, encoding]], callback)#

把data写入到文档中通过指定的fd,如果data不是buffer对象的实例则会把值强制转化成一个字符串。

position 是参考当前文档光标的位置，然后从该处写入数据。如果typeof position !== 'number'，那么数据会从当前文档位置写入，请看pwrite(2)。

encoding 是预期得到一个字符串编码

回调会得到这些参数 (err, written, string)，written表明传入的string需要写入的字符串长度。注意字节的写入跟字符串写入是不一样的。请看Buffer.byteLength.

与写入buffer不同，必须写入完整的字符串，截取字符串不是符合规定的。这是因为返回的字节的位移跟字符串的位移是不一样的。

注意，fs.write多次地在同一个文件中使用而没有等待回调是不安全的。在这种情况下，强烈推荐使用fs.createWriteStream。

在 Linux 上，无法对以追加 (append) 模式打开的文件进行指定位置的写入操作。 内核会忽略位置参数并且总是将数据追加到文件尾部。

fs.writeSync(fd, buffer, offset, length[, position])#

fs.writeSync(fd, data[, position[, encoding]])#

同步版本的fs.write()。返回写入的字节数。

fs.read(fd, buffer, offset, length, position, callback)#

从指定的文档标识符fd读取文件数据。

buffer 是缓冲区，数据将会写入这里。

offset 是开始向缓冲区 buffer 写入的偏移量。

length 是一个整形值，指定了读取的字节数。

position 是一个整形值，指定了从哪里开始读取文件，如果position为null，将会从文件当前的位置读取数据。

回调函数给定了三个参数， (err, bytesRead, buffer)， 分别为错误，读取的字节和缓冲区。

fs.readSync(fd, buffer, offset, length, position)#

fs.read 函数的同步版本。 返回bytesRead的个数。

fs.readFile(filename, [options], callback)#

• filename {String}
• options {Object}
  • encoding {String | Null} default = null
  • flag {String} default = 'r'
• callback {Function}

异步读取一个文件的全部内容。举例：

fs.readFile('/etc/passwd', function (err, data) {
  if (err) throw err;
  console.log(data);
});

回调函数传递了两个参数 (err, data), data 就是文件的内容。

如果未指定编码方式，原生buffer就会被返回。

fs.readFileSync(filename, [options])#

fs.readFile的同步版本。 返回文件名为 filename 的文件内容。

如果 encoding 选项被指定， 那么这个函数返回一个字符串。如果未指定，则返回一个原生buffer。

fs.writeFile(filename, data, [options], callback)#

• filename {String}
• data {String | Buffer}
• options {Object}
  • encoding {String | Null} default = 'utf8'
  • mode {Number} default = 438 (aka 0666 in Octal)
  • flag {String} default = 'w'
• callback {Function}

异步的将数据写入一个文件, 如果文件原先存在，会被替换。 data 可以是一个string，也可以是一个原生buffer。

encoding 选项会被忽视如果 data 不是string而是原生buffer。encoding缺省为 'utf8'。

实例：

fs.writeFile('message.txt', 'Hello Node', function (err) {
  if (err) throw err;
  console.log('It\'s saved!'); //文件被保存
});

fs.writeFileSync(filename, data, [options])#

fs.writeFile的同步版本。

fs.appendFile(filename, data, [options], callback)#

• filename {String}
• data {String | Buffer}
• options {Object}
  • encoding {String | Null} default = 'utf8'
  • mode {Number} default = 438 (aka 0666 in Octal)
  • flag {String} default = 'a'
• callback {Function}

异步的将数据添加到一个文件的尾部，如果文件不存在，会创建一个新的文件。 data 可以是一个string，也可以是原生buffer。

实例：

fs.appendFile('message.txt', 'data to append', function (err) {
  if (err) throw err;
  console.log('The "data to append" was appended to file!'); //数据被添加到文件的尾部
});

fs.appendFileSync(filename, data, [options])#

fs.appendFile的同步版本。

fs.watchFile(filename, [options], listener)#

稳定性: 2 - 不稳定.   尽可能的话推荐使用 fs.watch 来代替。

监视filename指定的文件的改变. 回调函数 listener 会在文件每一次被访问时被调用。

第二个参数是可选的。 如果提供此参数，options 应该是包含两个成员persistent和interval的对象，其中persistent值为boolean类型。persistent指定进程是否应该在文件被监视（watch）时继续运行，interval指定了目标文件被查询的间隔，以毫秒为单位。缺省值为{ persistent: true, interval: 5007 }。

listener 有两个参数，第一个为文件现在的状态，第二个为文件的前一个状态。

fs.watchFile('message.text', function (curr, prev) {
  console.log('the current mtime is: ' + curr.mtime);
  console.log('the previous mtime was: ' + prev.mtime);
});

listener中的文件状态对象类型为fs.Stat。

如果你只想在文件被修改时被告知，而不是仅仅在被访问时就告知，你应当在listener回调函数中比较下两个状态对象的mtime属性。即curr.mtime 和 prev.mtime.

fs.unwatchFile(filename, [listener])#

稳定性: 2 - 不稳定.   尽可能的话推荐使用 fs.watch 来代替。

停止监视文件名为 filename的文件. 如果 listener 参数被指定, 会移除在fs.watchFile函数中指定的那一个listener回调函数。 否则, 所有的 回调函数都会被移除，你将彻底停止监视filename文件。

调用 fs.unwatchFile() 时，传递的文件名为未被监视的文件时，不会发生错误，而会发生一个no-op。

fs.watch(filename, [options], [listener])#

稳定性: 2 - 不稳定的

观察指定路径的改变，filename 路径可以是文件或者目录。改函数返回的对象是 fs.FSWatcher。

第二个参数是可选的. 如果 options 选项被提供那么它应当是一个只包含成员persistent得对象， persistent为boolean类型。persistent指定了进程是否“只要文件被监视就继续执行”缺省值为 { persistent: true }.

监听器的回调函数得到两个参数 (event, filename)。其中 event 是 'rename'（重命名）或者 'change'（改变），而 filename 则是触发事件的文件名。

注意事项#

fs.watch 不是完全跨平台的，且在某些情况下不可用。

可用性#

此功能依赖于操作系统底层提供的方法来监视文件系统的变化。

• 在 Linux 操作系统上，使用 inotify。
• 在 BSD 操作系统上 (包括 OS X)，使用 kqueue。
• 在 SunOS 操作系统上 (包括 Solaris 和 SmartOS)，使用 event ports。
• 在 Windows 操作系统上，该特性依赖于 ReadDirectoryChangesW。

如果系统底层函数出于某些原因不可用，那么 fs.watch 也就无法工作。例如，监视网络文件系统(如 NFS, SMB 等)的文件或者目录，就时常不能稳定的工作，有时甚至完全不起作用。

你仍然可以调用使用了文件状态调查的 fs.watchFile，但是会比较慢而且比较不可靠。

文件名参数#

在回调函数中提供的 filename 参数不是在每一个操作系统中都被支持（当下仅在Linux和Windows上支持）。 即便是在支持的系统中，filename也不能保证在每一次回调都被提供。因此，不要假设filename参数总会会在 回调函数中提供，在回调函数中添加检测filename是否为null的if判断语句。

fs.watch('somedir', function (event, filename) {
  console.log('event is: ' + event);
  if (filename) {
    console.log('filename provided: ' + filename);
  } else {
    console.log('filename not provided');
  }
});

fs.exists(path, callback)#

检查指定路径的文件或者目录是否存在。接着通过 callback 传入的参数指明存在 (true) 或者不存在 (false)。示例:

fs.exists('/etc/passwd', function (exists) {
  util.debug(exists ? "存在" : "不存在!");
});

fs.existsSync(path)#

fs.exists 函数的同步版。

Class: fs.Stats#

fs.stat(), fs.lstat() 和 fs.fstat() 以及他们对应的同步版本返回的对象。

• stats.isFile()
• stats.isDirectory()
• stats.isBlockDevice()
• stats.isCharacterDevice()
• stats.isSymbolicLink() (仅在与 fs.lstat()一起使用时合法)
• stats.isFIFO()
• stats.isSocket()

对于一个普通文件使用 util.inspect(stats) 将会返回一个类似如下输出的字符串：

{ dev: 2114,
  ino: 48064969,
  mode: 33188,
  nlink: 1,
  uid: 85,
  gid: 100,
  rdev: 0,
  size: 527,
  blksize: 4096,
  blocks: 8,
  atime: Mon, 10 Oct 2011 23:24:11 GMT,
  mtime: Mon, 10 Oct 2011 23:24:11 GMT,
  ctime: Mon, 10 Oct 2011 23:24:11 GMT,
  birthtime: Mon, 10 Oct 2011 23:24:11 GMT }

请注意 atime, mtime, birthtime, and ctime 是 Date 对象的实例。而且在比较这些对象的值时你应当使用合适的方法。 大部分情况下，使用 getTime() 将会返回自 1 January 1970 00:00:00 UTC 以来逝去的毫秒数， 而且这个整形值应该能满足任何比较的使用条件。但是仍然还有一些额外的方法可以用来显示一些模糊的信息。更多细节请查看 MDN JavaScript Reference 页面。

Stat Time Values#

在状态对象（stat object）中的时间有以下语义：

• atime "Access Time" - 文件数据上次被访问的时间.
  会被 mknod(2), utimes(2), and read(2) 等系统调用改变。
• mtime "Modified Time" - 文件上次被修改的时间。 会被 mknod(2), utimes(2), and write(2) 等系统调用改变。
• ctime "Change Time" - 文件状态上次改变的时间。 (inode data modification). 会被 chmod(2), chown(2), link(2), mknod(2), rename(2), unlink(2), utimes(2), read(2), and write(2) 等系统调用改变。
• birthtime "Birth Time" - 文件被创建的时间。 会在文件被创建时生成。 在一些不提供文件birthtime的文件系统中, 这个字段会被 ctime 或 1970-01-01T00:00Z (ie, unix epoch timestamp 0)来填充。 在 Darwin 和其他 FreeBSD 系统变体中, 也将 atime 显式地设置成比它现在的 birthtime 更早的一个时间值，这个过程使用了utimes(2)系统调用。

在Node v0.12版本之前, ctime 持有Windows系统的 birthtime 值. 注意在v.0.12版本中, ctime 不再是"creation time", 而且在Unix系统中，他从来都不是。

fs.createReadStream(path, [options])#

返回一个新的 ReadStream 对象 (详见 Readable Stream).

options 是一个包含下列缺省值的对象：

{ flags: 'r',
  encoding: null,
  fd: null,
  mode: 0666,
  autoClose: true
}

options 可以提供 start 和 end 值用于读取文件内的特定范围而非整个文件。 start 和 end 都是包含在范围内的（inclusive, 可理解为闭区间）并且以 0 开始。 encoding 可选为 'utf8', 'ascii' 或者 'base64'。

如果 autoClose 为 false 则即使在发生错误时也不会关闭文件描述符 (file descriptor)。 此时你需要负责关闭文件，避免文件描述符泄露 (leak)。 如果 autoClose 为 true （缺省值）， 当发生 error 或者 end 事件时，文件描述符会被自动释放。

一个从100字节的文件中读取最后10字节的例子：

fs.createReadStream('sample.txt', {start: 90, end: 99});

Class: fs.ReadStream#

ReadStream 是一个可读的流(Readable Stream).

事件: 'open'#

• fd {整形} ReadStream 所使用的文件描述符。

当文件的 ReadStream 被创建时触发。

fs.createWriteStream(path, [options])#

返回一个新的 WriteStream 对象 (详见 Writable Stream).

options 是一个包含下列缺省值的对象：

{ flags: 'w',
  encoding: null,
  mode: 0666 }

options 也可以包含一个 start 选项用于指定在文件中开始写入数据的位置。 修改而不替换文件需要 flags 的模式指定为 r+ 而不是默值的 w.

Class: fs.WriteStream#

WriteStream 是一个可写的流(Writable Stream).

事件: 'open'#

• fd {整形} WriteStream 所使用的文件描述符。

当 WriteStream 创建时触发。

file.bytesWritten#

已写的字节数。不包含仍在队列中准备写入的数据。

Class: fs.FSWatcher#

fs.watch() 返回的对象类型。

watcher.close()#

停止观察 fs.FSWatcher 对象中的更改。

事件: 'change'#

• event {字符串} fs 改变的类型
• filename {字符串} 改变的文件名 (if relevant/available)

当正在观察的目录或文件发生变动时触发。更多细节，详见 fs.watch。

事件: 'error'#

• error {Error 对象}

当产生错误时触发

路径 (Path)#

稳定度: 3 - 稳定

本模块包含一套用于处理和转换文件路径的工具集。几乎所有的方法只做字符串变换， 不会调用文件系统检查路径是否有效。

通过 require('path') 来加载此模块。以下是本模块所提供的方法：

path.normalize(p)#

规范化字符串路径，注意 '..' 和 `'.' 部分

多个斜杠会被替换成一个； 路径末尾的斜杠会被保留； Windows 系统上, 会使用反斜杠。

实例：