Node.js 내장 util
모듈에는 promisify()
메소드util
模块有一个 promisify()
方法,该方法将基于回调的函数转换为基于 Promise 的函数。这使您可以将 Promise 链和 async/await
与基于回调的 API 结合使用。
例如,Node.js 的 fs
模块在读取文件时,需要使用回调:
const fs = require('fs') fs.readFile('./package.json', function callback(err, buf) { const obj = JSON.parse(buf.toString('utf8')) console.log(obj.name) // 'Example' -> package.json 包名 })
我们可以使用 util.promisify()
将 fs.readFile()
的回调函数转换为返回 Promise 函数:
const fs = require('fs') const util = require('util') // 将 fs.readFile() 转换为一个接受相同参数但返回 Promise 的函数。 const readFile = util.promisify(fs.readFile) // 现在可以将 readFile() 与 await 一起使用! const buf = await readFile('./package.json') const obj = JSON.parse(buf.toString('utf8')) console.log(obj.name) // 'Example'
util.promisify()
在后台是如何工作的?npm 上有一个 polyfill,您可以在这里阅读完整的实现。您也可以在这里找到 Node.js 的实现,不过为了便于理解,polyfill 更易于阅读。【推荐学习:《nodejs 教程》】
util.promisify()
背后的关键思想是向传入的参数添加回调函数。该回调函数解析或拒绝 promisified 函数返回的 Promise。
为了便于理解,下面是一个非常简化的 util.promisify()
自定义实现示例:
const fs = require('fs') // util.promisify() 的简化实现。不包括所有情况,不要在 prod 环境中使用此选项! function promisify(fn) { return function() { const args = Array.prototype.slice.call(arguments) return new Promise((resolve, reject) => { fn.apply(this, [].concat(args).concat([(err, res) => { if (err != null) { return reject(err) } resolve(res) }])) }) } } // 将 fs.readFile() 转换为一个接受相同参数但返回 Promise 的函数。 const readFile = promisify(fs.readFile) // 现在可以将 readFile() 与 await 一起使用! const buf = await readFile('./package.json') const obj = JSON.parse(buf.toString('utf8')) console.log(obj.name) // 'Example'
那么这是什么意思呢?首先,util.promisify()
向传入的参数添加 1 个额外参数,然后使用这些新参数调用原始函数。这意味着底层函数需要支持该数量的参数。因此,如果您要调用myFn()
具有 2 个类型参数的promisified 函数 [String, Object]
,请确保原始函数支持[String, Object, Function]
。
那么这意味着什么呢?首先,util.promisify()
向传入的参数添加一个额外参数,然后使用这些新参数调用原始函数。这意味着基础函数需要支持该数量的参数。因此,如果您使用 [String, Object]
类型的 2 个参数调用 promisified 函数 myFn()
,请确保原始函数支持 [String, Object, Function]
。
其次,util.promisify()
对函数上下文(this
)有影响。
丢失上下文(this
)意味着函数调用以错误的值结束。丢失上下文是转换函数的常见问题:
class MyClass { myCallbackFn(cb) { cb(null, this) } } const obj = new MyClass() const promisified = require('util').promisify(obj.myCallbackFn) const context = await promisified() console.log(context) // 打印 undefined 而不是 MyClass 实例!
请记住,this
는 콜백 기반 함수를 Promise 기반 함수로 변환합니다. 이를 통해 콜백 기반 API와 함께 Promise 체인 및 async/await
를 사용할 수 있습니다.
예를 들어 Node.js의 fs
모듈은 파일을 읽을 때 콜백을 사용해야 합니다. class MyClass {
myCallbackFn(cb) {
cb(null, this)
}
}
const obj = new MyClass()
// 保留上下文,因为 promisified 是 obj 的属性
obj.promisified = require('util').promisify(obj.myCallbackFn)
const context = await obj.promisified()
console.log(context === obj) // true
util.promisify()
를 사용하여 fs .readFile()의 콜백 함수는 Promise 반환 함수로 변환됩니다.
util.promisify()
뒤에서 어떻게 작동하나요? npm에는 polyfill🎜이 있으며 여기에서 읽을 수 있습니다. 완전한 구현 🎜. 여기에서도 찾을 수 있습니다. Node.js 구현🎜, 이해하기 쉽도록 폴리필이 읽기 더 쉽습니다. [추천 학습: "nodejs tutorial🎜"]🎜🎜 util.promisify()
의 핵심 아이디어는 전달된 매개변수에 콜백 함수를 추가합니다 🎜. 이 콜백 함수는 약속된 함수에서 반환된 약속을 확인하거나 거부합니다. 🎜🎜이해를 돕기 위해 다음은 util.promisify()
의 매우 단순화된 사용자 정의 구현 예입니다. 🎜rrreee🎜이게 무슨 뜻인가요? 먼저 util.promisify()
는 전달된 매개변수에 1개의 추가 매개변수를 추가한 다음 이러한 새 매개변수를 사용하여 원래 함수를 호출합니다. 이는 기본 함수가 해당 개수의 인수를 지원해야 함을 의미합니다. 따라서 2개의 유형 매개변수를 사용하여 약속된 함수 [String, Object]
를 myFn()
호출하는 경우 원래 함수가 [String, Object, Function]을 지원하는지 확인하세요. ]
. 🎜🎜그럼 이게 무슨 뜻인가요? 먼저 util.promisify()
는 전달된 매개변수에 추가 매개변수를 추가한 다음 이러한 새 매개변수를 사용하여 원래 함수를 호출합니다. 이는 기본 함수가 해당 개수의 매개변수를 지원해야 함을 의미합니다. 따라서 [String, Object]
유형의 인수 2개를 사용하여 약속된 함수 myFn()
을 호출하는 경우 원래 함수가 [String, Object]를 지원하는지 확인하세요. , 기능 ]
. 🎜🎜두 번째로, util.promisify()
는 함수 컨텍스트(this
)에 영향을 미칩니다. 🎜this
)은 함수 호출이 잘못된 값으로 끝나는 것을 의미합니다. 컨텍스트 손실은 캐스트 함수의 일반적인 문제입니다. 🎜rrreee🎜 this
는 함수가 호출될 때 속성을 포함하는 객체라는 점을 기억하세요. 따라서 약속된 함수를 동일한 객체의 속성으로 설정하여 컨텍스트를 보존할 수 있습니다. 🎜rrreee🎜더 많은 프로그래밍 관련 지식을 보려면 🎜프로그래밍 비디오🎜를 방문하세요! ! 🎜위 내용은 Node.js 유틸리티 모듈의 promisify() 메서드에 대해 자세히 살펴보기의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!