NodeJS の読み取り可能なストリームを理解する

#関連する推奨事項: 「

node js チュートリアル #」

可読ストリームとは

読み取り可能なストリームとは、プログラムで使用するために

がデータ を生成するストリームです。一般的なデータ生成方法には、ディスク ファイルの読み取り、ネットワーク リクエスト コンテンツの読み取りなどが含まれます。ストリームとは何かについての前の例を見てください。

const rs = fs.createReadStream(filePath);

rs は読み取り可能なストリームであり、そのデータ生成方法は次のとおりです。ディスクからファイルを取得するには、共通コンソールの process.stdin も読み取り可能なストリームです:

process.stdin.pipe(process.stdout);

簡単な文でコンソールの入力を出力できます。 process.stdin がデータを生成する方法コンソール上のユーザー入力を読み取ることです。

読み取り可能なストリームの定義を振り返ってください。読み取り可能なストリームとは、プログラムで使用するデータを生成するストリームです。

カスタム読み取り可能なストリーム

システムによって提供される

fs.CreateReadStream に加えて、gulp またはビニールによって提供される src もよく使用します。 -fs Method

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

特定の方法でデータを生成し、それをプログラムで使用できるようにしたい場合、どのように始めればよいでしょうか?

これは 2 つの簡単な手順で実行できます。

ストリーム モジュールの
1. 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;

コードのクラス継承部分は非常に単純です。主に次の実装を見てください。注目すべき点

Readable クラスにはデフォルトで _read メソッドが実装されていますが、何も行われません。パラメータ サイズを持つ

_read メソッド。読み取って read メソッドに返すデータ量を指定するために使用されますが、これは単なる参照データです。多くの実装ではこのパラメータが無視されます。ここでも無視します。詳しくは後述します
1. this.pushでバッファにプッシュします データとバッファの概念は後述しますが、とりあえず水道管に押し込められて消費できることが分かります。
2. プッシュのコンテンツは文字列またはバッファのみであり、数値は使用できません。
3. プッシュ メソッドには次の 2 つのパラメーター エンコーディングがあり、最初のパラメーターが文字列の場合にエンコーディングを指定するために使用されます。
4. 実行して効果を確認してください

5. const RandomNumberStream = require('./RandomNumberStream');
   
   const rns = new RandomNumberStream();
   
   rns.pipe(process.stdout);

このようにして、コンソールに数値が継続的に表示されていることがわかります。On では、乱数を生成する読み取り可能なストリームを実装しました。まだ解決すべき小さな問題がいくつかあります

停止方法

データを 100 ミリ秒ごとにバッファに送信します。数値を領域にプッシュすると、その後は、データを読み取るのと同じようになります。ローカルファイルの終了時に、データが読み取られたことを示すために停止するにはどうすればよいですか? 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;

最大識別子を使用して、コンシューマーが必要な文字数を指定できるようにします。これはインスタンス化中に指定できます

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

const rns = new RandomNumberStream(5);

rns.pipe(process.stdout);

こうすることで、コンソールに 5 文字しか出力されないことがわかります

setInterval ではなく setTimeout を使用する理由

慎重な生徒は、100 単位の乱数を生成していることに気づくかもしれません。 milliseconds は setInterval を呼び出さず、setTimeout を使用します。結果は正しいのに、遅延するだけで繰り返されないのはなぜですか? #これには、ストリームが機能する 2 つの方法を理解する必要があります

#フロー モード: データは基盤となるシステムによって読み取られ、できるだけ早くアプリケーションに提供されます

一時停止モード: 複数のデータ ブロックを読み取るには、read() メソッドを明示的に呼び出す必要があります

ストリームはデフォルトで一時停止モードになっており、プログラムは明示的に read() メソッドを呼び出す必要があります。ただし、この例では、ストリームが Pipe() メソッドを通じてフロー モードに切り替えられるため、データを呼び出すことなくデータを取得できます。そのため、データが読み取られるまで _read() メソッドが自動的に繰り返し呼び出されます。各 _read() メソッドで 1 回読み取るだけで済みます。
2. フロー モードと一時停止モードの切り替え

フローは、次の方法でデフォルトの一時停止モードからフロー モードに切り替えることができます。

データ イベント リスナーを追加してデータ監視を開始します。

resume() メソッドを呼び出してデータ フローを開始します。

pipe() メソッドを呼び出して、別の書き込み可能なストリームにデータを転送します

1. フロー モードから一時停止モードに切り替えるには 2 つの方法があります:
2. 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 机制部分对这些内部细节结合源码详细讲解，且听下回分解吧。

   更多编程相关知识，请访问：编程入门！！

以上がNodeJS の読み取り可能なストリームを理解するの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。