NodeJS Stream 三：readable

什么是可读流

可读流是生产数据用来供程序消费的流。咱们常见的数据生产方式有读取磁盘文件、读取网络请求内容等，看一下前面介绍什么是流用的例子：

const rs = fs.createReadStream(filePath);

rs 就是一个可读流，其生产数据的方式是读取磁盘的文件，咱们常见的控制台 process.stdin 也是一个可读流：

process.stdin.pipe(process.stdout);

经过简单的一句话能够把控制台的输入打印出来，process.stdin 生产数据的方式是读取用户在控制台的输入。

回头再看一下咱们对可读流的定义：可读流是生产数据用来供程序消费的流。

自定义可读流

除了系统提供给咱们的 fs.CreateReadStream 咱们还常用 gulp 或者 vinyl-fs 提供的 src 方法

gulp.src(['*.js', 'dist/**/*.scss'])

若是咱们想本身以某种特定的方式生产数据，交给程序消费，那么改如何开始呢？

简单两步便可

1. 继承 sream 模块的 Readable 类
2. 重写 **_read** 方法，调用 this.push 将生产的数据放入待读取队列

Readable 类已经把可读流要作的大部分工做完成，咱们只须要继承它，而后把生产数据的方式写在 _read 方法里就能够实现一个自定义的可读流。

若是咱们想实现一个每 100 毫秒生产一个随机数的流（没什么用处）

const Readable = require('stream').Readable;

class RandomNumberStream extends Readable {
    constructor(max) {
        super()
    }

    _read() {
        const ctx = this;
        setTimeout(() => {
            const randomNumber = parseInt(Math.random() * 10000);

            // 只能 push 字符串或 Buffer，为了方便显示打一个回车
            ctx.push(`${randomNumber}\n`);
        }, 100);
    }
}

module.exports = RandomNumberStream;

类继承部分代码很简单，主要看一下 _read 方法的实现，有几个值得注意的地方

1. Readable 类中默认有 _read 方法的实现，不过什么都没有作，咱们作的是覆盖重写
2. _read 方法有一个参数 size，用来向 read 方法指定应该读取多少数据返回，不过只是一个参考数据，不少实现忽略此参数，咱们这里也忽略了，后面会详细提到
3. 经过 this.push 向缓冲区推送数据，缓冲区概念后面会提到，暂时理解为挤到了水管中可消费了
4. push 的内容只能是字符串或者 Buffer，不能是数字
5. push 方法有第二个参数 encoding，用于第一个参数是字符串时指定 encoding

执行一下看看效果

const RandomNumberStream = require('./RandomNumberStream');

const rns = new RandomNumberStream();

rns.pipe(process.stdout);

这样能够看到数字源源不断的显示到了控制台上，咱们实现了一个产生随机数的可读流，还有几个小问题待解决

如何停下来

咱们每隔 100 毫秒向缓冲区推送一个数字，那么就像读取一个本地文件总有读完的时候，如何停下来标识数据读取完毕？

向缓冲区 push 一个 null 就能够。咱们修改一下代码，容许消费者定义须要多少个随机数字：

const Readable = require('stream').Readable;

class RandomNumberStream extends Readable {
    constructor(max) {
        super()
        this.max = max;
    }

    _read() {
        const ctx = this;

        setTimeout(() => {
            if (ctx.max) {
                const randomNumber = parseInt(Math.random() * 10000);

                // 只能 push 字符串或 Buffer，为了方便显示打一个回车
                ctx.push(`${randomNumber}\n`);
                ctx.max -= 1;
            } else {
                ctx.push(null);
            }
        }, 100);
    }
}

module.exports = RandomNumberStream;

咱们使用了一个 max 的标识，容许消费者指定须要的字符数，在实例化的时候指定便可

const RandomNumberStream = require('./RandomNumberStream');

const rns = new RandomNumberStream(5);

rns.pipe(process.stdout);

这样能够看到控制台只打印了 5 个字符

为何是 setTimeout 而不是 setInterval

细心的同窗可能注意到，咱们每隔 100 毫秒生产一个随机数并非调用的 setInterval，而是使用的 setTimeout，为何仅仅是延时了一下并无重复生产，结果倒是正确的呢？

这就须要了解流的两种工做方式

1. 流动模式：数据由底层系统读出，并尽量快地提供给应用程序
2. 暂停模式：必须显示地调用 read() 方法来读取若干数据块

流在默认状态下是处于暂停模式的，也就是须要程序显式的调用 read() 方法，可咱们的例子中并无调用就能够获得数据，由于咱们的流经过 pipe() 方法切换成了流动模式，这样咱们的 _read() 方法会自动被反复调用，直到数据读取完毕，因此咱们每次 _read() 方法里面只须要读取一次数据便可。

流动模式和暂停模式切换

流从默认的暂停模式切换到流动模式可使用如下几种方式：

1. 经过添加 data 事件监听器来启动数据监听
2. 调用 resume() 方法启动数据流
3. 调用 pipe() 方法将数据转接到另外一个 可写流

从流动模式切换为暂停模式又两种方法：

1. 在流没有 pipe() 时，调用 pause() 方法能够将流暂停
2. pipe() 时，须要移除全部 data 事件的监听，再调用 unpipe() 方法

data 事件

使用了 pipe() 方法后数据就从可读流进入了可写流，但对咱们好像是个黑盒，数据到底是怎么流向的呢？咱们看到切换流动模式和暂停模式的时候有两个重要的名词

1. 流动模式对应的 data 事件
2. 暂停模式对应的 read() 方法

这两个机制是咱们可以驱动数据流动的缘由，先来看一下流动模式 data 事件，一旦咱们监听了可读流的 data 时、事件，流就进入了流动模式，咱们能够改写一下上面调用流的代码

const RandomNumberStream = require('./RandomNumberStream');

const rns = new RandomNumberStream(5);

rns.on('data', chunk => {
  console.log(chunk);
});

这样咱们能够看到控制台打印出了相似下面的结果

<Buffer 39 35 37 0a>
<Buffer 31 30 35 37 0a>
<Buffer 38 35 31 30 0a>
<Buffer 33 30 35 35 0a>
<Buffer 34 36 34 32 0a>

当可读流生产出可供消费的数据后就会触发 data 事件，data 事件监听器绑定后，数据会被尽量地传递。data 事件的监听器能够在第一个参数收到可读流传递过来的 Buffer 数据，这也就是咱们打印的 chunk，若是想显示为数字，能够调用 Buffer 的 toString() 方法。

当数据处理完成后还会触发一个 end 事件，应为流的处理不是同步调用，因此若是咱们但愿完过后作一些事情就须要监听这个事件，咱们在代码最后追加一句：

rns.on('end', () => {
  console.log('done');
});

这样能够在数据接收完了显示 'done'

固然数据处理过程当中出现了错误会触发 error 事件，咱们一样能够监听，作异常处理：

rns.on('error', (err) => {
  console.log(err);
});

read(size)

流在暂停模式下须要程序显式调用 read() 方法才能获得数据。read() 方法会从内部缓冲区中拉取并返回若干数据，当没有更多可用数据时，会返回null。

使用 read() 方法读取数据时，若是传入了 size 参数，那么它会返回指定字节的数据；当指定的size字节不可用时，则返回null。若是没有指定size参数，那么会返回内部缓冲区中的全部数据。

如今有一个矛盾了，在流动模式下流生产出了数据，而后触发 data 事件通知给程序，这样很方便。在暂停模式下须要程序去读取，那么就有一种多是读取的时候还没生产好，若是咱们才用轮询的方式未免效率有些低。

NodeJS 为咱们提供了一个 readable 的事件，事件在可读流准备好数据的时候触发，也就是先监听这个事件，收到通知又数据了咱们再去读取就行了：

const rns = new RandomNumberStream(5);

rns.on('readable', () => {
  let chunk;
  while((chunk = rns.read()) !== null){
    console.log(chunk);
  }
});

这样咱们一样能够读取到数据，值得注意的一点是并非每次调用 read() 方法均可以返回数据，前面提到了若是可用的数据没有达到 size 那么返回 null，因此咱们在程序中加了个判断。

数据会不会漏掉

开始使用流动模式的时候我常常会担忧一个问题，上面代码中可读流在建立好的时候就生产数据了，那么会不会在咱们绑定 readable 事件以前就生产了某些数据，触发了 readable 事件，咱们尚未绑定，这样不是极端状况下会形成开头数据的丢失嘛

可事实并不会，按照 NodeJS event loop 咱们建立流和调用事件监听在一个事件队列里面，儿生产数据因为涉及到异步操做，已经处于了下一个事件队列，咱们监听事件再慢也会比数据生产块，数据不会丢失。

看到这里，你们其实对 data事件、readable事件触发时机， read() 方法每次读多少数据，何时返回 null 还有又必定的疑问，由于到如今为止咱们接触到的仍然是一个黑盒，后面咱们介绍了可写流后会在 back pressure 机制部分对这些内部细节结合源码详细讲解，且听下回分解吧。