node.js 入门笔记3

Node.js核心模块

　　全局对象

　　常用工具

　　事件机制

　　文件系统访问

　　HTTP服务器与客户端

1.全局对象和全局变量

全局对象 global ： 是作为全局变量的宿主

全局变量： 在最外层定义的变量、全局对象的属性、隐式定义的变量（未定义直接赋值的变量）

永远使用 var 定义变量以避免引入全局变量，因为全局变量会污染命名空间，提高代码的耦合风险。

 

process

process是一个全局变量。用于描述当前Node.js进程状态的对象。

process 对象的一些最常用的成员方法：

（1） process.argv 是命令行参数数组，第一个元素是 node，第二个元素是脚本文件名，从第三个元素开始每个元素是一个运行参数。

$ node argv.js 1991 name=byvoid --v "Carbo Kuo" 
[ 'node', 
 '/home/byvoid/argv.js', 
 '1991', 
 'name=byvoid', 
 '--v', 
 'Carbo Kuo' ]

 

（2）process.stdout 是标准输出流，通常我们使用的 console.log() 向标准输出打印字符，而 process.stdout.write() 函数提供了更底层的接口。

 

（3）process.stdin 是标准输入流，初始时它是被暂停的，要想从标准输入读取数据，你必须恢复流，并手动编写流的事件响应函数。

process.stdin.resume(); 
process.stdin.on('data', function(data) { 
 process.stdout.write('read from console: ' + data.toString()); 
});

 

（4）process.nextTick(callback)的功能是为事件循环设置一项任务，Node.js 会在

下次事件循环调响应时调用 callback。

 

console

console 用于提供控制台标准输出。

console 对象，用于向标准输出流（stdout）或标准错误流（stderr）输出字符。

 

（1）console.log()

向标准输出流打印字符并以换行符结束。

（2）console.error()

向标准错误流输出。

（3）console.trace()

向标准错误流输出当前的调用栈。

 

 

2.常用工具 util

util 是一个 Node.js 核心模块，提供常用函数的集合

（1）util.inherits

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

 

（2）util.inspect

util.inspect(object, [showHidden], [depth], [colors])是一个将任意对象转换为字符串的方法，通常用于调试和错误输出。它至少接受一个参数 object，即要转换的对象。

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

　　depth 表示最大递归的层数，如果对象很复杂，你可以指定层数以控制输出信息的多少。如果不指定depth，默认会递归层，指定为 null 表示将不限递归层数完整遍历对象。

　　如果color 值为 true，输出格式将会以 ANSI 颜色编码，通常用于在终端显示更漂亮

的效果。

 

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

 

除此之外，util还提供了util.isArray()、util.isRegExp()、util.isDate()、util.isError() 四个类型测试工具，以及 util.format()、util.debug() 等工具。

 

3.事件驱动 events

events 是 Node.js 最重要的模块，没有“之一”，原因是 Node.js 本身架构就是事件式的，而它提供了唯一的接口，所以堪称 Node.js 事件编程的基石。

events 模块不仅用于用户代码与 Node.js 下层事件循环的交互，还几乎被所有的模块依赖。

（1）事件发射器

events 模块只提供了一个对象： events.EventEmitter。EventEmitter 的核心就是事件发射与事件监听器功能的封装。

EventEmitter 的每个事件由一个事件名和若干个参数组成，事件名是一个字符串，通常表达一定的语义。

对于每个事件，EventEmitter 支持若干个事件监听器。当事件发射时，注册到这个事件的事件监听器被依次调用，事件参数作为回调函数参数传递。

让我们以下面的例子

var events = require('events'); 
var emitter = new events.EventEmitter(); 
emitter.on('someEvent', function(arg1, arg2) { 
 console.log('listener1', arg1, arg2); 
}); 
emitter.on('someEvent', function(arg1, arg2) { 
 console.log('listener2', arg1, arg2); 
}); 
emitter.emit('someEvent', 'byvoid', 1991);

运行结果：

　　listener1 byvoid 1991

　　listener2 byvoid 1991

EventEmitter常用的API：

• EventEmitter.on(event, listener) 为指定事件注册一个监听器，接受一个字符串 event 和一个回调函数 listener。
• EventEmitter.emit(event, [arg1], [arg2], [...]) 发射 event 事件，传递若干可选参数到事件监听器的参数表。
• EventEmitter.once(event, listener) 为指定事件注册一个单次监听器，即监听器最多只会触发一次，触发后立刻解除该监听器。
• EventEmitter.removeListener(event, listener) 移除指定事件的某个监听器，listener 必须是该事件已经注册过的监听器。

• EventEmitter.removeAllListeners([event]) 移除所有事件的所有监听器，如果指定 event，则移除指定事件的所有监听器。

（2）error事件

 

　　EventEmitter 定义了一个特殊的事件 error，它包含了“错误”的语义，我们在遇到异常的时候通常会发射 error 事件。当 error 被发射时，EventEmitter 规定如果没有响应的监听器，Node.js 会把它当作异常，退出程序并打印调用栈。我们一般要为会发射 error事件的对象设置监听器，避免遇到错误后整个程序崩溃。

 

var events = require('events'); 
var emitter = new events.EventEmitter(); 
emitter.emit('error'); 
运行时会显示以下错误：
node.js:201 
 throw e; // process.nextTick error, or 'error' event on first tick 
 ^ 
Error: Uncaught, unspecified 'error' event. 
 at EventEmitter.emit (events.js:50:15) 
 at Object.<anonymous> (/home/byvoid/error.js:5:9) 
 at Module._compile (module.js:441:26) 
 at Object..js (module.js:459:10) 
 at Module.load (module.js:348:31) 
 at Function._load (module.js:308:12) 
 at Array.0 (module.js:479:10) 
 at EventEmitter._tickCallback (node.js:192:40)

（3）继承 EventEmitter

　　大多数时候我们不会直接使用 EventEmitter，而是在对象中继承它。包括 fs、net、http 在内的，只要是支持事件响应的核心模块都是 EventEmitter 的子类。

 

4.文件系统 fs

　　fs 模块是文件操作的封装，它提供了文件的读取、写入、更名、删除、遍历目录、链接等 POSIX 文件系统操作。

　　与其他模块不同的是，fs 模块中所有的操作都提供了异步的和同步的两个版本，例如读取文件内容的函数有异步的 fs.readFile() 和同步的fs.readFileSync()。

 

fs.readFile

fs.readFile ( filename, [encoding], [callback(err,data)]) 是最简单的读取文件的函数。

它接受一个必选参数 filename，表示要读取的文件名。

第二个参数 encoding是可选的，表示文件的字符编码。

callback 是回调函数，用于接收文件的内容。如果不指定 encoding，则 callback 就是第二个参数。回调函数提供两个参数 err 和 data，err 表示有没有错误发生，data 是文件内容。

如果指定了 encoding，data 是一个解析后的字符串，否则 data 将会是以 Buffer 形式表示的二进制数据。

//未指定encoding
var fs = require('fs'); 
fs.readFile('content.txt', function(err, data) { 
 if (err) { 
 　　console.error(err); 
 } else { 
 　　console.log(data); 
 } 
});

假设 content.txt 中的内容是 UTF-8 编码的 Text 文本文件示例，运行结果如下：

<Buffer 54 65 78 74 20 e6 96 87 e6 9c ac e6 96 87 e4 bb b6 e7 a4 ba e4 be 8b>

//指定encoding
var fs = require('fs'); 
fs.readFile('content.txt', 'utf-8', function(err, data) { 
 if (err) { 
 　　console.error(err); 
 } else { 
 　　console.log(data); 
 } 
});

运行结果：

　　Text 文本文件示例

fs.readFileSync

　　fs.readFileSync (filename, [encoding]) 是 fs.readFile 同步的版本。它接受的参数和 fs.readFile 相同，而读取到的文件内容会以函数返回值的形式返回。如果有错误发生，fs 将会抛出异常，你需要使用 try 和 catch 捕捉并处理异常。

 

fs.open

　　fs.open(path, flags, [mode], [callback(err, fd)])是 POSIX open 函数的封装，与 C 语言标准库中的 fopen 函数类似。

它接受两个必选参数，path 为文件的路径，flags 可以是以下值。

 r ：以读取模式打开文件。

 r+ ：以读写模式打开文件。

 w ：以写入模式打开文件，如果文件不存在则创建。

 w+ ：以读写模式打开文件，如果文件不存在则创建。

 a ：以追加模式打开文件，如果文件不存在则创建。

 a+ ：以读取追加模式打开文件，如果文件不存在则创建。

mode 参数用于创建文件时给文件指定权限，默认是 0666①。回调函数将会传递一个文件描述符 fd②。

 

fs.read

　　fs.read (fd, buffer, offset, length, position, [callback(err, bytesRead,buffer)])是 POSIX read 函数的封装，相比 fs.readFile 提供了更底层的接口。

　　fs.read的功能是从指定的文件描述符 fd 中读取数据并写入 buffer 指向的缓冲区对象。offset 是buffer 的写入偏移量。length 是要从文件中读取的字节数。position 是文件读取的起始位置，如果 position 的值为 null，则会从当前文件指针的位置读取。回调函数传递bytesRead 和 buffer，分别表示读取的字节数和缓冲区对象

   

 5.HTTP 服务器与客户端

　　Node.js 标准库提供了 http 模块，其中封装了一个高效的 HTTP 服务器和一个简易的HTTP 客户端。

　　http.Server 是一个基于事件的 HTTP 服务器，它的核心由 Node.js 下层 C++部分实现，而接口由 JavaScript 封装，兼顾了高性能与简易性。

　　http.request 则是一个HTTP 客户端工具，用于向 HTTP 服务器发起请求，例如实现 Pingback①或者内容抓取。

（1）HTTP服务器

　　http.Server 是 http 模块中的 HTTP 服务器对象，用 Node.js 做的所有基于 HTTP 协议的系统，如网站、社交应用甚至代理服务器，都是基于 http.Server 实现的。它提供了一套封装级别很低的 API，仅仅是流控制和简单的消息解析，所有的高层功能都要通过它的接口来实现。

//app.js 
var http = require('http'); 
http.createServer(function(req, res) { 
 　　res.writeHead(200, {'Content-Type': 'text/html'}); 
 　　res.write('<h1>Node.js</h1>'); 
 　　res.end('<p>Hello World</p>'); 
}).listen(3000); 
console.log("HTTP server is listening at port 3000.");

http.Server 的事件

　　http.Server 是一个基于事件的 HTTP 服务器，所有的请求都被封装为独立的事件，开发者只需要对它的事件编写响应函数即可实现 HTTP 服务器的所有功能。它继承自EventEmitter，提供了以下几个事件：

• request：当客户端请求到来时，该事件被触发，提供两个参数 req 和res，分别是http.ServerRequest 和 http.ServerResponse 的实例，表示请求和响应信息。
•  connection：当 TCP 连接建立时，该事件被触发，提供一个参数 socket，为net.Socket 的实例。connection 事件的粒度要大于 request，因为客户端在Keep-Alive 模式下可能会在同一个连接内发送多次请求。
• close ：当服务器关闭时，该事件被触发。注意不是在用户连接断开时

在这些事件中，最常用的就是 request 了，因此 http 提供了一个捷径：http.createServer([requestListener]) ，功能是创建一个 HTTP 服务器并将requestListener 作为 request 事件的监听函数。

 

http.ServerRequest

　　http.ServerRequest 是 HTTP 请求的信息，是后端开发者最关注的内容。它一般由http.Server 的 request 事件发送，作为第一个参数传递，通常简称 request 或 req。

　　HTTP 请求一般可以分为两部分：请求头（Request Header）和请求体（Requset Body）。

　　以上内容由于长度较短都可以在请求头解析完成后立即读取。而请求体可能相对较长，需要一定的时间传输，因此 http.ServerRequest 提供了以下3个事件用于控制请求体传输：

 data：当请求体数据到来时，该事件被触发。该事件提供一个参数 chunk，表示接收到的数据。如果该事件没有被监听，那么请求体将会被抛弃。该事件可能会被调用多次。

 end ：当请求体数据传输完成时，该事件被触发，此后将不会再有数据到来。

 close： 用户当前请求结束时，该事件被触发。不同于 end，如果用户强制终止了传输，也还是调用close。

 

 

 获取GET请求内容

 由于 GET 请求直接被嵌入在路径中，URL是完整的请求路径，包括了 ? 后面的部分，因此你可以手动解析后面的内容作为 GET

请求的参数。Node.js 的 url 模块中的 parse 函数提供了这个功能：

//httpserverrequestget.js 
var http = require('http'); 
var url = require('url'); 
var util = require('util'); 
http.createServer(function(req, res) { 
 　　res.writeHead(200, {'Content-Type': 'text/plain'}); 
 　　res.end(util.inspect(url.parse(req.url, true))); 
}).listen(3000);

在浏览器中访问 http://127.0.0.1:3000/user?name=byvoid&email=byvoid@byvoid.com，我

们可以看到浏览器返回的结果：

{  search: '?name=byvoid&email=byvoid@byvoid.com',

　　query: { name: 'byvoid', email: 'byvoid@byvoid.com' },

　　pathname: '/user', 

　　path: '/user?name=byvoid&email=byvoid@byvoid.com',

　　href: '/user?name=byvoid&email=byvoid@byvoid.com' } 

通过 url.parse①，原始的 path 被解析为一个对象，其中 query 就是我们所谓的 GET请求的内容，而路径则是 pathname。

获取post请求内容

POST请求的内容全部都在请求体中。

//httpserverrequestpost.js 
var http = require('http'); 
var querystring = require('querystring'); 
var util = require('util'); 
http.createServer(function(req, res) { 
 　　var post = ''; 
 　　req.on('data', function(chunk) { 
 　　　　post += chunk; 
 　　}); 
 　　req.on('end', function() { 
 　　　　post = querystring.parse(post); 
 　　　　res.end(util.inspect(post)); 
 　　}); 
}).listen(3000);

http.ServerResponse

http.ServerResponse 是返回给客户端的信息，决定了用户最终能看到的结果。它也是由 http.Server 的 request 事件发送的，作为第二个参数传递，一般简称为response 或 res。

http.ServerResponse 有三个重要的成员函数，用于返回响应头、响应内容以及结束请求。

 response.writeHead(statusCode, [headers])：向请求的客户端发送响应头。

statusCode 是 HTTP 状态码，如 200 （请求成功）、404 （未找到）等。headers是一个类似关联数组的对象，表示响应头的每个属性。该函数在一个请求内最多只能调用一次，如果不调用，则会自动生成一个响应头。

 response.write(data, [encoding])：向请求的客户端发送响应内容。data 是一个 Buffer 或字符串，表示要发送的内容。如果 data 是字符串，那么需要指定encoding 来说明它的编码方式，默认是 utf-8。在 response.end 调用之前，response.write 可以被多次调用。

 response.end([data], [encoding])：结束响应，告知客户端所有发送已经完成。当所有要返回的内容发送完毕的时候，该函数 必须 被调用一次。它接受两个可选参数，意义和 response.write 相同。如果不调用该函数，客户端将永远处于等待状态。

HTTP客户端

http 模块提供了两个函数 http.request 和 http.get，功能是作为客户端向 HTTP服务器发起请求。

http.request(options, callback)发起 HTTP 请求。接受两个参数，option 是一个类似关联数组的对象，表示请求的参数，callback 是请求的回调函数。

option常用的参数如下所示：

　　 host ：请求网站的域名或 IP 地址。

　　 port ：请求网站的端口，默认 80。

　　 method ：请求方法，默认是 GET。

　　 path ：请求的相对于根的路径，默认是“/”。QueryString 应该包含在其中。

　　　　例如 /search?query=byvoid。

　　 headers ：一个关联数组对象，为请求头的内容。

callback 传递一个参数，为 http.ClientResponse 的实例。

http.request 返回一个 http.ClientRequest 的实例。

下面是一个通过 http.request 发送 POST 请求的代码：

//httprequest.js 
var http = require('http'); 
var querystring = require('querystring'); 
var contents = querystring.stringify({ 
 name: 'byvoid', 
 email: 'byvoid@byvoid.com', 
 address: 'Zijing 2#, Tsinghua University', 
}); 
var options = { 
 host: 'www.byvoid.com', 
 path: '/application/node/post.php', 
 method: 'POST', 
 headers: { 
 　　'Content-Type': 'application/x-www-form-urlencoded', 
 　　'Content-Length' : contents.length 
 } 
}; 
var req = http.request(options, function(res) { 
 　　res.setEncoding('utf8'); 
 　　res.on('data', function (data) { 
 　　　　console.log(data); 
 　　}); 
}); 
req.write(contents); 
req.end();//结束请求，否则服务器将不会收到信息

运行后结果如下：

array(3) {

　　["name"]=>

　　string(6) "byvoid"

　　["email"]=>

　　string(17) "byvoid@byvoid.com"

　　["address"]=>

　　string(30) "Zijing 2#, Tsinghua University"

} 

 http.get(options, callback)

　　http 模块还提供了一个更加简便的方法用于处理GET请求：http.get。它是 http.request 的简化版，唯一的区别在于http.get自动将请求方法设为了 GET 请求，同时不需要手动调用 req.end()。

//httpget.js 
var http = require('http'); 
http.get({host: 'www.byvoid.com'}, function(res) { 
 res.setEncoding('utf8'); 
 res.on('data', function (data) { 
 　　console.log(data); 
 }); 
});

http.ClientRequest

　　http.ClientRequest 是由 http.request 或 http.get 返回产生的对象，表示一个已经产生而且正在进行中的 HTTP 请求。它提供一个 response 事件，即 http.request或 http.get 第二个参数指定的回调函数的绑定对象。

http.ClientRequest 像 http.ServerResponse 一样也提供了 write 和 end 函数，用于向服务器发送请求体，通常用于 POST、PUT 等操作。所有写结束以后必须调用 end函数以通知服务器，否则请求无效。

http.ClientRequest 还提供了以下函数:

 request.abort()：终止正在发送的请求。

 request.setTimeout(timeout, [callback])：设置请求超时时间，timeout 为毫秒数。当请求超时以后，callback 将会被调用。

http.ClientResponse

　　http.ClientResponse 与 http.ServerRequest 相似，提供了三个事件 data、end和 close，分别在数据到达、传输结束和连接结束时触发，其中 data 事件传递一个参数chunk，表示接收到的数据。http.ClientResponse 也提供了一些属性，用于表示请求的结果状态，参见表 4-3。

 

http.ClientResponse 还提供了以下几个特殊的函数:

 response.setEncoding([encoding])：设置默认的编码，当 data 事件被触发时，数据将会以 encoding 编码。默认值是 null，即不编码，以 Buffer 的形式存储。常用编码为 utf8。

 response.pause()：暂停接收数据和发送事件，方便实现下载功能。

 response.resume()：从暂停的状态中恢复。