util.promisify的相關內容講解

這篇文章帶給大家的內容是關於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)
    })
  })
}

呼叫工具函數傳回一個匿名函數，匿名函數接收原函數的參數。

匿名函數在呼叫後根據這些參數來呼叫真實的函數，同時拼接一個用來處理結果的callback。

偵測到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時就會進行判斷：

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

如果不是一個可執行的函數，拋出異常

如果是可執行的函數，則直接返回其對應的函數

如果目標函數不存在對應的屬性，按照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的相關內容講解的詳細內容。更多資訊請關注PHP中文網其他相關文章！