util.promisify 的那些事兒

util.promisify是在node.js 8.x版本中新增的一個工具，用於將老式的Error first callback轉換爲Promise對象，讓老項目改造變得更爲輕鬆。

在官方推出這個工具之前，民間已經有很多類似的工具了，比如es6-promisify、thenify、bluebird.promisify。

以及很多其他優秀的工具，都是實現了這樣的功能，幫助我們在處理老項目的時候，不必費神將各種代碼使用Promise再重新實現一遍。

工具實現的大致思路

首先要解釋一下這種工具大致的實現思路，因爲在Node中異步回調有一個約定：Error first，也就是說回調函數中的第一個參數一定要是Error對象，其餘參數纔是正確時的數據。

知道了這樣的規律以後，工具就很好實現了，在匹配到第一個參數有值的情況下，觸發reject，其餘情況觸發resolve，一個簡單的示例代碼：

function util (func) {
  return (...arg) => new Promise((resolve, reject) => {
    func(...arg, (err, arg) => {
      if (err) reject(err)
      else resolve(arg)
    })
  })
}

1. 調用工具函數返回一個匿名函數，匿名函數接收原函數的參數。
2. 匿名函數被調用後根據這些參數來調用真實的函數，同時拼接一個用來處理結果的callback。
3. 檢測到err有值，觸發reject，其他情況觸發resolve

resolve 只能傳入一個參數，所以callback中沒有必要使用...arg獲取所有的返回值

常規的使用方式

拿一個官方文檔中的示例

const { promisify } = require('util')
const fs = require('fs')

const statAsync = promisify(fs.stat)

statAsync('.').then(stats => {
  // 拿到了正確的數據
}, err => {
  // 出現了異常
})

以及因爲是Promise，我們可以使用await來進一步簡化代碼：

const { promisify } = require('util')
const fs = require('fs')

const statAsync = promisify(fs.stat)

// 假設在 async 函數中
try {
  const stats = await statAsync('.')
  // 拿到正確結果
} catch (e) {
  // 出現異常
}

用法與其他工具並沒有太大的區別，我們可以很輕易的將回調轉換爲Promise，然後應用於新的項目中。

自定義的 Promise 化

有那麼一些場景，是不能夠直接使用promisify來進行轉換的，有大概這麼兩種情況：

1. 沒有遵循Error first callback約定的回調函數
2. 返回多個參數的回調函數

首先是第一個，如果沒有遵循我們的約定，很可能導致reject的誤判，得不到正確的反饋。
而第二項呢，則是因爲Promise.resolve只能接收一個參數，多餘的參數會被忽略。

所以爲了實現正確的結果，我們可能需要手動實現對應的Promise函數，但是自己實現了以後並不能夠確保使用方不會針對你的函數調用promisify。

所以，util.promisify還提供了一個Symbol類型的key，util.promisify.custom。

Symbol類型的大家應該都有了解，是一個唯一的值，這裏是util.prosimify用來指定自定義的Promise化的結果的，使用方式如下：

const { promisify } = require('util')
// 比如我們有一個對象，提供了一個返回多個參數的回調版本的函數
const obj = {
  getData (callback) {
    callback(null, 'Niko', 18) // 返回兩個參數，姓名和年齡
  }
}

// 這時使用promisify肯定是不行的
// 因爲Promise.resolve只接收一個參數，所以我們只會得到 Niko

promisify(obj.getData)().then(console.log) // Niko

// 所以我們需要使用 promisify.custom 來自定義處理方式

obj.getData[promisify.custom] = async () => ({ name: 'Niko', age: 18 })

// 當然了，這是一個曲線救國的方式，無論如何 Promise 不會返回多個參數過來的
promisify(obj.getData)().then(console.log) // { name: 'Niko', age: 18 }

關於Promise爲什麼不能resolve多個值，我有一個大膽的想法，一個沒有經過考證，強行解釋的理由：如果能resolve多個值，你讓async函數怎麼return（當個樂子看這句話就好，不要當真）
不過應該確實跟return有關，因爲Promise是可以鏈式調用的，每個Promise中執行then以後都會將其返回值作爲一個新的Promise對象resolve的值，在JavaScript中並沒有辦法return多個參數，所以即便第一個Promise可以返回多個參數，只要經過return的處理就會丟失

在使用上就是很簡單的針對可能會被調用promisify的函數上添加promisify.custom對應的處理即可。
當後續代碼調用promisify時就會進行判斷：

1. 如果目標函數存在promisify.custom屬性，則會判斷其類型：

   1. 如果不是一個可執行的函數，拋出異常
   2. 如果是可執行的函數，則直接返回其對應的函數
2. 如果目標函數不存在對應的屬性，按照Error first callback的約定生成對應的處理函數然後返回

添加了這個custom屬性以後，就不用再擔心使用方針對你的函數調用promisify了。
而且可以驗證，賦值給custom的函數與promisify返回的函數地址是一處：

obj.getData[promisify.custom] = async () => ({ name: 'Niko', age: 18 })

// 上邊的賦值爲 async 函數也可以改爲普通函數，只要保證這個普通函數會返回 Promise 實例即可
// 這兩種方式與上邊的 async 都是完全相等的

obj.getData[promisify.custom] = () => Promise.resolve({ name: 'Niko', age: 18 })
obj.getData[promisify.custom] = () => new Promise(resolve({ name: 'Niko', age: 18 }))

console.log(obj.getData[promisify.custom] === promisify(obj.getData)) // true

一些內置的 custom 處理

在一些內置包中，也能夠找到promisify.custom的蹤跡，比如說最常用的child_process.exec就內置了promisify.custom的處理：

const { exec } = require('child_process')
const { promisify } = require('util')

console.log(typeof exec[promisify.custom]) // function

因爲就像前邊示例中所提到的曲線救國的方案，官方的做法也是將函數簽名中的參數名作爲key，將其所有參數存放到一個Object對象中進行返回，比如child_process.exec的返回值拋開error以外會包含兩個，stdout和stderr，一個是命令執行後的正確輸出，一個是命令執行後的錯誤輸出：

promisify(exec)('ls').then(console.log)
// -> { stdout: 'XXX', stderr: '' }

或者我們故意輸入一些錯誤的命令，當然了，這個只能在catch模塊下才能夠捕捉到，一般命令正常執行stderr都會是一個空字符串：

promisify(exec)('lss').then(console.log, console.error)
// -> { ..., stdout: '', stderr: 'lss: command not found' }

包括像setTimeout、setImmediate也都實現了對應的promisify.custom。
之前爲了實現sleep的操作，還手動使用Promise封裝了setTimeout：

const sleep = promisify(setTimeout)

console.log(new Date())

await sleep(1000)

console.log(new Date())

內置的 promisify 轉換後函數

如果你的Node版本使用10.x以上的，還可以從很多內置的模塊中找到類似.promises的子模塊，這裏邊包含了該模塊中常用的回調函數的Promise版本（都是async函數），無需再手動進行promisify轉換了。

而且我本人覺得這是一個很好的指引方向，因爲之前的工具實現，有的選擇直接覆蓋原有函數，有的則是在原有函數名後邊增加Async進行區分，官方的這種在模塊中單獨引入一個子模塊，在裏邊實現Promise版本的函數，其實這個在使用上是很方便的，就拿fs模塊進行舉例：

// 之前引入一些 fs 相關的 API 是這樣做的
const { readFile, stat } = require('fs')

// 而現在可以很簡單的改爲
const { readFile, stat } = require('fs').promises
// 或者
const { promises: { readFile, stat } } = require('fs')

後邊要做的就是將調用promisify相關的代碼刪掉即可，對於其他使用API的代碼來講，這個改動是無感知的。
所以如果你的node版本夠高的話，可以在使用內置模塊之前先去翻看文檔，有沒有對應的promises支持，如果有實現的話，就可以直接使用。

promisify 的一些注意事項

1. 一定要符合Error first callback的約定
2. 不能返回多個參數
3. 注意進行轉換的函數是否包含this的引用

前兩個問題，使用前邊提到的promisify.custom都可以解決掉。
但是第三項可能會在某些情況下被我們所忽視，這並不是promisify獨有的問題，就一個很簡單的例子：

const obj = {
  name: 'Niko',
  getName () {
    return this.name
  }
}

obj.getName() // Niko

const func = obj.getName

func() // undefined

類似的，如果我們在進行Promise轉換的時候，也是類似這樣的操作，那麼可能會導致生成後的函數this指向出現問題。
修復這樣的問題有兩種途徑：

1. 使用箭頭函數，也是推薦的做法
2. 在調用promisify之前使用bind綁定對應的this

不過這樣的問題也是建立在promisify轉換後的函數被賦值給其他變量的情況下會發生。
如果是類似這樣的代碼，那麼完全不必擔心this指向的問題：

const obj = {
  name: 'Niko',
  getName (callback) {
    callback(null, this.name)
  }
}

// 這樣的操作是不需要擔心 this 指向問題的
obj.XXX = promisify(obj.getName)

// 如果賦值給了其他變量，那麼這裏就需要注意 this 的指向了
const func = promisify(obj.getName) // 錯誤的 this

小結

個人認爲Promise作爲當代javaScript異步編程中最核心的一部分，瞭解如何將老舊代碼轉換爲Promise是一件很有意思的事兒。
而我去了解官方的這個工具，原因是在搜索Redis相關的Promise版本時看到了這個readme：

This package is no longer maintained. node_redis now includes support for promises in core, so this is no longer needed.

然後跳到了node_redis裏邊的實現方案，裏邊提到了util.promisify，遂抓過來研究了一下，感覺還挺有意思，總結了下分享給大家。

參考資料

• util.promisify
• child_process.exec
• fs.promises