Bluebird NPM : promesse Bluebird JS avec exemple

Qu’est-ce que Bluebird JS ?

Bluebird JS est une bibliothèque de promesses complète pour JavaCe script a pour principal atout la possibilité de « promisifier » d'autres modules Node afin de les utiliser de manière asynchrone. La promesse est un concept appliqué aux fonctions de rappel, garantissant que chaque fonction de rappel appelée renvoie une valeur.

Donc si un Node.js Le module contient une fonction de rappel qui ne renvoie pas de valeur, ce qui implique que le module modifie automatiquement toutes ses fonctions afin que chacune renvoie une valeur.

Cela signifie que vous pouvez utiliser Bluebird pour fabriquer le MongoDB Le module s'exécute de manière asynchrone, ce qui simplifie encore davantage le développement d'applications Node.js.

L'exemple ci-dessous établit d'abord une connexion à la collection « Employee » de la base de données « EmployeeDB ». Une fois la connexion établie, il récupère tous les enregistrements de la collection et les affiche dans la console.

Comment générer des promesses avec la bibliothèque Bluebird JS

Voici un exemple étape par étape montrant comment générer des promesses avec la bibliothèque JS Bluebird.

Étape 1) Installation des modules NPM

Pour utiliser Bluebird dans une application Node, le module Bluebird est requis. Installez-le avec la commande ci-dessous :

npm install bluebird

Étape 2) Inclure le module Bluebird

L'étape suivante consiste à inclure le module Bluebird dans votre code et à convertir l'ensemble en promesse. MongoDB module. Promettre ici signifie que Bluebird garantit que chaque méthode définie dans le module MongoDB la bibliothèque renvoie une promesse.

Code Explication:

1. Le require Cette commande inclut la bibliothèque Bluebird.
2. Le merlebleu .promisifyAll() Cette méthode crée une version asynchrone de chaque méthode. MongoDB Ce module fournit des fonctions qui s'exécutent en arrière-plan et renvoient une promesse.

Étape 3) Se connecter à la base de données

La dernière étape consiste à se connecter à la base de données, à récupérer tous les enregistrements de la collection et à les afficher dans la console.

Code Explication:

1. Notez le connectAsync La méthode est utilisée à la place de la méthode normale connect méthode. Bluebird ajoute le Async suffixe à chaque méthode dans le MongoDB Cette bibliothèque permet de distinguer les appels qui renvoient des promesses de ceux qui n'en renvoient pas. Les méthodes sans le suffixe Async n'offrent aucune garantie de ce type.
2. Similaire à connectAsync, le findAsync la méthode renvoie tous les enregistrements dans le MongoDB Collection « Employé ».
3. If findAsync Une fois la résolution réussie, le bloc suivant parcourt chaque enregistrement de la collection et l'affiche dans la console.

Si les étapes ci-dessus sont correctement effectuées, tous les documents de la collection Employé s'affichent dans la console, comme indiqué dans le résultat ci-dessous.

Voici le code complet pour référence :

var Promise = require('bluebird');

// promisifyAll adds an Async variant of every MongoDB method
var mongoClient = Promise.promisifyAll(require('mongodb')).MongoClient;

mongoClient.connectAsync('mongodb://localhost/EmployeeDB')

    .then(function(db) {
        return db.collection('Employee').findAsync({});
    })
    .then(function(cursor) {
        cursor.each(function(err, doc) {
            console.log(doc);
        });
    });

⚠️ Note concernant la version du pilote : Le code ci-dessus cible MongoDB Pilote Node 2.x, où connect se résout avec un objet de base de données. À partir du pilote 3.0 à partir de maintenant il se résout avec un MongoClient, la chaîne doit donc appeler client.db('EmployeeDB').collection('Employee') au lieu de db.collection('Employee')Les versions modernes des pilotes renvoient déjà des promesses natives, ce qui rend promisifyAll inutile pour MongoDB Plus précisément.

Bluebird ou Native Promises : lequel utiliser ?

Lors de sa première conception, Bluebird ne prenait pas en charge les promesses dans Node.js ; la bibliothèque comblait donc une véritable lacune de la plateforme. Node.js intègre les promesses natives depuis la version 4. async/await Depuis la version 7.6, ce qui modifie considérablement le calcul pour toute personne démarrant un projet aujourd'hui.

Pour les nouveaux développements, privilégiez les promesses natives, car elles ne nécessitent aucune dépendance et s'intègrent directement avec `async/await`. Utilisez Bluebird lorsqu'une dépendance n'expose que des fonctions de rappel, ou lorsque ses outils de gestion de la concurrence, tels que… Promise.map Avec une limite de concurrence, économisez une quantité significative de code.

Comment gérer les erreurs avec les promesses Bluebird

L'exemple ci-dessus ne comporte aucun chemin d'échec. Si MongoDB Si la chaîne de promesses ne s'exécute pas ou si le nom de la collection est incorrect, elle est rejetée et aucun affichage n'est effectué : le processus se termine simplement sans explication. Chaque chaîne de promesses nécessite un gestionnaire de fin de chaîne.

Bluebird soutient .catch() pour les rejets et .finally() pour le nettoyage qui doit être exécuté dans tous les cas. Il prend également en charge les blocs catch typés, qui gèrent une classe d'erreurs tout en laissant les autres se propager.

var Promise = require('bluebird');
var mongoClient = Promise.promisifyAll(require('mongodb')).MongoClient;

var connection;

mongoClient.connectAsync('mongodb://localhost/EmployeeDB')
    .then(function(db) {
        connection = db;
        return db.collection('Employee').findAsync({});
    })
    .then(function(cursor) {
        return cursor.toArrayAsync();
    })
    .then(function(docs) {
        docs.forEach(function(doc) { console.log(doc); });
    })
    .catch(Promise.TimeoutError, function(err) {
        console.error('The database did not respond in time.');
    })
    .catch(function(err) {
        // Any other rejection from any step above arrives here
        console.error('Query failed:', err.message);
    })
    .finally(function() {
        // Runs on success and on failure, so the socket always closes
        if (connection) { connection.close(); }
    });

Trois habitudes sont importantes ici. Premièrement, la place .catch() à la fin plutôt qu'après chaque étape, car un gestionnaire de terminal reçoit les rejets de chaque maillon précédent de la chaîne. Deuxièmement, utilisez .finally() Pour la libération de ressources telles qu'une connexion à une base de données, car cette opération s'exécute aussi bien en cas de succès qu'en cas d'échec. Troisièmement, il ne faut jamais laisser une chaîne sans gestion de rejet : un rejet non géré met fin au processus Node sur les versions actuelles, et Bluebird affichera un avertissement explicite au préalable. Activation de la pile longue traces pendant le développement avec Promise.config({ longStackTraces: true }) facilite grandement la localisation de l'origine d'un rejet.

Erreurs et correctifs de Common Bluebird Promisify

La plupart des problèmes rencontrés avec Bluebird proviennent de la convention de nommage basée sur les promesses, ou du mélange des styles d'appel de callback et de promesse dans une même chaîne, plutôt que d'un défaut de la bibliothèque elle-même. Chaque symptôme ci-dessous indique sa cause et sa solution.

• « connectAsync n’est pas une fonction » : Le module était requis directement et non par le biais de promisifyAll()Il n'existe donc pas de variantes asynchrones. Encapsulez l'appel require comme indiqué ci-dessus.
• Appel de la méthode simple et obtention de la valeur indéfinie : connect() Attend toujours un rappel. Seule la copie avec le suffixe Async renvoie une promesse.
• Passer une fonction de rappel à une méthode asynchrone : ne fournir ni rappel ni await et la promesse est résolue sans observation. Utilisez un style par appel, pas les deux.
• promisifyAll sur une bibliothèque déjà basée sur les promesses : Sans danger mais inutile, cela produit des noms à double suffixe sources de confusion. Consultez d'abord la documentation de la bibliothèque.
• Erreurs de perte silencieuses : une chaîne sans .catch() Masque la raison du rejet jusqu'à ce que Node signale un rejet non géré et s'arrête. Terminez toujours la chaîne par un bloc catch, même dans les scripts courts.

FAQ