Node.js 中的 Util.callbackify() 方法

2025年3月4日 | 阅读 3 分钟

在本文中，我们将讨论 Node.js 中的 util.callbackify() 方法，包括其语法、参数、工作原理和示例。

Node.js 中的 util.callbackify() 方法是什么？

在 Node.js 中，util.Callbackify() 函数返回一个 Promise，该 Promise 可以转换为应用传统的错误优先回调模式。这在与不使用 Promise 而使用回调式 API 的代码库合并时非常有用。

语法

它具有以下语法：

 
const util = require('util');
const callbackifiedFunction = util.callbackify(originalFunction);   

参数

originalFunction: 返回 Promise 的函数。

返回值

一个函数，它接受与原始函数相同的参数，并额外在最后一个参数中添加一个回调函数。该回调函数遵循标准的错误优先模式：callback(err, result)。

它是如何工作的？

当调用返回的函数时，会调用原始的函数，并期望它返回一个 Promise。当 Promise 解决时，解析值将作为第二个参数传递给回调函数，而 null（表示没有错误）将作为第一个参数传递。如果 Promise 被拒绝，则使用错误作为第一个参数调用回调函数。

示例 1

让我们举一个例子来演示 Node.js 中 util.callbackify() 函数的用法。

 
const util = require('util');
async function asyncFunction() {
return 'Hello, world!';
}
const callbackifiedFunction = util.callbackify(asyncFunction);
callbackifiedFunction((err, result) => {
if (err) {
console.error('Error:', err);
} else {
console.log('Result:', result);
}
});   

输出

示例 2

让我们再举一个例子来演示 Node.js 中 util.callbackify() 函数的用法。

 
const util = require('util'); 
async function async_function() { 
return 'message from async function'; 
} 
const callback_function = 
util.callbackify(async_function); 
callback_function((err, ret) => { 
if (err) throw err; 
console.log(ret); 
});    

输出

示例 3

让我们再举一个例子来演示 Node.js 中 util.callbackify() 函数的用法。

 
const util = require('util'); 
async function async_function() { 
return Promise.reject(new Error( 'this is an error message!')); 
} 
const callback_function = 
util.callbackify(async_function); 
callback_function((err, ret) => { 
if (err && err.hasOwnProperty('reason') 
&& err.reason === null) { 
console.log(err.reason); 
} else { 
console.log(err); 
} 
});    

输出

错误处理

当 callbackify() 函数使用错误对象作为第一个输入调用回调函数时，原始函数的 Promise 将被拒绝。

 
async function asyncFunctionWithError() {
throw new Error('Something went wrong!');
}
const callbackifiedFunctionWithError = util.callbackify(asyncFunctionWithError);
callbackifiedFunctionWithError((err, result) => {
if (err) {
console.error('Error:', err.message); 
} else {
console.log('Result:', result);
}
});   

局限性

Node.js 中 util.callbackify() 方法的几个限制如下：

单个拒绝/解决：回调样式不支持多个拒绝或解决。Promise 解决后只会调用一个回调函数。
无返回值：回调用于传递结果；回调样式的函数不返回任何值。
未捕获的异常：Promise 不会捕获在已回调函数中抛出的异常。

用例

Node.js 中 util.callbackify() 方法的几个用例如下：

遗留代码集成：开发人员可以使用 util.callbackify() 将现代基于 Promise 的方法与遗留的回调代码集成。
确保 API 与基于回调和基于 Promise 的客户端兼容。

结论

总而言之，Node.js 工具 util.callbackify() 促进了基于 Promise 的代码和基于回调的代码之间的转换，从而简化了依赖于回调模式的旧系统或库的集成。

下一主题10-best-nodejs-data-validation-libraries

Node.js 中的 Util.callbackify() 方法