把 Node.js 中的回调转换为 Promise

介绍

在几年前，回调是 JavaScript 中实现执行异步代码的惟一方法。回调自己几乎没有什么问题，最值得注意的是“回调地狱”。

在 ES6 中引入了 Promise 做为这些问题的解决方案。最后经过引入 async/await 关键字来提供更好的体验并提升了可读性。

即便有了新的方法，可是仍然有许多使用回调的原生模块和库。在本文中，咱们将讨论如何将 JavaScript 回调转换为 Promise。 ES6 的知识将会派上用场，由于咱们将会使用 展开操做符之类的功能来简化要作的事情。

什么是回调

回调是一个函数参数，刚好是一个函数自己。虽然咱们能够建立任何函数来接受另外一个函数，但回调主要用于异步操做。

JavaScript 是一种解释性语言，一次只能处理一行代码。有些任务可能须要很长时间才能完成，例以下载或读取大文件等。 JavaScript 将这些运行时间很长的任务转移到浏览器或 Node.js 环境中的其余进程中。这样它就不会阻止其余代码的执行。

一般异步函数会接受回调函数，因此完成以后能够处理其数据。

举个例子，咱们将编写一个回调函数，这个函数会在程序成功从硬盘读取文件以后执行。

因此须要准备一个名为 sample.txt 的文本文件，其中包含如下内容：

Hello world from sample.txt

而后写一个简单的 Node.js 脚原本读取文件：

const fs = require('fs');

fs.readFile('./sample.txt', 'utf-8', (err, data) => {
    if (err) {
        // 处理错误
        console.error(err);
          return;
    }
    console.log(data);
});

for (let i = 0; i < 10; i++) {
    console.log(i);
}

运行代码后将会输出：

0
...
8
9
Hello world from sample.txt

若是这段代码，应该在执行回调以前看到 0..9 被输出到控制台。这是由于 JavaScript 的异步管理机制。在读取文件完毕以后，输出文件内容的回调才被调用。

顺便说明一下，回调也能够在同步方法中使用。例如 Array.sort() 会接受一个回调函数，这个函数容许你自定义元素的排序方式。

接受回调的函数被称为“高阶函数”。

如今咱们有了一个更好的回调方法。那么们继续看看什么是 Promise。

什么是 Promise

在 ECMAScript 2015（ES6）中引入了 Promise，用来改善在异步编程方面的体验。顾名思义，JavaScript 对象最终将返回的“值”或“错误”应该是一个 Promise。

一个 Promise 有 3 个状态：

• Pending（待处理）： 用来指示异步操做还没有完成的初始状态。
• Fulfilled（已完成）：表示异步操做已成功完成。
• Rejected（拒绝）：表示异步操做失败。

大多数 Promise 最终看起来像这样：

someAsynchronousFunction()
    .then(data => {
        // promise 被完成
        console.log(data);
    })
    .catch(err => {
        // promise 被拒绝
        console.error(err);
    });

Promise 在现代 JavaScript 中很是重要，由于它们与 ECMAScript 2016 中引入的 async/await 关键字一块儿使用。使用 async / await 就不须要再用回调或 then() 和 catch() 来编写异步代码。

若是要改写前面的例子，应该是这样：

try {
    const data = await someAsynchronousFunction();
} catch(err) {
    // promise 被拒绝
    console.error(err);
}

这看起来很像“通常的”同步 JavaScript。大多数流行的JavaScript库和新项目都把 Promises 与 async/await 关键字放在一块儿用。

可是，若是你要更新现有的库或遇到旧的代码，则可能会对将基于回调的 API 迁移到基于 Promise 的 API 感兴趣，这样能够改善你的开发体验。

来看一下将回调转换为 Promise 的几种方法。

将回调转换为 Promise

Node.js Promise

大多数在 Node.js 中接受回调的异步函数（例如 fs 模块）有标准的实现方式：把回调做为最后一个参数传递。

例如这是在不指定文本编码的状况下用 fs.readFile() 读取文件的方法：

fs.readFile('./sample.txt', (err, data) => {
    if (err) {
        console.error(err);
          return;
    }
    console.log(data);
});

注意：若是你指定 utf-8 做为编码，那么获得的输出是一个字符串。若是不指定获得的输出是 Buffer。

另外传给这个函数的回调应接受 Error，由于它是第一个参数。以后能够有任意数量的输出。

若是你须要转换为 Promise 的函数遵循这些规则，那么能够用 util.promisify ，这是一个原生 Node.js 模块，其中包含对 Promise 的回调。

首先导入ʻutil`模块：

const util = require('util');

而后用 promisify 方法将其转换为 Promise：

const fs = require('fs');
const readFile = util.promisify(fs.readFile);

如今，把新建立的函数用做 promise：

readFile('./sample.txt', 'utf-8')
    .then(data => {
        console.log(data);
    })
    .catch(err => {
        console.log(err);
    });

另外也能够用下面这个示例中给出的 async/await 关键字：

const fs = require('fs');
const util = require('util');

const readFile = util.promisify(fs.readFile);

(async () => {
    try {
        const content = await readFile('./sample.txt', 'utf-8');
        console.log(content);
    } catch (err) {
        console.error(err);
    }
})();

你只能在用 async 建立的函数中使用 await 关键字，这也是为何要使用函数包装器的缘由。函数包装器也被称为当即调用的函数表达式。

若是你的回调不遵循这个特定标准也不用担忧。 util.promisify() 函数可以让你自定义转换是如何发生的。

注意： Promise 在被引入后不久就开始流行了。 Node.js 已经将大部分核心函数从回调转换成了基于 Promise 的API。

若是须要用 Promise 处理文件，能够用 Node.js 附带的库（https://nodejs.org/docs/lates...）。

如今你已经了解了如何将 Node.js 标准样式回调隐含到 Promise 中。从 Node.js 8 开始，这个模块仅在 Node.js 上可用。若是你用的是浏览器或早期版本版本的 Node，则最好建立本身的基于 Promise 的函数版本。

建立你本身的 Promise

让咱们讨论一下怎样把回调转为 util.promisify() 函数的 promise。

思路是建立一个新的包含回调函数的 Promise 对象。若是回调函数返回错误，就拒绝带有该错误的Promise。若是回调函数返回非错误输出，就解决并输出 Promise。

先把回调转换为一个接受固定参数的函数的 promise 开始：

const fs = require('fs');

const readFile = (fileName, encoding) => {
    return new Promise((resolve, reject) => {
        fs.readFile(fileName, encoding, (err, data) => {
            if (err) {
                return reject(err);
            }

            resolve(data);
        });
    });
}

readFile('./sample.txt')
    .then(data => {
        console.log(data);
    })
    .catch(err => {
        console.log(err);
    });

新函数 readFile() 接受了用来读取 fs.readFile() 文件的两个参数。而后建立一个新的 Promise 对象，该对象包装了该函数，并接受回调，在本例中为 fs.readFile()。

要 reject Promise 而不是返回错误。因此代码中没有当即把数据输出，而是先 resolve 了Promise。而后像之前同样使用基于 Promise 的 readFile() 函数。

接下来看看接受动态数量参数的函数：

const getMaxCustom = (callback, ...args) => {
    let max = -Infinity;

    for (let i of args) {
        if (i > max) {
            max = i;
        }
    }

    callback(max);
}

getMaxCustom((max) => { console.log('Max is ' + max) }, 10, 2, 23, 1, 111, 20);

第一个参数是 callback 参数，这使它在接受回调的函数中有点不同凡响。

转换为 promise 的方式和上一个例子同样。建立一个新的 Promise 对象，这个对象包装使用回调的函数。若是遇到错误，就 reject，当结果出现时将会 resolve。

咱们的 promise 版本以下：

const getMaxPromise = (...args) => {
    return new Promise((resolve) => {
        getMaxCustom((max) => {
            resolve(max);
        }, ...args);
    });
}

getMaxCustom(10, 2, 23, 1, 111, 20)
    .then(max => console.log(max));

在建立 promise 时，无论函数是以非标准方式仍是带有许多参数使用回调都可有可无。咱们能够彻底控制它的完成方式，而且原理是同样的。

总结

尽管如今回调已成为 JavaScript 中利用异步代码的默认方法，但 Promise 是一种更现代的方法，它更容易使用。若是遇到了使用回调的代码库，那么如今就能够把它转换为 Promise。

在本文中，咱们首先学到了如何 在Node.js 中使用 utils.promisfy() 方法将接受回调的函数转换为 Promise。而后，了解了如何建立本身的 Promise 对象，并在对象中包装了无需使用外部库便可接受回调的函数。这样许多旧 JavaScript 代码能够轻松地与现代的代码库和混合在一块儿。

---

本文首发微信公众号：前端先锋

欢迎扫描二维码关注公众号，天天都给你推送新鲜的前端技术文章

欢迎继续阅读本专栏其它高赞文章：

• 深刻理解Shadow DOM v1
• 一步步教你用 WebVR 实现虚拟现实游戏
• 13个帮你提升开发效率的现代CSS框架
• 快速上手BootstrapVue
• JavaScript引擎是如何工做的？从调用栈到Promise你须要知道的一切
• WebSocket实战：在 Node 和 React 之间进行实时通讯
• 关于 Git 的 20 个面试题
• 深刻解析 Node.js 的 console.log
• Node.js 到底是什么？
• 30分钟用Node.js构建一个API服务器
• Javascript的对象拷贝
• 程序员30岁前月薪达不到30K，该何去何从
• 14个最好的 JavaScript 数据可视化库
• 8 个给前端的顶级 VS Code 扩展插件
• Node.js 多线程彻底指南
• 把HTML转成PDF的4个方案及实现

---

• 更多文章...