NodeJs学习笔记2

  |  

前言

今天来学些Node.js的核心模块,它有一些精简而高效的库组成,为Node.js提供了基本的API


20



全局对象

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

全局对象与全局变量

global最根本的作用是作为全局变量的宿主。满足以下条件的变量是全局变量:

  • 在最外层定义的变量;
  • 全局对象的属性
  • 隐式定义的变量(未定义直接赋值的变量)

在Node.js中你不可能在最外层定义变量,因为所有用户代码都属于当前的模块,而模块本身不是最外层上下文

process

process是一个全局变量,即global对象的属性。它用于描述当前Node.js进程状态的对象,提供了一个与操作系统的简单接口。

process对象常用的成员方法:

  • process.argv是命令行参数数组,第一个元素是node,第二个元素是脚本名,从第三个元素开始每个元素是一个运行参数
  • process.stdout是标准输出流,通常我们使用console.log()向标准输出打印字符,而process.stdout.write()函数提供更底层的接口
  • process.stdin是标准输入流,初始时它是被暂停的,要想从标准输入读取数据,你必须恢复流,并手动编写流的事件响应函数
  • process.nextTick(callback)的功能是为事件循环设置一项任务,Node.js会在下次事件循环响应时调用callback

Node.js适合I/O密集型的应用,而不是计算密集型(CPU密集型)的应用,因为Node.js进程只有一个线程,因此在任何时刻都只有一个事件在执行。如果这个事件占用大量的CPU时间,执行事件循环中的下一个事件就需要等待很久,因此Node.js的要给编程原则就是尽量缩短每个事件的执行时间。process.nextTick()提供了要给这样的工具,可以把复杂的工作拆散成一个个较小的事件,在不同的事件循环中执行

console

console用于提供控制台标准输出,用于向标准输出流(stdout)或标准错误流(stderr)输出字符

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

常用工具util

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

until.inherits

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

示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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();
console.log(objSub);

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

1
2
3
4
5
base
Hellobase
Base { name: 'base', base: 1991, sayHello: [Function] }
sub
Sub { name: 'sub' }

注意,Sub 仅仅继承了 Base 在原型中定义的函数,而构造函数内部创造的 base 属 性和 sayHello 函数都没有被 Sub 继承。同时,在原型中定义的属性不会被 console.log 作 为对象的属性输出。

util.inspect

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

参数分析:

  • object:必须,要转换的对象
  • showHIdden:可选,值为true将会输出更多隐藏信息

  • depth:可选,表示最大递归的层数,如果对象很复杂,你可以指定层数以控制输出信息的多少,默认递归2层

  • color:可选,为true,输出格式将会以ANSI颜色编码

util.inspect并不会简单的调用对象定义的toString方法

示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
var util = require('util');

function Person() {
this.name = 'byvoid';

this.toString = function() {
return this.name;
};
}

var obj = new Person();
console.log(util.inspect(obj));
console.log(util.inspect(obj, true));

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

事件驱动events

events是Node.js最重要的模块,Node.js本身架构就是事件式的,而它提供了唯一的接口。events模块不仅用于用户代码与Node.js下层事件循环的交互,还几乎被所有的模块依赖。

事件发射器

events模块只提供了一个对象:events.EventEmitter。EventEmitter的核心就是事件发射与事件监听器功能的封装。EventEmitter的每个事件由一个事件名和若干个参数组成,事件名是一个字符串,通常表达一定的语义。对于每个事件,EventEmitter支持若干个事件监听器。当事件发射时,注册到这个事件的事件监听器被依次调用,事件参数作为回调函数参数传递。我们通过下面这个例子来解释这一整个过程:

1
2
3
4
5
6
7
8
9
10
11
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);

emitter为someEvent事件注册了两个事件监听器,然后发射了someEvent事件。

EventEmitter常用的API:

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

error事件

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

继承EventEmitter

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

这样的做的原因有两点:首先,具有某个实体功能的对象实现事件符合语义,时间的监听和发射应该是一个对象的方法。其次JavaScript的对象机制是基于原型链的,支持部分多重继承,继承EventEmitter不会打乱对象原有的继承关系。

文件系统fs

fs模块是文件操作的封装,它提供了文件的读取、写入、更名、删除、目录遍历、链接等POSIX文件系统操作。与其它模块不同的是,fs模块中所有的操作都提供了异步和同步两个版本。

fs.readFile:

fs.readFile(filename, [encoding], [callback(err, data)])

最简单的读取文件函数,接受一个必选参数filename,表示读取的文件名。第二个encoding,可选,表示文件的字符编码方式。callback是回调函数,回调函数提供两个参数,err表示是否发生错误,data是文件内容

fs.readFileSync:

fs.readFileSync(filename, [encoding])是文件读取的同步方式,没有回调函数,文件内容以函数返回值的形式返回

fs.open:

fs.open(path, flags, [mode], [callback(err, fd)])是POSIX open函数的封装,接收两个必选参数,path为文件的路径,flags是打开文件的模式:

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

mode参数可选,用于创建时给文件指定权限,以要给八进制数来表示(例如777、755)

回调函数会传递一个文件描述符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,分别表示读取的字节数和缓冲区对象。

HTTP服务器与客户端

Node.js标准库提供了http模块,其中封装了一个高效的HT TP服务器和一个简易的HTTP客户端。http.Server是一个基于事件的HTTP服务器,http.request则是一个HTTP客户端工具,用于向HTTP服务器发起请求。

HTTP服务器

http.Server的事件:

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

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

http.ServerRequest:

http.ServerRequest是HTTP请求的信息。它一般由http.Server的request事件发送,作为第一个参数传递。http.ServerRequest提供以下事件来控制请求体传输:

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

获取GET请求内容:

注意,http.ServerRequest 提供的属性中没有类似于 PHP 语言中的 $_GET 或 $_POST 的属性,那我们如何接受客户端的表单请求呢?由于 GET 请求直接被嵌入在路径 中,URL是完整的请求路径,包括了 ? 后面的部分,因此你可以手动解析后面的内容作为 GET 请求的参数。Node.js 的 url 模块中的 parse 函数提供了这个功能,例如:

1
2
3
4
5
6
7
8
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);

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

获取POST请求的内容:

POST 请求的内容全部都在请求体中。 http.ServerRequest 并没有一个属性内容为请求体,原因是等待请求体传输可能是一件 耗时的工作,譬如上传文件。而很多时候我们可能并不需要理会请求体的内容,恶意的 POST 请求会大大消耗服务器的资源。所以 Node.js 默认是不会解析请求体的,当你需要的时候, 需要手动来做。让我们看看实现方法:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
var http = rquire('http');
var querystring = reuqire('qureystring');
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(tuil.inspect(post));
});
}).listen(3000)

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

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.request(options, callback) 发起 HTTP 请求。接受两个参数,option 是 一个类似关联数组的对象,表示请求的参数,callback 是请求的回调函数。option 常用的参数如下所示:

  • host:请求网站的域名或IP地址。
  • port:请求网站的端口,默认80。
  • method:请求方法,默认是GET。
  • path:请求的相对于根的路径,默认是”/“
  • headers:要给关联数组对象,为请求头的内容

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

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

http.get(options, callback):

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

http.ClientRequest:

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

http.ClientResponse:

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

文章目录
  1. 1. 全局对象
    1. 1.1. 全局对象与全局变量
    2. 1.2. process
    3. 1.3. console
  2. 2. 常用工具util
    1. 2.1. until.inherits
    2. 2.2. util.inspect
  3. 3. 事件驱动events
    1. 3.1. 事件发射器
    2. 3.2. error事件
    3. 3.3. 继承EventEmitter
  4. 4. 文件系统fs
  5. 5. HTTP服务器与客户端
    1. 5.1. HTTP服务器
    2. 5.2. HTTP客户端