关于本文档#

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

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

每个 .html 文件都对应一分内容相同的结构化 .json 文档。这个特性如今仍是实验性质的，但愿可以为一些须要对文档进行操做的IDE或者其余工具提供帮助。node

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

稳定度#

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

稳定度定义以下git

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

JSON 输出#

稳定度: 1 - 实验性

每一个经过 markdown 生成的 HTML 文件都对应于一个具备相同数据的 JSON 文件。程序员

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

概述#

一个输出 “Hello World” 的简单 Web 服务器例子：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'); } }