NodeJs 之 HTTP服务器与客户端

Posted 2020-06-09

　　Node.js标准库提供了http模块，其中封装了一个高效的HTTP服务器和一个简易的HTTP客户端。http.Server是一个基于事件的HTTP服务器，它的核心由Node.js下层C++部分实现，而接口由javascript封装，兼顾了高性能与简易性。http.request则是一个HTTP客户端工具，用于向HTTP服务器发起请求，例如实现Pinkback或者内容抓取。

 

HTTP服务器

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

//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 prot 3000.‘);

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

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>‘);
});
console.log(‘HTTP server is listening at prot 3000.‘);

2.http.ServerRequest
　　http.ServerRequest是HTTP请求的信息，是后端开发者最关注的内容。他一般由http.Server的request事件发送，作为第一个参数传递，通常简称request或req。HTTP请求一般可以分为两部分：请求头（Request Header）和请求体（Request Body）。以上内容由于长度较短都可以在请求头解析完成后立即读取。而请求提可能相对较长，需要一定的时间传输，因此http.ServerRequest提供了一下3个事件用于控制请求体传输。

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

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.Scoket的实例

socket：connection属性的别名

client：client属性的别名

3.获取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 protected]，可以看到浏览器返回的结果：

{ 
    search: ‘?name=byvoid&[email protected]‘,
    query: {     
        name: ‘byvoid‘, 
        email: ‘[email protected]‘ 
    },
    pathname: ‘/user‘,
    path: ‘/user?name=byvoid&[email protected]‘,
    href: ‘/user?name=byvoid&[email protected]‘ 
}

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

4.获取POST请求内容

 　　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请求格式，然后向客户端返回。
*注：不要在真正的生产应用中使用上面这种简单的方法来获取POST请求，因为它有严重的效率问题和安全问题，这只是一个帮助理解的示例。

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

HTTP客户端

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

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

1. host：请求网站的域名或IP地址
2. port：请求网站的端口，默认80
3. method：请求发发，默认是GET
4. PATH：请求的相对于根的路径，默认是”/"。QueryString应该包含在其中。例如/search?query=byvoid。
5. 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: ‘[email protected]‘,
    address: ‘address1‘
});
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(‘utf-8‘);
    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: ‘ww.byvoid.com‘}, function (res) {
    res.setEncoding(‘utf-8‘);
    res.on(‘data‘, function (data) {
        console.log(data);
    });
});

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: ‘ww.byvoid.com‘});
req.on(‘response‘, function (res) {
    res.setEncoding(‘utf-8‘);
    res.on(‘data‘, function (data) {
        console.log(data);
    });
})

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

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

　　此外还有request.setNoDelay([noDelay])、request.setSocketKeepAlive([enable], [initialDelay])等函数。

　　2.http.ClientResponse

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

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

• response.setEncoding([encoding])：设置默认的编码，当data事件被触发时，数据将会以encoding编码。默认值是null，即不编码，以Buffer的形式存储。常用编码为utf8.
• response.pause()：暂停接收数据和发送事件，方便实现下载功能。
• response.resume()：从暂停的状态中恢复。