Node.js核心入门（二）

2023年2月16日 182次阅读 来源: Srtian

目录：
Node.js核心入门(一)

  • 全局对象
  • 常用工具
  • 事件机制

Node.js核心入门（二）

  • 文件系统访问
  • HTTP服务器与客户端

文件系统 fs

fs 模块是文件操作的封装，它提供了文件的读取、写入、更名、删除、遍历目录、链接等 POSIX 文件系统操作，且所有的方法都有异步和同步的形式。异步方法的最后一个参数都是一个回调函数。 传给回调函数的参数取决于具体方法，但回调函数的第一个参数都会保留给异常。 如果操作成功完成，则第一个参数会是 null 或 undefined。

const fs = require('fs');
fs.unlink('/tmp/hello', (err) => {
  if (err) throw err;
  console.log('成功删除 /tmp/hello');
});

当使用同步方法时，任何异常都会被立即抛出。 可以使用 try/catch 来处理异常，或让异常向上冒泡。

const fs = require('fs');
fs.unlinkSync('/tmp/hello');
console.log('成功删除 /tmp/hello');

1.fs.readFile(path,[options], callback)

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

fs.readFile('/etc/passwd', 'utf8', callback);

需要注意的是，当 path 是一个目录时，fs.readFile() 与 fs.readFileSync() 的行为与平台有关。在 macOS、Linux 与 Windows 上，会返回一个错误。在 FreeBSD 上，会返回目录内容的表示。

// 在 macOS、Linux 与 Windows 上：
fs.readFile('<directory>', (err, data) => {
  // => [Error: EISDIR: illegal operation on a directory, read <directory>]
});

//  在 FreeBSD 上：
fs.readFile('<directory>', (err, data) => {
  // => null, <data>
});

2.fs.readFileSync(path[, options])

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

3.fs.open(path, flags[, mode], callback)

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

'r' - 以读取模式打开文件。如果文件不存在则发生异常。

'r+' - 以读写模式打开文件。如果文件不存在则发生异常。

'rs+' - 以同步读写模式打开文件。命令操作系统绕过本地文件系统缓存。

（这对 NFS 挂载模式下打开文件很有用，因为它可以让你跳过潜在的旧本地缓存。 它对 I/O 的性能有明显的影响，所以除非需要，否则不要使用此标志。

注意，这不会使 fs.open() 进入同步阻塞调用。 如果那是你想要的，则应该使用 fs.openSync()。）

'w' - 以写入模式打开文件。文件会被创建（如果文件不存在）或截断（如果文件存在）。

'wx' - 类似 'w'，但如果 path 存在，则失败。

'w+' - 以读写模式打开文件。文件会被创建（如果文件不存在）或截断（如果文件存在）。

'wx+' - 类似 'w+'，但如果 path 存在，则失败。

'a' - 以追加模式打开文件。如果文件不存在，则会被创建。

'ax' - 类似于 'a'，但如果 path 存在，则失败。

'a+' - 以读取和追加模式打开文件。如果文件不存在，则会被创建。

'ax+' - 类似于 'a+'，但如果 path 存在，则失败。

mode 可设置文件模式（权限和 sticky 位），但只有当文件被创建时才有效。默认为 0o666，可读写。

4.fs.read(fd, buffer, offset, length, position, callback)

fs.read(fd, buffer, offset, length, position, callback) 是 POSIX read 函数的封装，相比 fs.readFile 提供了更底层的接口。从 fd 指定的文件中读取数据。buffer 是数据将被写入到的 buffer。offset 是 buffer 中开始写入的偏移量。length是一个整数，指定要读取的字节数。position指定从文件中开始读取的位置。如果position为null，则数据从当前文件读取位置开始读取，且文件读取位置会被更新。 如果 position 为一个整数，则文件读取位置保持不变。回调有三个参数 (err, bytesRead, buffer)。

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>

HTTP服务器与客户端

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

Node.js 中的HTTP接口被设计成支持协议的许多特性。比如，大块编码的消息。这些接口不缓冲完整的请求或响应，用户能够以流的形式处理数据。HTTP消息头由一个对象表示，其中键名是小写的，键值不能修改：

{ 'content-length': '123',
  'content-type': 'text/plain',
  'connection': 'keep-alive',
  'host': 'mysite.com',
  'accept': '*/*' }

为了支持各种可能的 HTTP 应用，Node.js的 HTTP API是非常底层的。它只涉及流处理与消息解析。它把一个消息解析成消息头和消息主体，但不解析具体的消息头或消息主体。键名是小写的，键值不能修改。为了支持各种可能的 HTTP 应用，Node.js 的 HTTP API 是非常底层的。 它只涉及流处理与消息解析。 它把一个消息解析成消息头和消息主体，但不解析具体的消息头或消息主体。

HTTP服务器

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

const http = require('http');

const hostname = '127.0.0.1';
const port = 3000;

const server = http.createServer((req, res) => {
  res.statusCode = 200;
  res.setHeader('Content-Type', 'text/plain');
  res.end('Hello World\n');
});

server.listen(port, hostname, () => {
  console.log(`Server running at http://${hostname}:${port}/`);
})

在这段代码中，就使用了http.createServer([requestListener])来新建一个的 http.Server 实例。现在就先让我们来看看http.createServer([requestListener])吧。

1. http.Server 的事件

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

  • request：每次接收到一个请求时触发。 注意，每个连接可能有多个请求（在 HTTP keep-alive 连接的情况下）。
  • connection ：当一个新的 TCP 流被建立时触发。socket 是一个 net.Socket 类型的对象。 通常用户无需访问该事件。 注意，因为协议解析器绑定到 socket 的方式，socket 不会触发 ‘readable’ 事件。socket 也可以通过 request.connection 访问。
  • connect：每当客户端发送 HTTP CONNECT 请求时触发。 如果该事件未被监听，则发送 CONNECT 请求的客户端会关闭连接。当该事件被触发后，请求的 socket 上没有 ‘data’ 事件监听器，这意味着需要绑定 ‘data’ 事件监听器，用来处理 socket 上被发送到服务器的数据。
  • close：当服务器关闭时，该事件被触发。注意不是在用户连接断开时，而是服务器关闭时。

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

//httpserver.js
const http = require('http');
const hostname = '127.0.0.1';
const port = 3000;
const server = new http.Server();
server.on('request', (req, res) => {
  res.statusCode = 200;
  res.setHeader('Content-Type', 'text/plain');
  res.end('Hello World\n');
});
server.listen(port, hostname, () => {
  console.log(`Server running at http://${hostname}:${port}/`);
})

2. http.ServerRequest

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

  1. data：当请求体数据到来时，该事件被触发，提供一个参数给回调函数，是接受到的数据，该事件可能被多次调用（所有data按顺序的集合，是请求体数据）。如果该事件没有被监听，请求体将被抛弃；

  2. end：当请求体数据完成时该事件触发。此后不再触发data事件；

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

                  表4-2  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 属性的别名

3. 获取 GET 请求内容

注意， http.ServerRequest 提供的属性中没有类似于 PHP 语言中的 $_GET 或 $_POST 的属性，GET请求被直接内嵌在路径中。URL是完整的请求路径（包括？后面的部分），因此手动解析后面的内容作为GET请求的参数。Node.js的url模块中的parse函数提供了这个功能。

以url：http://127.0.0.1/user?name=byvoid&email=byvoid@byvoid.com为例：

var http = require("http");
var url = require("url");
var server = new http.Server();
server.on("request", function (req, res) {
    if (req.url == "/favicon.ico") {
        return;
    }
    var m = url.parse(req.url, true);
    console.log(m)
    res.writeHead(200, {'Content-type': 'text/html;charset = utf8'});
    res.end();
})
server.listen(80);
console.log("The server begin");

console.log输出内容：

Url {
  protocol: null,
  slashes: null,
  auth: null,
  host: null,
  port: null,
  hostname: null,
  hash: null,
  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' 
}

4. 获取 POST 请求内容

HTTP 协议1.1版本提供了8种标准的请求方法，而其中最常见的就是 GET 和 POST。相比GET请求把所有的内容编码到访问路径中，POST 请求的内容全部都在请求体中。http.ServerRequest 并没有一个属性内容是在请求体中，原因是等待请求体传输可能是一件耗时的工作，譬如上传文件。而很多时候我们可能并不需要理会请求体的内容，且恶意的 POST
请求会大大消耗服务器的资源。所以 Node.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);

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服务器发起请求。

1.http.request(options,callback)

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 请求的代码：

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"
}

2.http.get(options, callback)

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

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.request() 内部被创建并返回。它表示着一个正在处理的请求，其请求头已进入队列。它提供一个response事件，即http.request或http.get第二个参数指定的回调函数的绑定对象。

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() ：标记请求为终止。 调用该方法将使响应中剩余的数据被丢弃且 socket 被销毁。
  • request.setTimeout(timeout,[callback])：设置请求超时时间， timeout为毫秒数。一旦socket被分配给请求且已连接，socket.setTimeout() 会被调用。
  • request.end([data[, encoding]][, callback])结束发送请求。如果部分请求主体还未被发送，则会刷新它们到流中。 如果请求是分块的，则会发送终止字符 ‘0\r\n\r\n’。

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() ：从暂停的状态中恢复。
    原文作者：Srtian
    原文地址: https://www.jianshu.com/p/988b2f112dc4
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞