基本使用

将 callback 转为 promise 对象，首先要确保这个 callback 为一个错误优先的回调函数，即 (err, value) => ... err 指定一个错误参数，value 为返回值。

  1. const { promisify } = require('util');
  2. const readFilePromisify = util.promisify(fs.readFile); // 转化为 promise
  4. readFilePromisify('text.txt', 'utf8')
  5.   .then(result => console.log(result)) // Nodejs Callback 转 Promise 对象测试
  6.   .catch(err => console.log(err));

util.promisify.custom 基本使用

  1. const util = require('util');
  3. function doSomething(foo, callback) {
  4.   // ...
  5. }
  7. // 利用 util.promisify.custom 这个 key 自定义 promisify 行为
  8. doSomething[util.promisify.custom] = (foo) => {
  9.   return getPromiseSomehow();
  10. };
  12. // 调用 util.promisify 方法
  13. const promisified = util.promisify(doSomething);
  15. // 返回的 promisified 就是刚才自定义的 doSomething[util.promisify.custom] 函数
  16. console.log(promisified === doSomething[util.promisify.custom]);
  17. // prints 'true'
  20. const fs = require('fs');
  22. fs.readFile[util.promisify.custom] = () => {
  23.   return Promise.reject('该文件暂时禁止读取');
  24. }
  26. const readFilePromisify = util.promisify(fs.readFile);
  28. readFilePromisify('text.txt', 'utf8')
  29.   .then(result => console.log(result))
  30.   .catch(err => console.log(err)); // 该文件暂时禁止读取

实现

  1. const kCustomPromisifiedSymbol = Symbol('util.promisify.custom');
  2. promisify.custom = kCustomPromisifiedSymbol;
  4. function promisify(original) {
  5.     // 保证 promisify 处理仅对函数生效
  6.     if (typeof original !== 'function') {
  7.         throw new Error('the original argument must be of type Function.Received type undefined');
  8.     }
  10.     if (original[kCustomPromisifiedSymbol]) {
  11.         const fn = original[kCustomPromisifiedSymbol];
  12.         if (typeof fn !== 'function') {
  13.             throw new Error('The "mayJunPromisify.custom" property must be of type Function. Received type number');
  14.         }
  16.         return Object.defineProperty(fn, kCustomPromisifiedSymbol, {
  17.             value: fn,
  18.             enumerable: false,
  19.             writable: false,
  20.             configurable: true
  21.         })
  22.     }
  24.     // 将传入的 original 函数 promisify 的关键处理逻辑，
  25.     // 此时的 fn 即为 promisify 化后的 original 结果函数
  26.     function fn(...args) {
  27.         return new Promise((resolve, reject) => {
  28.             try {
  29.                 original.call(this, ...args, (err, result) => {
  30.                     if (err) {
  31.                         reject(err);
  32.                     } else {
  33.                         resolve(result);
  34.                     }
  35.                 })
  36.             } catch(err) {
  37.                 reject(err);
  38.             }
  39.         })
  40.     }
  42.     return fn;
  43. }

参考资料

  1. nodejs promisify 实现
  2. Node.js 源码解析 util.promisify 如何将 Callback 转为 Promise