Bluebird NPM: promessa do Bluebird JS com exemplo

O que é Bluebird JS?

Bluebird JS é uma biblioteca de Promises completa para JavaScript. Sua principal característica é permitir que você "prometa" outros módulos do Node para usá-los de forma assíncrona. Promisificar é um conceito aplicado a funções de retorno de chamada (callbacks), garantindo que toda função de retorno de chamada executada retorne um valor.

Então, se um Node.js O módulo contém uma função de retorno de chamada que não retorna um valor, prometendo que o módulo modificará automaticamente todas as funções nele contidas para que cada uma retorne um valor.

Isso significa que você pode usar o Bluebird para fazer o MongoDB O módulo é executado de forma assíncrona, o que adiciona um nível extra de facilidade ao escrever aplicações Node.js.

O exemplo abaixo primeiro estabelece uma conexão com a coleção “Employee” no banco de dados “EmployeeDB”. Uma vez estabelecida a conexão, ele recupera todos os registros da coleção e os exibe no console.

Como gerar promessas com a biblioteca Bluebird JS

Aqui está um exemplo passo a passo mostrando como gerar promessas com a biblioteca Bluebird JS.

Passo 1) Instalando os módulos NPM

Para usar o Bluebird em uma aplicação Node, o módulo Bluebird é necessário. Instale-o com o comando abaixo:

npm install bluebird

Etapa 2) Inclua o módulo Bluebird

O próximo passo é incluir o módulo Bluebird no seu código e transformá-lo em uma promessa. MongoDB módulo. Promissor aqui significa que o Bluebird garante que cada método definido no MongoDB biblioteca retorna uma promessa.

Code Explicação:

1. O require O comando inclui a biblioteca Bluebird.
2. Pássaro Azul .promisifyAll() O método cria uma versão assíncrona de cada método. MongoDB O módulo fornece as informações necessárias, de forma que cada um seja executado em segundo plano e retorne uma promessa.

Etapa 3) Conecte-se ao banco de dados

A etapa final consiste em conectar-se ao banco de dados, recuperar todos os registros da coleção e exibi-los no log do console.

Code Explicação:

1. Observe a connectAsync O método é usado em vez do normal. connect método. Bluebird acrescenta o Assíncrono sufixo para cada método no MongoDB Biblioteca para distinguir as chamadas que retornam promessas daquelas que não retornam. Métodos sem o sufixo Async não possuem essa garantia.
2. Semelhante a connectAsync, findAsync O método retorna todos os registros em MongoDB Coleção “Funcionário”.
3. If findAsync Se a operação for resolvida com sucesso, o bloco seguinte itera por cada registro da coleção e o exibe no console.

Se os passos acima forem executados corretamente, todos os documentos da coleção Funcionário serão exibidos no console, conforme mostrado na saída abaixo.

Segue o código completo para referência:

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

⚠️ Observação sobre a versão do driver: O código acima tem como alvo MongoDB Driver Node 2.x, onde connect resolve com um objeto de banco de dados. Do driver 3.0 em diante resolve-se com um MongoClient, então a cadeia deve chamar client.db('EmployeeDB').collection('Employee') em vez de db.collection('Employee')As versões modernas dos drivers também já retornam promessas nativas, o que torna promisifyAll desnecessário para MongoDB especificamente.

Bluebird vs Native Promises: Qual usar?

Quando o Bluebird foi escrito pela primeira vez, o Node não tinha nenhum suporte a promises, então a biblioteca preencheu uma lacuna real na plataforma. O Node passou a oferecer promises nativas a partir da versão 4 e async/await Desde a versão 7.6, o cálculo muda consideravelmente para quem está começando um projeto hoje.

Escolha promises nativas para novos trabalhos, pois elas não precisam de dependências e se integram diretamente com async/await. Recorra ao Bluebird quando uma dependência ainda expõe apenas callbacks ou quando seus auxiliares de concorrência, como Promise.map Com um limite de concorrência, é possível economizar uma quantidade significativa de código.

Como lidar com erros com Promises do Bluebird

O exemplo acima não possui um caminho de falha. Se MongoDB Se a cadeia de promessas não estiver em execução ou o nome da coleção estiver incorreto, ela será rejeitada e nada será impresso — o processo simplesmente será encerrado sem nenhuma explicação. Toda cadeia de promessas precisa de um manipulador de término.

Suporte Bluebird .catch() para rejeições e .finally() para limpeza que deve ser executada de qualquer maneira. Também oferece suporte a blocos catch tipados, que lidam com uma classe de erro enquanto permitem que outras se propaguem.

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

Três hábitos são importantes aqui. Primeiro, o lugar .catch() no final, em vez de após cada etapa, porque um manipulador de terminal recebe rejeições de todos os elos precedentes na cadeia. Em segundo lugar, use .finally() para liberar recursos como uma conexão de banco de dados, já que é executado tanto no caminho de sucesso quanto no de falha. Terceiro, nunca deixe uma cadeia sem uma condição: uma rejeição não tratada encerra o processo do Node nas versões atuais, e o Bluebird exibirá um aviso explícito sobre isso antecipadamente. Habilitando pilha longa traces durante o desenvolvimento com Promise.config({ longStackTraces: true }) Isso facilita muito a localização da origem de uma rejeição.

Erros comuns do Bluebird Promisify e suas soluções

A maioria dos problemas do Bluebird decorre da convenção de nomenclatura baseada em promessas ou da mistura de estilos de chamada de callback e promessa na mesma cadeia, e não de qualquer falha na biblioteca em si. Cada sintoma abaixo indica sua causa e sua solução.

• “connectAsync não é uma função”: O módulo foi exigido diretamente em vez de por meio de promisifyAll()Portanto, não existem variantes assíncronas. Envolva a chamada require conforme mostrado acima.
• Chamando o método simples e obtendo undefined: connect() Ainda espera um retorno de chamada. Somente a cópia com o sufixo Async retorna uma promessa.
• Passando uma função de retorno de chamada para um método assíncrono: não fornecer nem um retorno de chamada nem await e a promessa se resolve sem ser observada. Use um estilo por chamada, não ambos.
• promisifyAll em uma biblioteca já baseada em promessas: Inofensivo, porém inútil, e gera nomes confusos com sufixos duplos. Consulte a documentação da biblioteca primeiro.
• Perder erros silenciosamente: uma corrente sem .catch() Oculta o motivo da rejeição até que o Node reporte uma rejeição não tratada e encerre a execução. Sempre finalize a cadeia com um bloco `catch`, mesmo em scripts curtos.

Perguntas Frequentes