【Node.js】Stream（流）的学习笔记

2022-10-16 17:41:12

　　最近学习使用Node.js创建http proxy server，少不了要跟Stream打交道。昨天开始查阅一些资料，多少有了一些粗浅了解。整理在这里，供学习之用。

　　从Node.js API文档中可知，

　　"A stream is an abstract interface implemented by various objects in Node. For example a request to an HTTP server is a stream, as is stdout. Streams are readable, writable, or both. All streams are instances of EventEmitter。""流是很多I/0操作的抽象，被 Node 中的很多对象所实现。比如对一个 HTTP 服务器的请求是一个流（可读流）（服务器的响应是一个流（可写流）），stdout也是流。流是可读、可写或兼具两者的。所有流都是 EventEmitter 的实例。"

一. 为什么需要流（Stream）？

　　举个例子，如果要读取一个文件，一次性读取需要占用大内存，是不可取的。因此就有了流，用流会很方便，可以帮我们避免这样的问题，调用其接口不用关心底层如何实现。

二. 什么是流（Stream）？

　　流（Stream）是可读，可写或双工的。可以通过require('stream')加载流的基类，其中包括四类流， Readable 流、Writable 流、Duplex 流和Transform 流的基类。

　　另外如果觉得上述四类基类流不能满足需求，可以编写自己的扩充类流。像我们Team现在正做的Node项目，就重写了Transform类以供使用。

　　按照官方的API文档，步骤如下：

在您的子类中扩充适合的父类。（例如util.inherits(MyTransform, Transform); ）
在您的构造函数中调用父类的构造函数，以确保内部的机制被正确初始化。
实现一个或多个特定的方法，参见下面的细节。

三. Readable流（可读流）介绍

　 Readable（可读）流接口是对您正在读取的数据的来源的抽象。换言之，数据出自一个可读流。

　 Readable 流有两种“模式”：流动模式和暂停模式。

　当处于流动模式时，数据由底层系统读出，并尽可能快地提供给您的程序；当处于暂停模式时，您必须明确地调用 stream.read() 来取出若干数据块。流默认处于暂停模式。

　 A. 通过以下三种方法，可读流会被切换到流动模式

　　 1. 添加一个'data'事件处理器来监听数据。

　　 2. 调用 resume()方法来明确开启数据流。

　 3. 调用 pipe()方法将数据发送到一个可写流（Writable）。

　　之前我一直对pipe()方法有疑问，不清楚其用法。现在了解，当我们用pipe()为可读流指定了一个接受者（可写流）的时候，数据才会真正的被从底层系统读出，传递给可写流。

　 B. 下面介绍Readable流有以下几种事件

　　 1. 'Readable'事件

　　 2. 'data'事件 - 数据正在传递时，触发该事件（以chunk数据块为对象）

　　 3. 'end'事件 - 数据传递完成后，会触发该事件。

　　 4. 'close'事件

　　 5. 'error'事件

　　 所有这些事件都可以在官方API文档中找到例子。

　 C. 下面介绍Readable流很重要的一个方法，pipe()方法。

　　该方法从可读流中拉取所有数据，并写入到所提供的目标（可写流）。该方法能自动控制流量以避免目标被快速读取的可读流所淹没。

　　值得注意的是，默认情况下，当数据传送完毕，触发'end'事件时，会同时触发目标（可写流）的'end'事件，导致目标不再可写。

　　　举个简单的小例子，

 //http.js

 var http = require('http');

 var fs = require('fs');

 http.createServer(function(req, res){

     var stream = fs.createReadStream(__dirname + '/data.txt');

     stream.pipe(res);

 }).listen(3000);

 console.log('now we are listening 3000 port');

　　 data.txt文件内容如下：