Comprendre les flux lisibles dans NodeJS

Recommandations associées : "Tutoriel node js"

Qu'est-ce qu'un flux lisible

Un flux lisible est un flux qui produit des données pour la consommation du programme. Nos méthodes courantes de production de données incluent la lecture de fichiers disque, la lecture du contenu des requêtes réseau, etc. Jetez un œil à l'exemple précédent de ce qu'est un flux :

const rs = fs.createReadStream(filePath);

rs est un flux lisible, et sa méthode de production de données est lire Pour obtenir le fichier du disque, notre console commune process.stdin est également un flux lisible :

process.stdin.pipe(process.stdout);

Vous pouvez imprimer l'entrée de la console avec une simple phrase La façon dont process.stdin produit les données. est de lire l'entrée de l'utilisateur sur la console.

Retournez sur notre définition des flux lisibles : les flux lisibles sont des flux qui produisent des données destinées à la consommation du programme.

Flux lisible personnalisé

En plus du fs.CreateReadStream fourni par le système, nous utilisons aussi souvent la méthode src fournie par gulp ou vinyl-fs

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

Si nous voulons produire des données d'une manière spécifique et les transmettre au programme pour les consommer, par où commencer ?

Vous pouvez le faire en deux étapes simples

1. Héritez la classe Readable du module sream
2. Réécrivez le _read méthode et appelez this.push Mettez les données produites dans la file d'attente pour être lues

La classe Readable a déjà fait l'essentiel du travail pour le flux lisible, nous seulement besoin d'en hériter, puis un flux lisible personnalisé peut être implémenté en écrivant la méthode de production de données dans la méthode _read.

Si nous voulons implémenter un flux qui génère un nombre aléatoire toutes les 100 millisecondes (sans utilité)

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;

La partie héritage de classe du code est très simple, regardez principalement l'implémentation de la méthode _read, il y en a plusieurs. Il convient de noter que la classe

1. Readable a l'implémentation de la méthode _read par défaut, mais elle ne fait rien. Ce que nous faisons est de remplacer et de réécrire le
<.> Méthode _read qui a un paramètre size, utilisée pour spécifier la quantité de données qui doivent être lues et renvoyées à la méthode read, mais ce n'est qu'une donnée de référence. De nombreuses implémentations ignorent ce paramètre, et nous l'ignorons ici. en détail plus tard
2. Pousser vers le tampon via this.push Le concept de données et de tampon sera évoqué plus tard. Pour le moment, il est entendu qu'il est pressé dans la conduite d'eau et peut être consommé <.>
3. Le contenu de push ne peut être constitué que de chaînes ou de tampons, pas de nombres
4. La méthode push a l'encodage à deux paramètres suivant, utilisé pour spécifier l'encodage lorsque le premier paramètre est une chaîne
5. Exécutez-le pour voir l'effet

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

const rns = new RandomNumberStream();

rns.pipe(process.stdout);

De cette façon, vous pouvez voir que les nombres sont affichés en continu sur la console. Sur, nous avons implémenté un flux lisible qui génère des nombres aléatoires, et il y en a encore quelques petits problèmes à résoudre

Comment arrêter

Nous envoyons des données au tampon toutes les 100 millisecondes Pousser un numéro vers la zone, puis tout comme lire un local fichier, une fois terminé, comment l'arrêter et indiquer que les données ont été lues ?

Insérez simplement une valeur nulle dans le tampon. Modifions le code pour permettre aux consommateurs de définir combien de nombres aléatoires sont nécessaires :

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;

Nous utilisons un identifiant maximum pour permettre aux consommateurs de spécifier le nombre de caractères requis, qui peut être spécifié lors de l'instanciation

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

const rns = new RandomNumberStream(5);

rns.pipe(process.stdout);

De cette façon, vous pouvez voir que la console n'a imprimé que 5 caractères

Pourquoi setTimeout au lieu de setInterval

Les étudiants attentifs remarqueront peut-être que nous produisons un nombre aléatoire dans 100 milliseconds n'appelle pas setInterval, mais utilise setTimeout. Pourquoi est-il simplement retardé et non répété, mais le résultat est correct ?

Cela nécessite de comprendre les deux façons dont fonctionnent les flux

Mode fluide : les données sont lues par le système sous-jacent et fournies à l'application le plus rapidement possible

1. Pause mode : La méthode read() doit être appelée explicitement pour lire plusieurs blocs de données.
2. Le flux est en mode pause par défaut, ce qui signifie que le programme doit appeler explicitement la méthode read(). dans notre exemple, nous pouvons obtenir les données sans les appeler, car notre flux passe en mode flux via la méthode pipe(), donc notre méthode _read() sera automatiquement appelée à plusieurs reprises jusqu'à ce que les données soient lues, nous n'avons donc besoin que de données à lire une fois dans chaque méthode _read().

Basculage entre le mode débit et le mode pause

Le flux peut être basculé du mode pause par défaut au mode débit des manières suivantes :

Démarrez la surveillance des données en ajoutant un écouteur d'événements de données

1. Appelez la méthode curriculum vitae() pour démarrer le flux de données
2. Appelez la méthode pipe() pour transférer les données vers un autre flux inscriptible
3. Il existe deux manières de passer du mode débit au mode pause :

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 机制部分对这些内部细节结合源码详细讲解，且听下回分解吧。

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

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!