02 Node.js核心模块

内容来自《Node.js开发指南》

核心模块是 Node.js 的心脏,它由一些精简而高效的库组成,为 Node.js 提供了基本的API。本章中,我们挑选了一部分最常用的核心模块加以详细介绍,主要内容包括:

  • 全局对象;
  • 常用工具;
  • 事件机制;
  • 文件系统访问;
  • HTTP 服务器与客户端。

1. 全局对象


Javascript中有一个特殊的对象,成为全局对象(Global Object),它及其所有属性都可以在程序的任何地方访问,即全局变量。在浏览器JavaScript中,通常window是全局对象,而Node.js中的全局对象是global,所有全局变量(除了global本身以外)都是gloal对象的属性。

我们在Node.js中能搞直接访问到的对象通常都是global的属性,如console、process等,下面逐一介绍。

1.1 全局对象与全局变量

global 最根本的作用是作为全局变量的宿主。按照 ECMAScript 的定义,满足以下条件的变量是全局变量:

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

1.2 process

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

  • process.argv是命令行参数数组,第一个元素是 node, 第二个元素是脚本文件名,
    从第三个元素开始每个元素是一个运行参数。
console.log(process.argv);

将以上代码存储为 argv.js,通过以下命令运行:

$ node argv.js 1991 name=byvoid --v "Carbo Kuo"
    [ 'node',
    '/home/byvoid/argv.js',
    '1991',
    'name=byvoid',
    '--v',
    'Carbo Kuo' ]
  • process.stdout 是标准输出流,通常我们是用的console.log()向标准输出打印字符,而 process.stdout.write()函数提供了更底层的接口。
  • process.stdin是标准输入流,初始时它是被暂停的,要想从标准输入读取数据,你必须恢复流,并手动编写流的事件响应函数。
process.stdin.resume();
process.stdin.on('data', function(data) {
    process.stdout.write('read from console: ' + data.toString());
});
  • process.nextTick(callback)的功能是为事件循环设置一项任务,Node.js会在下次事件循环响应时调用callback;

process.nextTick() 提供了一个这样的工具,可以把复杂的工作拆散,变成一个个较小的事件。

    function doSomething(args, callback) {
        somethingComplicated(args);
        callback();
    }
    doSomething(function onEnd() {
        compute();
    });

我们假设 compute() 和 somethingComplicated() 是两个较为耗时的函数,以上的程序在调用 doSomething() 时会先执行 somethingComplicated(),然后立即调用回调函数,在 onEnd() 中又会执行 compute()。下面用 process.nextTick() 改写上面的程序:

function doSomething(args, callback) {
    somethingComplicated(args);
    process.nextTick(callback);
}
doSomething(function onEnd() {
    compute();
});

改写后的程序会把上面耗时的操作拆分为两个事件,减少每个事件的执行时间,提高事件响应速度。

不要使用 setTimeout(fn,0)代替 process.nextTick(callback),前者比后者效率要低得多。

我们探讨了process对象常用的几个成员,除此之外process还展示了process.platform、process.pid、 process.execPath、 process.memoryUsage() 等方法,以及 POSIX进程信号响应机制。有兴趣的读者可以访问 http://nodejs.org/api/process.html 了解详细内容。

1.3 console

console 用于提供控制台标准输出,它是由 Internet Explorer 的 JScript 引擎提供的调试工具,后来逐渐成为浏览器的事实标准。 Node.js 沿用了这个标准,提供与习惯行为一致的console 对象,用于向标准输出流(stdout)或标准错误流(stderr)输出字符。

  • console.log():向标准输出流打印字符并以换行符结束。 console.log 接受若干个参数,如果只有一个参数,则输出这个参数的字符串形式。如果有多个参数,则以类似于 C 语言 printf() 命令的格式输出。第一个参数是一个字符串,如果没有参数,只打印一个换行。
  • console.error():与 console.log() 用法相同,只是向标准错误流输出。
  • console.trace():向标准错误流输出当前的调用栈。

2 常用工具 util

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

2.1 util.inherits

util.inherits(constructor, superConstructor)是一个实现对象间原型继承的函数。 JavaScript 的面向对象特性是基于原型的,与常见的基于类的不同。 JavaScript 没有提供对象继承的语言级别特性,而是通过原型复制来实现的,具体细节我们在附录A中讨论,在这里我们只介绍 util.inherits 的用法,示例如下:

var util = require('util');

function Base() {
    this.name = 'base';
    this.base = 1991;
    this.sayHello = function() {
        console.log('Hello ' + this.name);
    };
}

Base.prototype.showName = function() {
    console.log(this.name);
};

function Sub() {
    this.name = 'sub';
}

util.inherits(Sub, Base);
var objBase = new Base();
objBase.showName();
objBase.sayHello();
console.log(objBase);

var objSub = new Sub();
objSub.showName();
//objSub.sayHello();
console.log(objSub);

我们定义了一个基础对象 Base 和一个继承自 Base 的 Sub, Base 有三个在构造函数内定义的属性和一个原型中定义的函数,通过 util.inherits 实现继承。运行结果如下:

base
Hello base
{ name: 'base', base: 1991, sayHello: [Function] }
sub
{ name: 'sub' }

Sub 仅仅继承了 Base 在原型中定义的函数,而构造函数内部创造的 base 属性和 sayHello 函数都没有被 Sub 继承。

2.2 util.inspect

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

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

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

除了以上我们介绍的几个函数之外, util还提供了util.isArray()、util.isRegExp()、util.isDate()、 util.isError() 四个类型测试工具,以及 util.format()、 util.debug() 等工具。有兴趣的读者可以访问 http://nodejs.org/api/util.html 了解详细内容。

3. 事件驱动 events


event 是Node.js最重要的模块,没有“之一”,原因是Node.js本身构架就是事件式的,而它提供了唯一的接口,所以堪称Node.js事件编程的基石。events模块不仅用于用户代码与Node.js下层事件循环的交互,还几乎被所有的模块依赖。

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

以上例子中, emitter 为事件 someEvent 注册了两个事件监听器,然后触发了
someEvent 事件。运行结果中可以看到两个事件监听器回调函数被先后调用。

  • 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,则移除指定事件的所有监听器。

更详细的 API 文档参见 http://nodejs.org/api/events.html

3.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.3 继承EventEmitter

大多数时候我们不会直接使用EventEmitter,而是在对象中继承它。包括fs、ner、http在内的,只要是支持事件响应的核心模块都是EventEmitter的子类
为什么要这么做呢?原因有2点。首先,具有某个实体功能的对象事件符合语义,事件监听和触发应该是一个对象的方法。其次JavaScript的对象机制是基于原型的,支持部分多重继承,继承EventEmitter不会打乱对象原有的继承关系。

4 文件系统fs


fs模块是文件操作的封装,它提供了文件的读取、写入、更名、删除、遍历目录、链接等POSIX文件系统操作。与其他模块不停的是,fs模块中所有的操作都提供了异步和同步的两个版本,例如读取文件内容的函数有异步的fs.readFile()和同步的fs.readFileSync()。我们以几个函数为代表,介绍fs常用的功能,并列出fs所有函数的定义和功能。

4.1 fs.readFile

fs.readFile(filename,[encoding],[callback(err,data)])是最简单的读取文件的函数。它接收一个必选参数filename,表示要读取的文件名。第二个参数encoding是可选的,表示文件的字符编码。callback是回调函数,用于接收文件的内容。如果不指定encoding,则callback就是第二个参数。毁回调函数提供两个参数err和data,err表示有没有错误发生,data是文件内容。如果指定了encoding,data是一个解析后的字符串,否则data将会是以buffer形式表示的二进制数据。

例如一下程序,我们从content.txt中读取数据,但不指定编码:

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>

这个程序以二进制的模式读取了文件的内容, data 的值是 Buffer 对象。如果我们给fs.readFile 的 encoding 指定编码:

fs.readFile('content.txt', 'utf-8', function(err, data) {
if (err) {
console.error(err);
} else {
console.log(data);
}
});

那么运行结果则是:

Text 文本文件示例

当读取文件出现错误时, err 将会是 Error 对象。如果 content.txt 不存在,运行前面的代码则会出现以下结果:

{ [Error: ENOENT, no such file or directory 'content.txt'] errno: 34, code: 'ENOENT',
path: 'content.txt' }

Node.js 的异步编程接口习惯是以函数的最后一个参数为回调函数,通常一个函数只有一个回调函数。回调函数的实际参数中第一个是 err,其余的参数是其他返回的内容。如果没有发生错误, err 的值会是 null 或undefined。如果有错误发生, err 通常是 Error 对象的实例。

4.2 fs.readFileSync

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

与同步 I/O 函数不同, Node.js 中异步函数大多没有返回值。

4.3 fs.open

fs.open(path, flags, [mode], [callback(err, fd)])是POSIC open函数的封装,与C语言标准库中的fopen函数类似。它接收两个必选参数,path为文件的路径,flags可以是以下值。

  • r :以读取模式打开文件。
  • r+ :以读写模式打开文件。
  • w :以写入模式打开文件,如果文件不存在则创建。
  • w+ :以读写模式打开文件,如果文件不存在则创建。
  • a :以追加模式打开文件,如果文件不存在则创建。
  • a+ :以读取追加模式打开文件,如果文件不存在则创建。

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

① 文件权限指的是 POSIX 操作系统中对文件读取和访问权限的规范,通常用一个八进制数来表示。例如 0754 表示文件所有者的权限是 7 (读、写、执行),同组的用户权限是 5 (读、执行),其他用户的权限是 4 (读),写成字符表示就是 -rwxr-xr--。
② 文件描述符是一个非负整数,表示操作系统内核为当前进程所维护的打开文件的记录表索引。

4.4 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,分别表示读取的字节数和缓冲区对象。

以下是一个使用 fs.open 和 fs.read 的示例。

var fs = require('fs');

fs.open('content.txt', 'r', function(err, fd) {
    if (err) {
        console.error(err);
        return;
    }
    var buf = new Buffer(8);
    fs.read(fd, buf, 0, 8, null, function(err, bytesRead, buffer) {
        if (err) {
            console.error(err);
            return;
        }
        console.log('bytesRead: ' + bytesRead);
        console.log(buffer);
    })
});

运行结果是:

bytesRead: 8
<Buffer 54 65 78 74 20 e6 96 87>

一般来说,除非必要,否则不要使用这种方式读取文件,因为它要求你手动管理缓冲区和文件指针,尤其是在你不知道文件大小的时候,这将会是一件很麻烦的事情。

fs 模块函数表

功能 异步函数 同步函数
打开文件 fs.open(path,flags, [mode], [callback(err,fd)]) fs.openSync(path, flags, [mode])
关闭文件 fs.close(fd, [callback(err)]) fs.closeSync(fd)
读取文件(文件描述符) fs.read(fd,buffer,offset,length,position,[callback(err, bytesRead, buffer)]) fs.readSync(fd, buffer, offset,length, position)
写入文件(文件描述符) fs.write(fd,buffer,offset,length,position,[callback(err, bytesWritten, buffer)]) fs.writeSync(fd, buffer, offset,length, position)
读取文件内容 fs.readFile(filename,[encoding],[callback(err,data)]) fs.readFileSync(filename,[encoding])
写入文件内容 fs.writeFile(filename, data,[encoding],[callback(err)]) fs.writeFileSync(filename, data,[encoding])
删除文件 fs.unlink(path, [callback(err)]) fs.unlinkSync(path)
创建目录 fs.mkdir(path, [mode], [callback(err)]) fs.mkdirSync(path, [mode])
删除目录 fs.rmdir(path, [callback(err)]) fs.rmdirSync(path)
读取目录 fs.readdir(path, [callback(err, files)]) fs.readdirSync(path)
获取真实路径 fs.realpath(path, [callback(err,resolvedPath)]) fs.realpathSync(path)
更名 fs.rename(path1, path2, [callback(err)]) fs.renameSync(path1, path2)
截断 fs.truncate(fd, len, [callback(err)]) fs.truncateSync(fd, len)
更改所有权 fs.chown(path, uid, gid, [callback(err)]) fs.chownSync(path, uid, gid)
更改所有权(文件描述符) fs.fchown(fd, uid, gid, [callback(err)]) fs.fchownSync(fd, uid, gid)
更改所有权(不解析符号链接) fs.lchown(path, uid, gid, [callback(err)]) fs.lchownSync(path, uid, gid)
更改权限 fs.chmod(path, mode, [callback(err)]) fs.chmodSync(path, mode)
更改权限(文件描述符) fs.fchmod(fd, mode, [callback(err)]) fs.fchmodSync(fd, mode)
更改权限(不解析符号链接) fs.lchmod(path, mode, [callback(err)]) fs.lchmodSync(path, mode)
获取文件信息 fs.stat(path, [callback(err, stats)]) fs.statSync(path)
获取文件信息 (文件描述符) fs.fstat(fd, [callback(err, stats)]) fs.fstatSync(fd)
获取文件信息 (不解析符号链接) fs.lstat(path, [callback(err, stats)]) fs.lstatSync(path)
创建硬链接 fs.link(srcpath, dstpath, [callback(err)]) fs.linkSync(srcpath, dstpath)
创建符号链接 fs.symlink(linkdata, path, [type],[callback(err)]) fs.symlinkSync(linkdata, path,[type])
读取链接 fs.readlink(path, [callback(err,linkString)]) fs.readlinkSync(path)
修改文件时间戳 fs.utimes(path, atime, mtime, [callback(err)]) fs.utimesSync(path, atime, mtime)
修改文件时间戳(文件描述符) fs.futimes(fd, atime, mtime, [callback(err)]) fs.futimesSync(fd, atime, mtime)
同步磁盘缓存 fs.fsync(fd, [callback(err)]) fs.fsyncSync(fd)

5 HTTP服务器与客户端


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

5.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.createServer 创建了一个 http.Server 的实例,将一个函数作为 HTTP 请求处理函数。这个函数接受两个参数,分别是请求对象( req )和响应对象( res )。在函数体内, res 显式地写回了响应代码 200 表示请求成功),指定响应头为'Content-Type': 'text/html',然后写入响应体 '<h1>Node.js</h1>',通过 res.end结束并发送。最后该实例还调用了 listen 函数,启动服务器并监听 3000 端口。

5.1.1 http.Server 的事件

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

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

除此之外还有 checkContinue、 upgrade、 clientError 事件,通常我们不需要关心,只有在实现复杂的 HTTP 服务器的时候才会用到。

在 这 些 事 件 中 , 最 常 用 的 就 是 request 了 , 因 此 http 提 供 了 一 个 捷 径 :http.createServer([requestListener]) , 功 能 是 创 建 一 个 HTTP 服 务 器 并 将requestListener 作为 request 事件的监听函数,这也是我们前面例子中使用的方法。事实上它显式的实现方法是:

//httpserver.js

var http = require('http');
var server = new http.Server();

server.on('request', function(req, res) {
    res.writeHead(200, {'Content-Type': 'text/html'});
    res.write('<h1>Node.js</h1>');
    res.end('<p>Hello World</p>');
});
server.listen(3000);

console.log("HTTP server is listening at port 3000.");

5.1.2

http.ServerRequest 是 HTTP 请求的信息,是后端开发者最关注的内容。它一般由http.Server 的 request 事件发送,作为第一个参数传递,通常简称 request 或 req。ServerRequest 提供一些属性,下表中列出了这些属性。

名称 含义
complete 客户端请求是否已经发送完成
httpVersion HTTP 协议版本,通常是 1.0 或 1.1
method HTTP 请求方法,如 GET、 POST、 PUT、 DELETE 等
url 原始的请求路径,例如 /static/image/x.jpg 或 /user?name=byvoid
headers HTTP 请求头
trailers HTTP 请求尾(不常见)
connection 当前 HTTP 连接套接字,为 net.Socket 的实例
socket connection 属性的别名
client client 属性的别名

HTTP 请求一般可以分为两部分: 请求头(Request Header)和请求体(Requset Body)。以上内容由于长度较短都可以在请求头解析完成后立即读取。而请求体可能相对较长,需要一定的时间传输,因此 http.ServerRequest 提供了以下3个事件用于控制请求体传输。

  • data :当请求体数据到来时,该事件被触发。该事件提供一个参数 chunk,表示接收到的数据。如果该事件没有被监听,那么请求体将会被抛弃。该事件可能会被调用多次。
  • end :当请求体数据传输完成时,该事件被触发,此后将不会再有数据到来。
  • close: 用户当前请求结束时,该事件被触发。不同于 end,如果用户强制终止了传输,也还是调用close。

5.1.3 3. 获取 GET 请求内容

注意, http.ServerRequest 提供的属性中没有类似于 PHP 语言中的 $_GET或 $_POST 的属性,那我们如何接受客户端的表单请求呢?由于 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。

5.1.4 获取 POST 请求内容

HTTP协议 1.1 版本提供了8种标准的请求方法,其中最常见的就是 GET 和 POST。相比GET 请求把所有的内容编码到访问路径中, POST 请求的内容全部都在请求体中。http.ServerRequest 并没有一个属性内容为请求体,原因是等待请求体传输可能是一件耗时的工作,譬如上传文件。而很多时候我们可能并不需要理会请求体的内容,恶意的 POST请求会大大消耗服务器的资源。所以 Node.js 默认是不会解析请求体的,当你需要的时候,需要手动来做。让我们看看实现方法:

//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);

上面代码并没有在请求响应函数中向客户端返回信息,而是定义了一个 post 变量,用于在闭包中暂存请求体的信息。通过 req 的 data 事件监听函数,每当接受到请求体的数据,就累加到 post 变量中。在 end 事件触发后,通过 querystring.parse 将 post 解析为真正的 POST 请求格式,然后向客户端返回。

5.1.5 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 相同。如果不调用该函数,客户端将永远处于等待状态。

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

5.2.1 http.ClientRequest

http.ClientRequest 是由 http.request 或 http.get 返回产生的对象,表示一个已经产生而且正在进行中的 HTTP请求。它提供一个 response 事件,即 http.request或 http.get 第二个参数指定的回调函数的绑定对象。我们也可以显式地绑定这个事件的监听函数:

//httpresponse.js

var http = require('http');

var req = http.get({host: 'www.byvoid.com'});

req.on('response', function(res) {
    res.setEncoding('utf8');
    res.on('data', function (data) {
        console.log(data);
    });
});

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

  • request.abort():终止正在发送的请求。
  • request.setTimeout(timeout, [callback]):设置请求超时时间, timeout 为毫秒数。当请求超时以后, callback 将会被调用。

此外还有request.setNoDelay([noDelay])、 request.setSocketKeepAlive([enable], [initialDelay]) 等函数,具体内容请参见 Node.js 文档。

5.2.2 http.ClientResponse

http.ClientResponse 与 http.ServerRequest 相似,提供了三个事件 data、 end和 close,分别在数据到达、传输结束和连接结束时触发,其中 data 事件传递一个参数chunk,表示接收到的数据。

http.ClientResponse 也提供了一些属性,用于表示请求的结果状态,参见表

名称 含义
statusCode HTTP 状态码,如 200、 404、 500
httpVersion HTTP 协议版本,通常是 1.0 或 1.1
headers HTTP 请求头
trailers HTTP 请求尾(不常见)

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

  • response.setEncoding([encoding]):设置默认的编码,当 data 事件被触发时,数据将会以 encoding 编码。默认值是 null,即不编码,以 Buffer 的形式存储。常用编码为 utf8。
  • response.pause():暂停接收数据和发送事件,方便实现下载功能。
  • response.resume():从暂停的状态中恢复。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,013评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,205评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,370评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,168评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,153评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,954评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,271评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,916评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,382评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,877评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,989评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,624评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,209评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,199评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,418评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,401评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,700评论 2 345

推荐阅读更多精彩内容