Bluebird NPM: Bluebird JS Promise med eksempel

Hvad er Bluebird JS?

Bluebird JS er et fuldt udstyret Promise-bibliotek til JavaScript. Dens stærkeste funktion er, at den giver dig mulighed for at "promisify" andre Node-moduler for at bruge dem asynkront. Promisify er et koncept, der anvendes på callback-funktioner, og det sikrer, at hver callback-funktion, der kaldes, returnerer en værdi.

Så hvis en node.js Modulet indeholder en callback-funktion, der ikke returnerer en værdi, og lover, at modulet automatisk ændrer alle funktionerne i det, så hver enkelt returnerer en værdi.

Det betyder, at du kan bruge Bluebird til at lave MongoDB modulet kører asynkront, hvilket gør det endnu nemmere at skrive Node.js-applikationer.

Eksemplet nedenfor opretter først en forbindelse til samlingen "Employee" i databasen "EmployeeDB". Når forbindelsen er etableret, hentes alle poster i samlingen og vises i konsollen.

Sådan genererer du løfter med Bluebird JS Library

Her er et trin-for-trin eksempel, der viser, hvordan man genererer promises med Bluebird JS-biblioteket.

Trin 1) Installation af NPM-modulerne

For at bruge Bluebird fra en Node-applikation kræves Bluebird-modulet. Installer det med kommandoen nedenfor:

npm install bluebird

Trin 2) Inkluder Bluebird-modulet

Det næste trin er at inkludere Bluebird-modulet i din kode og love hele MongoDB modul. At love her betyder, at Bluebird sikrer, at alle metoder defineret i MongoDB biblioteket giver et løfte.

Code Forklaring:

1. require Kommandoen inkluderer Bluebird-biblioteket.
2. Bluebird's .promisifyAll() Metoden opretter en asynkron version af hver metode MongoDB modulet leverer, så hver enkelt kører i baggrunden og returnerer et løfte.

Trin 3) Opret forbindelse til databasen

Det sidste trin er at oprette forbindelse til databasen, hente alle poster i samlingen og vise dem i konsolloggen.

Code Forklaring:

1. Læg mærke til connectAsync metoden anvendes i stedet for den normale connect metode. Bluebird tilføjer asynkron suffiks til hver metode i MongoDB biblioteket til at skelne mellem de kald, der returnerer løfter, og dem, der ikke gør. Metoder uden suffikset Async har ingen sådan garanti.
2. Svarende til connectAsync, findAsync Metoden returnerer alle poster i MongoDB "Medarbejder"-kollektionen.
3. If findAsync Hvis det løses korrekt, iterererer den følgende blok gennem hver post i samlingen og viser den i konsolloggen.

Hvis ovenstående trin udføres korrekt, vises alle dokumenterne i medarbejdersamlingen i konsollen, som vist i outputtet nedenfor.

Her er den komplette kode til reference:

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);
        });
    });

⚠️ Bemærkning om driverversion: koden ovenfor mål MongoDB Nodedriver 2.x, hvor connect løser med et databaseobjekt. Fra driver 3.0 og fremefter det løser sig med en MongoClient, så kæden skal ringe client.db('EmployeeDB').collection('Employee') i stedet for db.collection('Employee')Moderne driverversioner returnerer også allerede native løfter, hvilket gør promisifyAll unødvendig for MongoDB specifikt.

Bluebird vs. Native Promises: Hvilke skal man bruge

Da Bluebird først blev skrevet, havde Node slet ingen understøttelse af promises, så biblioteket udfyldte et reelt hul i platformen. Node har leveret native promises siden version 4 og async/await siden version 7.6, hvilket ændrer beregningen betydeligt for alle, der starter et projekt i dag.

Vælg native promises til nyt arbejde, da de ikke kræver nogen afhængighed og integrerer direkte med async await. Brug Bluebird, når en afhængighed stadig kun eksponerer callbacks, eller når dens samtidighedshjælpere, f.eks. Promise.map med en samtidighedsgrænse, spar en betydelig mængde kode.

Sådan håndterer du fejl med Bluebird Promises

Eksemplet ovenfor har ingen fejlsti. Hvis MongoDB kører ikke, eller samlingsnavnet er forkert, afviser kæden, og der udskrives intet — processen afsluttes simpelthen uden forklaring. Enhver løftekæde har brug for en terminalhandler.

Bluebird-støtter .catch() for afslag og .finally() til oprydning, der skal køre på begge måder. Den understøtter også typede fangster, som håndterer én fejlklasse, mens andre lader sprede sig.

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(); }
    });

Tre vaner er vigtige her. For det første, sted .catch() i slutningen snarere end efter hvert trin, fordi én terminalhandler modtager afvisninger fra alle foregående led i kæden. For det andet, brug .finally() til frigivelse af ressourcer såsom en databaseforbindelse, da den kører på både succes- og fiaskostierne. For det tredje, lad aldrig en kæde være uden en fangst: en ubehandlet afvisning afslutter Node-processen på aktuelle versioner, og Bluebird vil udskrive en eksplicit advarsel om det på forhånd. Aktivering af long stack traces under udvikling med Promise.config({ longStackTraces: true }) gør det langt nemmere at finde oprindelsen af ​​en afvisning.

Almindelige Bluebird Promisify-fejl og rettelser

De fleste Bluebird-problemer stammer fra den promisified-navngivningskonvention eller fra en blanding af callback- og promise-kaldsstile i samme kæde, snarere end fra en fejl i selve biblioteket. Hvert symptom nedenfor angiver sin årsag og sin løsning.

• "connectAsync er ikke en funktion": modulet var påkrævet direkte i stedet for via promisifyAll(), så der findes ingen async-varianter. Ombryd require-kaldet som vist ovenfor.
• Kalder plain-metoden og får udefineret: connect() forventer stadig et callback. Kun kopien med Async-suffikset returnerer et løfte.
• Videregivelse af et callback til en async-metode: hverken give et tilbagekald eller await og løftet opløses ubemærket. Brug én stil pr. kald, ikke begge.
• promisifyAll på et allerede løftebaseret bibliotek: harmløst, men meningsløst, og det producerer forvirrende navne med dobbelte suffikser. Tjek først bibliotekets dokumentation.
• Mister fejl lydløst: en kæde uden .catch() skjuler årsagen til afvisningen, indtil Node rapporterer en ubehandlet afvisning og afslutter. Afslut altid kæden med en catch, selv i korte scripts.

Ofte Stillede Spørgsmål