如何将传统的基于回调的 API 转化为基于 Promise 的 API?

浅婷吖_2692

浅婷吖_2692

2026-06-06

693人浏览

原创

最省事的是用 node.js 内置的 util.promisify(),它专为转换 node-style 回调函数设计,零依赖、稳定、自动处理错误;批量转换可用 pify 或 mz 等库;非标准回调需手动封装 promise;小程序和浏览器环境需定制适配。

如何将传统的基于回调的 api 转化为基于 promise 的 api?

直接用 Node.js 内置的 util.promisify() 最省事,它专为这种转换设计,零依赖、稳定、符合官方规范。

用内置工具:util.promisify()

Node.js 从 v8.0 开始原生支持该方法,适用于所有遵循 (err, result) 约定的回调函数(即“Node-style callback”)。

  • 只需传入目标函数,它就返回一个等效的 Promise 版本
  • 无需安装额外包,不引入运行时开销
  • 自动处理错误:回调中传入 err,Promise 就 reject;传入 result,Promise 就 resolve

示例:

const fs = require('fs');
const util = require('util');

const readFile = util.promisify(fs.readFile);
const stat = util.promisify(fs.stat);

async function run() {
  try {
    const data = await readFile('config.json', 'utf8');
    const info = await stat('config.json');
    console.log(data, info.size);
  } catch (err) {
    console.error(err);
  }
}

批量转换整个模块

当需要把一个模块(如 fs、dns)里几十个方法都 Promise 化时,手动调用 promisify 太繁琐。这时可用第三方库简化流程。

  • pify:轻量、可配置(比如 multiArgs: true 支持多返回值)
  • mz:专为 Node.js 核心模块优化,已预置 fs、child_process 等模块的 Promise 版本,开箱即用
  • es6-promisify:API 简洁,适合老项目快速接入

例如用 pify 批量处理:

Web前端Promise教程从入门到精通课件
Web前端Promise教程从入门到精通课件

Web前端Promise教程从入门到精通课件

下载
const fs = require('fs');
const pify = require('pify');

const fsP = pify(fs); // 所有 fs 方法都变成 Promise 返回
const data = await fsP.readFile('package.json');

手动封装:适用于非标准回调格式

如果回调函数不按 (err, result) 形式传递参数(比如只有 result、或多个结果、或用事件触发),就不能直接用 util.promisify()。此时需手写 Promise 包装器。

  • 用 new Promise((resolve, reject) => {...}) 显式控制状态
  • 注意正确捕获同步异常(如参数校验失败)并 reject
  • 确保回调只执行一次,避免重复 resolve 或 reject

示例(适配仅传 result 的回调):

function wrapSimpleCallback(fn, ...args) {
  return new Promise((resolve) => {
    fn(...args, (result) => resolve(result));
  });
}

// 使用
const result = await wrapSimpleCallback(someLib.getData, 'id123');

小程序与浏览器环境的特别处理

微信小程序、支付宝小程序等平台 API 多数是 success/fail/complete 三回调结构,不属于 Node-style,不能直传给 util.promisify()。

  • 推荐使用社区封装好的适配包,如 @miniprogram-api-promise
  • 也可自行封装通用 wrapper,统一转为 Promise,并兼容 fail 错误和 complete 统一收口
  • 浏览器 DOM 事件(如 load、click)可用 once + Promise 组合实现

例如封装小程序 API:

function promisifyWx(api, options) {
  return new Promise((resolve, reject) => {
    api({
      ...options,
      success: resolve,
      fail: reject
    });
  });
}

// 调用
const res = await promisifyWx(wx.request, { url: '/api/user' });

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4866

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1209

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4804

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

940

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1876

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3465

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4493

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2960

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

928

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程