Node.js 8 中的 util.promisify的详解

让我来详细讲解“Node.js 8 中的 util.promisify的详解”。

1. 什么是util.promisify？

在 Node.js 8 版本中，引入了一个新的模块 util.promisify，它是一个实用工具，用于将一个返回值为 callback 的函数转换为 Promise 风格。使用 util.promisify，可以更轻松地将现有的回调函数 API 迁移到 Promise 风格，并在异步处理中得到更加简单、优雅的代码。

2. 如何使用util.promisify？

使用 util.promisify 可以将一个返回值为 callback 的函数转换为 Promise 风格。

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

// 以 fs.readFile 函数为例
const readFile = util.promisify(fs.readFile);

// 调用 readFile 函数
readFile('test.txt', 'utf8')
  .then(data => {
    console.log(data);
  })
  .catch(err => {
    console.log(err);
  });

从上面的例子中可以看出，使用 util.promisify 将 fs.readFile 函数转换为了 Promise 风格的函数，我们可以直接在 .then() 和 .catch() 中处理成功和失败的情况。

3. 实现原理

util.promisify 的实现原理是利用了 Node.js 中的 util.callbackify 和 Promise。在 util.promisify 的内部实现中，会先调用 util.callbackify 将原本的 callback 风格的函数转换为带有 Node.js 回调形式的函数，然后再将这个函数封装到一个 return Promise 的函数中返回，这个函数就是 Promise 风格的函数。

下面是 util.promisify 的源码：

const kCustomPromisifiedSymbol = typeof Symbol !== 'undefined' ? Symbol('util.promisify.custom') : undefined;

function isFunction(f) {
  return typeof f === 'function';
}

function isObject(o) {
  return o !== null && typeof o === 'object';
}

function promisify(original) {
  if (!isFunction(original)) {
    throw new TypeError('The "original" argument must be of type Function');
  }

  if (original[kCustomPromisifiedSymbol]) {
    const fn = original[kCustomPromisifiedSymbol];
    if (typeof fn !== 'function') {
      throw new TypeError('The [util.promisify.custom] property must be a function');
    }
    Object.defineProperty(fn, kCustomPromisifiedSymbol, {
      value: fn,
      enumerable: false,
      writable: false,
      configurable: true
    });
    return fn;
  }

  function fn(...args) {
    return new Promise((resolve, reject) => {
      function callback(err, ...values) {
        if (err) {
          return reject(err);
        }
        if (values.length === 1) {
          return resolve(values[0]);
        }
        return resolve(values);
      }
      original.call(this, ...args, callback);
    });
  }

  Object.setPrototypeOf(fn, Object.getPrototypeOf(original));

  Object.defineProperty(fn, kCustomPromisifiedSymbol, {
    value: fn,
    enumerable: false,
    writable: false,
    configurable: true
  });
  return Object.defineProperties(
    fn,
    Object.getOwnPropertyDescriptors(original)
  );
}

4. 示例说明

示例1：使用 util.promisify 重写一个基于 Node.js 回调的函数

// 假设我有一个返回值为 callback 的函数
function getUser(userId, callback) {
  // 这个回调函数有两个参数，第一个参数为错误信息，第二个参数为返回的用户信息
  // 返回的用户信息为一个对象，包含了用户ID和用户名称
  if (userId === '123') {
    callback(null, {id: '123', name: 'Tom'});
  } else {
    callback(new Error('User not found'));
  }
}

使用 util.promisify 将 getUser 函数转换为 Promise 风格的函数：

const util = require('util');

const promisifyGetUser = util.promisify(getUser);

// 调用 promisifyGetUser 函数，返回一个 Promise
promisifyGetUser('123')
  .then(user => {
    console.log(`User ID: ${user.id}, User Name: ${user.name}`);
  })
  .catch(err => {
    console.log(err);
  });

示例2：使用 util.promisify 重写一个基于第三方回调的函数

// 假设我有一个返回值为 callback 的第三方包的函数
const puppeteer = require('puppeteer');

function getPageTitle(url, callback) {
  puppeteer.launch().then(async browser => {
    const page = await browser.newPage();
    await page.goto(url);
    const title = await page.title();
    await browser.close();
    callback(null, title);
  }).catch(err => {
    callback(err);
  });
}

使用 util.promisify 将 getPageTitle 函数转换为 Promise 风格的函数：

const util = require('util');

const promisifyGetPageTitle = util.promisify(getPageTitle);

// 调用 promisifyGetPageTitle 函数，返回一个 Promise
promisifyGetPageTitle('https://www.baidu.com')
  .then(title => {
    console.log(title);
  })
  .catch(err => {
    console.log(err);
  });

总结

以上就是关于"Node.js 8 中的 util.promisify的详解"的完整攻略。总结一下，util.promisify 是实用的模块，可以将一个返回值为 callback 的函数转换为 Promise 风格，让异步处理更加简单、优雅。我们可以利用 util.promisify 重写基于 Node.js 回调的函数，也可以重写基于第三方回调的函数，使得这些函数能够更加方便地在异步处理中使用。