การแทนที่การโทรกลับด้วยคำสัญญาใน Node.js

ฉันมีโมดูลโหนดอย่างง่ายที่เชื่อมต่อกับฐานข้อมูลและมีฟังก์ชันต่างๆในการรับข้อมูลตัวอย่างเช่นฟังก์ชันนี้:

dbConnection.js:

import mysql from 'mysql';

const connection = mysql.createConnection({
  host: 'localhost',
  user: 'user',
  password: 'password',
  database: 'db'
});

export default {
  getUsers(callback) {
    connection.connect(() => {
      connection.query('SELECT * FROM Users', (err, result) => {
        if (!err){
          callback(result);
        }
      });
    });
  }
};

โมดูลจะถูกเรียกด้วยวิธีนี้จากโมดูลโหนดอื่น:

app.js:

import dbCon from './dbConnection.js';

dbCon.getUsers(console.log);

ฉันต้องการใช้สัญญาแทนการโทรกลับเพื่อส่งคืนข้อมูล จนถึงตอนนี้ฉันได้อ่านเกี่ยวกับคำสัญญาที่ซ้อนกันในหัวข้อต่อไปนี้: การเขียน Clean Code ด้วย Nested Promisesแต่ฉันไม่พบวิธีแก้ปัญหาใด ๆ ที่ง่ายพอสำหรับกรณีการใช้งานนี้ อะไรคือวิธีที่ถูกต้องในการกลับมาresultโดยใช้คำสัญญา?

การใช้Promiseคลาส

ฉันขอแนะนำให้ดูเอกสาร Promise ของ MDNซึ่งเป็นจุดเริ่มต้นที่ดีในการใช้Promise หรือฉันแน่ใจว่ามีบทเรียนออนไลน์มากมาย :)

บันทึก:เบราว์เซอร์สมัยใหม่รองรับข้อกำหนด ECMAScript 6 ของ Promises อยู่แล้ว (ดูเอกสาร MDN ที่ลิงก์ด้านบน) และฉันคิดว่าคุณต้องการใช้การใช้งานแบบเนทีฟโดยไม่มีไลบรารีของบุคคลที่สาม

สำหรับตัวอย่างจริง ...

หลักการพื้นฐานทำงานดังนี้:

1. API ของคุณเรียกว่า
2. คุณสร้างวัตถุ Promise ใหม่วัตถุนี้รับฟังก์ชันเดียวเป็นพารามิเตอร์ตัวสร้าง
3. ฟังก์ชันที่คุณให้มาถูกเรียกใช้โดยการนำไปใช้งานและฟังก์ชันจะได้รับสองฟังก์ชัน - resolveและreject
4. เมื่อคุณทำตามตรรกะของคุณคุณจะเรียกหนึ่งในสิ่งเหล่านี้เพื่อเติมเต็มสัญญาหรือปฏิเสธด้วยข้อผิดพลาด

สิ่งนี้อาจดูเหมือนมากดังนั้นนี่คือตัวอย่างจริง

exports.getUsers = function getUsers () {
  // Return the Promise right away, unless you really need to
  // do something before you create a new Promise, but usually
  // this can go into the function below
  return new Promise((resolve, reject) => {
    // reject and resolve are functions provided by the Promise
    // implementation. Call only one of them.

    // Do your logic here - you can do WTF you want.:)
    connection.query('SELECT * FROM Users', (err, result) => {
      // PS. Fail fast! Handle errors first, then move to the
      // important stuff (that's a good practice at least)
      if (err) {
        // Reject the Promise with an error
        return reject(err)
      }

      // Resolve (or fulfill) the promise with data
      return resolve(result)
    })
  })
}

// Usage:
exports.getUsers()  // Returns a Promise!
  .then(users => {
    // Do stuff with users
  })
  .catch(err => {
    // handle errors
  })

การใช้คุณลักษณะภาษา async / await (Node.js> = 7.6)

ใน Node.js 7.6 คอมไพเลอร์ JavaScript v8 ได้รับการอัพเกรดด้วยasync สนับสนุน ตอนนี้คุณสามารถประกาศฟังก์ชันว่าเป็นอยู่ได้asyncแล้วซึ่งหมายความว่าฟังก์ชันเหล่านี้จะส่งคืนค่าPromiseที่ได้รับการแก้ไขโดยอัตโนมัติเมื่อฟังก์ชัน async ดำเนินการเสร็จสิ้น ภายในฟังก์ชันนี้คุณสามารถใช้awaitคีย์เวิร์ดเพื่อรอจนกว่าสัญญาอื่นจะแก้ไข

นี่คือตัวอย่าง:

exports.getUsers = async function getUsers() {
  // We are in an async function - this will return Promise
  // no matter what.

  // We can interact with other functions which return a
  // Promise very easily:
  const result = await connection.query('select * from users')

  // Interacting with callback-based APIs is a bit more
  // complicated but still very easy:
  const result2 = await new Promise((resolve, reject) => {
    connection.query('select * from users', (err, res) => {
      return void err ? reject(err) : resolve(res)
    })
  })
  // Returning a value will cause the promise to be resolved
  // with that value
  return result
}

ด้วยbluebirdคุณสามารถใช้Promise.promisifyAll(และPromise.promisify) เพื่อเพิ่ม Promise ready method ให้กับวัตถุใด ๆ

var Promise = require('bluebird');
// Somewhere around here, the following line is called
Promise.promisifyAll(connection);

exports.getUsersAsync = function () {
    return connection.connectAsync()
        .then(function () {
            return connection.queryAsync('SELECT * FROM Users')
        });
};

และใช้สิ่งนี้:

getUsersAsync().then(console.log);

หรือ

// Spread because MySQL queries actually return two resulting arguments, 
// which Bluebird resolves as an array.
getUsersAsync().spread(function(rows, fields) {
    // Do whatever you want with either rows or fields.
});

การเพิ่มเครื่องกำจัด

ครามสนับสนุนจำนวนมากของคุณสมบัติหนึ่งของพวกเขาคือ disposers จะช่วยให้คุณได้อย่างปลอดภัยทิ้งของการเชื่อมต่อหลังจากที่มันจบลงด้วยความช่วยเหลือของและPromise.using Promise.prototype.disposerนี่คือตัวอย่างจากแอปของฉัน:

function getConnection(host, user, password, port) {
    // connection was already promisified at this point

    // The object literal syntax is ES6, it's the equivalent of
    // {host: host, user: user, ... }
    var connection = mysql.createConnection({host, user, password, port});
    return connection.connectAsync()
        // connect callback doesn't have arguments. return connection.
        .return(connection) 
        .disposer(function(connection, promise) { 
            //Disposer is used when Promise.using is finished.
            connection.end();
        });
}

จากนั้นใช้ดังนี้:

exports.getUsersAsync = function () {
    return Promise.using(getConnection()).then(function (connection) {
            return connection.queryAsync('SELECT * FROM Users')
        });
};

การดำเนินการนี้จะยุติการเชื่อมต่อโดยอัตโนมัติเมื่อคำสัญญาได้รับการแก้ไขด้วยค่า (หรือปฏิเสธด้วยError)

Node.js เวอร์ชัน 8.0.0+:

คุณไม่จำเป็นต้องใช้bluebirdเพื่อรับประกันวิธีการโหนด API อีกต่อไป เนื่องจากตั้งแต่เวอร์ชัน 8+ คุณสามารถใช้util.promisifyดั้งเดิมได้:

const util = require('util');

const connectAsync = util.promisify(connection.connectAsync);
const queryAsync = util.promisify(connection.queryAsync);

exports.getUsersAsync = function () {
    return connectAsync()
        .then(function () {
            return queryAsync('SELECT * FROM Users')
        });
};

ตอนนี้ไม่ต้องใช้ lib ของบุคคลที่สามเพื่อทำสัญญา

สมมติว่า API อะแดปเตอร์ฐานข้อมูลของคุณไม่ได้ส่งออกPromisesเองคุณสามารถทำสิ่งต่อไปนี้:

exports.getUsers = function () {
    var promise;
    promise = new Promise();
    connection.connect(function () {
        connection.query('SELECT * FROM Users', function (err, result) {
            if(!err){
                promise.resolve(result);
            } else {
                promise.reject(err);
            }
        });
    });
    return promise.promise();
};

หาก API ฐานข้อมูลรองรับPromisesคุณสามารถทำสิ่งต่างๆเช่น: (ที่นี่คุณจะเห็นพลังของคำสัญญาการเรียกกลับของคุณจะหายไปค่อนข้างมาก)

exports.getUsers = function () {
    return connection.connect().then(function () {
        return connection.query('SELECT * FROM Users');
    });
};

ใช้.then()เพื่อส่งคืนสัญญาใหม่ (ซ้อนกัน)

โทรด้วย:

module.getUsers().done(function (result) { /* your code here */ });

ฉันใช้ mockup API สำหรับสัญญาของฉัน API ของคุณอาจแตกต่างออกไป หากคุณแสดง API ของคุณฉันสามารถปรับแต่งได้

2019:

ใช้โมดูลเนทีฟนั้นconst {promisify} = require('util');เพื่อแปลงรูปแบบการโทรกลับแบบเก่าธรรมดาเพื่อให้สัญญากับรูปแบบเพื่อให้คุณได้รับ Benfit จากasync/awaitโค้ด

const {promisify} = require('util');
const glob = promisify(require('glob'));

app.get('/', async function (req, res) {
    const files = await glob('src/**/*-spec.js');
    res.render('mocha-template-test', {files});
});

เมื่อตั้งค่าสัญญาว่าคุณจะใช้เวลาสองพารามิเตอร์และresolve rejectในกรณีของความสำเร็จให้โทรresolveด้วยผลลัพธ์ในกรณีของการเรียกล้มเหลวrejectด้วยข้อผิดพลาด

จากนั้นคุณสามารถเขียน:

getUsers().then(callback)

callbackจะถูกเรียกด้วยผลของคำสัญญาที่ส่งกลับมาgetUsersคือresult

การใช้ไลบรารี Q เช่น:

function getUsers(param){
    var d = Q.defer();

    connection.connect(function () {
    connection.query('SELECT * FROM Users', function (err, result) {
        if(!err){
            d.resolve(result);
        }
    });
    });
    return d.promise;   
}

โค้ดด้านล่างใช้ได้กับโหนด -v> 8.x เท่านั้น

ฉันใช้มิดเดิลแวร์ MySQL Promisified สำหรับ Node.js

อ่านบทความนี้สร้าง MySQL Database Middleware ด้วย Node.js 8 และ Async / Await

database.js

var mysql = require('mysql'); 

// node -v must > 8.x 
var util = require('util');


//  !!!!! for node version < 8.x only  !!!!!
// npm install util.promisify
//require('util.promisify').shim();
// -v < 8.x  has problem with async await so upgrade -v to v9.6.1 for this to work. 



// connection pool https://github.com/mysqljs/mysql   [1]
var pool = mysql.createPool({
  connectionLimit : process.env.mysql_connection_pool_Limit, // default:10
  host     : process.env.mysql_host,
  user     : process.env.mysql_user,
  password : process.env.mysql_password,
  database : process.env.mysql_database
})


// Ping database to check for common exception errors.
pool.getConnection((err, connection) => {
if (err) {
    if (err.code === 'PROTOCOL_CONNECTION_LOST') {
        console.error('Database connection was closed.')
    }
    if (err.code === 'ER_CON_COUNT_ERROR') {
        console.error('Database has too many connections.')
    }
    if (err.code === 'ECONNREFUSED') {
        console.error('Database connection was refused.')
    }
}

if (connection) connection.release()

 return
 })

// Promisify for Node.js async/await.
 pool.query = util.promisify(pool.query)



 module.exports = pool

คุณต้องอัพเกรดโหนด -v> 8.x

คุณต้องใช้ฟังก์ชัน async เพื่อให้สามารถใช้ await ได้

ตัวอย่าง:

   var pool = require('./database')

  // node -v must > 8.x, --> async / await  
  router.get('/:template', async function(req, res, next) 
  {
      ...
    try {
         var _sql_rest_url = 'SELECT * FROM arcgis_viewer.rest_url WHERE id='+ _url_id;
         var rows = await pool.query(_sql_rest_url)

         _url  = rows[0].rest_url // first record, property name is 'rest_url'
         if (_center_lat   == null) {_center_lat = rows[0].center_lat  }
         if (_center_long  == null) {_center_long= rows[0].center_long }
         if (_center_zoom  == null) {_center_zoom= rows[0].center_zoom }          
         _place = rows[0].place


       } catch(err) {
                        throw new Error(err)
       }