util.promisifyの関連内容の説明

この記事では、util.promisify についていくつか説明します。必要な方は参考にしていただければ幸いです。

util.promisify は、node.js 8.x バージョンの新しいツールで、古い Error first コールバックを Promise オブジェクトに変換するために使用され、古いプロジェクトの変換を容易にします。

このツールが正式にリリースされる前に、es6-promisify、thenify、bluebird.promisify など、民間部門にはすでに同様のツールが多数存在していました。

や他の多くの優れたツールがこの機能を実装しているため、古いプロジェクトを扱うときに Promise を使用してさまざまなコードを再実装することを心配する必要がなくなります。

ツール実装の一般的な考え方

まず、このツールの実装に関する一般的な考え方を説明する必要があります。 Node には非同期コールバックに関する規則があります。まずエラーが発生します。つまり、コールバック関数の最初のパラメータは Error オブジェクトでなければならず、残りのパラメータは正しいデータであると言われています。

このルールを理解すると、最初のパラメーターが一致し、値がある場合に拒否がトリガーされ、それ以外の場合には解決がトリガーされます。簡単なコード例:

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

。

ツール関数を呼び出すと匿名関数が返され、匿名関数は元の関数のパラメーターを受け取ります。

匿名関数が呼び出された後、これらのパラメーターに基づいて実際の関数を呼び出し、結果を処理するためのコールバックを結合します。

err に値があることを検出し、拒否をトリガーし、その他の場合は解決をトリガーします。

resolve は 1 つのパラメーターのみを渡すことができるため、...arg を使用する必要はありません。すべての戻り値を取得するコールバック内で Value

一般的な使用法

公式ドキュメントから例を取り上げます

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

promise を変換に直接使用できないシナリオがいくつかあります。大まかに 2 つの状況があります。

1。 Error first コールバックの規約に従わないもの

2. 複数のパラメータを返すコールバック関数

1 つ目は、規約に従わない場合、拒否の誤判定を引き起こす可能性があります。そして正しいフィードバックはありません。
2 番目の項目は、Promise.resolve が受け取るパラメーターは 1 つだけであり、追加のパラメーターは無視されるためです。

したがって、正しい結果を得るには、対応する Promise 関数を手動で実装する必要がある場合がありますが、それを自分で実装した後、ユーザーが関数に対して promisify を呼び出さないことを保証することはできません。

したがって、util.promisify は、シンボル タイプのキー 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 は複数の値を解決できないのですか? 私には大胆なアイデアがありますが、その理由は検証されておらず、説明する必要があります。複数の値を解決できる場合、どのように async 関数に返すように要求すればよいでしょうか (この文は、お楽しみとして読んでください)やめてください）
しかし、Promise はチェーン内で呼び出すことができるため、各 Promise で実行された後、その戻り値が新しい Promise オブジェクトの解決の値として使用されるため、これは return に関連する必要があります。 JavaScript では複数のパラメータを返す方法がないため、最初の Promise が複数のパラメータを返すことができたとしても、それらが return によって処理される限り、それらは失われます。 promisify と呼ばれる関数に .custom を適用するだけです。

後続のコードが promisify を呼び出すと、次のように判断されます。

対象関数に promisify.custom 属性がある場合、その型が判断されます。

実行可能な関数ではない場合。 , throw 例外が発生します。

実行可能な関数の場合、対応する関数が直接返されます。

ターゲット関数に対応する属性がない場合、対応する処理関数が次のように生成されます。 Error が最初にコールバックされてから返されるという規則

このカスタム属性を追加すると、ユーザーが関数に対して 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

いくつかの組み込みカスタム処理

一部の組み込みパッケージでは、promisify.custom の痕跡も見つかります。たとえば、最も一般的に使用される child_process.exec には、promisify.custom 処理が組み込まれています。 # なぜなら、前の例で述べたように、国を保存するための正式な方法は、関数シグネチャ内のパラメータ名をキーとして使用し、戻り値などのすべてのパラメータを Object オブジェクトに格納することです。 child_process.exec には、error と stderr を除く 2 つの stdout が含まれます。1 つはコマンド実行後の正しい出力で、もう 1 つはコマンド実行後のエラー出力です。もちろん、これは 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 中国語 Web サイトの他の関連記事を参照してください。