util.promisify 관련 내용 설명
- 不言앞으로
- 2018-10-18 14:19:262198검색
이 기사는 util.promisify에 대한 몇 가지 설명을 제공합니다. 특정 참고 가치가 있으므로 도움이 필요한 친구에게 도움이 되기를 바랍니다.
util.promisify는 node.js 8.x 버전의 새로운 도구로, 기존 Error First 콜백을 Promise 객체로 변환하여 기존 프로젝트를 더 쉽게 변환하는 데 사용됩니다.
이 도구가 공식 출시되기 전에는 이미 es6-promisify, thenify, bluebird.promisify 등 대중들 사이에 유사한 도구가 많이 있었습니다.
및 기타 여러 우수한 도구에서 이 기능을 구현하여 오래된 프로젝트를 처리할 때 Promise를 사용하여 다양한 코드를 다시 구현하는 것에 대해 걱정할 필요가 없도록 도와줍니다.
도구 구현에 대한 일반적인 아이디어
우선 Node: Error first에 비동기 콜백에 대한 규칙이 있기 때문에 이 도구 구현에 대한 일반적인 아이디어를 설명해야 합니다. , 이는 콜백 함수의 첫 번째 매개변수가 Error Object여야 하고 나머지 매개변수는 올바른 데이터임을 의미합니다.
이 규칙을 알고 나면 도구를 쉽게 구현할 수 있습니다. 첫 번째 매개변수가 일치하고 값이 있으면 거부가 트리거되고 다른 경우에는 해결이 트리거됩니다.
function util (func) {
return (...arg) => new Promise((resolve, reject) => {
func(...arg, (err, arg) => {
if (err) reject(err)
else resolve(arg)
})
})
}
도구를 호출합니다. 함수는 익명 함수를 반환하고 익명 함수는 원래 함수의 매개변수를 받습니다.
익명 함수가 호출된 후 이러한 매개변수를 기반으로 실제 함수를 호출하고 결과 처리를 위해 콜백을 연결합니다.
err에 값이 있음을 감지하고 거부를 트리거하며 다른 경우에는 해결을 트리거합니다.
resolve는 하나의 매개변수만 전달할 수 있으므로 모든 반환 값을 얻기 위해 콜백에서...arg를 사용할 필요가 없습니다
일반 사용법
공식 문서에서 예를 들어보세요
const { promisify } = require('util')
const fs = require('fs')
const statAsync = promisify(fs.stat)
statAsync('.').then(stats => {
// 拿到了正确的数据
}, err => {
// 出现了异常
})
Promise이므로 await를 사용하여 코드를 더욱 단순화할 수 있습니다. Promise，我们可以使用await来进一步简化代码：
const { promisify } = require('util')
const fs = require('fs')
const statAsync = promisify(fs.stat)
// 假设在 async 函数中
try {
const stats = await statAsync('.')
// 拿到正确结果
} catch (e) {
// 出现异常
}
用法与其他工具并没有太大的区别，我们可以很轻易的将回调转换为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 }The 사용법은 다른 도구와 크게 다르지 않습니다. 차이점은 콜백을 Promise로 쉽게 변환한 다음 새 프로젝트에 적용할 수 있다는 것입니다. Customized Promise
promisify를 변환에 직접 사용할 수 없는 경우는 대략 두 가지입니다. 1 Error first callback 규칙2을 따르는 콜백 함수가 없습니다. 여러 매개변수를 반환합니다
첫 번째입니다. 합의를 따르지 않으면 잘못된 판단으로 인해 잘못된 피드백이 발생할 가능성이 높습니다.
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
Promise가 여러 값을 확인할 수 없는 이유는 다음과 같습니다. 나는 대담한 아이디어, 검증되지 않고 강요된 설명을 가지고 있습니다. 여러 값을 해결할 수 있는 경우 비동기 함수에 반환을 요청하는 방법은 무엇입니까? (이 문장을 재미로 읽으십시오. 진지하게 받아들이지 마십시오) 하지만 실제로는 return 관련과 동일합니다. Promise는 체인에서 호출될 수 있으므로 각 Promise에서 실행한 후 해당 반환 값은 새 Promise 객체의 확인 값으로 사용됩니다. JavaScript에서는 여러 매개변수를 반환할 수 없습니다. 따라서 첫 번째 Promise 다중 매개변수가 반환될 수 있더라도 반환으로 처리되는 한 해당 매개변수는 손실됩니다.
사용 시 호출할 수 있는 함수에 promisify.custom의 해당 처리를 추가하는 것은 매우 간단합니다. 약속하다.
이 사용자 정의 속성을 추가한 후에는 더 이상 당신을 타겟팅하는 사용자에 대해 걱정할 필요가 없습니다.
const { exec } = require('child_process')
const { promisify } = require('util')
console.log(typeof exec[promisify.custom]) // function
일부 내장된 맞춤형 처리일부 내장 패키지에서는 promisify의 흔적이 보입니다. .custom도 찾을 수 있습니다. 가장 일반적으로 사용되는 child_process.exec에는 promisify.custom 처리가 내장되어 있다고 합니다.
promisify(exec)('ls').then(console.log)
// -> { stdout: 'XXX', stderr: '' } 이전 예에서 언급한 곡선 절약 계획과 마찬가지로 공식적인 방법은 다음과 같습니다. 함수 서명의 매개변수 이름을 키로 사용하고 이를 키로 사용합니다. 모든 매개변수는 반환을 위해 Object 개체에 저장됩니다. 예를 들어, child_process.exec의 반환 값에는 stdout과 stderr 두 개가 포함됩니다. 하나는 명령이 실행된 후의 올바른 출력이고, 다른 하나는 명령이 실행된 후의 오류 출력입니다.
promisify(exec)('lss').then(console.log, console.error)
// -> { ..., stdout: '', stderr: 'lss: command not found' } 또는 의도적으로 일부 잘못된 명령을 입력하는 것은 물론 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 的一些注意事项
一定要符合Error first callback的约定
不能返回多个参数
注意进行转换的函数是否包含this的引用
前两个问题，使用前边提到的promisify.custom都可以解决掉。
但是第三项可能会在某些情况下被我们所忽视，这并不是promisify独有的问题，就一个很简单的例子：
const obj = {
name: 'Niko',
getName () {
return this.name
}
}
obj.getName() // Niko
const func = obj.getName
func() // undefined
类似的，如果我们在进行Promise转换的时候，也是类似这样的操作，那么可能会导致生成后的函数this指向出现问题。
修复这样的问题有两种途径：
使用箭头函数，也是推荐的做法
在调用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 중국어 웹사이트의 기타 관련 기사를 참조하세요!