nodejs api 中文文档


本作品采用知识共享署名-非商业性使用 3.0 未本地化版本许可协议进行许可。

Node.js v0.10.18 手册 & 文档

索引 | 在单一页面中浏览 | JSON格式

目录

显示原文其他翻译纠错

关于本文档#

显示原文其他翻译纠错

本文档的目标是从参考和概念的角度全面解释 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‘)的时候都会返回同一个对象，当然，必须是每次都解析到同一个文件。

显示原文其他翻译纠错

Multiple calls to require(‘foo‘) may not cause the module code to be executed multiple times. This is an important feature. With it, "partially done" objects can be returned, thus allowing transitive dependencies to be loaded even when they would cause cycles.

显示原文其他翻译纠错

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

显示原文其他翻译纠错

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‘);
});

显示原文其他翻译纠错

Note that assignment to module.exports must be done immediately. It cannot be done in any callbacks. This does not work:

显示原文其他翻译纠错

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语句就可以调用。

显示原文其他翻译纠错

在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() 目标，同时流被切换到流动模式，那么数据会流失。

显示原文其他翻译纠错

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

显示原文其他翻译纠错

显示原文其他翻译纠错

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

显示原文其他翻译纠错

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

显示原文其他翻译纠错

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

显示原文其他翻译纠错

一些可读流的例子：

显示原文其他翻译纠错

显示原文其他翻译纠错

事件: ‘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（可写）流接口是对您正在写入数据至一个目标的抽象。

显示原文其他翻译纠错

一些可写流的例子：

显示原文其他翻译纠错

显示原文其他翻译纠错

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‘#

显示原文其他翻译纠错

显示原文其他翻译纠错

该事件发生于可读流的 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 的接口。详见下文用例。

显示原文其他翻译纠错

一些双工流的例子：

显示原文其他翻译纠错

显示原文其他翻译纠错

类: stream.Transform#

显示原文其他翻译纠错

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

显示原文其他翻译纠错

一些转换流的例子：

显示原文其他翻译纠错

显示原文其他翻译纠错

面向流实现者的 API#

显示原文其他翻译纠错

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

显示原文其他翻译纠错

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

显示原文其他翻译纠错

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

显示原文其他翻译纠错


使用情景
类
要实现的方法

只读
Readable
_read

只写
Writable
_write

读写
Duplex
_read, _write

操作被写入数据，然后读出结果
Transform
_transform, _flush

显示原文其他翻译纠错

在您的实现代码中，十分重要的一点是绝对不要调用上文面向流消费者的 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‘ 数据块。

显示原文其他翻译纠错

大多数程序会维持正常功能，然而，这也会在下列条件下引入一种边界情况：

显示原文其他翻译纠错

显示原文其他翻译纠错

举个例子，请留意下面代码：

显示原文其他翻译纠错

// 警告！不能用！
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: docs on creating a CA, for now interested users should just look at test/fixtures/keys/Makefile in the Node source code)

显示原文其他翻译纠错

像这样创建 .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

显示原文其他翻译纠错

Client-initiated renegotiation attack mitigation#

显示原文其他翻译纠错

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) and SNI (Server Name Indication) are TLS handshake extensions allowing you:

显示原文其他翻译纠错

  • NPN - to use one TLS server for multiple protocols (HTTP, SPDY)
  • SNI - to use one TLS server for multiple hostnames with different SSL certificates.

显示原文其他翻译纠错

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: A string or Buffer containing the certificate key of the server in PEM format. (Required)

显示原文其他翻译纠错

  • 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: A string describing the ciphers to use or exclude.

显示原文其他翻译纠错

**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.

显示原文其他翻译纠错

A `‘clientError‘` is emitted on the `tls.Server` object whenever a handshake
times out.

显示原文其他翻译纠错

  • honorCipherOrder : When choosing a cipher, use the server‘s preferences instead of the client preferences.

显示原文其他翻译纠错

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: An array or Buffer of possible NPN protocols. (Protocols should be ordered by their priority).

显示原文其他翻译纠错

  • 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: Host the client should connect to

显示原文其他翻译纠错

  • port: Port the client should connect to

显示原文其他翻译纠错

  • 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: A string or Buffer containing the private key, certificate and CA certs of the server in PFX or PKCS12 format.

显示原文其他翻译纠错

  • key: A string or Buffer containing the private key of the client in PEM format.

显示原文其他翻译纠错

  • passphrase: 私钥或pfx密码的字符串。

显示原文其他翻译纠错

  • cert: A string or Buffer containing the certificate key of the client in PEM format.

显示原文其他翻译纠错

  • 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: Servername for SNI (Server Name Indication) TLS extension.

显示原文其他翻译纠错

  • 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();
});

显示原文其他翻译纠错

类: 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: An optional credentials object from crypto.createCredentials( ... )

显示原文其他翻译纠错

  • isServer: If true - TLS socket will be instantiated in server-mode

显示原文其他翻译纠错

显示原文其他翻译纠错

显示原文其他翻译纠错

显示原文其他翻译纠错

显示原文其他翻译纠错

显示原文其他翻译纠错

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: A credentials object from 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 is the tls.TLSSocket that the error originated from.

显示原文其他翻译纠错

事件: ‘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.

显示原文其他翻译纠错

类: 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 checktlsSocket.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‘ }

显示原文其他翻译纠错

If the peer does not provide a certificate, it returns null or an empty object.

显示原文其他翻译纠错

tlsSocket.getCipher()#

Returns an object representing the cipher name and the SSL/TLS protocol version of the current connection.

显示原文其他翻译纠错

Example: { name: ‘AES256-SHA‘, version: ‘TLSv1/SSLv3‘ }

显示原文其他翻译纠错

See SSL_CIPHER_get_name() and SSL_CIPHER_get_version() inhttp://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.cwdto 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 系统会使用反斜杠。

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

path.normalize(‘/foo/bar//baz/asdf/quux/..‘)
// returns
‘/foo/bar/baz/asdf‘

显示原文其他翻译纠错

path.join([path1], [path2], [...])#

显示原文其他翻译纠错

组合参数中的所有路径，返回规范化后的路径。

显示原文其他翻译纠错

参数必须是字符串。在 v0.8 版本非字符串参数会被悄悄忽略。 在 v0.10 及以后版本将会抛出一个异常。

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

path.join(‘foo‘, {}, ‘bar‘)
// 抛出异常
TypeError: Arguments to path.join must be strings

显示原文其他翻译纠错

path.resolve([from ...], to)#

显示原文其他翻译纠错

将 to 参数解析为一个绝对路径。

显示原文其他翻译纠错

如果to不是一个相对于from 参数的绝对路径，to会被添加到from的右边，直到找出一个绝对路径为止。如果使用from路径且仍没有找到绝对路径时，使用当时路径作为目录。返回的结果已经规范化，得到的路径会去掉结尾的斜杠，除非得到的当前路径为root目录。非字符串参数将被忽略。

显示原文其他翻译纠错

另一种思考方式就是像在shell里面用一系列的‘cd’命令一样.

显示原文其他翻译纠错

path.resolve(‘foo/bar‘, ‘/tmp/file/‘, ‘..‘, ‘a/../subfile‘)

显示原文其他翻译纠错

相当于:

显示原文其他翻译纠错

cd foo/bar
cd /tmp/file/
cd ..
cd a/../subfile
pwd

显示原文其他翻译纠错

不同的是，不同的路径不需要存在的，也可能是文件。

显示原文其他翻译纠错

示例:

显示原文其他翻译纠错

path.resolve(‘wwwroot‘, ‘static_files/png/‘, ‘../gif/image.gif‘)
// 如果当前工作目录为 /home/myself/node，它返回：
‘/home/myself/node/wwwroot/static_files/gif/image.gif‘

显示原文其他翻译纠错

path.isAbsolute(path)#

显示原文其他翻译纠错

判定path是否为绝对路径。一个绝对路径总是指向一个相同的位置，无论当前工作目录是在哪里。

显示原文其他翻译纠错

Posix 示例:

显示原文其他翻译纠错

path.isAbsolute(‘/foo/bar‘) // true
path.isAbsolute(‘/baz/..‘)  // true
path.isAbsolute(‘qux/‘)     // false
path.isAbsolute(‘.‘)        // false

显示原文其他翻译纠错

Windows 示例:

显示原文其他翻译纠错

path.isAbsolute(‘//server‘)  // true
path.isAbsolute(‘C:/foo/..‘) // true
path.isAbsolute(‘bar\\baz‘)   // false
path.isAbsolute(‘.‘)         // false

显示原文其他翻译纠错

path.relative(from, to)#

显示原文其他翻译纠错

解决从from到to的相对路径。

显示原文其他翻译纠错

有时我们有2个绝对路径, 我们需要从中找出相对目录的起源目录。这完全是path.resolve的相反实现,我们可以看看是什么意思:

显示原文其他翻译纠错

path.resolve(from, path.relative(from, to)) == path.resolve(to)

显示原文其他翻译纠错

示例:

显示原文其他翻译纠错

path.relative(‘/data/orandea/test/aaa‘, ‘/data/orandea/impl/bbb‘)
// 返回
‘../../impl/bbb‘

显示原文其他翻译纠错

path.dirname(p)#

显示原文其他翻译纠错

返回路径中文件夹的名称. 类似于Unix的dirname 命令.

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

path.dirname(‘/foo/bar/baz/asdf/quux‘)
// returns
‘/foo/bar/baz/asdf‘

显示原文其他翻译纠错

path.basename(p, [ext])#

显示原文其他翻译纠错

返回路径中的最后哦一部分. 类似于Unix 的 basename 命令.

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

path.basename(‘/foo/bar/baz/asdf/quux.html‘, ‘.html‘)
// returns
‘quux‘

显示原文其他翻译纠错

path.extname(p)#

显示原文其他翻译纠错

返回路径中文件的扩展名, 在从最后一部分中的最后一个‘.‘到字符串的末尾。 如果在路径的最后一部分没有‘.‘，或者第一个字符是‘.‘，就返回一个 空字符串。 例子：

显示原文其他翻译纠错

path.extname(‘index‘)
// returns
‘‘

显示原文其他翻译纠错

path.sep#

显示原文其他翻译纠错

特定平台的文件分隔工具. ‘\\‘ 或者 ‘/‘.

显示原文其他翻译纠错

*nix 上的例子:

显示原文其他翻译纠错

‘foo/bar/baz‘.split(path.sep)
// returns
[‘foo‘, ‘bar‘, ‘baz‘]

显示原文其他翻译纠错

Windows 上的例子:

显示原文其他翻译纠错

‘foo\\bar\\baz‘.split(path.sep)
// returns
[‘foo‘, ‘bar‘, ‘baz‘]

显示原文其他翻译纠错

path.delimiter#

显示原文其他翻译纠错

特定平台的路径分隔符, ; 或者 ‘:‘.

显示原文其他翻译纠错

*nix 上的例子:

显示原文其他翻译纠错

process.env.PATH.split(path.delimiter)
// returns
[‘/usr/bin‘, ‘/bin‘, ‘/usr/sbin‘, ‘/sbin‘, ‘/usr/local/bin‘]

显示原文其他翻译纠错

Windows 上的例子:

显示原文其他翻译纠错

console.log(process.env.PATH)
// ‘C:\Windows\system32;C:\Windows;C:\Program Files\nodejs\‘

显示原文其他翻译纠错

process.env.PATH.split(path.delimiter)
// returns
[‘C:\Windows\system32‘, ‘C:\Windows‘, ‘C:\Program Files\nodejs\‘]

显示原文其他翻译纠错

net#

显示原文其他翻译纠错

稳定度: 3 - 稳定

显示原文其他翻译纠错

The net module provides you with an asynchronous network wrapper. It contains methods for creating both servers and clients (called streams). You can include this module with require(‘net‘);

显示原文其他翻译纠错

net.createServer([options], [connectionListener])#

显示原文其他翻译纠错

创建一个新的 TCP 服务器。参数 connectionListener 会被自动作为 ‘connection‘ 事件的监听器。

显示原文其他翻译纠错

options 是一个包含下列缺省值的对象：

显示原文其他翻译纠错

{ allowHalfOpen: false
}

显示原文其他翻译纠错

如果允许半开连接 allowHalfOpen 被设置为 true，则当另一端的套接字发送 FIN 报文时套接字并不会自动发送 FIN 报文。套接字会变为不可读，但仍然可写。您应当明确地调用 end() 方法。详见 ‘end‘ 事件。

显示原文其他翻译纠错

下面是一个监听 8124 端口连接的应答服务器的例子：

显示原文其他翻译纠错

var net = require(‘net‘);
var server = net.createServer(function(c) { // ‘connection‘ 监听器
  console.log(‘服务器已连接‘);
  c.on(‘end‘, function() {
    console.log(‘服务器已断开‘);
  });
  c.write(‘hello\r\n‘);
  c.pipe(c);
});
server.listen(8124, function() { // ‘listening‘ 监听器
  console.log(‘服务器已绑定‘);
});

显示原文其他翻译纠错

使用 telnet 测试：

显示原文其他翻译纠错

telnet localhost 8124

显示原文其他翻译纠错

要监听套接字 /tmp/echo.sock 仅需更改倒数第三行代码：

显示原文其他翻译纠错

server.listen(‘/tmp/echo.sock‘, function() { // ‘listening‘ 监听器

显示原文其他翻译纠错

使用 nc 连接到一个 UNIX domain 套接字服务器：

显示原文其他翻译纠错

nc -U /tmp/echo.sock

显示原文其他翻译纠错

net.connect(options, [connectionListener])#

net.createConnection(options, [connectionListener])#

显示原文其他翻译纠错

构建一个新的套接字对象并打开所给位置的套接字。当套接字就绪时会触发 ‘connect‘ 事件。

显示原文其他翻译纠错

对于 TCP 套接字，选项 options 参数应为一个指定下列参数的对象：

显示原文其他翻译纠错

  • port：客户端连接到的端口（必须）

显示原文其他翻译纠错

  • host：客户端连接到的主机，缺省为 ‘localhost‘

显示原文其他翻译纠错

  • localAddress：网络连接绑定的本地接口

显示原文其他翻译纠错

  • family：IP 栈版本，缺省为 4

显示原文其他翻译纠错

对于 UNIX domain 套接字，选项 options 参数应当为一个指定下列参数的对象：

显示原文其他翻译纠错

  • path：客户端连接到的路径（必须）

显示原文其他翻译纠错

通用选项：

显示原文其他翻译纠错

  • allowHalfOpen：允许半开连接，如果被设置为 true，则当另一端的套接字发送 FIN 报文时套接字并不会自动发送 FIN 报文。缺省为 false。详见 ‘end‘ 事件。

显示原文其他翻译纠错

connectListener 用于 ‘connect‘ 事件的监听器

显示原文其他翻译纠错

下面是一个上述应答服务器的客户端的例子：

显示原文其他翻译纠错

var net = require(‘net‘);
var client = net.connect({port: 8124},
    function() { //‘connect‘ 监听器
  console.log(‘client connected‘);
  client.write(‘world!\r\n‘);
});
client.on(‘data‘, function(data) {
  console.log(data.toString());
  client.end();
});
client.on(‘end‘, function() {
  console.log(‘客户端断开连接‘);
});

显示原文其他翻译纠错

要连接到套接字 /tmp/echo.sock，仅需将第二行改为

显示原文其他翻译纠错

var client = net.connect({path: ‘/tmp/echo.sock‘},

显示原文其他翻译纠错

net.connect(port, [host], [connectListener])#

net.createConnection(port, [host], [connectListener])#

显示原文其他翻译纠错

创建一个 host 主机 port 端口的 TCP 连接。如果省略 host 则假定为 ‘localhost‘。connectListener参数会被用作 ‘connect‘ 事件的监听器。

显示原文其他翻译纠错

net.connect(path, [connectListener])#

net.createConnection(path, [connectListener])#

显示原文其他翻译纠错

创建一个到路径 path 的 UNIX 套接字连接。connectListener 参数会被用作 ‘connect‘ 事件的监听器。

显示原文其他翻译纠错

类: net.Server#

显示原文其他翻译纠错

该类用于创建一个 TCP 或 UNIX 服务器。服务器本质上是一个可监听传入连接的 net.Socket。

显示原文其他翻译纠错

server.listen(port, [host], [backlog], [callback])#

显示原文其他翻译纠错

在指定端口 port 和主机 host 上开始接受连接。如果省略 host 则服务器会接受来自所有 IPv4 地址（INADDR_ANY）的连接；端口为 0 则会使用分随机分配的端口。

显示原文其他翻译纠错

积压量 backlog 为连接等待队列的最大长度。实际长度由您的操作系统通过 sysctl 设置决定，比如 Linux 上的 tcp_max_syn_backlog 和 somaxconn。该参数缺省值为 511（不是 512）。

显示原文其他翻译纠错

这是一个异步函数。当服务器已被绑定时会触发 ‘listening‘ 事件。最后一个参数 callback 会被用作 ‘listening‘事件的监听器。

显示原文其他翻译纠错

有些用户会遇到的情况是遇到 ‘EADDINUSE‘ 错误。这表示另一个服务器已经运行在所请求的端口上。一个处理这种情况的方法是等待一段时间再重试

显示原文其他翻译纠错

server.on(‘error‘, function (e) {
  if (e.code == ‘EADDRINUSE‘) {
    console.log(‘地址被占用，重试中...‘);
    setTimeout(function () {
      server.close();
      server.listen(PORT, HOST);
    }, 1000);
  }
});

显示原文其他翻译纠错

（注意：Node 中的所有套接字已设置了 SO_REUSEADDR）

显示原文其他翻译纠错

server.listen(path, [callback])#

显示原文其他翻译纠错

启动一个 UNIX 套接字服务器在所给路径 path 上监听连接。

显示原文其他翻译纠错

这是一个异步函数。当服务器已被绑定时会触发 ‘listening‘ 事件。最后一个参数 callback 会被用作 ‘listening‘事件的监听器。

显示原文其他翻译纠错

server.listen(handle, [callback])#

显示原文其他翻译纠错

  • handle处理器 {Object}
  • callback回调函数 {Function}

显示原文其他翻译纠错

handle 变量可以被设置为server 或者 socket(任一以下划线开头的成员 _handle), 或者一个 {fd: <n>} 对象

显示原文其他翻译纠错

这将使服务器用指定的句柄接受连接，但它假设文件描述符或者句柄已经被绑定在特定的端口或者域名套接字。

显示原文其他翻译纠错

Windows 不支持监听一个文件描述符。

显示原文其他翻译纠错

这是一个异步函数。当服务器已被绑定时会触发 ‘listening‘ 事件。最后一个参数 callback 会被用作 ‘listening‘事件的监听器。

显示原文其他翻译纠错

server.close([callback])#

显示原文其他翻译纠错

用于停止服务器接受新连接，但保持已存在的连接。这是一个异步函数， 服务器将在所有的连接都结束后关闭，并且服务器发送 ‘close‘事件 你可以有选择的传入回调函数来监听 ‘close‘事件。

显示原文其他翻译纠错

server.address()#

显示原文其他翻译纠错

返回操作系统报告的绑定的地址，协议族和端口。 对查找操作系统分配的地址哪个端口已被分配非常有用， 如.{ port: 12346, family: ‘IPv4‘, address: ‘127.0.0.1‘ }

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

// 获得随机端口
server.listen(function() {
  address = server.address();
  console.log("opened server on %j", address);
});

显示原文其他翻译纠错

在 ‘listening‘ 事件发生前请勿调用 server.address()。

显示原文其他翻译纠错

server.unref()#

显示原文其他翻译纠错

如果这是事件系统中唯一一个活动的服务器，调用 unref 将允许程序退出。如果服务器已被 unref，则再次调用 unref 并不会产生影响。

显示原文其他翻译纠错

server.ref()#

显示原文其他翻译纠错

与 unref 相反，如果这是仅剩的服务器，在一个之前被 unref 了的服务器上调用 ref 将不会让程序退出（缺省行为）。如果服务器已经被 ref，则再次调用 ref 并不会产生影响。

显示原文其他翻译纠错

server.maxConnections#

显示原文其他翻译纠错

设置这个选项能在当服务器连接数超过数量时拒绝连接。

显示原文其他翻译纠错

这个选项不推荐使用在套接字已经用 child_process.fork()发送给子进程。

显示原文其他翻译纠错

server.connections#

显示原文其他翻译纠错

这个函数已被 废弃; 请用 [server.getConnections()][] 代替. 服务器的当前活动连接的数量。

显示原文其他翻译纠错

当用child_process.fork()发送一个套接字给子进程时，它将是 null 。 要轮询子进程来获取当前活动的连接请用 server.getConnections 代替.

显示原文其他翻译纠错

net.Server 是一个包含下列事件的 EventEmitter :

显示原文其他翻译纠错

server.getConnections(callback)#

显示原文其他翻译纠错

异步获取服务器当前活跃的连接数. 用于套接字呗发送给子进程。

显示原文其他翻译纠错

回调函数需要两个参数 err 和 count.

显示原文其他翻译纠错

事件: ‘listening‘#

显示原文其他翻译纠错

在服务器调用 server.listen绑定后触发。

显示原文其他翻译纠错

事件: ‘connection‘#

显示原文其他翻译纠错

  • {Socket object} 连接对象

显示原文其他翻译纠错

在一个新连接被创建时触发。 socket 是一个net.Socket的实例。

显示原文其他翻译纠错

事件: ‘close‘#

显示原文其他翻译纠错

当服务被关闭时触发. 注意：如果当前仍有活动连接，他个事件将等到所有连接都结束后才触发。

显示原文其他翻译纠错

事件: ‘error‘#

显示原文其他翻译纠错

  • {Error Object}

显示原文其他翻译纠错

当一个错误发生时触发。  ‘close‘ 事件将直接被下列时间调用。 请查看讨论 server.listen的例子。

显示原文其他翻译纠错

类: net.Socket#

显示原文其他翻译纠错

这个对象是一个TCP或UNIX套接字的抽象。  net.Socket 实例实现了一个双工流接口。 他们可以被用户使用在客户端(使用 connect()) 或者它们可以由 Node创建，并通过 ‘connection‘服务器事件传递给用户。

显示原文其他翻译纠错

new net.Socket([options])#

显示原文其他翻译纠错

构造一个新的套接字对象。

显示原文其他翻译纠错

options 是一个包含下列缺省值的对象：

显示原文其他翻译纠错

{ fd: null
  type: null
  allowHalfOpen: false
}

显示原文其他翻译纠错

fd 允许你指定一个存在的文件描述符和套接字。 type 指定一个优先的协议。 他可以是 ‘tcp4‘, ‘tcp6‘, 或 ‘unix‘. 关于 allowHalfOpen, 参见 createServer() 和 ‘end‘ 事件。

显示原文其他翻译纠错

socket.connect(port, [host], [connectListener])#

socket.connect(path, [connectListener])#

显示原文其他翻译纠错

使用传入的套接字打开一个连接 如果 port 和 host 都被传入， 那么套接字将会被已TCP套接字打开，如果 host 被省略, 默认为localhost . 如果 path 被传入, 套接字将会被已指定路径UNIX套接字打开。

显示原文其他翻译纠错

一般情况下这个函数是不需要使用, 比如用 net.createConnection 打开套接字. 只有在您实现了自定义套接字时候才需要。

显示原文其他翻译纠错

这是一个异步函数。 当 ‘connect‘ 触发了的套接字是established状态 .或者在连接的时候出现了一个问题, ‘connect‘ 事件不会被触发， 而 ‘error‘ 事件会触发并发送异常信息。

显示原文其他翻译纠错

connectListener 用于 ‘connect‘ 事件的监听器

显示原文其他翻译纠错

socket.bufferSize#

显示原文其他翻译纠错

是一个net.Socket 的属性，用于 socket.write() . 用于帮助用户获取更快的运行速度。 计算机不能一直处于大量数据被写入状态 —— 网络链接可能会变得过慢。 Node 在内部会排队等候数据被写入套接字并确保传输连接上的数据完好。 (内部实现为：轮询套接字的文件描述符等待它为可写).

显示原文其他翻译纠错

内部缓冲的可能后果是内存使用会增加。这个属性表示了现在处于缓冲区等待被写入的字符数。（字符的数目约等于要被写入的字节数，但是缓冲区可能包含字符串，而字符串是惰性编码的，所以确切的字节数是未知的。）

显示原文其他翻译纠错

遇到数值很大或者增长很快的bufferSize的时候，用户应该尝试用pause()和resume()来控制数据流。

显示原文其他翻译纠错

socket.setEncoding([encoding])#

显示原文其他翻译纠错

设置套接字的编码为一个可读流. 更多信息请查看 stream.setEncoding()

显示原文其他翻译纠错

socket.write(data, [encoding], [callback])#

显示原文其他翻译纠错

在套接字上发送数据。第二参数指明了使用字符串时的编码方式-默认为UTF8编码。

显示原文其他翻译纠错

如果所有数据被成功刷新到内核缓冲区，则返回true。如果所有或部分数据在用户内存里还处于队列中，则返回false。当缓冲区再次被释放时，‘drain‘事件会被分发。 ‘drain‘ will be emitted when the buffer is again free.

显示原文其他翻译纠错

当数据最终被完整写入时，可选的callback参数会被执行 - 但不一定是马上执行。

显示原文其他翻译纠错

socket.end([data], [encoding])#

显示原文其他翻译纠错

半关闭套接字 如., 它发送一个 FIN 包 .可能服务器仍在发送数据。

显示原文其他翻译纠错

如果 data被传入, 等同于调用 socket.write(data, encoding) 然后调用 socket.end().

显示原文其他翻译纠错

socket.destroy()#

显示原文其他翻译纠错

确保没有I/O活动在这个套接字。 只有在错误发生情况下才需要（处理错误等等）。

显示原文其他翻译纠错

socket.pause()#

显示原文其他翻译纠错

暂停读取数据。 ‘data‘ 事件不会被触发。 对于控制上传非常有用。

显示原文其他翻译纠错

socket.resume()#

显示原文其他翻译纠错

在调用 pause()后恢复读操作。

显示原文其他翻译纠错

socket.setTimeout(timeout, [callback])#

显示原文其他翻译纠错

如果套接字超过timeout毫秒处于闲置状态，则将套接字设为超时。默认情况下net.Socket不存在超时。

显示原文其他翻译纠错

当一个闲置超时被触发时，套接字会接收到一个‘timeout‘事件，但是连接将不会被断开。用户必须手动end()或destroy()这个套接字。

显示原文其他翻译纠错

如果timeout为0，那么现有的闲置超时会被禁用。

显示原文其他翻译纠错

可选的callback参数将会被添加成为‘timeout‘事件的一次性监听器。

显示原文其他翻译纠错

socket.setNoDelay([noDelay])#

显示原文其他翻译纠错

禁用纳格（Nagle）算法。默认情况下TCP连接使用纳格算法，这些连接在发送数据之前对数据进行缓冲处理。 将noDelay设成true会在每次socket.write()被调用时立刻发送数据。noDelay默认为true。

显示原文其他翻译纠错

socket.setKeepAlive([enable], [initialDelay])#

显示原文其他翻译纠错

禁用/启用长连接功能，并在第一个在闲置套接字上的长连接probe被发送之前，可选地设定初始延时。enable默认为false。

显示原文其他翻译纠错

设定initialDelay (毫秒)，来设定在收到的最后一个数据包和第一个长连接probe之间的延时。将initialDelay设成0会让值保持不变(默认值或之前所设的值)。默认为0。

显示原文其他翻译纠错

socket.address()#

显示原文其他翻译纠错

返回 socket 绑定的IP地址, 协议类型 (family name) 以及 端口号 (port). 具体是一个包含三个属性的对象, 形如 { port: 12346, family: ‘IPv4‘, address: ‘127.0.0.1‘ }

显示原文其他翻译纠错

socket.unref()#

显示原文其他翻译纠错

如果这是事件系统中唯一一个活动的套接字，调用 unref 将允许程序退出。如果套接字已被 unref，则再次调用 unref 并不会产生影响。

显示原文其他翻译纠错

socket.ref()#

显示原文其他翻译纠错

与 unref 相反，如果这是仅剩的套接字，在一个之前被 unref 了的套接字上调用 ref 将不会让程序退出（缺省行为）。如果一个套接字已经被 ref，则再次调用 ref 并不会产生影响。

显示原文其他翻译纠错

socket.remoteAddress#

显示原文其他翻译纠错

远程IP地址的字符串表示。例如，‘74.125.127.100‘或 ‘2001:4860:a005::68‘。

显示原文其他翻译纠错

socket.remotePort#

显示原文其他翻译纠错

远程端口的数值表示。例如，80 或 21。

显示原文其他翻译纠错

socket.localAddress#

显示原文其他翻译纠错

远程客户端正在连接的本地IP地址的字符串表示。例如，如果你在监听‘0.0.0.0‘而客户端连接在‘192.168.1.1‘，这个值就会是 ‘192.168.1.1‘。

显示原文其他翻译纠错

socket.localPort#

显示原文其他翻译纠错

本地端口的数值表示。比如80 或 21。

显示原文其他翻译纠错

socket.bytesRead#

显示原文其他翻译纠错

所接收的字节数。

显示原文其他翻译纠错

socket.bytesWritten#

显示原文其他翻译纠错

所发送的字节数。

显示原文其他翻译纠错

net.Socket实例是带有以下事件的EventEmitter对象：

显示原文其他翻译纠错

事件: ‘lookup‘#

显示原文其他翻译纠错

这个事件在解析主机名之后，连接主机之前被分发。对UNIX套接字不适用。

显示原文其他翻译纠错

  • err {Error | Null} 错误对象。见[dns.lookup()][]。
  • address {String} IP地址。
  • family {String | Null} 得知类型。见[dns.lookup()][]。

显示原文其他翻译纠错

事件: ‘connect‘#

显示原文其他翻译纠错

该事件在一个套接字连接成功建立后被分发。见connect()。

显示原文其他翻译纠错

事件: ‘data‘#

显示原文其他翻译纠错

  • {Buffer object}

显示原文其他翻译纠错

当收到数据时被分发。data参数会是一个Buffer或String对象。数据的编码方式由socket.setEncoding()设定。 （详见 [可读流][] 章节）

显示原文其他翻译纠错

请注意，如果一个Socket对象分发一个‘data‘事件时没有任何监听器存在，则 数据会丢失。

显示原文其他翻译纠错

事件: ‘end‘#

显示原文其他翻译纠错

当套接字的另一端发送FIN包时，该事件被分发。

显示原文其他翻译纠错

默认情况下 （allowHalfOpen == false），当套接字完成待写入队列中的任务时，它会destroy文件描述符。然而，如果把allowHalfOpen设成true，那么套接字将不会从它这边自动调用end()，使得用户可以随意写入数据，但同时使得用户自己需要调用end()。

显示原文其他翻译纠错

事件: ‘timeout‘#

显示原文其他翻译纠错

当套接字因为非活动状态而超时时该事件被分发。这只是用来表明套接字处于空闲状态。用户必须手动关闭这个连接。

显示原文其他翻译纠错

参阅：socket.setTimeout()

显示原文其他翻译纠错

事件: ‘drain‘#

显示原文其他翻译纠错

当写入缓冲被清空时产生。可被用于控制上传流量。

显示原文其他翻译纠错

参阅：socket.write() 的返回值

显示原文其他翻译纠错

事件: ‘error‘#

显示原文其他翻译纠错

  • {Error object}

显示原文其他翻译纠错

当一个错误发生时产生。‘close‘ 事件会紧接着该事件被触发。

显示原文其他翻译纠错

事件: ‘close‘#

显示原文其他翻译纠错

  • had_error {Boolean} 如果套接字发生了传输错误则此字段为true

显示原文其他翻译纠错

当套接字完全关闭时该事件被分发。参数had_error是一个布尔值，表示了套接字是否因为一个传输错误而被关闭。

显示原文其他翻译纠错

net.isIP(input)#

显示原文其他翻译纠错

测试 input 是否 IP 地址。无效字符串返回 0；IP 版本 4 地址返回 4；IP 版本 6 地址返回 6。

显示原文其他翻译纠错

net.isIPv4(input)#

显示原文其他翻译纠错

如果 input 为版本 4 地址则返回 true，否则返回 false。

显示原文其他翻译纠错

net.isIPv6(input)#

显示原文其他翻译纠错

如果 input 为版本 6 地址则返回 true，否则返回 false。

显示原文其他翻译纠错

显示原文其他翻译纠错

UDP / 数据报套接字#

显示原文其他翻译纠错

稳定度: 3 - 稳定

显示原文其他翻译纠错

数据报套接字通过 require(‘dgram‘) 提供。

显示原文其他翻译纠错

重要提醒：dgram.Socket#bind() 的行为在 v0.10 中已改变，并且现在它总是异步的。如果您的代码看起来像这样：

显示原文其他翻译纠错

var s = dgram.createSocket(‘udp4‘);
s.bind(1234);
s.addMembership(‘224.0.0.114‘);

显示原文其他翻译纠错

您需要将它改成这样：

显示原文其他翻译纠错

var s = dgram.createSocket(‘udp4‘);
s.bind(1234, function() {
  s.addMembership(‘224.0.0.114‘);
});

显示原文其他翻译纠错

dgram.createSocket(type, [callback])#

显示原文其他翻译纠错

  • type String 可以是 ‘udp4‘ 或 ‘udp6‘
  • callback Function 可选，会被作为 message 事件的监听器。
  • 返回：Socket 对象

显示原文其他翻译纠错

创建一个指定类型的数据报 Socket。有效类型包括 udp4 和 udp6。

显示原文其他翻译纠错

接受一个可选的回调，会被添加为 message 事件的监听器。

显示原文其他翻译纠错

如果您想接收数据报则可调用 socket.bind。socket.bind() 会绑定到“所有网络接口”地址的一个随机端口（udp4 和 udp6 皆是如此）。然后您可以通过 socket.address().address 和 socket.address().port来取得地址和端口。

显示原文其他翻译纠错

类: dgram.Socket#

显示原文其他翻译纠错

dgram Socket 类封装了数据报功能，可以通过 dgram.createSocket(type, [callback]) 创建。

显示原文其他翻译纠错

事件: ‘message‘#

显示原文其他翻译纠错

  • msg Buffer 对象，消息
  • rinfo Object，远程地址信息

显示原文其他翻译纠错

当套接字中有新的数据报时发生。msg 是一个 Buffer，rinfo 是一个包含了发送者地址信息的对象：

显示原文其他翻译纠错

socket.on(‘message‘, function(msg, rinfo) {
  console.log(‘收到 %d 字节，来自 %s:%d\n‘,
              msg.length, rinfo.address, rinfo.port);
});

显示原文其他翻译纠错

事件: ‘listening‘#

显示原文其他翻译纠错

当一个套接字开始监听数据报时产生。它会在 UDP 套接字被创建时发生。

显示原文其他翻译纠错

事件: ‘close‘#

显示原文其他翻译纠错

当一个套接字被 close() 关闭时产生。之后这个套接字上不会再有 message 事件发生。

显示原文其他翻译纠错

事件: ‘error‘#

显示原文其他翻译纠错

  • exception Error 对象

显示原文其他翻译纠错

当发生错误时产生。

显示原文其他翻译纠错

socket.send(buf, offset, length, port, address, [callback])#

显示原文其他翻译纠错

  • buf Buffer 对象，要发送的消息
  • offset Integer，Buffer 中消息起始偏移值。
  • length Integer，消息的字节数。
  • port Integer，目标端口
  • address String，目标 IP
  • callback Function，可选，当消息被投递后的回调。

显示原文其他翻译纠错

对于 UDP 套接字，必须指定目标端口和 IP 地址。address 参数可以是一个字符串，它会被 DNS 解析。可选地可以指定一个回调以用于发现任何 DNS 错误或当 buf 可被重用。请注意 DNS 查询会将发送的时间推迟到至少下一个事件循环。确认发送完毕的唯一已知方法是使用回调。

显示原文其他翻译纠错

如果套接字之前并未被调用 bind 绑定，则它会被分配一个随机端口并绑定到“所有网络接口”地址（udp4 套接字是 0.0.0.0；udp6 套接字是 ::0）。

显示原文其他翻译纠错

向 localhost 随机端口发送 UDP 报文的例子：

显示原文其他翻译纠错

var dgram = require(‘dgram‘);
var message = new Buffer("Some bytes");
var client = dgram.createSocket("udp4");
client.send(message, 0, message.length, 41234, "localhost", function(err) {
  client.close();
});

显示原文其他翻译纠错

关于 UDP 数据报大小的注意事项

显示原文其他翻译纠错

一个 IPv4/v6 数据报的最大大小取决与 MTU（最大传输单位）和 Payload Length 字段大小。

显示原文其他翻译纠错

  • Payload Length 字段宽 16 bits，意味着正常负载包括网络头和数据不能大于 64K（65,507 字节 = 65,535 − 8 字节 UDP 头 − 20 字节 IP 头）；这对环回接口通常是真的，但如此大的数据报对大多数主机和网络来说是不切实际的。

显示原文其他翻译纠错

  • MTU 是一个给定的数据链路层技术能为数据报提供支持的最大大小。对于任何连接，IPv4 允许最小 68 字节的 MTU，而 IPv4 所推荐的 MTU 为 576（通常作为拨号类应用的推荐 MTU），无论它们是完整接收还是分片。

显示原文其他翻译纠错

对于 IPv6，最小的 MTU 为 1280 字节，但所允许的最小碎片重组缓冲大小为 1500 字节。 68 的值是非常小的，因为现在大多数数据链路层技术有都具有 1500 的最小 MTU（比如以太网）。

显示原文其他翻译纠错

请注意我们不可能提前得知一个报文可能经过的每一个连接 MTU，因此通常情况下不能发送一个大于（接收者的）MTU 的数据报（报文会被悄悄地丢掉，而不会将数据没有到达它意图的接收者的消息告知来源）。

显示原文其他翻译纠错

socket.bind(port, [address], [callback])#

显示原文其他翻译纠错

  • port Integer
  • address String，可选
  • callback 没有参数的 Function，可选，当绑定完成时被调用。

显示原文其他翻译纠错

对于 UDP 套接字，在一个具名端口 port 和可选的地址 address 上监听数据报。如果 address 未指定，则操作系统会尝试监听所有地址。当绑定完成后，一个 "listening" 事件会发生，并且回调 callback（如果指定）会被调用。同时指定 "listening" 事件监听器和 callback 并不会产生副作用，但也没什么用。

显示原文其他翻译纠错

一个绑定了的数据报套接字会保持 node 进程运行来接收数据报。

显示原文其他翻译纠错

如果绑定失败，则一个 "error" 事件会被产生。在极少情况下（比如绑定一个已关闭的套接字），该方法会抛出一个 Error。

显示原文其他翻译纠错

一个监听端口 41234 的 UDP 服务器的例子：

显示原文其他翻译纠错

server.bind(41234);
// 服务器正在监听 0.0.0.0:41234

显示原文其他翻译纠错

socket.close()#

显示原文其他翻译纠错

关闭底层套接字并停止监听数据。

显示原文其他翻译纠错

socket.address()#

显示原文其他翻译纠错

返回一个包含了套接字地址信息的对象。对于 UDP 套接字，该对象会包含地址 address、地址族 family 和端口号 port。

显示原文其他翻译纠错

socket.setBroadcast(flag)#

显示原文其他翻译纠错

  • flag Boolean

显示原文其他翻译纠错

设置或清除 SO_BROADCAST 套接字选项。当该选项被设置，则 UDP 报文可能被发送到一个本地接口的广播地址。

显示原文其他翻译纠错

socket.setTTL(ttl)#

显示原文其他翻译纠错

  • ttl Integer

显示原文其他翻译纠错

设置 IP_TTL 套接字选项。TTL 表示“Time to Live”（生存时间），但在此上下文中它指的是报文允许通过的 IP 跃点数。各个转发报文的路由器或网关都会递减 TTL。如果 TTL 被一个路由器递减到 0，则它将不会被转发。改变 TTL 值通常被用于网络探测器或多播。

显示原文其他翻译纠错

setTTL() 的参数为介于 1 至 255 的跃点数。在大多数系统上缺省值为 64。

显示原文其他翻译纠错

socket.setMulticastTTL(ttl)#

显示原文其他翻译纠错

  • ttl Integer

显示原文其他翻译纠错

设置 IP_MULTICAST_TTL 套接字选项。TTL 表示“Time to Live”（生存时间），但在此上下文中它指的是报文允许通过的 IP 跃点数，特别是组播流量。各个转发报文的路由器或网关都会递减 TTL。如果 TTL 被一个路由器递减到 0，则它将不会被转发。

显示原文其他翻译纠错

setMulticastTTL() 的参数为介于 1 至 255 的跃点数。在大多数系统上缺省值为 1。

显示原文其他翻译纠错

socket.setMulticastLoopback(flag)#

显示原文其他翻译纠错

  • flag Boolean

显示原文其他翻译纠错

设置或清除 IP_MULTICAST_LOOP 套接字选项。当该选项被设置时，组播报文也会被本地接口收到。

显示原文其他翻译纠错

socket.addMembership(multicastAddress, [multicastInterface])#

显示原文其他翻译纠错

  • multicastAddress String
  • multicastInterface String，可选

显示原文其他翻译纠错

以 IP_ADD_MEMBERSHIP 套接字选项告诉内核加入一个组播分组。

显示原文其他翻译纠错

如果未指定 multicastInterface，则操作系统会尝试向所有有效接口添加关系。

显示原文其他翻译纠错

socket.dropMembership(multicastAddress, [multicastInterface])#

显示原文其他翻译纠错

  • multicastAddress String
  • multicastInterface String，可选

显示原文其他翻译纠错

与 addMembership 相反，以 IP_DROP_MEMBERSHIP 套接字选项告诉内核退出一个组播分组。当套接字被关闭或进程结束时内核会自动调用，因此大多数应用都没必要调用它。

显示原文其他翻译纠错

如果未指定 multicastInterface，则操作系统会尝试向所有有效接口移除关系。

显示原文其他翻译纠错

socket.unref()#

显示原文其他翻译纠错

如果这是事件系统中唯一一个活动的套接字，调用 unref 将允许程序退出。如果套接字已被 unref，则再次调用 unref 并不会产生影响。

显示原文其他翻译纠错

socket.ref()#

显示原文其他翻译纠错

与 unref 相反，如果这是仅剩的套接字，在一个之前被 unref 了的套接字上调用 ref 将不会让程序退出（缺省行为）。如果一个套接字已经被 ref，则再次调用 ref 并不会产生影响。

显示原文其他翻译纠错

DNS#

显示原文其他翻译纠错

稳定度: 3 - 稳定

显示原文其他翻译纠错

使用 require(‘dns‘) 引入此模块。dns 模块中的所有方法都使用了 C-Ares，除了 dns.lookup 使用了线程池中的 getaddrinfo(3)。C-Ares 比 getaddrinfo 要快得多，但系统解析器相对于其它程序的操作要更固定。当一个用户使用 net.connect(80, ‘google.com‘) 或 http.get({ host: ‘google.com‘ }) 时会使用 dns.lookup 方法。如果用户需要进行大量的快速查询，则最好使用 C-Ares 提供的方法。

显示原文其他翻译纠错

下面是一个解析 ‘www.google.com‘ 并反向解析所返回 IP 地址的例子。

显示原文其他翻译纠错

      console.log(‘反向解析 ‘ + a + ‘: ‘ + JSON.stringify(domains));
    });
  });
});

显示原文其他翻译纠错

dns.lookup(domain, [family], callback)#

显示原文其他翻译纠错

将一个域名（比如 ‘google.com‘）解析为第一个找到的 A 记录（IPv4）或 AAAA 记录（IPv6）。地址族 family 可以是数字 4 或 6，缺省为 null 表示同时允许 IPv4 和 IPv6 地址族。

显示原文其他翻译纠错

回调参数为 (err, address, family)。地址 address 参数为一个代表 IPv4 或 IPv6 地址的字符串。地址族 family 参数为数字 4 或 6，地表 address 的地址族（不一定是之前传入 lookup 的值）。

显示原文其他翻译纠错

当错误发生时，err 为一个 Error 对象，其中 err.code 为错误代码。请记住 err.code 被设定为 ‘ENOENT‘ 的情况不仅是域名不存在，也可能是查询在其它途径出错，比如没有可用文件描述符时。

显示原文其他翻译纠错

dns.resolve(domain, [rrtype], callback)#

显示原文其他翻译纠错

将一个域名（比如 ‘google.com‘）解析为一个 rrtype 指定记录类型的数组。有效 rrtypes 取值有 ‘A‘（IPv4 地址，缺省）、‘AAAA‘（IPv6 地址）、‘MX‘（邮件交换记录）、‘TXT‘（文本记录）、‘SRV‘（SRV 记录）、‘PTR‘（用于 IP 反向查找）、‘NS‘（域名服务器记录）和 ‘CNAME‘（别名记录）。

显示原文其他翻译纠错

回调参数为 (err, addresses)。其中 addresses 中每一项的类型取决于记录类型，详见下文对应的查找方法。

显示原文其他翻译纠错

当出错时，err 参数为一个 Error 对象，其中 err.code 为下文所列出的错误代码之一。

显示原文其他翻译纠错

dns.resolve4(domain, callback)#

显示原文其他翻译纠错

于 dns.resolve() 一样，但只用于查询 IPv4（A 记录）。addresses 是一个 IPv4 地址的数组（比如 [‘74.125.79.104‘, ‘74.125.79.105‘, ‘74.125.79.106‘]）。

显示原文其他翻译纠错

dns.resolve6(domain, callback)#

显示原文其他翻译纠错

类似于 dns.resolve4()，但用于 IPv6（AAAA）查询。

显示原文其他翻译纠错

dns.resolveMx(domain, callback)#

显示原文其他翻译纠错

类似于 dns.resolve()，但用于邮件交换查询（MX 记录）。

显示原文其他翻译纠错

addresses 为一个 MX 记录的数组，每一项包含优先级和交换属性（比如 [{‘priority‘: 10, ‘exchange‘: ‘mx.example.com‘},...]）。

显示原文其他翻译纠错

dns.resolveTxt(domain, callback)#

显示原文其他翻译纠错

与 dns.resolve() 相似，但用于文本查询（TXT 记录）。addresses 为 domain 可用文本记录的数组（比如 [‘v=spf1 ip4:0.0.0.0 ~all‘]）。

显示原文其他翻译纠错

dns.resolveSrv(domain, callback)#

显示原文其他翻译纠错

查询 SRV 记录，与 dns.resolve() 相似。 addresses 是域名 domain 可用的 SRV 记录数组， 每一条记录都包含优先级（priority）、权重（weight）、端口号（port）、服务名称（name）等属性 (比如： [{‘priority‘: 10, {‘weight‘: 5, ‘port‘: 21223, ‘name‘: ‘service.example.com‘}, ...])。

显示原文其他翻译纠错

dns.resolveNs(domain, callback)#

显示原文其他翻译纠错

查询 NS 记录，与 dns.resolve() 相似。 addresses 是域名 domain 可用的 NS 记录数组， (比如： [‘ns1.example.com‘, ‘ns2.example.com‘]).

显示原文其他翻译纠错

dns.resolveCname(domain, callback)#

显示原文其他翻译纠错

查询 CNAME 记录，与 dns.resolve() 相似。 addresses 是域名 domain 可用的 CNAME 记录数组， (比如： [‘bar.example.com‘]).

显示原文其他翻译纠错

dns.reverse(ip, callback)#

显示原文其他翻译纠错

反向解析 IP 地址，返回指向该 IP 地址的域名数组。

显示原文其他翻译纠错

回调函数接收两个参数： (err, domains).

显示原文其他翻译纠错

当出错时，err 参数为一个 Error 对象，其中 err.code 为下文所列出的错误代码之一。

显示原文其他翻译纠错

dns.getServers()#

显示原文其他翻译纠错

已字符串返回一个当前用于解析的 IP 地址的数组。

显示原文其他翻译纠错

dns.setServers(servers)#

显示原文其他翻译纠错

指定一个 IP 地址字符串数组，将它们作为解析所用的服务器。

显示原文其他翻译纠错

如果您在地址中指定了端口，则端口会被忽略，因为底层库并不支持。

显示原文其他翻译纠错

如果您传入无效参数，则会抛出异常。

显示原文其他翻译纠错

错误代码#

显示原文其他翻译纠错

每个 DNS 查询都可能返回下列错误代码之一：

显示原文其他翻译纠错

  • dns.NODATA: DNS 服务器返回无数据应答。
  • dns.FORMERR: DNS 声称查询格式错误。
  • dns.SERVFAIL: DNS 服务器返回一般失败。
  • dns.NOTFOUND: 域名未找到。
  • dns.NOTIMP: DNS 服务器未实现所请求操作。
  • dns.REFUSED: DNS 服务器拒绝查询。
  • dns.BADQUERY: DNS 查询格式错误。
  • dns.BADNAME: 域名格式错误。
  • dns.BADFAMILY: 不支持的地址类型。
  • dns.BADRESP: DNS 答复格式错误。
  • dns.CONNREFUSED: 无法联系 DNS 服务器。
  • dns.TIMEOUT: 联系 DNS 服务器超时。
  • dns.EOF: 文件末端。
  • dns.FILE: 读取文件错误。
  • dns.NOMEM: 超出内存。
  • dns.DESTRUCTION: 通道正在被销毁。
  • dns.BADSTR: 字符串格式错误。
  • dns.BADFLAGS: 指定了非法标记。
  • dns.NONAME: 所给主机名非数字。
  • dns.BADHINTS: 指定了非法提示标记。
  • dns.NOTINITIALIZED: c-ares 库初始化尚未进行。
  • dns.LOADIPHLPAPI: 加载 iphlpapi.dll 出错。
  • dns.ADDRGETNETWORKPARAMS: 无法找到 GetNetworkParams 函数。
  • dns.CANCELLED: DNS 查询取消。

显示原文其他翻译纠错

HTTP#

显示原文其他翻译纠错

稳定度: 3 - 稳定

显示原文其他翻译纠错

要使用HTTP服务器或客户端功能，需引用此模块require(‘http‘).

显示原文其他翻译纠错

Node中的HTTP接口的设计支持许多HTTP协议中原本用起来很困难的特性.特别是对于很大的或者块编码的消息.这些接口很谨慎,它从来不会完全缓存整个请求(request)或响应(response),这样用户可以在请求(request)或响应(response)中使用数据流.

显示原文其他翻译纠错

HTTP 的消息头(Headers)通过如下对象来表示:

显示原文其他翻译纠错

{ ‘content-length‘: ‘123‘,
  ‘content-type‘: ‘text/plain‘,
  ‘connection‘: ‘keep-alive‘,
  ‘host‘: ‘mysite.com‘,
  ‘accept‘: ‘*/*‘ }

显示原文其他翻译纠错

其中键为小写字母，值是不能修改的。

显示原文其他翻译纠错

为了能全面地支持可能的HTTP应用程序，Node提供的HTTP API都很底层。它处理的只有流处理和消息解析。它把一份消息解析成报文头和报文体，但是它不解析实际的报文头和报文体。

显示原文其他翻译纠错

定义好的消息头允许多个值以,分割, 除了set-cookie和cookie,因为他们表示值的数组. 像 content-length这样只能有单个值的消息头直接解析, 并且只有单值可以表示成已解析好的对像.

显示原文其他翻译纠错

接收到的原始头信息以数组形式 [key, value, key2, value2, ...] 保存在 rawHeaders 属性中. 例如, 前面提到的消息对象会有 rawHeaders 列表如下:

显示原文其他翻译纠错

[ ‘ConTent-Length‘, ‘123456‘,
  ‘content-LENGTH‘, ‘123‘,
  ‘content-type‘, ‘text/plain‘,
  ‘CONNECTION‘, ‘keep-alive‘,
  ‘Host‘, ‘mysite.com‘,
  ‘accepT‘, ‘*/*‘ ]

显示原文其他翻译纠错

http.STATUS_CODES#

显示原文其他翻译纠错

  • {Object}

显示原文其他翻译纠错

全部标准HTTP响应状态码的集合和简短描述。例如http.STATUS_CODES[404] === ‘Not Found‘。

显示原文其他翻译纠错

http.createServer([requestListener])#

显示原文其他翻译纠错

返回一个新的web服务器对象

显示原文其他翻译纠错

参数 requestListener 是一个函数,它将会自动加入到 ‘request‘ 事件的监听队列.

显示原文其他翻译纠错

http.createClient([port], [host])#

显示原文其他翻译纠错

该函数已弃用,请用http.request()代替. 创建一个新的HTTP客户端. port 和host 表示所连接的服务器.

显示原文其他翻译纠错

Class: http.Server#

显示原文其他翻译纠错

这是一个包含下列事件的EventEmitter:

显示原文其他翻译纠错

事件 : ‘request‘#

显示原文其他翻译纠错

function (request, response) { }

显示原文其他翻译纠错

每次收到一个请求时触发.注意每个连接又可能有多个请求(在keep-alive的连接中).request是http.IncomingMessage的一个实例.response是http.ServerResponse的一个实例

显示原文其他翻译纠错

事件: ‘connection‘#

显示原文其他翻译纠错

function (socket) { }

显示原文其他翻译纠错

新的TCP流建立时出发。 socket是一个net.Socket对象。 通常用户无需处理该事件。 特别注意，协议解析器绑定套接字时采用的方式使套接字不会出发readable事件。 还可以通过request.connection访问socket。

显示原文其他翻译纠错

事件: ‘close‘#

显示原文其他翻译纠错

function () { }

显示原文其他翻译纠错

当此服务器关闭时触发

显示原文其他翻译纠错

Event: ‘checkContinue‘#

显示原文其他翻译纠错

function (request, response) { }

显示原文其他翻译纠错

每当收到Expect: 100-continue的http请求时触发。 如果未监听该事件，服务器会酌情自动发送100 Continue响应。

显示原文其他翻译纠错

处理该事件时，如果客户端可以继续发送请求主体则调用response.writeContinue， 如果不能则生成合适的HTTP响应（例如，400 请求无效）。

显示原文其他翻译纠错

需要注意到, 当这个事件触发并且被处理后, request 事件将不再会触发.

显示原文其他翻译纠错

事件: ‘connect‘#

显示原文其他翻译纠错

function (request, socket, head) { }

显示原文其他翻译纠错

每当客户端发起CONNECT请求时出发。如果未监听该事件，客户端发起CONNECT请求时连接会被关闭。

显示原文其他翻译纠错

  • request 是该HTTP请求的参数，与request事件中的相同。
  • socket 是服务端与客户端之间的网络套接字。
  • head 是一个Buffer实例，隧道流的第一个包，该参数可能为空。

显示原文其他翻译纠错

在这个事件被分发后，请求的套接字将不会有data事件监听器，也就是说你将需要绑定一个监听器到data事件，来处理在套接字上被发送到服务器的数据。

显示原文其他翻译纠错

Event: ‘upgrade‘#

显示原文其他翻译纠错

function (request, socket, head) { }

显示原文其他翻译纠错

每当一个客户端请求http升级时，该事件被分发。如果这个事件没有被监听，那么这些请求升级的客户端的连接将会被关闭。

显示原文其他翻译纠错

  • request 是该HTTP请求的参数，与request事件中的相同。
  • socket 是服务端与客户端之间的网络套接字。
  • head 是一个Buffer实例，升级后流的第一个包，该参数可能为空。

显示原文其他翻译纠错

在这个事件被分发后，请求的套接字将不会有data事件监听器，也就是说你将需要绑定一个监听器到data事件，来处理在套接字上被发送到服务器的数据。

显示原文其他翻译纠错

Event: ‘clientError‘#

显示原文其他翻译纠错

function (exception, socket) { }

显示原文其他翻译纠错

如果一个客户端连接触发了一个 ‘error‘ 事件, 它就会转发到这里.

显示原文其他翻译纠错

socket 是导致错误的 net.Socket 对象。

显示原文其他翻译纠错

server.listen(port, [hostname], [backlog], [callback])#

显示原文其他翻译纠错

开始在指定的主机名和端口接收连接。如果省略主机名，服务器会接收指向任意IPv4地址的链接（INADDR_ANY）。

显示原文其他翻译纠错

监听一个 unix socket, 需要提供一个文件名而不是端口号和主机名。

显示原文其他翻译纠错

积压量 backlog 为连接等待队列的最大长度。实际长度由您的操作系统通过 sysctl 设置决定，比如 Linux 上的 tcp_max_syn_backlog 和 somaxconn。该参数缺省值为 511（不是 512）。

显示原文其他翻译纠错

这个函数是异步的。最后一个参数callback会被作为事件监听器添加到 ‘listening‘事件。另见net.Server.listen(port)。

显示原文其他翻译纠错

server.listen(path, [callback])#

显示原文其他翻译纠错

启动一个 UNIX 套接字服务器在所给路径 path 上监听连接。

显示原文其他翻译纠错

该函数是异步的.最后一个参数callback将会加入到[listening][]事件的监听队列中.又见net.Server.listen(path).

显示原文其他翻译纠错

server.listen(handle, [callback])#

显示原文其他翻译纠错

  • handle处理器 {Object}
  • callback回调函数 {Function}

显示原文其他翻译纠错

handle 变量可以被设置为server 或者 socket(任一以下划线开头的成员 _handle), 或者一个 {fd: <n>} 对象

显示原文其他翻译纠错

这将使服务器用指定的句柄接受连接，但它假设文件描述符或者句柄已经被绑定在特定的端口或者域名套接字。

显示原文其他翻译纠错

Windows 不支持监听一个文件描述符。

显示原文其他翻译纠错

这个函数是异步的。最后一个参数callback会被作为事件监听器添加到‘listening‘事件。另见net.Server.listen()。

显示原文其他翻译纠错

server.close([callback])#

显示原文其他翻译纠错

禁止服务端接收新的连接. 查看 net.Server.close().

显示原文其他翻译纠错

server.maxHeadersCount#

显示原文其他翻译纠错

最大请求头数目限制, 默认 1000 个. 如果设置为0, 则代表不做任何限制.

显示原文其他翻译纠错

server.setTimeout(msecs, callback)#

显示原文其他翻译纠错

  • msecs {Number}
  • callback {Function}

显示原文其他翻译纠错

为套接字设定超时值。如果一个超时发生，那么Server对象上会分发一个‘timeout‘事件，同时将套接字作为参数传递。

显示原文其他翻译纠错

如果在Server对象上有一个‘timeout‘事件监听器，那么它将被调用，而超时的套接字会作为参数传递给这个监听器。

显示原文其他翻译纠错

默认情况下，服务器的超时时间是2分钟，超时后套接字会自动销毁。 但是如果为‘timeout’事件指定了回调函数，你需要负责处理套接字超时。

显示原文其他翻译纠错

server.timeout#

显示原文其他翻译纠错

  • {Number} 默认 120000 (2 分钟)

显示原文其他翻译纠错

一个套接字被判断为超时之前的闲置毫秒数。

显示原文其他翻译纠错

注意套接字的超时逻辑在连接时被设定，所以更改这个值只会影响新创建的连接，而不会影响到现有连接。

显示原文其他翻译纠错

设置为0将阻止之后建立的连接的一切自动超时行为。

显示原文其他翻译纠错

Class: http.ServerResponse#

显示原文其他翻译纠错

这是一个由HTTP服务器内部创建的对象（不是由用户自行创建）。它将作为第二个参数传递到‘request‘事件中。

显示原文其他翻译纠错

该响应实现了 Writable Stream 接口。这是一个包含下列事件的 EventEmitter ：

显示原文其他翻译纠错

事件: ‘close‘#

显示原文其他翻译纠错

function () { }

显示原文其他翻译纠错

Indicates that the underlying connection was terminated before response.end() was called or able to flush.

显示原文其他翻译纠错

response.writeContinue()#

显示原文其他翻译纠错

Sends a HTTP/1.1 100 Continue message to the client, indicating that the request body should be sent. See the ‘checkContinue‘ event on Server.

显示原文其他翻译纠错

response.writeHead(statusCode, [reasonPhrase], [headers])#

显示原文其他翻译纠错

向请求回复响应头. statusCode是一个三位是的HTTP状态码, 例如 404. 最后一个参数, headers, 是响应头的内容. 可以选择性的，把人类可读的‘原因短句’作为第二个参数。

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

var body = ‘hello world‘;
response.writeHead(200, {
  ‘Content-Length‘: body.length,
  ‘Content-Type‘: ‘text/plain‘ });

显示原文其他翻译纠错

这个方法只能在当前请求中使用一次，并且必须在response.end()之前调用。

显示原文其他翻译纠错

如果你在调用这之前调用了response.write()或者 response.end() , 就会调用这个函数，并且 不明/容易混淆 的头将会被使用。

显示原文其他翻译纠错

注意：Content-Length 是以字节(byte)计，而不是以字符(character)计。之前的例子奏效的原因是字符串‘hello world‘只包含了单字节的字符。如果body包含了多字节编码的字符，就应当使用Buffer.byteLength()来确定在多字节字符编码情况下字符串的字节数。需要进一步说明的是Node不检查Content-Lenth属性和已传输的body长度是否吻合。

显示原文其他翻译纠错

response.setTimeout(msecs, callback)#

显示原文其他翻译纠错

  • msecs {Number}
  • callback {Function}

显示原文其他翻译纠错

设定套接字的超时时间为msecs。如果提供了回调函数，会将其添加为响应对象的‘timeout‘事件的监听器。

显示原文其他翻译纠错

如果请求、响应、服务器均未添加‘timeout‘事件监听，套接字将在超时时被销毁。 如果监听了请求、响应、服务器之一的‘timeout‘事件，需要自行处理超时的套接字。

显示原文其他翻译纠错

response.statusCode#

显示原文其他翻译纠错

当使用默认headers时（没有显式地调用 response.writeHead() 来修改headers），这个属性决定headers更新时被传回客户端的HTTP状态码。

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

response.statusCode = 404;

显示原文其他翻译纠错

当响应头被发送回客户端，那么这个属性则表示已经被发送出去的状态码。

显示原文其他翻译纠错

response.setHeader(name, value)#

显示原文其他翻译纠错

为默认或者已存在的头设置一条单独的头内容。如果这个头已经存在于 将被送出的头中，将会覆盖原来的内容。如果我想设置更多的头， 就使用一个相同名字的字符串数组

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

response.setHeader("Content-Type", "text/html");

显示原文其他翻译纠错

或者

显示原文其他翻译纠错

response.setHeader("Set-Cookie", ["type=ninja", "language=javascript"]);

显示原文其他翻译纠错

response.headersSent#

显示原文其他翻译纠错

Boolean值(只读).如果headers发送完毕,则为true,反之为false

显示原文其他翻译纠错

response.sendDate#

显示原文其他翻译纠错

若为true,则当headers里没有Date值时自动生成Date并发送.默认值为true

显示原文其他翻译纠错

只有在测试环境才禁用它; 因为 HTTP 要求响应包含 Date 头.

显示原文其他翻译纠错

response.getHeader(name)#

显示原文其他翻译纠错

Reads out a header that‘s already been queued but not sent to the client. Note that the name is case insensitive. This can only be called before headers get implicitly flushed.

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

var contentType = response.getHeader(‘content-type‘);

显示原文其他翻译纠错

response.removeHeader(name)#

显示原文其他翻译纠错

Removes a header that‘s queued for implicit sending.

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

response.removeHeader("Content-Encoding");

显示原文其他翻译纠错

response.write(chunk, [encoding])#

显示原文其他翻译纠错

如果这个方法被调用但是 response.writeHead() 没有被调用，它将切换到默认header模式并更新默认的headers。

显示原文其他翻译纠错

This sends a chunk of the response body. This method may be called multiple times to provide successive parts of the body.

显示原文其他翻译纠错

chunk can be a string or a buffer. If chunk is a string, the second parameter specifies how to encode it into a byte stream. By default the encoding is ‘utf8‘.

显示原文其他翻译纠错

Note: This is the raw HTTP body and has nothing to do with higher-level multi-part body encodings that may be used.

显示原文其他翻译纠错

The first time response.write() is called, it will send the buffered header information and the first body to the client. The second time response.write() is called, Node assumes you‘re going to be streaming data, and sends that separately. That is, the response is buffered up to the first chunk of body.

显示原文其他翻译纠错

如果所有数据被成功刷新到内核缓冲区，则返回true。如果所有或部分数据在用户内存里还处于队列中，则返回false。当缓冲区再次被释放时，‘drain‘事件会被分发。 ‘drain‘ will be emitted when the buffer is again free.

显示原文其他翻译纠错

response.addTrailers(headers)#

显示原文其他翻译纠错

This method adds HTTP trailing headers (a header but at the end of the message) to the response.

显示原文其他翻译纠错

Trailers will only be emitted if chunked encoding is used for the response; if it is not (e.g., if the request was HTTP/1.0), they will be silently discarded.

显示原文其他翻译纠错

Note that HTTP requires the Trailer header to be sent if you intend to emit trailers, with a list of the header fields in its value. E.g.,

显示原文其他翻译纠错

response.writeHead(200, { ‘Content-Type‘: ‘text/plain‘,
                          ‘Trailer‘: ‘Content-MD5‘ });
response.write(fileData);
response.addTrailers({‘Content-MD5‘: "7895bf4b8828b55ceaf47747b4bca667"});
response.end();

显示原文其他翻译纠错

response.end([data], [encoding])#

显示原文其他翻译纠错

This method signals to the server that all of the response headers and body have been sent; that server should consider this message complete. The method, response.end(), MUST be called on each response.

显示原文其他翻译纠错

如果指定了参数 data , 就相当于先调用 response.write(data, encoding) 之后再调用 response.end().

显示原文其他翻译纠错

http.request(options, callback)#

显示原文其他翻译纠错

Node maintains several connections per server to make HTTP requests. This function allows one to transparently issue requests.

显示原文其他翻译纠错

options可以是一个对象或一个字符串。如果options是一个字符串, 它将自动使用url.parse()解析。

显示原文其他翻译纠错

Options:

显示原文其他翻译纠错

  • host：请求发送到的服务器的域名或IP地址。默认为‘localhost‘。
  • hostname：用于支持url.parse()。hostname比host更好一些
  • port：远程服务器的端口。默认值为80。
  • localAddress：用于绑定网络连接的本地接口。
  • socketPath：Unix域套接字（使用host:port或socketPath）
  • method：指定HTTP请求方法的字符串。默认为‘GET‘。
  • path：请求路径。默认为‘/‘。如果有查询字符串，则需要包含。例如‘/index.html?page=12‘。请求路径包含非法字符时抛出异常。目前，只否决空格，不过在未来可能改变。
  • headers：包含请求头的对象。
  • auth：用于计算认证头的基本认证，即‘user:password‘
  • agent：控制Agent的行为。当使用了一个Agent的时候，请求将默认为Connection: keep-alive。可能的值为：
    • undefined（默认）：在这个主机和端口上使用[全局Agent][]。
    • Agent对象：在Agent中显式使用passed。
    • false：在对Agent进行资源池的时候，选择停用连接，默认请求为：Connection: close。
  • keepAlive：{Boolean} 保持资源池周围的套接字在未来被用于其它请求。默认值为false
  • keepAliveMsecs：{Integer} 当使用HTTP KeepAlive的时候，通过正在保持活动的套接字发送TCP KeepAlive包的频繁程度。默认值为1000。仅当keepAlive被设置为true时才相关。

显示原文其他翻译纠错

http.request() 返回一个 http.ClientRequest类的实例。ClientRequest实例是一个可写流对象。如果需要用POST请求上传一个文件的话，就将其写入到ClientRequest对象。

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

// write data to request body
req.write(‘data\n‘);
req.write(‘data\n‘);
req.end();

显示原文其他翻译纠错

注意，例子里的req.end()被调用了。使用http.request()方法时都必须总是调用req.end()以表明这个请求已经完成，即使响应body里没有任何数据。

显示原文其他翻译纠错

If any error is encountered during the request (be that with DNS resolution, TCP level errors, or actual HTTP parse errors) an ‘error‘ event is emitted on the returned request object.

显示原文其他翻译纠错

There are a few special headers that should be noted.

显示原文其他翻译纠错

  • Sending a ‘Connection: keep-alive‘ will notify Node that the connection to the server should be persisted until the next request.

显示原文其他翻译纠错

  • 发送 ‘Content-length‘ 头将会禁用默认的 chunked 编码.

显示原文其他翻译纠错

  • Sending an ‘Expect‘ header will immediately send the request headers. Usually, when sending ‘Expect: 100-continue‘, you should both set a timeout and listen for the continue event. See RFC2616 Section 8.2.3 for more information.

显示原文其他翻译纠错

  • Sending an Authorization header will override using the auth option to compute basic authentication.

显示原文其他翻译纠错

http.get(options, callback)#

显示原文其他翻译纠错

因为大部分的请求是没有报文体的GET请求，所以Node提供了这种便捷的方法。该方法与http.request()的唯一区别是它设置的是GET方法并自动调用req.end()。

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

http.get("http://www.google.com/index.html", function(res) {
  console.log("响应：" + res.statusCode);
}).on(‘error‘, function(e) {
  console.log("错误：" + e.message);
});

显示原文其他翻译纠错

Class: http.Agent#

显示原文其他翻译纠错

HTTP Agent 是用于把套接字做成资源池，用于HTTP客户端请求。

显示原文其他翻译纠错

HTTP Agent 也把客户端的请求默认为使用Connection:keep-alive。如果没有HTTP请求正在等待成为空闲的套接字的话，那么套接字将关闭。这意味着Node的资源池在负载的情况下对keep-alive有利，但是仍然不需要开发人员使用KeepAlive来手动关闭HTTP客户端。

显示原文其他翻译纠错

如果你选择使用HTTP KeepAlive，那么你可以创建一个标志设为true的Agent对象。（见下面的构造函数选项。）然后，Agent将会在资源池中保持未被使用的套接字，用于未来使用。它们将会被显式标记，以便于不保持Node进程的运行。但是当KeepAlive agent没有被使用时，显式地destroy() KeepAlive agent仍然是个好主意，这样套接字们会被关闭。

显示原文其他翻译纠错

当套接字触发了close事件或者特殊的agentRemove事件的时候，套接字们从agent的资源池中移除。这意味着如果你打算保持一个HTTP请求长时间开启，并且不希望它保持在资源池中，那么你可以按照下列几行的代码做事：

显示原文其他翻译纠错

http.get(options, function(res) {
  // 做点事
}).on("socket", function (socket) {
  socket.emit("agentRemove");
});

显示原文其他翻译纠错

另外，你可以直接使用agent:false选择完全停用资源池。

显示原文其他翻译纠错

http.get({
  hostname: ‘localhost‘,
  port: 80,
  path: ‘/‘,
  agent: false  // 仅仅为了这一个请求，而创建一个新的agent
}, function (res) {
  // 为响应做些事
})

显示原文其他翻译纠错

new Agent([options])#

显示原文其他翻译纠错

  • options {Object} 设置于agent上的配置选项的集合。可以有下列字段：

    • keepAlive {Boolean} 保持在资源池周围套接未来字被其它请求使用。默认值为false
    • keepAliveMsecs {Integer} 当使用HTTP KeepAlive时, 通过正在被保持活跃的套接字来发送TCP KeepAlive包的频繁程度。默认值为1000。仅当keepAlive设置为true时有效。
    • maxSockets {Number} 每台主机允许的套接字的数目的最大值。默认值为Infinity。
    • 在空闲状态下还依然开启的套接字的最大值。仅当keepAlive设置为true的时候有效。默认值为256。

显示原文其他翻译纠错

被http.request使用的默认的http.globalAgent有设置为它们各自的默认值的全部这些值。

显示原文其他翻译纠错

要配置这些值，你必须创建一个你自己的Agent对象。

显示原文其他翻译纠错

var http = require(‘http‘);
var keepAliveAgent = new http.Agent({ keepAlive: true });
keepAliveAgent.request(options, onResponseCallback);

显示原文其他翻译纠错

agent.maxSockets#

显示原文其他翻译纠错

默认设置为Infinity。决定每台主机上的agent可以拥有的并发套接字的打开的数量。

显示原文其他翻译纠错

agent.maxFreeSockets#

显示原文其他翻译纠错

默认设置为256。对于支持HTTP KeepAlive的Agent，这设置了在空闲状态下仍然打开的套接字数目的最大值。

显示原文其他翻译纠错

agent.sockets#

显示原文其他翻译纠错

An object which contains arrays of sockets currently in use by the Agent. Do not modify.

显示原文其他翻译纠错

agent.freeSockets#

显示原文其他翻译纠错

An object which contains arrays of sockets currently awaiting use by the Agent when HTTP KeepAlive is used. Do not modify.

显示原文其他翻译纠错

agent.requests#

显示原文其他翻译纠错

An object which contains queues of requests that have not yet been assigned to sockets. Do not modify.

显示原文其他翻译纠错

agent.destroy()#

显示原文其他翻译纠错

销毁被此agent占用的任何套接字

显示原文其他翻译纠错

It is usually not necessary to do this. However, if you are using an agent with KeepAlive enabled, then it is best to explicitly shut down the agent when you know that it will no longer be used. Otherwise, sockets may hang open for quite a long time before the server terminates them.

显示原文其他翻译纠错

agent.getName(options)#

显示原文其他翻译纠错

Get a unique name for a set of request options, to determine whether a connection can be reused. In the http agent, this returns host:port:localAddress. In the https agent, the name includes the CA, cert, ciphers, and other HTTPS/TLS-specific options that determine socket reusability.

显示原文其他翻译纠错

http.globalAgent#

显示原文其他翻译纠错

Global instance of Agent which is used as the default for all http client requests.

显示原文其他翻译纠错

Class: http.ClientRequest#

显示原文其他翻译纠错

This object is created internally and returned from http.request(). It represents an in-progress request whose header has already been queued. The header is still mutable using the setHeader(name, value), getHeader(name), removeHeader(name) API. The actual header will be sent along with the first data chunk or when closing the connection.

显示原文其他翻译纠错

To get the response, add a listener for ‘response‘ to the request object. ‘response‘ will be emitted from the request object when the response headers have been received. The ‘response‘ event is executed with one argument which is an instance of http.IncomingMessage.

显示原文其他翻译纠错

During the ‘response‘ event, one can add listeners to the response object; particularly to listen for the ‘data‘ event.

显示原文其他翻译纠错

If no ‘response‘ handler is added, then the response will be entirely discarded. However, if you add a ‘response‘ event handler, then you must consume the data from the response object, either by calling response.read() whenever there is a ‘readable‘ event, or by adding a ‘data‘ handler, or by calling the .resume() method. Until the data is consumed, the ‘end‘ event will not fire. Also, until the data is read it will consume memory that can eventually lead to a ‘process out of memory‘ error.

显示原文其他翻译纠错

Note: Node does not check whether Content-Length and the length of the body which has been transmitted are equal or not.

显示原文其他翻译纠错

该请求实现了 Writable Stream 接口。这是一个包含下列事件的 EventEmitter ：

显示原文其他翻译纠错

Event ‘response‘#

显示原文其他翻译纠错

function (response) { }

显示原文其他翻译纠错

Emitted when a response is received to this request. This event is emitted only once. The response argument will be an instance of http.IncomingMessage.

显示原文其他翻译纠错

Options:

显示原文其他翻译纠错

  • host: 请求发送到的服务器的域名或IP地址。
  • port: 远程服务器的端口。
  • socketPath: Unix域套接字（使用host:port或socketPath）

显示原文其他翻译纠错

Event: ‘socket‘#

显示原文其他翻译纠错

function (socket) { }

显示原文其他翻译纠错

触发于一个套接字被赋予为这个请求的时候。

显示原文其他翻译纠错

事件: ‘connect‘#

显示原文其他翻译纠错

function (response, socket, head) { }

显示原文其他翻译纠错

Emitted each time a server responds to a request with a CONNECT method. If this event isn‘t being listened for, clients receiving a CONNECT method will have their connections closed.

显示原文其他翻译纠错

展示监听connect事件的一个客户端—服务器对。

显示原文其他翻译纠错

    // make a request over an HTTP tunnel
    socket.write(‘GET / HTTP/1.1\r\n‘ +
                 ‘Host: www.google.com:80\r\n‘ +
                 ‘Connection: close\r\n‘ +
                 ‘\r\n‘);
    socket.on(‘data‘, function(chunk) {
      console.log(chunk.toString());
    });
    socket.on(‘end‘, function() {
      proxy.close();
    });
  });
});

显示原文其他翻译纠错

Event: ‘upgrade‘#

显示原文其他翻译纠错

function (response, socket, head) { }

显示原文其他翻译纠错

Emitted each time a server responds to a request with an upgrade. If this event isn‘t being listened for, clients receiving an upgrade header will have their connections closed.

显示原文其他翻译纠错

A client server pair that show you how to listen for the upgrade event.

显示原文其他翻译纠错

  req.on(‘upgrade‘, function(res, socket, upgradeHead) {
    console.log(‘got upgraded!‘);
    socket.end();
    process.exit(0);
  });
});

显示原文其他翻译纠错

Event: ‘continue‘#

显示原文其他翻译纠错

function () { }

显示原文其他翻译纠错

Emitted when the server sends a ‘100 Continue‘ HTTP response, usually because the request contained ‘Expect: 100-continue‘. This is an instruction that the client should send the request body.

显示原文其他翻译纠错

request.write(chunk, [encoding])#

显示原文其他翻译纠错

Sends a chunk of the body. By calling this method many times, the user can stream a request body to a server--in that case it is suggested to use the [‘Transfer-Encoding‘, ‘chunked‘] header line when creating the request.

显示原文其他翻译纠错

chunk 参数必须是 Buffer 或者 string.

显示原文其他翻译纠错

encoding 参数是可选的, 并且只能在 chunk 是 string 类型的时候才能设置. 默认是 ‘utf8‘.

显示原文其他翻译纠错

request.end([data], [encoding])#

显示原文其他翻译纠错

Finishes sending the request. If any parts of the body are unsent, it will flush them to the stream. If the request is chunked, this will send the terminating ‘0\r\n\r\n‘.

显示原文其他翻译纠错

If data is specified, it is equivalent to calling request.write(data, encoding) followed by request.end().

显示原文其他翻译纠错

request.abort()#

显示原文其他翻译纠错

终止一个请求. (从 v0.3.8 开始新加.)

显示原文其他翻译纠错

request.setTimeout(timeout, [callback])#

显示原文其他翻译纠错

Once a socket is assigned to this request and is connected socket.setTimeout() will be called.

显示原文其他翻译纠错

request.setNoDelay([noDelay])#

显示原文其他翻译纠错

Once a socket is assigned to this request and is connected socket.setNoDelay() will be called.

显示原文其他翻译纠错

request.setSocketKeepAlive([enable], [initialDelay])#

显示原文其他翻译纠错

一旦一个套接字被分配到这个请求，而且成功连接，那么socket.setKeepAlive()就会被调用。

显示原文其他翻译纠错

http.IncomingMessage#

显示原文其他翻译纠错

一个 IncomingMessage对象是由 http.Server或http.ClientRequest创建的，并作为第一参数分别传递给‘request‘和‘response‘ 事件。它也可以被用来访问应答的状态，头文件和数据。

显示原文其他翻译纠错

它实现了 Readable Stream 接口以及以下额外的事件，方法和属性。

显示原文其他翻译纠错

事件: ‘close‘#

显示原文其他翻译纠错

function () { }

显示原文其他翻译纠错

表示在response.end()被调用或强制刷新之前，底层的连接已经被终止了。

显示原文其他翻译纠错

跟‘end‘一样，这个事件对于每个应答只会触发一次。详见[http.ServerResponse][]的 ‘close‘事件。

显示原文其他翻译纠错

message.httpVersion#

显示原文其他翻译纠错

客户端向服务器发出请求时，客户端发送的HTTP版本；或是服务器向客户端返回应答时，服务器的HTTP版本。通常是 ‘1.1‘或‘1.0‘。

显示原文其他翻译纠错

Also response.httpVersionMajor is the first integer and response.httpVersionMinor is the second.

显示原文其他翻译纠错

message.headers#

显示原文其他翻译纠错

请求/响应 头对象.

显示原文其他翻译纠错

只读的头文件名称和值的映射。头文件名称全小写。示例：

显示原文其他翻译纠错

// 输出类似这样：
//
// { ‘user-agent‘: ‘curl/7.22.0‘,
//   host: ‘127.0.0.1:8000‘,
//   accept: ‘*/*‘ }
console.log(request.headers);

显示原文其他翻译纠错

message.rawHeaders#

显示原文其他翻译纠错

The raw request/response headers list exactly as they were received.

显示原文其他翻译纠错

Note that the keys and values are in the same list. It is not a list of tuples. So, the even-numbered offsets are key values, and the odd-numbered offsets are the associated values.

显示原文其他翻译纠错

Header names are not lowercased, and duplicates are not merged.

显示原文其他翻译纠错

// Prints something like:
//
// [ ‘user-agent‘,
//   ‘this is invalid because there can be only one‘,
//   ‘User-Agent‘,
//   ‘curl/7.22.0‘,
//   ‘Host‘,
//   ‘127.0.0.1:8000‘,
//   ‘ACCEPT‘,
//   ‘*/*‘ ]
console.log(request.rawHeaders);

显示原文其他翻译纠错

message.trailers#

显示原文其他翻译纠错

The request/response trailers object. Only populated at the ‘end‘ event.

显示原文其他翻译纠错

message.rawTrailers#

显示原文其他翻译纠错

The raw request/response trailer keys and values exactly as they were received. Only populated at the ‘end‘ event.

显示原文其他翻译纠错

message.setTimeout(msecs, callback)#

显示原文其他翻译纠错

  • msecs {Number}
  • callback {Function}

显示原文其他翻译纠错

调用message.connection.setTimeout(msecs, callback)

显示原文其他翻译纠错

message.method#

显示原文其他翻译纠错

仅对从http.Server获得到的请求(request)有效.

显示原文其他翻译纠错

请求（request）方法如同一个只读的字符串，比如‘GET’、‘DELETE’。

显示原文其他翻译纠错

message.url#

显示原文其他翻译纠错

仅对从http.Server获得到的请求(request)有效.

显示原文其他翻译纠错

请求的URL字符串.它仅包含实际HTTP请求中所提供的URL.加入请求如下:

显示原文其他翻译纠错

GET /status?name=ryan HTTP/1.1\r\n
Accept: text/plain\r\n
\r\n

显示原文其他翻译纠错

则request.url 为:

显示原文其他翻译纠错

‘/status?name=ryan‘

显示原文其他翻译纠错

如果你想要将URL分解出来,你可以用require(‘url‘).parse(request.url). 例如:

显示原文其他翻译纠错

node> require(‘url‘).parse(‘/status?name=ryan‘)
{ href: ‘/status?name=ryan‘,
  search: ‘?name=ryan‘,
  query: ‘name=ryan‘,
  pathname: ‘/status‘ }

显示原文其他翻译纠错

如果你想要提取出从请求字符串(query string)中的参数,你可以用require(‘querystring‘).parse函数, 或者将true作为第二个参数传递给require(‘url‘).parse. 例如:

显示原文其他翻译纠错

node> require(‘url‘).parse(‘/status?name=ryan‘, true)
{ href: ‘/status?name=ryan‘,
  search: ‘?name=ryan‘,
  query: { name: ‘ryan‘ },
  pathname: ‘/status‘ }

显示原文其他翻译纠错

message.statusCode#

显示原文其他翻译纠错

仅对从http.ClientRequest获得的响应(response)有效.

显示原文其他翻译纠错

三位数的HTTP响应状态码. 例如 404.

显示原文其他翻译纠错

message.socket#

显示原文其他翻译纠错

与此连接(connection)关联的net.Socket对象.

显示原文其他翻译纠错

通过https的支持，使用 request.connection.verifyPeer()方法和request.connection.getPeerCertificate()方法来得到客户端的身份信息。

显示原文其他翻译纠错

显示原文其他翻译纠错

HTTPS#

显示原文其他翻译纠错

稳定度: 3 - 稳定

显示原文其他翻译纠错

HTTPS 是建立在 TLS/SSL 之上的 HTTP 协议。在 Node 中被实现为单独的模块。

显示原文其他翻译纠错

类: https.Server#

显示原文其他翻译纠错

该类是 tls.Server 的子类，并且发生和 http.Server 一样的事件。更多信息详见 http.Server。

显示原文其他翻译纠错

server.setTimeout(msecs, callback)#

显示原文其他翻译纠错

详见 http.Server#setTimeout()。

显示原文其他翻译纠错

server.timeout#

显示原文其他翻译纠错

详见 http.Server#timeout。

显示原文其他翻译纠错

https.createServer(options, [requestListener])#

显示原文其他翻译纠错

返回一个新的 HTTPS Web 服务器对象。其中 options 类似于 tls.createServer()；requestListener 是一个会被自动添加到 request 事件的函数。

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

https.createServer(options, function (req, res) {
  res.writeHead(200);
  res.end("hello world\n");
}).listen(8000);

显示原文其他翻译纠错

或者

显示原文其他翻译纠错

https.createServer(options, function (req, res) {
  res.writeHead(200);
  res.end("hello world\n");
}).listen(8000);

显示原文其他翻译纠错

server.listen(port, [host], [backlog], [callback])#

server.listen(path, [callback])#

server.listen(handle, [callback])#

显示原文其他翻译纠错

详见 http.listen()。

显示原文其他翻译纠错

server.close([callback])#

显示原文其他翻译纠错

详见 http.close()。

显示原文其他翻译纠错

https.request(options, callback)#

显示原文其他翻译纠错

向一个安全 Web 服务器发送请求。

显示原文其他翻译纠错

options 可以是一个对象或字符串。如果 options 是字符串，它会自动被 url.parse() 解析。

显示原文其他翻译纠错

所有来自 http.request() 的选项都是经过验证的。

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

req.on(‘error‘, function(e) {
  console.error(e);
});

显示原文其他翻译纠错

options 参数有如下选项

显示原文其他翻译纠错

  • host：发送请求的服务器的域名或 IP 地址，缺省为 ‘localhost‘。
  • hostname：为了支持 url.parse()，hostname 优先于 host。
  • port：远程服务器的端口，缺省为 443。
  • method：指定 HTTP 请求方法的字符串，缺省为 `‘GET‘。
  • path：请求路径，缺省为 ‘/‘。如有查询字串则应包含，比如 ‘/index.html?page=12‘。
  • headers：包含请求头的对象。
  • auth：基本认证，如 ‘user:password‘ 来计算 Authorization 头。
  • agent：控制 Agent 行为。当使用 Agent 时请求会缺省为 Connection: keep-alive。可选值有：
    • undefined（缺省）：为该主机和端口使用 globalAgent。
    • Agent 对象：明确使用传入的 Agent。
    • false：不使用 Agent 连接池，缺省请求 Connection: close。

显示原文其他翻译纠错

下列来自 tls.connect() 的选项也能够被指定，但一个 globalAgent 会忽略它们。

显示原文其他翻译纠错

  • pfx：证书，SSL 所用的私钥或 CA 证书。缺省为 null。
  • key：SSL 所用私钥。缺省为 null。
  • passphrase：私钥或 pfx 的口令字符串，缺省为 null。
  • cert：所用公有 x509 证书，缺省为 null。
  • ca：用于检查远程主机的证书颁发机构或包含一系列证书颁发机构的数组。
  • ciphers：描述要使用或排除的密码的字符串，格式请参阅 http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT。
  • rejectUnauthorized：如为 true 则服务器证书会使用所给 CA 列表验证。如果验证失败则会触发 ‘error‘ 时间。验证过程发生于连接层，在 HTTP 请求发送之前。缺省为 true。
  • secureProtocol：所用 SSL 方法，比如 SSLv3_method 强制使用 SSL version 3。可取值取决于您安装的 OpenSSL 并被定义在 SSL_METHODS 常量。

显示原文其他翻译纠错

要指定这些选项，使用一个自定义 Agent。

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

var req = https.request(options, function(res) {
  ...
}

显示原文其他翻译纠错

或不使用 Agent。

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

var req = https.request(options, function(res) {
  ...
}

显示原文其他翻译纠错

https.get(options, callback)#

显示原文其他翻译纠错

类似 http.get() 但为 HTTPS。

显示原文其他翻译纠错

options 可以是一个对象或字符串。如果 options 是字符串，它会自动被 url.parse() 解析。

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

}).on(‘error‘, function(e) {
  console.error(e);
});

显示原文其他翻译纠错

类: https.Agent#

显示原文其他翻译纠错

类似于 http.Agent 的 HTTPS Agent 对象。详见 https.request()。

显示原文其他翻译纠错

https.globalAgent#

显示原文其他翻译纠错

所有 HTTPS 客户端请求的全局 https.Agent 实例。

显示原文其他翻译纠错

显示原文其他翻译纠错

URL#

显示原文其他翻译纠错

稳定度: 3 - 稳定

显示原文其他翻译纠错

该模块包含用以 URL 解析的实用函数。 使用 require(‘url‘) 来调用该模块。

显示原文其他翻译纠错

不同的 URL 字符串解析后返回的对象会有一些额外的字段信息，仅当该部分出现在 URL 中才会有。以下是一个 URL 例子：

显示原文其他翻译纠错

‘http://user:[email protected]:8080/p/a/t/h?query=string#hash‘

显示原文其他翻译纠错

  • href: 所解析的完整原始 URL。协议名和主机名都已转为小写。

显示原文其他翻译纠错

例如: `‘http://user:[email protected]:8080/p/a/t/h?query=string#hash‘`

显示原文其他翻译纠错

  • protocol: 请求协议，小写

显示原文其他翻译纠错

例如: `‘http:‘`

显示原文其他翻译纠错

  • host: URL主机名已全部转换成小写, 包括端口信息

显示原文其他翻译纠错

例如: `‘host.com:8080‘`

显示原文其他翻译纠错

  • auth:URL中身份验证信息部分

显示原文其他翻译纠错

例如: `‘user:pass‘`

显示原文其他翻译纠错

  • hostname:主机的主机名部分, 已转换成小写

显示原文其他翻译纠错

例如: `‘host.com‘`

显示原文其他翻译纠错

  • port: 主机的端口号部分

显示原文其他翻译纠错

例如: `‘8080‘`

显示原文其他翻译纠错

  • pathname: URL的路径部分,位于主机名之后请求查询之前, including the initial slash if present.

显示原文其他翻译纠错

例如: `‘/p/a/t/h‘`

显示原文其他翻译纠错

  • search: URL 的“查询字符串”部分，包括开头的问号。

显示原文其他翻译纠错

例如: `‘?query=string‘`

显示原文其他翻译纠错

  • path: pathname 和 search 连在一起。

显示原文其他翻译纠错

例如: `‘/p/a/t/h?query=string‘`

显示原文其他翻译纠错

  • query: 查询字符串中的参数部分（问号后面部分字符串），或者使用  querystring.parse() 解析后返回的对象。

显示原文其他翻译纠错

例如: `‘query=string‘` or `{‘query‘:‘string‘}`

显示原文其他翻译纠错

  • hash: URL 的 “#” 后面部分（包括 # 符号）

显示原文其他翻译纠错

例如: `‘#hash‘`

显示原文其他翻译纠错

以下是 URL 模块提供的方法：

显示原文其他翻译纠错

url.parse(urlStr, [parseQueryString], [slashesDenoteHost])#

显示原文其他翻译纠错

输入 URL 字符串，返回一个对象。

显示原文其他翻译纠错

将第二个参数设置为 true 则使用 querystring 模块来解析 URL 中德查询字符串部分，默认为 false。

显示原文其他翻译纠错

将第三个参数设置为 true 来把诸如 //foo/bar 这样的URL解析为 { host: ‘foo‘, pathname: ‘/bar‘ }而不是 { pathname: ‘//foo/bar‘ }。 默认为 false。

显示原文其他翻译纠错

url.format(urlObj)#

显示原文其他翻译纠错

输入一个 URL 对象，返回格式化后的 URL 字符串。

显示原文其他翻译纠错

  • href 属性会被忽略处理.
  • protocol无论是否有末尾的 : (冒号)，会同样的处理
    • 这些协议包括 http, https, ftp, gopher, file 后缀是 :// (冒号-斜杠-斜杠).
    • 所有其他的协议如 mailto, xmpp, aim, sftp, foo, 等 会加上后缀 : (冒号)
  • auth 如果有将会出现.
  • hostname 如果 host 属性没被定义，则会使用此属性.
  • port 如果 host 属性没被定义，则会使用此属性.
  • host 优先使用，将会替代 hostname 和port
  • pathname 将会同样处理无论结尾是否有/ (斜杠)
  • search 将会替代 query属性
  • query (object类型; 详细请看 querystring) 如果没有 search,将会使用此属性.
  • search 无论前面是否有 ? (问号)，都会同样的处理
  • hash无论前面是否有# (井号, 锚点)，都会同样处理

显示原文其他翻译纠错

url.resolve(from, to)#

显示原文其他翻译纠错

给定一个基础URL路径，和一个href URL路径，并且象浏览器那样处理他们可以带上锚点。 例子：

显示原文其他翻译纠错

url.resolve(‘/one/two/three‘, ‘four‘)         // ‘/one/two/four‘
url.resolve(‘http://example.com/‘, ‘/one‘)    // ‘http://example.com/one‘
url.resolve(‘http://example.com/one‘, ‘/two‘) // ‘http://example.com/two‘

显示原文其他翻译纠错

Query String#

显示原文其他翻译纠错

稳定度: 3 - 稳定

显示原文其他翻译纠错

这个模块提供一些处理 query string 的工具。它提供下列方法：

显示原文其他翻译纠错

querystring.stringify(obj, [sep], [eq])#

显示原文其他翻译纠错

序列化一个对象到一个 query string。可以选择是否覆盖默认的分割符（‘&‘）和分配符（‘=‘）。

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

querystring.stringify({foo: ‘bar‘, baz: ‘qux‘}, ‘;‘, ‘:‘)
// 返回如下字串
‘foo:bar;baz:qux‘

显示原文其他翻译纠错

querystring.parse(str, [sep], [eq], [options])#

显示原文其他翻译纠错

将一个 query string 反序列化为一个对象。可以选择是否覆盖默认的分割符（‘&‘）和分配符（‘=‘）。

显示原文其他翻译纠错

options对象可能包含maxKeys属性(默认为1000),它可以用来限制处理过的键(key)的数量.设为0可以去除键(key)的数量限制.

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

querystring.parse(‘foo=bar&baz=qux&baz=quux&corge‘)
// returns
{ foo: ‘bar‘, baz: [‘qux‘, ‘quux‘], corge: ‘‘ }

显示原文其他翻译纠错

querystring.escape#

显示原文其他翻译纠错

供 querystring.stringify 使用的转意函数，在必要的时候可被重写。

显示原文其他翻译纠错

querystring.unescape#

显示原文其他翻译纠错

供 querystring.parse 使用的反转意函数，在必要的时候可被重写。

显示原文其他翻译纠错

punycode#

显示原文其他翻译纠错

稳定度: 2 - 不稳定

显示原文其他翻译纠错

Punycode.js 自 Node.js v0.6.2+ 开始被内置，通过 require(‘punycode‘) 引入。（要在其它 Node.js 版本中使用它，请先使用 npm 安装 punycode 模块。）

显示原文其他翻译纠错

punycode.decode(string)#

显示原文其他翻译纠错

将一个纯 ASCII 符号的 Punycode 字符串转换为 Unicode 符号的字符串。

显示原文其他翻译纠错

// 解码域名部分
punycode.decode(‘maana-pta‘); // ‘mañana‘
punycode.decode(‘--dqo34k‘); // ‘?-?‘

显示原文其他翻译纠错

punycode.encode(string)#

显示原文其他翻译纠错

将一个 Unicode 符号的字符串转换为纯 ASCII 符号的 Punycode 字符串。

显示原文其他翻译纠错

// 编码域名部分
punycode.encode(‘mañana‘); // ‘maana-pta‘
punycode.encode(‘?-?‘); // ‘--dqo34k‘

显示原文其他翻译纠错

punycode.toUnicode(domain)#

显示原文其他翻译纠错

将一个表示域名的 Punycode 字符串转换为 Unicode。只有域名中的 Punycode 部分会转换，也就是说您在一个已经转换为 Unicode 的字符串上调用它也是没问题的。

显示原文其他翻译纠错

// 解码域名
punycode.toUnicode(‘xn--maana-pta.com‘); // ‘mañana.com‘
punycode.toUnicode(‘xn----dqo34k.com‘); // ‘?-?.com‘

显示原文其他翻译纠错

punycode.toASCII(domain)#

显示原文其他翻译纠错

将一个表示域名的 Unicode 字符串转换为 Punycode。只有域名的非 ASCII 部分会被转换，也就是说您在一个已经是 ASCII 的域名上调用它也是没问题的。

显示原文其他翻译纠错

// 编码域名
punycode.toASCII(‘mañana.com‘); // ‘xn--maana-pta.com‘
punycode.toASCII(‘?-?.com‘); // ‘xn----dqo34k.com‘

显示原文其他翻译纠错

punycode.ucs2#

显示原文其他翻译纠错

punycode.ucs2.decode(string)#

显示原文其他翻译纠错

创建一个数组，包含字符串中每个 Unicode 符号的数字编码点。由于 JavaScript 在内部使用 UCS-2， 该函数会按照 UTF-16 将一对代半数（UCS-2 暴露的单独的字符）转换为单独一个编码点。

显示原文其他翻译纠错

punycode.ucs2.decode(‘abc‘); // [0x61, 0x62, 0x63]
// surrogate pair for U+1D306 tetragram for centre:
punycode.ucs2.decode(‘\uD834\uDF06‘); // [0x1D306]

显示原文其他翻译纠错

punycode.ucs2.encode(codePoints)#

显示原文其他翻译纠错

以数字编码点的值的数组创建一个字符串。

显示原文其他翻译纠错

punycode.ucs2.encode([0x61, 0x62, 0x63]); // ‘abc‘
punycode.ucs2.encode([0x1D306]); // ‘\uD834\uDF06‘

显示原文其他翻译纠错

punycode.version#

显示原文其他翻译纠错

表示当前 Punycode.js 版本号的字符串。

显示原文其他翻译纠错

Readline#

显示原文其他翻译纠错

稳定度: 2 - 不稳定

显示原文其他翻译纠错

要使用此模块，需要require(‘readline‘).Readline程序允许逐行读取一个流内容(例如process.stdin).

显示原文其他翻译纠错

需要注意的是你一旦调用了这个模块，你的node程序将不会终止直到你关闭此接口。下面是如何让你的程序正常退出的方法:

显示原文其他翻译纠错

  rl.close();
});

显示原文其他翻译纠错

readline.createInterface(options)#

显示原文其他翻译纠错

创建一个readline的接口实例. 接受一个Object类型参数，可传递以下几个值:

显示原文其他翻译纠错

  • input - 要监听的可读流 (必需).

显示原文其他翻译纠错

  • output - 要写入 readline 的可写流 (必须).

显示原文其他翻译纠错

  • completer - 用于 Tab 自动补全的可选函数。见下面使用的例子。

显示原文其他翻译纠错

  • terminal - 如果希望 input 和 output 流像 TTY 一样对待，那么传递参数 true ，并且经由 ANSI/VT100 转码。 默认情况下检查 isTTY 是否在 output 流上实例化。

显示原文其他翻译纠错

通过用户 completer 函数给定了一个当前行入口，并且期望返回一个包含两个条目的数组：

显示原文其他翻译纠错

  1. 一个匹配当前输入补全的字符串数组.

显示原文其他翻译纠错

  1. 一个用于匹配的子字符串。

显示原文其他翻译纠错

最终像这种形式: [[substr1, substr2, ...], originalsubstring].

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

function completer(line) {
  var completions = ‘.help .error .exit .quit .q‘.split(‘ ‘)
  var hits = completions.filter(function(c) { return c.indexOf(line) == 0 })
  // show all completions if none found
  return [hits.length ? hits : completions, line]
}

显示原文其他翻译纠错

completer 也可以运行在异步模式下，此时接受两个参数：

显示原文其他翻译纠错

function completer(linePartial, callback) {
  callback(null, [[‘123‘], linePartial]);
}

显示原文其他翻译纠错

为了接受用户的输入，createInterface 通常跟 process.stdin 和 process.stdout 一块使用：

显示原文其他翻译纠错

var readline = require(‘readline‘);
var rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout
});

显示原文其他翻译纠错

一旦你有一个 readline 实例，你通常会监听 "line" 事件。

显示原文其他翻译纠错

如果这个实例中terminal为true，而且output流定义了一个output.columns属性，那么output流将获得最好的兼容性，并且，当columns变化时(当它是TTY时，process.stdout会自动这样做)，会在output上触发一个 "resize"事件。

显示原文其他翻译纠错

类: 接口#

显示原文其他翻译纠错

代表一个有输入输出流的 readline 接口的类。

显示原文其他翻译纠错

rl.setPrompt(prompt)#

显示原文其他翻译纠错

设置提示符，例如当你在命令行运行 node 时，你会看到 > ，这就是 node 的提示符。

显示原文其他翻译纠错

rl.prompt([preserveCursor])#

显示原文其他翻译纠错

为用户输入准备好readline，将现有的setPrompt选项放到新的一行，让用户有一个新的地方开始输入。将preserveCursor设为true来防止光标位置被重新设定成0。

显示原文其他翻译纠错

如果暂停，也会使用 createInterface 重置 input 流。

显示原文其他翻译纠错

rl.question(query, callback)#

显示原文其他翻译纠错

预先提示指定的query，然后用户应答后触发指定的callback。 显示指定的query给用户后，当用户的应答被输入后，就触发了指定的callback

显示原文其他翻译纠错

如果暂停，也会使用 createInterface 重置 input 流。

显示原文其他翻译纠错

使用示例：

显示原文其他翻译纠错

interface.question(‘What is your favorite food?‘, function(answer) {
  console.log(‘Oh, so your favorite food is ‘ + answer);
});

显示原文其他翻译纠错

rl.pause()#

显示原文其他翻译纠错

暂停 readline 的输入流 (input stream), 如果有需要稍后还可以恢复。

显示原文其他翻译纠错

rl.resume()#

显示原文其他翻译纠错

恢复 readline 的输入流 (input stream).

显示原文其他翻译纠错

rl.close()#

显示原文其他翻译纠错

关闭接口实例 (Interface instance), 放弃控制输入输出流。"close" 事件会被触发。

显示原文其他翻译纠错

rl.write(data, [key])#

显示原文其他翻译纠错

将 data 写入到 output 流。key 是一个代表键序列的对象；当终端是一个 TTY 时可用。

显示原文其他翻译纠错

如果暂停，也会重置 input 流。

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

rl.write(‘Delete me!‘);
// 模仿 ctrl+u快捷键，删除之前所写行
rl.write(null, {ctrl: true, name: ‘u‘});

显示原文其他翻译纠错

Events#

显示原文其他翻译纠错

Event: ‘line‘#

显示原文其他翻译纠错

function (line) {}

显示原文其他翻译纠错

在 input 流接受了一个 \n 时触发，通常在用户敲击回车或者返回时接收。 这是一个监听用户输入的利器。

显示原文其他翻译纠错

监听 line 事件的示例:

显示原文其他翻译纠错

rl.on(‘line‘, function (cmd) {
  console.log(‘You just typed: ‘+cmd);
});

显示原文其他翻译纠错

事件: ‘pause‘#

显示原文其他翻译纠错

function () {}

显示原文其他翻译纠错

不论何时，只要输入流被暂停就会触发。

显示原文其他翻译纠错

同样当输入流未被暂停，但收到 SIGCONT 也会触发。 (详见 SIGTSTP 和 SIGCONT 事件)

显示原文其他翻译纠错

监听 pause 事件的示例：

显示原文其他翻译纠错

rl.on(‘pause‘, function() {
  console.log(‘Readline 输入暂停.‘);
});

显示原文其他翻译纠错

事件: ‘resume‘#

显示原文其他翻译纠错

function () {}

显示原文其他翻译纠错

不论何时，只要输入流重新启用就会触发。

显示原文其他翻译纠错

监听 resume 事件的示例：

显示原文其他翻译纠错

rl.on(‘resume‘, function() {
  console.log(‘Readline 恢复.‘);
});

显示原文其他翻译纠错

事件: ‘close‘#

显示原文其他翻译纠错

function () {}

显示原文其他翻译纠错

当 close() 被调用时触发。

显示原文其他翻译纠错

当 input流接收到"结束"事件时也会被触发. 一旦触发，应当认为Interface实例 "结束" . 例如, 当input流接收到^D时, 分别被认为EOT.

显示原文其他翻译纠错

当 input 流接收到一个 ^C 时，即使没有 SIGINT 监听器，也会触发这个事件，分别被称为 SIGINT 。

显示原文其他翻译纠错

Event: ‘SIGINT‘#

显示原文其他翻译纠错

function () {}

显示原文其他翻译纠错

只要 input流 接收到^C就会被触发, 分别被认为SIGINT.当input流接收到SIGINT时, 如果没有 SIGINT 事件监听器，pause 将会被触发.

显示原文其他翻译纠错

监听 SIGINT 信号的示例：

显示原文其他翻译纠错

rl.on(‘SIGINT‘, function() {
  rl.question(‘Are you sure you want to exit?‘, function(answer) {
    if (answer.match(/^y(es)?$/i)) rl.pause();
  });
});

显示原文其他翻译纠错

Event: ‘SIGTSTP‘#

显示原文其他翻译纠错

function () {}

显示原文其他翻译纠错

该功能不支持 windows 操作系统

显示原文其他翻译纠错

只要input流接收到^Z时就被触发, 分别被认为SIGTSTP. 当input流接收到 SIGTSTP时，如果没有SIGTSTP事件监听器 ,程序会被发送到后台 .

显示原文其他翻译纠错

当程序使用参数 fg 重启，pause 和 SIGCONT 事件将会被触发。 你可以使用两者中任一事件来恢复流。

显示原文其他翻译纠错

在程序被发送到后台之前，如果流暂停，pause 和 SIGCONT 事件将不会被触发。

显示原文其他翻译纠错

监听 SIGTSTP 的示例：

显示原文其他翻译纠错

rl.on(‘SIGTSTP‘, function() {
  // 这将重载 SIGTSTP并防止程序转到
  // 后台.
  console.log(‘Caught SIGTSTP.‘);
});

显示原文其他翻译纠错

Event: ‘SIGCONT‘#

显示原文其他翻译纠错

function () {}

显示原文其他翻译纠错

该功能不支持 windows 操作系统

显示原文其他翻译纠错

一旦 input流中含有 ^Z并被发送到后台就会触发,分别被认为 SIGTSTP, 然后继续执行fg(1). 这一事件只有在流被发送后台之前没有暂停才会触发.

显示原文其他翻译纠错

监听 SIGCONT 的示例:

显示原文其他翻译纠错

rl.on(‘SIGCONT‘, function() {
  // `prompt` 将会自动恢复流
  rl.prompt();
});

显示原文其他翻译纠错

示例: Tiny CLI#

显示原文其他翻译纠错

这里有一个使用所有方法精心设计的小命令行程序：

显示原文其他翻译纠错

rl.on(‘line‘, function(line) {
  switch(line.trim()) {
    case ‘hello‘:
      console.log(‘world!‘);
      break;
    default:
      console.log(‘Say what? I might have heard `‘ + line.trim() + ‘`‘);
      break;
  }
  rl.prompt();
}).on(‘close‘, function() {
  console.log(‘Have a great day!‘);
  process.exit(0);
});

显示原文其他翻译纠错

REPL#

显示原文其他翻译纠错

稳定度: 3 - 稳定

显示原文其他翻译纠错

一个 Read-Eval-Print-Loop（REPL，读取-执行-输出循环）既可用于独立程序也可很容易地被集成到其它程序中。REPL 提供了一种交互地执行 JavaScript 并查看输出的方式。它可以被用作调试、测试或仅仅尝试某些东西。

显示原文其他翻译纠错

在命令行中不带任何参数执行 node 您便会进入 REPL。它提供了一个简单的 Emacs 行编辑。

显示原文其他翻译纠错

mjr:~$ node
Type ‘.help‘ for options.
> a = [ 1, 2, 3];
[ 1, 2, 3 ]
> a.forEach(function (v) {
...   console.log(v);
...   });
1
2
3

显示原文其他翻译纠错

若想使用高级的编辑模式，设置环境变量 NODE_NO_READLINE=1 后运行 node。这将在允许你在可以使用 rlwrap 的终端上，启动高级的 REPL 模式 (the main and debugger REPL)。

显示原文其他翻译纠错

例如，您可以将下列代码加入到您的 bashrc 文件：

显示原文其他翻译纠错

alias node="env NODE_NO_READLINE=1 rlwrap node"

显示原文其他翻译纠错

repl.start(options)#

显示原文其他翻译纠错

启动并返回一个 REPLServer 实例。接受一个包含如下内容的 "options" 对象：

显示原文其他翻译纠错

  • prompt - 所有输入输出的提示符。默认是 > .

显示原文其他翻译纠错

  • input - 监听的可读流。默认指向标准输入流 process.stdin。

显示原文其他翻译纠错

  • output - 用来输出数据的可写流。默认指向标准输出流 process.stdout。

显示原文其他翻译纠错

  • terminal - 如果 stream 应该被当做 TTY 来对待并且有 ANSI/VT100 转义时，则传 true。 默认使用 output 实例的 isTTY来检查。

显示原文其他翻译纠错

  • eval - 用来对每一行进行求值的函数。 默认为eval()的一个异步包装函数。下面给出一个自定义eval的例子。

显示原文其他翻译纠错

  • useColors - 一个布尔值，表明了writer函数是否会输出颜色。如果设定了一个不同的writer函数，那么这不会产生任何影响。默认为repl的terminal值。

显示原文其他翻译纠错

  • useGlobal - 如果设定为true，那么repl就会使用global对象而不是在一个独立环境里运行脚本。默认为false。

显示原文其他翻译纠错

  • ignoreUndefined - 如果设定为true，那么repl将不会输出未定义命令的返回值。默认为false。

显示原文其他翻译纠错

  • writer - 每一个命令被求值时都会调用此函数，而该函数会返回显示的格式（包括颜色）。默认为util.inspect。 util.inspect.

显示原文其他翻译纠错

你可以使用你自己的eval函数，只有它有如下的签名：

显示原文其他翻译纠错

function eval(cmd, context, filename, callback) {
  callback(null, result);
}

显示原文其他翻译纠错

多个REPL可以在同一个运行的节点实例上打开。它们共享同一个global对象，但分别有各自的I/O。

显示原文其他翻译纠错

以下是通过标准输入流（stdin）、Unix socket 以及 TCP socket 三种情况来启动 REPL 的例子:

显示原文其他翻译纠错

net.createServer(function (socket) {
  connections += 1;
  repl.start({
    prompt: "node via TCP socket> ",
    input: socket,
    output: socket
  }).on(‘exit‘, function() {
    socket.end();
  });
}).listen(5001);

显示原文其他翻译纠错

从命令行运行该程序，将会从标准输入流启动 REPL 模式。 其他的 REPL 客户端也可以通过 Unix socket 或者 TCP socket 连接。 telnet 常用于连接 TCP sockets，而 socat 则可以同时用来连接 Unix 和 TCP sockets。

显示原文其他翻译纠错

通过从一个Unix的套接字服务器而不是stdin来启动REPL, 你可以连接到一个长久运行的node进程而不不需要重启。

显示原文其他翻译纠错

一个在net.Server和net.Socket实例上运行的"全功能"(terminal)REPL的例子可以查看这里： https://gist.github.com/2209310

显示原文其他翻译纠错

一个在curl(1)上运行的REPL实例的例子可以查看这里： https://gist.github.com/2053342

显示原文其他翻译纠错

事件: ‘exit‘#

显示原文其他翻译纠错

function () {}

显示原文其他翻译纠错

当用户通过任意预定义的方式退出REPL，该事件被分发。比如，在repl里输入.exit，按Ctrl+C两次来发送SIGINT信号，或者在input流上按Ctrl+D来发送"end"。

显示原文其他翻译纠错

监听 exit 事件的例子：

显示原文其他翻译纠错

r.on(‘exit‘, function () {
  console.log(‘从 REPL 得到 "exit" 事件！‘);
  process.exit();
});

显示原文其他翻译纠错

事件: ‘reset‘#

显示原文其他翻译纠错

function (context) {}

显示原文其他翻译纠错

当REPL的上下文被重置时，该事件被分发。当你打.clear命令时这种情况就会发生。如果你以{ useGlobal: true }来启动repl，那么这个事件就永远不会被分发。

显示原文其他翻译纠错

监听reset的例子：

显示原文其他翻译纠错

// 当一个新的上下文被创建时，扩充这个上下文。
r.on(‘reset‘, function (context) {
  console.log(‘repl有一个新的上下文‘);
  someExtension.extend(context);
});

显示原文其他翻译纠错

REPL 特性#

显示原文其他翻译纠错

在REPL里，Control+D会退出。可以输入多行表达式。对于全局变量和本地变量都支持自动缩进。

显示原文其他翻译纠错

特殊变量 _ (下划线)储存了上一个表达式的结果。

显示原文其他翻译纠错

> [ "a", "b", "c" ]
[ ‘a‘, ‘b‘, ‘c‘ ]
> _.length
3
> _ += 1
4

显示原文其他翻译纠错

REPL提供了访问global域里所有变量的权限。通过将一个变量赋值给与每一个REPLServer关联的context对象，你可以显式地将一个变量暴露给REPL。例如：

显示原文其他翻译纠错

repl.start("> ").context.m = msg;

显示原文其他翻译纠错

在context对象里的东西，会在REPL以本地变量的形式出现。

显示原文其他翻译纠错

mjr:~$ node repl_test.js
> m
‘message‘

显示原文其他翻译纠错

有几个特殊的REPL命令：

显示原文其他翻译纠错

  • .break - 当你输入一个多行表达式时，有时你走神了或者你不想完成这个表达式了。.break让你可以重头再来。
  • .clear - 重置context对象为一个空对象，并且清除所有的多行表达式。
  • .exit - 关闭I/O流，使得REPL退出。
  • .help - 显示这个特殊命令的列表。
  • .save - 将当前的REPL会话保存到一个文件

    .save ./file/to/save.js

  • .load - 将一个文件装载到当前的REPL会话。

    .load ./file/to/load.js

显示原文其他翻译纠错

下面的组合键在REPL中有以下效果：

显示原文其他翻译纠错

  • <ctrl>C - 与.break关键字类似。终止正在执行的命令。在一个空行连按两次会强制退出。
  • <ctrl>D - 与.exit关键字类似。

显示原文其他翻译纠错

执行 JavaScript#

显示原文其他翻译纠错

稳定度: 3 - 稳定

显示原文其他翻译纠错

你可以这样引入此模块：

显示原文其他翻译纠错

var vm = require(‘vm‘);

显示原文其他翻译纠错

JavaScript 代码可以被编译并立即执行，也可以在编译后保存，留到稍后执行。

显示原文其他翻译纠错

vm.runInThisContext(code, [options])#

显示原文其他翻译纠错

vm.runInThisContext() 对 code 进行编译、运行并返回结果。 被运行的代码没有对本地作用域 (local scope) 的访问权限，但是可以访问当前的 global 对象。

显示原文其他翻译纠错

使用 vm.runInThisContext 和 eval 分别执行相同的代码：

显示原文其他翻译纠错

// vmResult: ‘vm‘, localVar: ‘initial value‘
// evalResult: ‘eval‘, localVar: ‘eval‘

显示原文其他翻译纠错

vm.runInThisContext 无法访问本地作用域，因此 localVar 没有被改变。 eval 可以访问本地作用域，因此 localVar 被改变。

显示原文其他翻译纠错

这种情况下 vm.runInThisContext 可以看作一种 间接的 eval 调用， 如 (0,eval)(‘code‘)。但是 vm.runInThisContext 也提供下面几个额外的参数：

显示原文其他翻译纠错

  • filename: 允许您更改显示在站追踪 (stack trace) 中的文件名
  • displayErrors: 是否在抛出异常前输出带高亮错误代码行的错误信息到 stderr。 将会捕捉所有在编译 code 的过程中产生的语法错误以及执行过程中产生的运行时错误。 默认为 true
  • timeout: 以毫秒为单位规定 code 允许执行的时间。在执行过程中被终止时会有 Error 抛出。

显示原文其他翻译纠错

显示原文其他翻译纠错

vm.createContext([sandbox])#

显示原文其他翻译纠错

如提供 sandbox 对象则将沙箱 (sandbox) 对象 “上下文化 (contextify)” 供 vm.runInContext 或者 script.runInContext 使用。 以此方式运行的脚本将以 sandbox 作为全局对象，该对象将在保留其所有的属性的基础上拥有标准 全局对象 所拥有的内置对象和函数。 在由 vm 模块运行的脚本之外的地方 sandbox 将不会被改变。

显示原文其他翻译纠错

如果没有提供沙箱对象，则返回一个新建的、没有任何对象被上下文化的可用沙箱。

显示原文其他翻译纠错

此函数可用于创建可执行多个脚本的沙箱， 比如，在模拟浏览器的时候可以使用该函数创建一个用于表示 window 全局对象的沙箱， 并将所有 <script> 标签放入沙箱执行。

显示原文其他翻译纠错

显示原文其他翻译纠错

vm.isContext(sandbox)#

显示原文其他翻译纠错

返回沙箱对象是否已经通过 vm.createContext 上下文化 (contextified)

显示原文其他翻译纠错

vm.runInContext(code, contextifiedSandbox, [options])#

显示原文其他翻译纠错

vm.runInContext 编译 code 放入 contextifiedSandbox 执行并返回执行结果。 被执行的代码对 本地作用域 (local scope) 没有访问权。 contextifiedSandbox 必须在使用前通过 vm.createContext 上下文化，用作 code 的全局对象。

显示原文其他翻译纠错

vm.runInContext 使用与 vm.runInThisContext 相同的 选项 (options)

显示原文其他翻译纠错

示例：在同一个上下文中编译并执行不同的脚本

显示原文其他翻译纠错

// { globalVar: 1024 }

显示原文其他翻译纠错

执行不可信代码 (untrusted code) 是一件充满技巧而且需要非常小心的工作。 vm.runInContext 十分好用，但是安全地运行不可信代码还需要将这些代码放入单独的进程里面执行。

显示原文其他翻译纠错

vm.runInNewContext(code, [sandbox], [options])#

显示原文其他翻译纠错

vm.runInNewContext 首先编译 code，若提供 sandbox 则将 sandbox 上下文化，若未提供则创建一个新的沙箱并上下文化， 然后将代码放入沙箱作为全局对象的上下文内执行并返回结果。

显示原文其他翻译纠错

vm.runInNewContext 使用与 vm.runInThisContext 相同的 选项 (options)

显示原文其他翻译纠错

示例: 编译并执行一段“自增一个全局变量然后创建一个全局变量”的代码。这些被操作的全局变量会被保存在沙箱中。

显示原文其他翻译纠错

// { animal: ‘cat‘, count: 3, name: ‘kitty‘ }

显示原文其他翻译纠错

执行不可信代码 (untrusted code) 是一件充满技巧而且需要非常小心的工作。 vm.runInNewContext 十分好用，但是安全地运行不可信代码还需要将这些代码放入单独的进程里面执行。

显示原文其他翻译纠错

类: Script#

显示原文其他翻译纠错

用于存放预编译脚本的类，可将预编译代码放入沙箱执行。

显示原文其他翻译纠错

new vm.Script(code, options)#

显示原文其他翻译纠错

创建一个新的 Script 用于编译 code 但是不执行。使用被创建的 vm.Script 用来表示完成编译的代码。 这份可以在后面的代码中执行多次。 返回的脚本是未绑定任何全局对象 (上下文 context) 的，全局对象仅在每一次执行的时候被绑定，执行结束后即释放绑定。

显示原文其他翻译纠错

创建脚本的选项 (option) 有：

显示原文其他翻译纠错

  • filename: 允许您更改显示在站追踪 (stack trace) 中的文件名
  • displayErrors: 是否在抛出异常前输出带高亮错误代码行的错误信息到 stderr。 仅捕捉所有在编译过程中产生的语法错误（运行时错误由运行脚本选项控制）。

显示原文其他翻译纠错

script.runInThisContext([options])#

显示原文其他翻译纠错

类似 vm.runInThisContext 只是作为预编译的 Script 对象方法。 script.runInThisContext 执行被编译的 script 并返回结果。 被运行的代码没有对本地作用域 (local scope) 的访问权限，但是可以访问当前的 global 对象。

显示原文其他翻译纠错

示例: 使用 script.runInThisContext 编译代码并多次执行:

显示原文其他翻译纠错

// 1000

显示原文其他翻译纠错

运行脚本的选项 (option) 有:

显示原文其他翻译纠错

  • displayErrors: 是否在抛出异常前输出带高亮错误代码行的错误信息到 stderr。 仅捕捉所有执行过程中产生的运行时错误（语法错误会在 Script 示例创建时就发生，因此不可能创建出带语法错误的 Script 对象）。
  • timeout: 以毫秒为单位规定 code 允许执行的时间。在执行过程中被终止时会有 Error 抛出。

显示原文其他翻译纠错

script.runInContext(contextifiedSandbox, [options])#

显示原文其他翻译纠错

类似 vm.runInContext 只是作为预编译的 Script 对象方法。 script.runInContext 在 contextifiedSandbox 中执行 script 编译出的代码，并返回结果。 被运行的代码没有对本地作用域 (local scope) 的访问权限。

显示原文其他翻译纠错

script.runInContext 使用与 script.runInThisContext 相同的 选项 (option)。

显示原文其他翻译纠错

示例: 编译一段“自增一个全局变量然后创建一个全局变量”的代码，然后多次执行此代码， 被操作的全局变量会被保存在沙箱中。

显示原文其他翻译纠错

// { animal: ‘cat‘, count: 12, name: ‘kitty‘ }

显示原文其他翻译纠错

执行不可信代码 (untrusted code) 是一件充满技巧而且需要非常小心的工作。 script.runInContext 十分好用，但是安全地运行不可信代码还需要将这些代码放入单独的进程里面执行。

显示原文其他翻译纠错

script.runInNewContext([sandbox], [options])#

显示原文其他翻译纠错

类似 vm.runInNewContext 但是作为预编译的 Script 对象方法。 若提供 sandbox 则 script.runInNewContext 将 sandbox 上下文化，若未提供，则创建一个新的上下文化的沙箱， 然后将代码放入沙箱作为全局对象的上下文内执行并返回结果。

显示原文其他翻译纠错

script.runInNewContext 使用与 script.runInThisContext 相同的 选项 (option)。

显示原文其他翻译纠错

示例: 编译一段“写入一个全局变量”的代码，然后将代码放入不同的上下文 (context) 执行，这些被操作的全局变量会被保存在沙箱中。

显示原文其他翻译纠错

// [{ globalVar: ‘set‘ }, { globalVar: ‘set‘ }, { globalVar: ‘set‘ }]

显示原文其他翻译纠错

执行不可信代码 (untrusted code) 是一件充满技巧而且需要非常小心的工作。 script.runInNewContext 十分好用，但是安全地运行不可信代码还需要将这些代码放入单独的进程里面执行。

显示原文其他翻译纠错

子进程#

显示原文其他翻译纠错

稳定度: 3 - 稳定

显示原文其他翻译纠错

Node 通过 child_process 模块提供了类似 popen(3) 的处理三向数据流（stdin/stdout/stderr）的功能。

显示原文其他翻译纠错

它能够以完全非阻塞的方式与子进程的 stdin、stdout 和 stderr 以流式传递数据。（请注意，某些程序在内部使用行缓冲 I/O。这不会影响到 node.js，但您发送到子进程的数据不会被立即消费。）

显示原文其他翻译纠错

使用 require(‘child_process‘).spawn()或者 require(‘child_process‘).fork() 创建子进程，这两种方法的语义有些区别，下文将会解释。

显示原文其他翻译纠错

类: ChildProcess#

显示原文其他翻译纠错

ChildProcess 是一个 EventEmitter。

显示原文其他翻译纠错

子进程有三个与之关联的流：child.stdin、child.stdout 和 child.stderr。它们可以共享父进程的 stdio 流，也可以作为独立的被导流的流对象。

显示原文其他翻译纠错

ChildProcess 类不能直接被使用， 使用 spawn() 或者 fork() 方法创建一个 Child Process 实例。

显示原文其他翻译纠错

事件: ‘error‘#

显示原文其他翻译纠错

  • err {Error Object} 错误。

显示原文其他翻译纠错

发生于：

显示原文其他翻译纠错

  1. 进程不能被创建, 或者
  2. 进程不能被终止掉, 或者
  3. 由任何原因引起的数据发送到子进程失败.

显示原文其他翻译纠错

参阅 ChildProcess#kill() 和 ChildProcess#send()。

显示原文其他翻译纠错

事件: ‘exit‘#

显示原文其他翻译纠错

  • code {Number} 假如进程正常退出，则为它的退出代码。
  • signal {String} 假如是被父进程终止，则为所传入的终止子进程的信号。

显示原文其他翻译纠错

这个事件是在子进程被结束的时候触发的. 假如进程被正常结束，‘code’就是退出进程的指令代码, 否则为‘null‘. 假如进程是由于接受到signal结束的, signal 就代表着信号的名称, 否则为null.

显示原文其他翻译纠错

注意子进程的 stdio 流可能仍为开启状态。

显示原文其他翻译纠错

参阅waitpid(2).

显示原文其他翻译纠错

事件: ‘close‘#

显示原文其他翻译纠错

  • code {Number} 假如进程正常退出，则为它的退出代码。
  • signal {String} 假如是被父进程终止，则为所传入的终止子进程的信号。

显示原文其他翻译纠错

这个事件会在一个子进程的所有stdio流被终止时触发， 这和‘exit‘事件有明显的不同，因为多进程有时候会共享同一个stdio流

显示原文其他翻译纠错

事件: ‘disconnect‘#

显示原文其他翻译纠错

在子进程或父进程中使用使用.disconnect()方法后，这个事件会被触发，在断开之后，就不可能再相互发送信息了。可以通过检查子进程的child.connected属性是否为true去检查是否可以发送信息

显示原文其他翻译纠错

事件: ‘message‘#

显示原文其他翻译纠错

  • message {Object} 一个已解析的JSON对象或者原始类型值
  • sendHandle {Handle object} 一个socket 或者 server对象

显示原文其他翻译纠错

通过.send()发送的信息可以通过监听‘message‘事件获取到

显示原文其他翻译纠错

child.stdin#

显示原文其他翻译纠错

  • {Stream object}

显示原文其他翻译纠错

子进程的‘stdin‘是一个‘可写流’，通过end()方法关闭该可写流可以终止子进程，

显示原文其他翻译纠错

假如子进程的stdio流与父线程共享，这个child.stdin不会被设置

显示原文其他翻译纠错

child.stdout#

显示原文其他翻译纠错

  • {Stream object}

显示原文其他翻译纠错

子进程的stdout是个可读流.

显示原文其他翻译纠错

假如子进程的stdio流与父线程共享，这个child.stdin不会被设置

显示原文其他翻译纠错

child.stderr#

显示原文其他翻译纠错

  • {Stream object}

显示原文其他翻译纠错

子进程的stderr是一个可读流

显示原文其他翻译纠错

假如子进程的stdio流与父线程共享，这个child.stdin不会被设置

显示原文其他翻译纠错

child.pid#

显示原文其他翻译纠错

  • {Integer}

显示原文其他翻译纠错

子进程的PID

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

console.log(‘Spawned child pid: ‘ + grep.pid);
grep.stdin.end();

显示原文其他翻译纠错

child.kill([signal])#

显示原文其他翻译纠错

  • signal {String}

显示原文其他翻译纠错

发送一个信号给子线程. 假如没有给参数, 将会发送 ‘SIGTERM‘. 参阅 signal(7) 查看所有可用的signals列表

显示原文其他翻译纠错

// send SIGHUP to process
grep.kill(‘SIGHUP‘);

显示原文其他翻译纠错

当一个signal不能被传递的时候，会触发一个‘error‘事件， 发送一个信号到已终止的子线程不会发生错误，但是可能引起不可预见的后果， 假如该子进程的ID已经重新分配给了其他进程，signal将会被发送到其他进程上面，大家可以猜想到这发生什么后果。

显示原文其他翻译纠错

注意，当函数调用‘kill’, 传递给子进程的信号不会去终结子进程， ‘kill’实际上只是发送一个信号到进程而已。

显示原文其他翻译纠错

See kill(2)

显示原文其他翻译纠错

child.send(message, [sendHandle])#

显示原文其他翻译纠错

  • message {Object}
  • sendHandle {Handle object}

显示原文其他翻译纠错

当使用 child_process.fork() 你可以使用 child.send(message, [sendHandle])向子进程写数据 and 数据将通过子进程上的‘message’事件接受.

显示原文其他翻译纠错

例如：

显示原文其他翻译纠错

n.send({ hello: ‘world‘ });

显示原文其他翻译纠错

然后是子进程脚本的代码, ‘sub.js‘ 代码如下:

显示原文其他翻译纠错

process.send({ foo: ‘bar‘ });

显示原文其他翻译纠错

在子进程脚本中‘process‘对象有‘send()’方法， ‘process’每次通过它的信道接收到信息都会触发事件，信息以对象形式返回。

显示原文其他翻译纠错

不过发送{cmd: ‘NODE_foo‘} 信息是个比较特殊的情况. 所有在‘cmd’属性中包含 a NODE_前缀的信息将不会触发‘message’事件, 因为他们是由node 核心使用的内部信息. 相反这种信息会触发 internalMessage 事件, 你应该通过各种方法避免使用这种特性, 他改变的时候不会接收到通知.

显示原文其他翻译纠错

child.send()的sendHandle 选项是用来发送一个TCP服务或者socket对象到另一个线程的，子进程将会接收这个参数作为‘message’事件的第二个参数。

显示原文其他翻译纠错

假如信息不能被发送，将会触发一个‘error’事件， 比如说因为子线程已经退出了。

显示原文其他翻译纠错

例子: 发送一个server对象#

显示原文其他翻译纠错

这里是一个发送一个server对象的例子:

显示原文其他翻译纠错

// 创建一个handle对象，发送一个句柄.
var server = require(‘net‘).createServer();
server.on(‘connection‘, function (socket) {
  socket.end(‘handled by parent‘);
});
server.listen(1337, function() {
  child.send(‘server‘, server);
});

显示原文其他翻译纠错

同时子进程将会以如下方式接收到这个server对象:

显示原文其他翻译纠错

process.on(‘message‘, function(m, server) {
  if (m === ‘server‘) {
    server.on(‘connection‘, function (socket) {
      socket.end(‘handled by child‘);
    });
  }
});

显示原文其他翻译纠错

注意，server对象现在有父进程和子进程共享，这意味着某些连接将会被父进程和子进程处理。

显示原文其他翻译纠错

对‘dgram’服务器，工作流程是一样的, 你监听的是‘message’事件，而不是 ‘connection’事件， 使用‘server.bind’ ,而不是‘server.listen’.(当前仅在UNIX平台支持)

显示原文其他翻译纠错

示例: 发送socket对象#

显示原文其他翻译纠错

这是个发送socket的例子. 他将创建两个子线程 ，同时处理连接，这是通过使用远程地址 74.125.127.100 作为 VIP 发送socket到一个‘特殊’的子线程. 其他的socket将会发送到‘正常’的线程里.

显示原文其他翻译纠错

  // if this is a VIP
  if (socket.remoteAddress === ‘74.125.127.100‘) {
    special.send(‘socket‘, socket);
    return;
  }
  // just the usual dudes
  normal.send(‘socket‘, socket);
});
server.listen(1337);

显示原文其他翻译纠错

child.js 文件代码如下:

显示原文其他翻译纠错

process.on(‘message‘, function(m, socket) {
  if (m === ‘socket‘) {
    socket.end(‘You were handled as a ‘ + process.argv[2] + ‘ person‘);
  }
});

显示原文其他翻译纠错

注意，一旦单个的socket被发送到子进程，当这个socket被删除之后，父进程将不再对它保存跟踪，这表明了这个条件下‘.connetions’属性将变成‘null‘， 在这个条件下同时也不推荐使用‘.maxConnections’属性.

显示原文其他翻译纠错

child.disconnect()#

显示原文其他翻译纠错

使用child.disconnect() 方法关闭父进程与子进程的IPC连接. 他让子进程非常优雅的退出，因为已经没有活跃的IPC信道. 当调用这个方法，‘disconnect’事件将会同时在父进程和子进程内被触发，‘connected’的标签将会被设置成‘flase’， 请注意，你也可以在子进程中调用‘process.disconnect()’

显示原文其他翻译纠错

child_process.spawn(command, [args], [options])#

显示原文其他翻译纠错

  • command {String}要运行的命令
  • args {Array} 字符串参数列表
  • options {Object}
    • cwd {String} 子进程的当前的工作目录
    • stdio {Array|String} 子进程 stdio 配置. (参阅下文)
    • customFds {Array} Deprecated 作为子进程 stdio 使用的 文件标示符. (参阅下文)
    • env {Object} 环境变量的键值对
    • detached {Boolean} 子进程将会变成一个进程组的领导者. (参阅下文)
    • uid {Number} 设置用户进程的ID. (See setuid(2).)
    • gid {Number} 设置进程组的ID. (See setgid(2).)
  • 返回: {ChildProcess object}

显示原文其他翻译纠错

用给定的命令发布一个子进程，带有‘args’命令行参数，如果省略的话，‘args’默认为一个空数组

显示原文其他翻译纠错

第三个参数被用来指定额外的设置，默认是:

显示原文其他翻译纠错

{ cwd: undefined,
  env: process.env
}

显示原文其他翻译纠错

cwd允许你从被创建的子进程中指定一个工作目录. 使用 env 去指定在新进程中可用的环境变量.

显示原文其他翻译纠错

一个运行 ls -lh /usr的例子, 获取stdout, stderr, 和退出代码:

显示原文其他翻译纠错

ls.on(‘close‘, function (code) {
  console.log(‘child process exited with code ‘ + code);
});

显示原文其他翻译纠错

例子: 一个非常精巧的方法执行 ‘ps ax | grep ssh‘

显示原文其他翻译纠错

grep.on(‘close‘, function (code) {
  if (code !== 0) {
    console.log(‘grep process exited with code ‘ + code);
  }
});

显示原文其他翻译纠错

检查执行错误的例子:

显示原文其他翻译纠错

child.stderr.setEncoding(‘utf8‘);
child.stderr.on(‘data‘, function (data) {
  if (/^execvp\(\)/.test(data)) {
    console.log(‘Failed to start child process.‘);
  }
});

显示原文其他翻译纠错

注意，当在spawn过程中接收一个空对象,这会导致创建的进程使用空的环境变量而不是使用‘process.env’.这是由于与一个废弃API向后兼容的问题.

显示原文其他翻译纠错

child_process.spawn() 中的 stdio 选项是一个数组，每个索引对应子进程中的一个文件标识符。可以是下列值之一：

显示原文其他翻译纠错

  1. ‘pipe‘ -在子进程与父进程之间创建一个管道，管道的父进程端以 child_process 的属性的形式暴露给父进程，如 ChildProcess.stdio[fd]。 为 文件标识（fds） 0 - 2 建立的管道也可以通过 ChildProcess.stdin，ChildProcess.stdout 及 ChildProcess.stderr 分别访问。
  2. ‘ipc‘ - 创建一个IPC通道以在父进程与子进程之间传递 消息/文件标识符。一个子进程只能有最多一个 IPC stdio 文件标识。 设置该选项激活 ChildProcess.send() 方法。如果子进程向此文件标识符写JSON消息，则会触发 ChildProcess.on("message")。 如果子进程是一个nodejs程序，那么IPC通道的存在会激活process.send()和process.on(‘message‘)
  3. ‘ignore‘ - 不在子进程中设置该文件标识。注意，Node 总是会为其spawn的进程打开 文件标识（fd） 0 - 2。 当其中任意一项被 ignored，node 会打开 /dev/null 并将其附给子进程的文件标识（fd）。
  4. Stream 对象 - 与子进程共享一个与tty，文件，socket，或者管道(pipe)相关的可读或可写流。 该流底层（underlying）的文件标识在子进程中被复制给stdio数组索引对应的文件标识（fd）
  5. 正数 - 该整形值被解释为父进程中打开的文件标识符。他与子进程共享，和Stream被共享的方式相似。
  6. null, undefined - 使用默认值。 对于stdio fds 0,1,2（或者说stdin,stdout和stderr），pipe管道被建立。对于fd 3及往后，默认为ignore

显示原文其他翻译纠错

作为快捷方式，stdio 参数除了数组也可以是下列字符串之一：

显示原文其他翻译纠错

  • ignore - [‘ignore‘, ‘ignore‘, ‘ignore‘]
  • pipe - [‘pipe‘, ‘pipe‘, ‘pipe‘]
  • inherit - [process.stdin, process.stdout, process.stderr] 或 [0,1,2]

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

// 开启一个额外的 fd=4 来与提供 startd 风格接口的程序进行交互。
spawn(‘prg‘, [], { stdio: [‘pipe‘, null, null, null, ‘pipe‘] });

显示原文其他翻译纠错

如果 detached 选项被设置，则子进程会被作为新进程组的 leader。这使得子进程可以在父进程退出后继续运行。

显示原文其他翻译纠错

缺省情况下，父进程会等待脱离了的子进程退出。要阻止父进程等待一个给出的子进程 child，使用 child.unref() 方法，则父进程的事件循环引用计数中将不会包含这个子进程。

显示原文其他翻译纠错

脱离一个长时间运行的进程并将它的输出重定向到一个文件的例子：

显示原文其他翻译纠错

 child.unref();

显示原文其他翻译纠错

当使用 detached 选项来启动一个长时间运行的进程，该进程不会在后台保持运行，除非向它提供了一个不连接到父进程的 stdio 配置。如果继承了父进程的 stdio，则子进程会继续附着在控制终端。

显示原文其他翻译纠错

有一个已废弃的选项 customFds 允许指定特定文件描述符作为子进程的 stdio。该 API 无法移植到所有平台，因此被移除。使用 customFds 可以将新进程的 [stdin, stdout, stderr] 钩到已有流上；-1 表示创建新流。自己承担使用风险。

显示原文其他翻译纠错

参阅：child_process.exec() 和 child_process.fork()

显示原文其他翻译纠错

child_process.exec(command, [options], callback)#

显示原文其他翻译纠错

  • command {String} 将要执行的命令，用空格分隔参数
  • options {Object}
    • cwd {String} 子进程的当前工作目录
    • env {Object} 环境变量键值对
    • encoding {String} 编码（缺省为 ‘utf8‘）
    • shell {String} 运行命令的 shell（UNIX 上缺省为 ‘/bin/sh‘，Windows 上缺省为 ‘cmd.exe‘。该 shell 在 UNIX 上应当接受 -c 开关，在 Windows 上应当接受 /s /c 开关。在 Windows 中，命令行解析应当兼容 cmd.exe。）
    • timeout {Number} 超时（缺省为 0）
    • maxBuffer {Number} 最大缓冲（缺省为 200*1024）
    • killSignal {String} 结束信号（缺省为 ‘SIGTERM‘）
  • callback {Function} 进程结束时回调并带上输出
    • error {Error}
    • stdout {Buffer}
    • stderr {Buffer}
  • 返回：ChildProcess 对象

显示原文其他翻译纠错

在 shell 中执行一个命令并缓冲输出。

显示原文其他翻译纠错

child = exec(‘cat *.js bad_file | wc -l‘,
  function (error, stdout, stderr) {
    console.log(‘stdout: ‘ + stdout);
    console.log(‘stderr: ‘ + stderr);
    if (error !== null) {
      console.log(‘exec error: ‘ + error);
    }
});

显示原文其他翻译纠错

回调参数为 (error, stdout, stderr)。当成功时，error 会是 null。当遇到错误时，error 会是一个 Error 实例，并且 err.code 会是子进程的退出代码，同时 err.signal 会被设置为结束进程的信号名。

显示原文其他翻译纠错

第二个可选的参数用于指定一些选项，缺省选项为：

显示原文其他翻译纠错

{ encoding: ‘utf8‘,
  timeout: 0,
  maxBuffer: 200*1024,
  killSignal: ‘SIGTERM‘,
  cwd: null,
  env: null }

显示原文其他翻译纠错

如果 timeout 大于 0，则当进程运行超过 timeout 毫秒后会被终止。子进程使用 killSignal 信号结束（缺省为 ‘SIGTERM‘）。maxBuffer 指定了 stdout 或 stderr 所允许的最大数据量，如果超出这个值则子进程会被终止。

显示原文其他翻译纠错

child_process.execFile(file, args, options, callback)#

显示原文其他翻译纠错

  • file {String} 要运行的程序的文件名
  • args {Array} 字符串参数列表
  • options {Object}
    • cwd {String} 子进程的当前工作目录
    • env {Object} 环境变量键值对
    • encoding {String} 编码（缺省为 ‘utf8‘）
    • timeout {Number} 超时（缺省为 0）
    • maxBuffer {Number} 最大缓冲（缺省为 200*1024）
    • killSignal {String} 结束信号（缺省为 ‘SIGTERM‘）
  • callback {Function} 进程结束时回调并带上输出
    • error {Error}
    • stdout {Buffer}
    • stderr {Buffer}
  • 返回：ChildProcess 对象

显示原文其他翻译纠错

该方法类似于 child_process.exec()，但是它不会执行一个子 shell，而是直接执行所指定的文件。因此它稍微比 child_process.exec 精简，参数与之一致。

显示原文其他翻译纠错

child_process.fork(modulePath, [args], [options])#

显示原文其他翻译纠错

  • modulePath {String} 子进程中运行的模块
  • args {Array} 字符串参数列表
  • options {Object}
    • cwd {String} 子进程的当前工作目录
    • env {Object} 环境变量键值对
    • encoding {String} 编码（缺省为 ‘utf8‘）
    • execPath {String} 创建子进程的可执行文件
  • 返回：ChildProcess 对象

显示原文其他翻译纠错

该方法是 spawn() 的特殊情景，用于派生 Node 进程。除了普通 ChildProcess 实例所具有的所有方法，所返回的对象还具有内建的通讯通道。详见 child.send(message, [sendHandle])。

显示原文其他翻译纠错

缺省情况下所派生的 Node 进程的 stdout、stderr 会关联到父进程。要更改该行为，可将 options 对象中的 silent 属性设置为 true。

显示原文其他翻译纠错

子进程运行完成时并不会自动退出，您需要明确地调用 process.exit()。该限制可能会在未来版本里接触。

显示原文其他翻译纠错

这些子 Node 是全新的 V8 实例，假设每个新的 Node 需要至少 30 毫秒的启动时间和 10MB 内存，就是说您不能创建成百上千个这样的实例。

显示原文其他翻译纠错

options 对象中的 execPath 属性可以用非当前 node 可执行文件来创建子进程。这需要小心使用，并且缺省情况下会使用子进程上的 NODE_CHANNEL_FD 环境变量所指定的文件描述符来通讯。该文件描述符的输入和输出假定为以行分割的 JSON 对象。

显示原文其他翻译纠错

显示原文其他翻译纠错

断言 (assert)#

显示原文其他翻译纠错

稳定度: 5 - 已锁定

显示原文其他翻译纠错

此模块主要用于对您的程序进行单元测试，要使用它，请 require(‘assert‘)。

显示原文其他翻译纠错

assert.fail(actual, expected, message, operator)#

显示原文其他翻译纠错

抛出异常：显示为被 operator （分隔符）所分隔的 actual （实际值）和 expected （期望值）。

显示原文其他翻译纠错

assert(value, message), assert.ok(value, [message])#

显示原文其他翻译纠错

测试结果是否为真（true），相当于 assert.equal(true, !!value, message);

显示原文其他翻译纠错

assert.equal(actual, expected, [message])#

显示原文其他翻译纠错

浅测试, 强制相等就像使用相等操作符( == ).

显示原文其他翻译纠错

assert.notEqual(actual, expected, [message])#

显示原文其他翻译纠错

Tests shallow, coercive non-equality with the not equal comparison operator ( != ).

显示原文其他翻译纠错

assert.deepEqual(actual, expected, [message])#

显示原文其他翻译纠错

用于深度匹配测试。

显示原文其他翻译纠错

assert.notDeepEqual(actual, expected, [message])#

显示原文其他翻译纠错

用于深度非匹配测试。

显示原文其他翻译纠错

assert.strictEqual(actual, expected, [message])#

显示原文其他翻译纠错

用于严格相等匹配测试，由（===）的结果决定

显示原文其他翻译纠错

assert.notStrictEqual(actual, expected, [message])#

显示原文其他翻译纠错

严格不相等测试, 强制不相等就像使用严格不相等操作符( !== ).

显示原文其他翻译纠错

assert.throws(block, [error], [message])#

显示原文其他翻译纠错

输出一个错误的 block。 error 可以是构造函数，正则或者验证函数

显示原文其他翻译纠错

使用验证实例的构造函数

显示原文其他翻译纠错

assert.throws(
  function() {
    throw new Error("错误值");
  },
  Error
);

显示原文其他翻译纠错

用正则表达式验证错误消息。

显示原文其他翻译纠错

assert.throws(
  function() {
    throw new Error("错误值");
  },
  /value/
);

显示原文其他翻译纠错

自定义错误校验：

显示原文其他翻译纠错

assert.throws(
  function() {
    throw new Error("Wrong value");
  },
  function(err) {
    if ( (err instanceof Error) && /value/.test(err) ) {
      return true;
    }
  },
  "unexpected error"
);

显示原文其他翻译纠错

assert.doesNotThrow(block, [message])#

显示原文其他翻译纠错

预期 block 不会抛出错误，详见 assert.throws。

显示原文其他翻译纠错

assert.ifError(value)#

显示原文其他翻译纠错

测试值是否不为 false，当为 true 时抛出。常用于回调中第一个 error 参数的检查。

显示原文其他翻译纠错

TTY#

显示原文其他翻译纠错

稳定度: 2 - 不稳定

显示原文其他翻译纠错

tty 模块提供了 tty.ReadStream 和 tty.WriteStream 类。在大部分情况下，您都不会需要直接使用此模块。

显示原文其他翻译纠错

当 node 检测到它正运行于 TTY 上下文中时，process.stdin 将会是一个 tty.ReadStream 实例，且 process.stdout 也将会是一个 tty.WriteStream 实例。检查 node 是否运行于 TTY 上下文的首选方式是检查 process.stdout.isTTY：

显示原文其他翻译纠错

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

显示原文其他翻译纠错

tty.isatty(fd)#

显示原文其他翻译纠错

若 fd 关联于中端则返回 true，反之返回 false。

显示原文其他翻译纠错

tty.setRawMode(mode)#

显示原文其他翻译纠错

已废弃，请使用 tty.ReadStream#setRawMode()（如 process.stdin.setRawMode()）。

显示原文其他翻译纠错

类: ReadStream#

显示原文其他翻译纠错

一个 net.Socket 子类，代表 TTY 的可读部分。通常情况下在所有 node 程序中 process.stdin 会是仅有的 tty.ReadStream 实例（进当 isatty(0) 为 true 时）。

显示原文其他翻译纠错

rs.isRaw#

显示原文其他翻译纠错

一个 Boolean，初始为 false，代表 tty.ReadStream 实例的当前 "raw" 状态。

显示原文其他翻译纠错

rs.setRawMode(mode)#

显示原文其他翻译纠错

mode 可以是 true 或 false。它设定 tty.ReadStream 的属性表现为原始设备或缺省。isRaw 会被设置为结果模式。

显示原文其他翻译纠错

类: WriteStream#

显示原文其他翻译纠错

一个 net.Socket 子类，代表 TTY 的可写部分。通常情况下 process.stdout 会是仅有的 tty.WriteStream 实例（进当 isatty(1) 为 true 时）。

显示原文其他翻译纠错

ws.columns#

显示原文其他翻译纠错

一个 `Number，表示 TTY 当前的列数。该属性会在 "resize" 事件中被更新。

显示原文其他翻译纠错

ws.rows#

显示原文其他翻译纠错

一个 `Number，表示 TTY 当前的行数。该属性会在 "resize" 事件中被更新。

显示原文其他翻译纠错

事件: ‘resize‘#

显示原文其他翻译纠错

function () {}

显示原文其他翻译纠错

由 refreshSize() 在 columns 或 rows 属性被改变时触发。

显示原文其他翻译纠错

process.stdout.on(‘resize‘, function() {
  console.log(‘屏幕大小已改变！‘);
  console.log(process.stdout.columns + ‘x‘ + process.stdout.rows);
});

显示原文其他翻译纠错

Zlib#

显示原文其他翻译纠错

稳定度: 3 - 稳定

显示原文其他翻译纠错

你可以这样引入此模块：

显示原文其他翻译纠错

var zlib = require(‘zlib‘);

显示原文其他翻译纠错

这个模块提供了对Gzip/Gunzip, Deflate/Inflate和DeflateRaw/InflateRaw类的绑定。每一个类都可以接收相同的选项，并且本身也是一个可读写的Stream类。

显示原文其他翻译纠错

例子#

显示原文其他翻译纠错

压缩或解压缩一个文件可以通过导流一个 fs.ReadStream 到一个 zlib 流，然后到一个 fs.WriteStream 来完成。

显示原文其他翻译纠错

inp.pipe(gzip).pipe(out);

显示原文其他翻译纠错

一步压缩或解压缩数据可以通过快捷方法来完成。

显示原文其他翻译纠错

var buffer = new Buffer(‘eJzT0yMAAGTvBe8=‘, ‘base64‘);
zlib.unzip(buffer, function(err, buffer) {
  if (!err) {
    console.log(buffer.toString());
  }
});

显示原文其他翻译纠错

要在 HTTP 客户端或服务器中使用此模块，请在请求和响应中使用 accept-encoding 和 content-encoding 头。

显示原文其他翻译纠错

注意：这些例子只是极其简单地展示了基础的概念 Zlib 编码消耗非常大,结果需要缓存.看下面的内存调优 中更多的关于Zlib用法中 速度/内存/压缩 的权衡取舍。

显示原文其他翻译纠错

  // 注意: 这不是一个不合格的 accept-encoding 解析器
  // 详见 http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3
  if (acceptEncoding.match(/\bdeflate\b/)) {
    response.writeHead(200, { ‘content-encoding‘: ‘deflate‘ });
    raw.pipe(zlib.createDeflate()).pipe(response);
  } else if (acceptEncoding.match(/\bgzip\b/)) {
    response.writeHead(200, { ‘content-encoding‘: ‘gzip‘ });
    raw.pipe(zlib.createGzip()).pipe(response);
  } else {
    response.writeHead(200, {});
    raw.pipe(response);
  }
}).listen(1337);

显示原文其他翻译纠错

zlib.createGzip([options])#

显示原文其他翻译纠错

以 options 所给选项返回一个新的 Gzip 对象。

显示原文其他翻译纠错

zlib.createGunzip([options])#

显示原文其他翻译纠错

以 options 所给选项返回一个新的 Gunzip 对象。

显示原文其他翻译纠错

zlib.createDeflate([options])#

显示原文其他翻译纠错

以 options 所给选项返回一个新的 Deflate 对象。

显示原文其他翻译纠错

zlib.createInflate([options])#

显示原文其他翻译纠错

以 options 所给选项返回一个新的 Inflate 对象。

显示原文其他翻译纠错

zlib.createDeflateRaw([options])#

显示原文其他翻译纠错

以 options 所给选项返回一个新的 DeflateRaw 对象。

显示原文其他翻译纠错

zlib.createInflateRaw([options])#

显示原文其他翻译纠错

以 options 所给选项返回一个新的 InflateRaw 对象。

显示原文其他翻译纠错

zlib.createUnzip([options])#

显示原文其他翻译纠错

以 options 所给选项返回一个新的 Unzip 对象。

显示原文其他翻译纠错

类: zlib.Zlib#

显示原文其他翻译纠错

这个类未被 zlib 模块导出，编入此文档是因为它是其它压缩器/解压缩器的基类。

显示原文其他翻译纠错

zlib.flush([kind], callback)#

显示原文其他翻译纠错

kind 缺省为 zlib.Z_FULL_FLUSH。

显示原文其他翻译纠错

写入缓冲数据。请勿轻易调用此方法，过早的写入会对压缩算法的作用产生影响。

显示原文其他翻译纠错

zlib.params(level, strategy, callback)#

显示原文其他翻译纠错

动态更新压缩级别和压缩策略。仅对 deflate 算法有效。

显示原文其他翻译纠错

zlib.reset()#

显示原文其他翻译纠错

将压缩器/解压缩器重置为缺省值。仅对 inflate 和 deflate 算法有效。

显示原文其他翻译纠错

类: zlib.Gzip#

显示原文其他翻译纠错

使用 gzip 压缩数据。

显示原文其他翻译纠错

类: zlib.Gunzip#

显示原文其他翻译纠错

解压缩一个 gzip 流。

显示原文其他翻译纠错

类: zlib.Deflate#

显示原文其他翻译纠错

使用 deflate 压缩数据。

显示原文其他翻译纠错

类: zlib.Inflate#

显示原文其他翻译纠错

解压缩一个 deflate 流。

显示原文其他翻译纠错

类: zlib.DeflateRaw#

显示原文其他翻译纠错

使用 deflate 压缩数据，并且不附带 zlib 头。

显示原文其他翻译纠错

类: zlib.InflateRaw#

显示原文其他翻译纠错

解压缩一个原始 deflate 流。

显示原文其他翻译纠错

类: zlib.Unzip#

显示原文其他翻译纠错

自动识别头部来解压缩一个以 gzip 或 deflate 压缩的流。

显示原文其他翻译纠错

快捷方法#

显示原文其他翻译纠错

所有这些方法的第一个参数都可以是字符串或 Buffer；可选地可以将传给 zlib 类的选项作为第二个参数传入；回调格式为 callback(error, result)。

显示原文其他翻译纠错

zlib.deflate(buf, [options], callback)#

显示原文其他翻译纠错

使用 Deflate 压缩一个字符串。

显示原文其他翻译纠错

zlib.deflateRaw(buf, [options], callback)#

显示原文其他翻译纠错

使用 DeflateRaw 压缩一个字符串。

显示原文其他翻译纠错

zlib.Gzip(buf, [options], callback)#

显示原文其他翻译纠错

使用 Gzip 压缩一个字符串。

显示原文其他翻译纠错

zlib.gunzip(buf, [options], callback)#

显示原文其他翻译纠错

使用 Gunzip 解压缩一个原始的 Buffer。

显示原文其他翻译纠错

zlib.inflate(buf, [options], callback)#

显示原文其他翻译纠错

使用 Inflate 解压缩一个原始的 Buffer。

显示原文其他翻译纠错

zlib.inflateRaw(buf, [options], callback)#

显示原文其他翻译纠错

使用 InflateRaw 解压缩一个原始的 Buffer。

显示原文其他翻译纠错

zlib.unzip(buf, [options], callback)#

显示原文其他翻译纠错

使用 Unzip 解压缩一个原始的 Buffer。

显示原文其他翻译纠错

选项#

显示原文其他翻译纠错

各个类都有一个选项对象。所有选项都是可选的。

显示原文其他翻译纠错

请注意有些选项仅对压缩有效，并会被解压缩类所忽略。

显示原文其他翻译纠错

  • flush（缺省：zlib.Z_NO_FLUSH）
  • chunkSize（缺省：16*1024）
  • windowBits
  • level（仅用于压缩）
  • memLevel（仅用于压缩）
  • strategy（仅用于压缩）
  • dictionary（仅用于 deflate/inflate，缺省为空目录）

显示原文其他翻译纠错

详情请参阅 http://zlib.net/manual.html#Advanced 的 deflateInit2 和 inflateInit2。

显示原文其他翻译纠错

内存使用调优#

显示原文其他翻译纠错

来自 zlib/zconf.h，修改为 node 的用法：

显示原文其他翻译纠错

deflate 的内存需求（按字节）：

显示原文其他翻译纠错

(1 << (windowBits+2)) +  (1 << (memLevel+9))

显示原文其他翻译纠错

表示：windowBits = 15 的 128K + memLevel = 8 的 128K（缺省值）加上其它对象的若干 KB。

显示原文其他翻译纠错

举个例子，如果您需要将缺省内存需求从 256K 减少到 128K，设置选项：

显示原文其他翻译纠错

{ windowBits: 14, memLevel: 7 }

显示原文其他翻译纠错

当然这通常会降低压缩等级（天底下没有免费午餐）。

显示原文其他翻译纠错

inflate 的内存需求（按字节）：

显示原文其他翻译纠错

1 << windowBits

显示原文其他翻译纠错

表示 windowBits = 15（缺省值）的 32K 加上其它对象的若干 KB。

显示原文其他翻译纠错

这是除了内部输出缓冲外 chunkSize 的大小，缺省为 16K。

显示原文其他翻译纠错

zlib 压缩的速度主要受压缩级别 level 的影响。更高的压缩级别会有更好的压缩率，但也要花费更长时间。更低的压缩级别会有较低压缩率，但速度更快。

显示原文其他翻译纠错

通常，使用更多内存的选项意味着 node 能减少对 zlib 的调用，因为单次 write操作能处理更多数据。因此，这是另一个影响速度和内存占用的因素。

显示原文其他翻译纠错

常量#

显示原文其他翻译纠错

所有在 zlib.h 中定义的常量同样也定义在 require(‘zlib‘) 中。 在通常情况下您几乎不会用到它们，编入文档只是为了让您不会对它们的存在感到惊讶。该章节几乎完全来自 zlib 的文档。详见 http://zlib.net/manual.html#Constants。

显示原文其他翻译纠错

允许的 flush 取值。

显示原文其他翻译纠错

  • zlib.Z_NO_FLUSH
  • zlib.Z_PARTIAL_FLUSH
  • zlib.Z_SYNC_FLUSH
  • zlib.Z_FULL_FLUSH
  • zlib.Z_FINISH
  • zlib.Z_BLOCK
  • zlib.Z_TREES

显示原文其他翻译纠错

压缩/解压缩函数的返回值。负数代表错误，正数代表特殊但正常的事件。

显示原文其他翻译纠错

  • zlib.Z_OK
  • zlib.Z_STREAM_END
  • zlib.Z_NEED_DICT
  • zlib.Z_ERRNO
  • zlib.Z_STREAM_ERROR
  • zlib.Z_DATA_ERROR
  • zlib.Z_MEM_ERROR
  • zlib.Z_BUF_ERROR
  • zlib.Z_VERSION_ERROR

显示原文其他翻译纠错

压缩级别。

显示原文其他翻译纠错

  • zlib.Z_NO_COMPRESSION
  • zlib.Z_BEST_SPEED
  • zlib.Z_BEST_COMPRESSION
  • zlib.Z_DEFAULT_COMPRESSION

显示原文其他翻译纠错

压缩策略。

显示原文其他翻译纠错

  • zlib.Z_FILTERED
  • zlib.Z_HUFFMAN_ONLY
  • zlib.Z_RLE
  • zlib.Z_FIXED
  • zlib.Z_DEFAULT_STRATEGY

显示原文其他翻译纠错

data_type 字段的可能值。

显示原文其他翻译纠错

  • zlib.Z_BINARY
  • zlib.Z_TEXT
  • zlib.Z_ASCII
  • zlib.Z_UNKNOWN

显示原文其他翻译纠错

deflate 压缩方法（该版本仅支持一种）。

显示原文其他翻译纠错

  • zlib.Z_DEFLATED

显示原文其他翻译纠错

初始化 zalloc/zfree/opaque。

显示原文其他翻译纠错

  • zlib.Z_NULL

显示原文其他翻译纠错

操作系统#

显示原文其他翻译纠错

稳定度: 4 - 冻结

显示原文其他翻译纠错

提供一些基本的操作系统相关函数。

显示原文其他翻译纠错

使用 require(‘os‘) 来调用这个模块。

显示原文其他翻译纠错

os.tmpdir()#

显示原文其他翻译纠错

返回操作系统默认的临时文件目录

显示原文其他翻译纠错

os.endianness()#

显示原文其他翻译纠错

返回 CPU 的字节序，可能的是 "BE" 或 "LE"。

显示原文其他翻译纠错

os.hostname()#

显示原文其他翻译纠错

返回操作系统的主机名。

显示原文其他翻译纠错

os.type()#

显示原文其他翻译纠错

返回操作系统名称。

显示原文其他翻译纠错

os.platform()#

显示原文其他翻译纠错

返回操作系统平台

显示原文其他翻译纠错

os.arch()#

显示原文其他翻译纠错

返回操作系统 CPU 架构，可能的值有 "x64"、"arm" 和 "ia32"。

显示原文其他翻译纠错

os.release()#

显示原文其他翻译纠错

返回操作系统的发行版本。

显示原文其他翻译纠错

os.uptime()#

显示原文其他翻译纠错

返回操作系统运行的时间，以秒为单位。

显示原文其他翻译纠错

os.loadavg()#

显示原文其他翻译纠错

返回一个包含 1、5、15 分钟平均负载的数组。

显示原文其他翻译纠错

os.totalmem()#

显示原文其他翻译纠错

返回系统内存总量，单位为字节。

显示原文其他翻译纠错

os.freemem()#

显示原文其他翻译纠错

返回操作系统空闲内存量，单位是字节。

显示原文其他翻译纠错

os.cpus()#

显示原文其他翻译纠错

返回一个对象数组，包含所安装的每个 CPU/内核的信息：型号、速度（单位 MHz）、时间（一个包含 user、nice、sys、idle 和 irq 所使用 CPU/内核毫秒数的对象）。

显示原文其他翻译纠错

os.cpus 的示例：

显示原文其他翻译纠错

[ { model: ‘Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz‘,
    speed: 2926,
    times:
     { user: 252020,
       nice: 0,
       sys: 30340,
       idle: 1070356870,
       irq: 0 } },
  { model: ‘Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz‘,
    speed: 2926,
    times:
     { user: 306960,
       nice: 0,
       sys: 26980,
       idle: 1071569080,
       irq: 0 } },
  { model: ‘Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz‘,
    speed: 2926,
    times:
     { user: 248450,
       nice: 0,
       sys: 21750,
       idle: 1070919370,
       irq: 0 } },
  { model: ‘Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz‘,
    speed: 2926,
    times:
     { user: 256880,
       nice: 0,
       sys: 19430,
       idle: 1070905480,
       irq: 20 } },
  { model: ‘Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz‘,
    speed: 2926,
    times:
     { user: 511580,
       nice: 20,
       sys: 40900,
       idle: 1070842510,
       irq: 0 } },
  { model: ‘Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz‘,
    speed: 2926,
    times:
     { user: 291660,
       nice: 0,
       sys: 34360,
       idle: 1070888000,
       irq: 10 } },
  { model: ‘Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz‘,
    speed: 2926,
    times:
     { user: 308260,
       nice: 0,
       sys: 55410,
       idle: 1071129970,
       irq: 880 } },
  { model: ‘Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz‘,
    speed: 2926,
    times:
     { user: 266450,
       nice: 1480,
       sys: 34920,
       idle: 1072572010,
       irq: 30 } } ]

显示原文其他翻译纠错

os.networkInterfaces()#

显示原文其他翻译纠错

获取网络接口的一个列表信息：

显示原文其他翻译纠错

{ lo:
   [ { address: ‘127.0.0.1‘,
       netmask: ‘255.0.0.0‘,
       family: ‘IPv4‘,
       mac: ‘00:00:00:00:00:00‘,
       internal: true },
     { address: ‘::1‘,
       netmask: ‘ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff‘,
       family: ‘IPv6‘,
       mac: ‘00:00:00:00:00:00‘,
       internal: true } ],
  eth0:
   [ { address: ‘192.168.1.108‘,
       netmask: ‘255.255.255.0‘,
       family: ‘IPv4‘,
       mac: ‘01:02:03:0a:0b:0c‘,
       internal: false },
     { address: ‘fe80::a00:27ff:fe4e:66a1‘,
       netmask: ‘ffff:ffff:ffff:ffff::‘,
       family: ‘IPv6‘,
       mac: ‘01:02:03:0a:0b:0c‘,
       internal: false } ] }

显示原文其他翻译纠错

os.EOL#

显示原文其他翻译纠错

一个定义了操作系统的一行结束的标识的常量。

显示原文其他翻译纠错

调试器#

显示原文其他翻译纠错

稳定度: 3 - 稳定

显示原文其他翻译纠错

V8 提供了一个强大的调试器，可以通过 TCP 协议从外部访问。Node 内建了这个调试器的客户端。要使用调试器，以 debug 参数启动 Node，出现提示符：

显示原文其他翻译纠错

% node debug myscript.js
< debugger listening on port 5858
connecting... ok
break in /home/indutny/Code/git/indutny/myscript.js:1
  1 x = 5;
  2 setTimeout(function () {
  3   debugger;
debug>

显示原文其他翻译纠错

Node 的调试器客户端并未完整支持所有命令，但简单的步进和检查是可行的。通过脚本的源代码中放置 debugger; 语句，您便可启用一个断点。

显示原文其他翻译纠错

比如，假设有一个类似这样的 myscript.js：

显示原文其他翻译纠错

// myscript.js
x = 5;
setTimeout(function () {
  debugger;
  console.log("world");
}, 1000);
console.log("hello");

显示原文其他翻译纠错

那么，当调试器运行时，它会在第 4 行中断：

显示原文其他翻译纠错

% node debug myscript.js
< debugger listening on port 5858
connecting... ok
break in /home/indutny/Code/git/indutny/myscript.js:1
  1 x = 5;
  2 setTimeout(function () {
  3   debugger;
debug> cont
< hello
break in /home/indutny/Code/git/indutny/myscript.js:3
  1 x = 5;
  2 setTimeout(function () {
  3   debugger;
  4   console.log("world");
  5 }, 1000);
debug> next
break in /home/indutny/Code/git/indutny/myscript.js:4
  2 setTimeout(function () {
  3   debugger;
  4   console.log("world");
  5 }, 1000);
  6 console.log("hello");
debug> repl
Press Ctrl + C to leave debug repl
> x
5
> 2+2
4
debug> next
< world
break in /home/indutny/Code/git/indutny/myscript.js:5
  3   debugger;
  4   console.log("world");
  5 }, 1000);
  6 console.log("hello");
  7
debug> quit
%

显示原文其他翻译纠错

repl 命令允许您远程执行代码；next 命令步进到下一行。此外还有一些其它命令，输入 help 查看。

显示原文其他翻译纠错

监视器#

显示原文其他翻译纠错

调试代码时您可以监视表达式或变量值。在每个断点中监视器列表中的各个表达式会被以当前上下文执行，并在断点的源代码前显示。

显示原文其他翻译纠错

输入 watch("my_expression") 开始监视一个表达式；watchers 显示活动监视器；unwatch("my_expression") 移除一个监视器。

显示原文其他翻译纠错

命令参考#

显示原文其他翻译纠错

步进#

显示原文其他翻译纠错

  • cont, c - 继续执行
  • next, n - Step next
  • step, s - Step in
  • out, o - Step out
  • pause - 暂停执行代码（类似开发者工具中的暂停按钮）

显示原文其他翻译纠错

断点#

显示原文其他翻译纠错

  • setBreakpoint(), sb() - 在当前行设置断点
  • setBreakpoint(line), sb(line) - 在指定行设置断点
  • setBreakpoint(‘fn()‘), sb(...) - 在函数体的第一条语句设置断点
  • setBreakpoint(‘script.js‘, 1), sb(...) - 在 script.js 的第一行设置断点
  • clearBreakpoint, cb(...) - 清除断点

显示原文其他翻译纠错

在一个尚未被加载的文件（模块）中设置断点也是可行的：

显示原文其他翻译纠错

% ./node debug test/fixtures/break-in-module/main.js
< debugger listening on port 5858
connecting to port 5858... ok
break in test/fixtures/break-in-module/main.js:1
  1 var mod = require(‘./mod.js‘);
  2 mod.hello();
  3 mod.hello();
debug> setBreakpoint(‘mod.js‘, 23)
Warning: script ‘mod.js‘ was not loaded yet.
  1 var mod = require(‘./mod.js‘);
  2 mod.hello();
  3 mod.hello();
debug> c
break in test/fixtures/break-in-module/mod.js:23
 21
 22 exports.hello = function() {
 23   return ‘hello from module‘;
 24 };
 25
debug>

显示原文其他翻译纠错

信息#

显示原文其他翻译纠错

  • backtrace, bt - 显示当前执行框架的回溯
  • list(5) - 显示脚本源代码的 5 行上下文（之前 5 行和之后 5 行）
  • watch(expr) - 向监视列表添加表达式
  • unwatch(expr) - 从监视列表移除表达式
  • watchers - 列出所有监视器和它们的值（每个断点会自动列出）
  • repl - 在所调试的脚本的上下文中打开调试器的 repl 执行代码

显示原文其他翻译纠错

执行控制#

显示原文其他翻译纠错

  • run - 运行脚本（调试器开始时自动运行）
  • restart - 重新运行脚本
  • kill - 终止脚本

显示原文其他翻译纠错

杂项#

显示原文其他翻译纠错

  • scripts - 列出所有已加载的脚本
  • version - 显示 V8 的版本

显示原文其他翻译纠错

高级使用#

显示原文其他翻译纠错

V8 调试器可以从两种方式启用和访问：以 --debug 命令行标志启动 Node；或者向已存在的 Node 进程发送 SIGUSR1 信号。

显示原文其他翻译纠错

一旦一个进程进入了调试模式，它便可被 Node 调试器连接。调试器可以通过 pid 或 URI 来连接，语法是：

显示原文其他翻译纠错

  • node debug -p <pid> - 通过 pid 连接进程
  • node debug <URI> - 通过类似 localhost:5858 的 URI 连接进程

显示原文其他翻译纠错

集群#

显示原文其他翻译纠错

稳定度: 1 - 实验性

显示原文其他翻译纠错

单个 Node 实例运行在单个线程中。要发挥多核系统的能力，用户有时候需要启动一个 Node 进程集群来处理负载。

显示原文其他翻译纠错

集群模块允许你方便地创建一个共享服务器端口的进程网络。

显示原文其他翻译纠错

cluster.on(‘exit‘, function(worker, code, signal) {
  console.log(‘worker ‘ + worker.process.pid + ‘ died‘);
});

if (cluster.isMaster) {
  cluster.fork();
  cluster.fork();
  console.log(‘master pid:‘ + process.pid);
} else {
  // Workers can share any TCP connection
  // In this case its a HTTP server
  http.createServer(function(req, res) {
    res.writeHead(200);
    res.end("hello world\n");
  }).listen(8000);
  console.log(‘child pid:‘ + process.pid);
}

显示原文其他翻译纠错

现在，运行 node 将会在所有工作进程间共享 8000 端口：

显示原文其他翻译纠错

% NODE_DEBUG=cluster node server.js
23521,Master Worker 23524 online
23521,Master Worker 23526 online
23521,Master Worker 23523 online
23521,Master Worker 23528 online

显示原文其他翻译纠错

这是一个近期推出的功能，在未来版本中可能会有所改变。请尝试并提供反馈。

显示原文其他翻译纠错

还要注意的是，在 Windows 中尚不能在工作进程中建立一个被命名的管道服务器。

显示原文其他翻译纠错

它是如何工作的#

显示原文其他翻译纠错

工作进程是通过使用 child_process.fork 方法派生的，因此它们可以通过 IPC（进程间通讯）与父进程通讯并互相传递服务器句柄。

显示原文其他翻译纠错

集群模块支持两种分配传入连接的方式。

显示原文其他翻译纠错

第一种（同时也是除 Windows 外所有平台的缺省方式）为循环式：主进程监听一个端口，接受新连接，并以轮流的方式分配给工作进程，并以一些内建机制来避免单个工作进程的超载。

显示原文其他翻译纠错

第二种方式是，主进程建立监听嵌套字，并将它发送给感兴趣的工作进程，由工作进程直接接受传入连接。

显示原文其他翻译纠错

第二种方式理论上有最好的性能。然而在实践中，由于操作系统的调度变幻莫测，分配往往十分不平衡。负载曾被观测到超过 70% 的连接结束于总共八个进程中的两个。

显示原文其他翻译纠错

因为 server.listen() 将大部分工作交给了主进程，所以一个普通的node.js进程和一个集群工作进程会在三种情况下有所区别：

显示原文其他翻译纠错

  1. server.listen({fd: 7}) 由于消息被传递到主进程，父进程中的文件描述符 7 会被监听，并且句柄会被传递给工作进程，而不是监听工作进程中文件描述符 7 所引用的东西。
  2. server.listen(handle) 明确地监听一个句柄会使得工作进程使用所给句柄，而不是与主进程通讯。如果工作进程已经拥有了该句柄，则假定您知道您在做什么。
  3. server.listen(0) 通常，这会让服务器监听一个随机端口。然而，在集群中，各个工作进程每次 listen(0) 都会得到一样的“随机”端口。实际上，端口在第一次时是随机的，但在那之后却是可预知的。如果您想要监听一个唯一的端口，则请根据集群工作进程 ID 来生成端口号。

显示原文其他翻译纠错

由于在 Node.js 或您的程序中并没有路由逻辑，工作进程之间也没有共享的状态，因此在您的程序中，诸如会话和登录等功能应当被设计成不能太过依赖于内存中的数据对象。

显示原文其他翻译纠错

由于工作进程都是独立的进程，因此它们会根据您的程序的需要被终止或重新派生，并且不会影响到其它工作进程。只要还有工作进程存在，服务器就会继续接受连接。但是，Node 不会自动为您管理工作进程的数量，根据您的程序所需管理工作进程池是您的责任。

显示原文其他翻译纠错

cluster.schedulingPolicy#

显示原文其他翻译纠错

调度策略 cluster.SCHED_RR 表示轮流制，cluster.SCHED_NONE 表示由操作系统处理。这是一个全局设定，并且一旦您派生了第一个工作进程或调用了 cluster.setupMaster() 后便不可更改。

显示原文其他翻译纠错

SCHED_RR 是除 Windows 外所有操作系统上的缺省方式。只要 libuv 能够有效地分配 IOCP 句柄并且不产生巨大的性能损失，Windows 也将会更改为 SCHED_RR 方式。

显示原文其他翻译纠错

cluster.schedulingPolicy 也可以通过环境变量 NODE_CLUSTER_SCHED_POLICY 设定。有效值为 "rr" 和 "none"。

显示原文其他翻译纠错

cluster.settings#

显示原文其他翻译纠错

  • {Object}

    • exec {String} 工作进程文件的路径。（缺省为 __filename）
    • args {Array} 传递给工作进程的字符串参数。（缺省为 process.argv.slice(2)）
    • silent {Boolean} 是否将输出发送到父进程的 stdio。（缺省为 false）

显示原文其他翻译纠错

所有由 .setupMaster 设定的设置都会储存在此设置对象中。这个对象不应由您手动更改或设定。

显示原文其他翻译纠错

集群的主进程(判断当前进程是否是主进程)#

显示原文其他翻译纠错

  • {Boolean}

显示原文其他翻译纠错

如果进程为主进程则为 true。这是由 process.env.NODE_UNIQUE_ID 判断的，如果 process.env.NODE_UNIQUE_ID 为 undefined，则 isMaster 为 true。

显示原文其他翻译纠错

当前进程是否是从主进程的fork出来的#

显示原文其他翻译纠错

  • {Boolean}

显示原文其他翻译纠错

如果当前进程是分支自主进程的工作进程，则该布尔标识的值为 true。如果 process.env.NODE_UNIQUE_ID被设定为一个值，则 isWorker 为 true。

显示原文其他翻译纠错

事件: ‘fork‘#

显示原文其他翻译纠错

  • worker {Worker object}

显示原文其他翻译纠错

当一个新的工作进程被分支出来，cluster 模块会产生一个 ‘fork‘ 事件。这可被用于记录工作进程活动，以及创建您自己的超时判断。

显示原文其他翻译纠错

cluster.on(‘fork‘, function(worker) {
  timeouts[worker.id] = setTimeout(errorMsg, 2000);
});
cluster.on(‘listening‘, function(worker, address) {
  clearTimeout(timeouts[worker.id]);
});
cluster.on(‘exit‘, function(worker, code, signal) {
  clearTimeout(timeouts[worker.id]);
  errorMsg();
});

显示原文其他翻译纠错

事件: ‘online‘#

显示原文其他翻译纠错

  • worker {Worker object}

显示原文其他翻译纠错

分支出一个新的工作进程后，工作进程会响应一个在线消息。当主进程收到一个在线消息后，它会触发该事件。‘fork‘ 和 ‘online‘ 的区别在于前者发生于主进程尝试分支出工作进程时，而后者发生于工作进程被执行时。

显示原文其他翻译纠错

cluster.on(‘online‘, function(worker) {
  console.log("嘿嘿，工作进程完成分支并发出回应了");
});

显示原文其他翻译纠错

事件: ‘listening‘#

显示原文其他翻译纠错

  • worker {Worker object}
  • address {Object}

显示原文其他翻译纠错

当工作进程调用 listen() 时，一个 listening 事件会被自动分配到服务器实例中。当服务器处于监听时，一个消息会被发送到那个‘listening‘事件被分发的主进程。

显示原文其他翻译纠错

事件处理器被执行时会带上两个参数。其中 worker 包含了工作进程对象，address 对象包含了下列连接属性：地址 address、端口号 port 和地址类型 addressType。如果工作进程监听多个地址，那么这些信息将十分有用。

显示原文其他翻译纠错

cluster.on(‘listening‘, function(worker, address) {
  console.log("一个工作进程刚刚连接到 " + address.address + ":" + address.port);
});

显示原文其他翻译纠错

事件: ‘disconnect‘#

显示原文其他翻译纠错

  • worker {Worker object}

显示原文其他翻译纠错

当一个工作进程的 IPC 通道断开时此事件会发生。这发生于工作进程结束时，通常是调用 .kill() 之后。

显示原文其他翻译纠错

当调用 .disconnect() 后，disconnect 和 exit 事件之间可能存在延迟。该事件可被用于检测进程是否被卡在清理过程或存在长连接。

显示原文其他翻译纠错

cluster.on(‘disconnect‘, function(worker) {
  console.log(‘工作进程 #‘ + worker.id + ‘ 断开了连接‘);
});

显示原文其他翻译纠错

事件: ‘exit‘#

显示原文其他翻译纠错

  • worker {Worker object}
  • code {Number} 如果是正常退出则为退出代码。
  • signal {String} 使得进程被终止的信号的名称（比如 ‘SIGHUP‘）。

显示原文其他翻译纠错

当任意工作进程被结束时，集群模块会分发exit 事件。通过再次调用fork()函数，可以使用这个事件来重启工作进程。

显示原文其他翻译纠错

cluster.on(‘exit‘, function(worker, code, signal) {
  var exitCode = worker.process.exitCode;
  console.log(‘工作进程 ‘ + worker.process.pid + ‘ 被结束（‘+exitCode+‘）。正在重启...‘);
  cluster.fork();
});

显示原文其他翻译纠错

事件: ‘setup‘#

显示原文其他翻译纠错

  • worker {Worker object}

显示原文其他翻译纠错

当 .setupMaster() 函数被执行时触发此事件。如果 .setupMaster() 在 fork() 之前没被执行，那么它会不带参数调用 .setupMaster()。

显示原文其他翻译纠错

cluster.setupMaster([settings])#

显示原文其他翻译纠错

  • settings {Object}

    • exec {String} 工作进程文件的路径。（缺省为 __filename）
    • args {Array} 传给工作进程的字符串参数。（缺省为 process.argv.slice(2)）
    • silent {Boolean} 是否将输出发送到父进程的 stdio。（缺省为 false）

显示原文其他翻译纠错

setupMaster 被用于更改缺省的 fork 行为。新的设置会立即永久生效，并且在之后不能被更改。

显示原文其他翻译纠错

示例：

显示原文其他翻译纠错

var cluster = require("cluster");
cluster.setupMaster({
  exec : "worker.js",
  args : ["--use", "https"],
  silent : true
});
cluster.fork();

显示原文其他翻译纠错

cluster.fork([env])#

显示原文其他翻译纠错

  • env {Object} 添加到子进程环境变量中的键值对。
  • 返回 {Worker object}

显示原文其他翻译纠错

派生一个新的工作进程。这个函数只能在主进程中被调用。

显示原文其他翻译纠错

cluster.disconnect([callback])#

显示原文其他翻译纠错

  • callback {Function} 当所有工作进程都断开连接并且句柄被关闭时被调用

显示原文其他翻译纠错

调用此方法时，所有的工作进程都会优雅地将自己结束掉。当它们都断开连接时，所有的内部处理器都会被关闭，使得主进程可以可以在没有其它事件等待时优雅地结束。

显示原文其他翻译纠错

该方法带有一个可选的回调参数，会在完成时被调用。

显示原文其他翻译纠错

cluster.worker#

显示原文其他翻译纠错

  • {Object}

显示原文其他翻译纠错

对当前工作进程对象的引用。在主进程中不可用。

显示原文其他翻译纠错

if (cluster.isMaster) {
  console.log(‘我是主进程‘);
  cluster.fork();
  cluster.fork();
} else if (cluster.isWorker) {
  console.log(‘我是工作进程 #‘ + cluster.worker.id);
}

显示原文其他翻译纠错

cluster.workers#

显示原文其他翻译纠错

  • {Object}

显示原文其他翻译纠错

一个储存活动工作进程对象的哈希表，以 id 字段作为主键。它能被用作遍历所有工作进程，仅在主进程中可用。

显示原文其他翻译纠错

// 遍历所有工作进程
function eachWorker(callback) {
  for (var id in cluster.workers) {
    callback(cluster.workers[id]);
  }
}
eachWorker(function(worker) {
  worker.send(‘向一线工作者们致以亲切问候！‘);
});

显示原文其他翻译纠错

如果您希望通过通讯通道引用一个工作进程，那么使用工作进程的唯一标识是找到那个工作进程的最简单的办法。

显示原文其他翻译纠错

socket.on(‘data‘, function(id) {
  var worker = cluster.workers[id];
});

显示原文其他翻译纠错

类: Worker#

显示原文其他翻译纠错

一个 Worker 对象包含了工作进程的所有公开信息和方法。可通过主进程中的 cluster.workers 或工作进程中的 cluster.worker 取得。

显示原文其他翻译纠错

worker.id#

显示原文其他翻译纠错

  • {String}

显示原文其他翻译纠错

每个新的工作进程都被赋予一个唯一的标识，这个标识被储存在 id 中。

显示原文其他翻译纠错

当一个工作进程可用时，这就是它被索引在 cluster.workers 中的主键。

显示原文其他翻译纠错

worker.process#

显示原文其他翻译纠错

  • {ChildProcess object}

显示原文其他翻译纠错

所有工作进程都是使用 child_process.fork() 创建的，该函数返回的对象被储存在 process 中。

显示原文其他翻译纠错

参考：Child Process 模块

显示原文其他翻译纠错

worker.suicide#

显示原文其他翻译纠错

  • {Boolean}

显示原文其他翻译纠错

该属性是一个布尔值。它会在工作进程调用 .kill() 后终止时或调用 .disconnect() 方法时被设置。在此之前它的值是 undefined。

显示原文其他翻译纠错

worker.send(message, [sendHandle])#

显示原文其他翻译纠错

  • message {Object}
  • sendHandle {Handle object}

显示原文其他翻译纠错

该函数等同于 child_process.fork() 提供的 send 方法。在主进程中您可以用该函数向特定工作进程发送消息。当然，在工作进程中您也能使用 process.send(message)，因为它们是同一个函数。

显示原文其他翻译纠错

这个例子会回应来自主进程的所有消息：

显示原文其他翻译纠错

} else if (cluster.isWorker) {
  process.on(‘message‘, function(msg) {
    process.send(msg);
  });
}

显示原文其他翻译纠错

worker.kill([signal=‘SIGTERM‘])#

显示原文其他翻译纠错

  • signal {String} 发送给工作进程的终止信号的名称

显示原文其他翻译纠错

该函数会终止工作进程，并告知主进程不要派生一个新工作进程。布尔值 suicide 让您区分自行退出和意外退出。

显示原文其他翻译纠错

// 终止工作进程
worker.kill();

显示原文其他翻译纠错

该方法的别名是 worker.destroy()，以保持向后兼容。

显示原文其他翻译纠错

worker.disconnect()#

显示原文其他翻译纠错

调用该函数后工作进程将不再接受新连接，但新连接仍会被其它正在监听的工作进程处理。已存在的连接允许正常退出。当没有连接存在，连接到工作进程的 IPC 通道会被关闭，以便工作进程安全地结束。当 IPC 通道关闭时 disconnect 事件会被触发，然后则是工作进程最终结束时触发的 exit 事件。

显示原文其他翻译纠错

由于可能存在长连接，通常会实现一个超时机制。这个例子会告知工作进程断开连接，并且在 2 秒后销毁服务器。另一个备选方案是 2 秒后执行 worker.kill()，但那样通常会使得工作进程没有机会进行必要的清理。

显示原文其他翻译纠错

  process.on(‘message‘, function(msg) {
    if (msg === ‘force kill‘) {
      server.close();
    }
  });
}

显示原文其他翻译纠错

事件: ‘message‘#

显示原文其他翻译纠错

  • message {Object}

显示原文其他翻译纠错

该事件和 child_process.fork() 所提供的一样。在主进程中您应当使用该事件，而在工作进程中您也可以使用 process.on(‘message‘)。

显示原文其他翻译纠错

举个例子，这里有一个集群，使用消息系统在主进程中统计请求的数量：

显示原文其他翻译纠错

    // 将请求通知主进程
    process.send({ cmd: ‘notifyRequest‘ });
  }).listen(8000);
}

显示原文其他翻译纠错

事件: ‘online‘#

显示原文其他翻译纠错

和 cluster.on(‘online‘) 事件一样，但仅当特定工作进程的状态改变时发生。

显示原文其他翻译纠错

cluster.fork().on(‘online‘, function() {
  // 工作进程在线
});

显示原文其他翻译纠错

事件: ‘listening‘#

显示原文其他翻译纠错

  • address {Object}

显示原文其他翻译纠错

和 cluster.on(‘listening‘) 事件一样，但仅当特定工作进程的状态改变时发生。

显示原文其他翻译纠错

cluster.fork().on(‘listening‘, function(address) {
  // 工作进程正在监听
});

显示原文其他翻译纠错

事件: ‘disconnect‘#

显示原文其他翻译纠错

和 cluster.on(‘disconnect‘) 事件一样，但仅当特定工作进程的状态改变时发生。

显示原文其他翻译纠错

cluster.fork().on(‘disconnect‘, function() {
  // 工作进程断开了连接
});

显示原文其他翻译纠错

事件: ‘exit‘#

显示原文其他翻译纠错

  • code {Number} 如果是正常退出则为退出代码。
  • signal {String} 使得进程被终止的信号的名称（比如 ‘SIGHUP‘）。

显示原文其他翻译纠错

由单个工作进程实例在底层子进程被结束时触发。详见子进程事件: ‘exit‘。

显示原文其他翻译纠错

var worker = cluster.fork();
worker.on(‘exit‘, function(code, signal) {
  if( signal ) {
    console.log("工人被信号 " + signal + " 杀掉了");
  } else if( code !== 0 ) {
    console.log("工作进程退出，错误码：" + code);
  } else {
    console.log("劳动者的胜利！");
  }
});

显示原文其他翻译纠错

Smalloc#

显示原文其他翻译纠错

稳定度: 1 - 实验性

显示原文其他翻译纠错

smalloc.alloc(length[, receiver][, type])#

显示原文其他翻译纠错

  • length {Number} <= smalloc.kMaxLength
  • receiver {Object} 可选，缺省为 new Object
  • type {Enum} 可选，缺省为 Uint8

显示原文其他翻译纠错

返回 receiver 及所分配的外部数组数据。如果未传入 receiver 则会创建并返回一个新的 Object。

显示原文其他翻译纠错

Buffer 后端为一个只处理外部原始内存的分配的简易分配器所支撑。Smalloc 暴露了该功能。

显示原文其他翻译纠错

这可用于创建你自己的类似 Buffer 的类。由于不会设置其它属性，因此使用者需要自行跟踪其它所需信息（比如所分配的长度 length）。

显示原文其他翻译纠错

SimpleData.prototype = { /* ... */ };

显示原文其他翻译纠错

它只检查 receiver 是否为一个非 Array 的 Object。因此，可以分配外部数组数据的不止纯 Object。

显示原文其他翻译纠错

// { [Function allocMe] ‘0‘: 0, ‘1‘: 0, ‘2‘: 0 }

显示原文其他翻译纠错

V8 不支持向一个 Array 分配外部数组数据，如果这么做将会抛出异常。

显示原文其他翻译纠错

您可以指定您想要的外部数组数据的类型。所有可取的值都已在 smalloc.Types 中列出。使用示例：

显示原文其他翻译纠错

// { ‘0‘: 0, ‘1‘: 0.1, ‘2‘: 0.2 }

显示原文其他翻译纠错

smalloc.copyOnto(source, sourceStart, dest, destStart, copyLength);#

显示原文其他翻译纠错

  • source 分配了外部数组的来源对象
  • sourceStart 从这个位置开始拷贝
  • dest 分配了外部数组的目标对象
  • destStart 拷贝到这个位置
  • copyLength 拷贝的长度

显示原文其他翻译纠错

从一个外部数组向另一个拷贝内存。所有参数都是必填，否则将会抛出异常。

显示原文其他翻译纠错

// { ‘0‘: 4, ‘1‘: 6, ‘2‘: 2, ‘3‘: 3 }

显示原文其他翻译纠错

copyOnto 会在内部自动检测分配的长度，因此无需对此给出额外的参数。

显示原文其他翻译纠错

smalloc.dispose(obj)#

显示原文其他翻译纠错

  • obj 对象

显示原文其他翻译纠错

释放已使用 smalloc.alloc 分配到一个对象的内存。

显示原文其他翻译纠错

// {}

显示原文其他翻译纠错

这对于减轻垃圾回收器的负担有所帮助，但开发者务必小心。难以跟踪的应用程序可能会发生奇怪的错误。

显示原文其他翻译纠错

// 将导致：
// Error: source has no external array data

显示原文其他翻译纠错

dispose() 不支持 Buffer，传入将会抛出异常。

显示原文其他翻译纠错

smalloc.kMaxLength#

显示原文其他翻译纠错

最大的分配大小。该值同时也适用于 Buffer 的创建。

显示原文其他翻译纠错

smalloc.Types#

显示原文其他翻译纠错

外部数组类型的可取值，包含：

显示原文其他翻译纠错

  • Int8
  • Uint8
  • Int16
  • Uint16
  • Int32
  • Uint32
  • Float
  • Double
  • Uint8Clamped
时间： 2024-09-30 23:30:16

nodejs api 中文文档的相关文章

jQuery EasyUI API 中文文档

http://www.cnblogs.com/Philoo/tag/jQuery/ 共2页: 1 2 下一页 jQuery EasyUI API 中文文档 - 树表格(TreeGrid) 风流涕淌 2011-11-19 18:51 阅读:25025 评论:3 jQuery EasyUI API 中文文档 - 树(Tree) 风流涕淌 2011-11-18 20:13 阅读:31937 评论:2 jQuery EasyUI 1.2.4 API 中文文档(完整)目录 风流涕淌 2011-11-17

jQuery EasyUI DataGrid API 中文文档

扩展自$.fn.panel.defaults,用 $.fn.datagrid.defaults重写了 defaults . 依赖 panel resizable linkbutton pagination 用法 1.  <table id="tt"></table> 1.  $('#tt').datagrid({ 2.      url:'datagrid_data.json', 3.      columns:[[ 4.          {field:'co

jQuery EasyUI API 中文文档 - ValidateBox验证框

jQuery EasyUI API 中文文档 - ValidateBox验证框,使用jQuery EasyUI的朋友可以参考下. 用 $.fn.validatebox.defaults 重写了 defaults. 用法 代码如下: <input id="vv" required="true" validType="email"> 代码如下: $('#vv').validatebox({ required:true }); 验证规则 验

jQuery API中文文档

jQuery API中文文档 http://www.css88.com/jqapi-1.9/category/events/event-handler-attachment/ jQuery UI API中文文档 http://www.css88.com/jquery-ui-api/

JDK1.8+API+中文文档+高清完整版（不要积分 免费拿）

JDK1.8+API+中文文档+高清完整版+CHM帮助文档 链接: https://pan.baidu.com/s/1LbdWSZ4qFjWXdJ88bXkn5w 提取码: frew 希望能帮上大家的忙. 原文地址:https://www.cnblogs.com/ooo888ooo/p/11105343.html

jQuery EasyUI 1.2.4 API 中文文档（完整）目录

Welcome 欢迎 由于项目需求,要使用富客户端,选择了EasyUI,之前并没有接触过,上网搜索一番,没有找到完整的中文文档,项目组又没有英语达人,无奈之下,我硬着头皮,把官方提供的英文文档啃了,一边啃顺便用中文记录下来. 其实几个月前就啃完了,现在的项目组一直在参考使用.我深感查字典揣摩英文原意的痛苦,早就想快点都通过博客共享出去,免去如我一样英语破(poor)人的痛苦,可是上班忙工作,下班忙家务,所以断断续续的,好在终于要发完了,也算了却一桩心事. 为了方便大家检索使用,制作此目录置顶.

Geth RPC API中文文档

Geth除了支持官方的DApp API开发接口,还支持额外的管理API接口.类似于DApp API,这些管理API也是通过JSON-PRC协议提供,并且遵循同样的规范.Geth内置的控制台支持所有这些额外的管理API.Geth管理API官方文档中文版由汇智网翻译整理,访问地址:Geth管理API文档 如果要快速高效地学习以太坊应用开发,推荐汇智网的以太坊智能合约与DApp开发入门 启用管理API 要通过Geth的RPC访问端结点提供这些管理API,需要在启动geth时使用--${interfac

webdriver API中文文档

1.1   下载selenium2.0的lib包 http://code.google.com/p/selenium/downloads/list 官方UserGuide:http://seleniumhq.org/docs/ 1.2   用webdriver打开一个浏览器 我们常用的浏览器有firefox和IE两种,firefox是selenium支持得比较成熟的浏览器.但是做页面的测试,速度通常很慢,严重影 响持续集成的速度,这个时候建议使用HtmlUnit,不过HtmlUnitDirver

jQuery EasyUI API 中文文档 - Panel面板

<html> <head> <title>布局管理器--控制面板</title> <script src="jquery-easyui/jquery.min.js"></script> <script src="jquery-easyui/jquery.easyui.min.js"></script> <script src="jquery-easyui/