讲师中心 微信公众号
AI工具推荐 视频效率加速

如何使用 Promise 封装基于事件的 API

胖辰大大_8997

胖辰大大_8997

发布时间:2026-07-10 06:19:18

|

362人浏览过

|

来源于php中文网

原创

用 Promise 封装事件 API 的核心是将事件触发转为可 await 的 Promise,需手动创建并用 resolve/reject 控制状态;支持一次监听(once)、超时保护(AbortController)及 Node.js EventEmitter 兼容方案。

如何使用 promise 封装基于事件的 api

用 Promise 封装基于事件的 API,核心是把“等待某个事件触发”变成“返回一个可 await 的 Promise”,让异步流程更线性、更易错误处理。关键在于手动创建 Promise,并在事件回调中调用 resolve 或 reject。

监听一次事件就完成:用 addEventListener + resolve

适用于只关心首次触发的事件(如 load、success、error)。

示例:封装 fetch 的替代方案——用 XMLHttpRequest 并返回 Promise:

function xhrGet(url) {
  return new Promise((resolve, reject) => {
    const xhr = new XMLHttpRequest();
    xhr.open('GET', url);
    xhr.onload = () => {
      if (xhr.status >= 200 && xhr.status < 300) {
        resolve(xhr.responseText);
      } else {
        reject(new Error(`HTTP ${xhr.status}: ${xhr.statusText}`));
      }
    };
    xhr.onerror = () => reject(new Error('Network error'));
    xhr.send();
  });
}
// 使用
xhrGet('/api/data')
  .then(data => console.log(data))
  .catch(err => console.error(err));

注意点:

  • 必须在 onload 和 onerror 中都调用 resolve 或 reject,避免 Promise 永远 pending
  • 手动清理不是必须的(XHR 实例会自动回收),但复杂场景建议在 resolve/reject 后设 xhr = null

封装自定义事件或多次触发事件:用 once 或手动移除监听器

DOM 元素的 once: true 选项可自动移除监听器,适合只响应一次的事件:

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

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

下载
function waitForClick(button) {
  return new Promise(resolve => {
    button.addEventListener('click', resolve, { once: true });
  });
}

// 使用
waitForClick(document.getElementById('submit'))
  .then(() => console.log('Clicked!'));

不支持 once 的环境(如某些旧版浏览器或自定义事件系统),需手动移除:

function waitForEvent(target, eventName) {
  return new Promise(resolve => {
    const handler = () => {
      target.removeEventListener(eventName, handler);
      resolve();
    };
    target.addEventListener(eventName, handler);
  });
}

处理超时和取消:Promise.race + AbortController(推荐)

真实场景中,事件可能永不触发。加入超时保护更健壮:

function waitForEventWithTimeout(target, eventName, timeoutMs = 5000) {
  const controller = new AbortController();
  
  const eventPromise = new Promise(resolve => {
    const handler = () => {
      target.removeEventListener(eventName, handler, { signal: controller.signal });
      resolve();
    };
    target.addEventListener(eventName, handler, { signal: controller.signal });
  });

  const timeoutPromise = new Promise((_, reject) => {
    setTimeout(() => {
      controller.abort();
      reject(new Error(`Timeout after ${timeoutMs}ms`));
    }, timeoutMs);
  });

  return Promise.race([eventPromise, timeoutPromise]);
}

说明:

  • 利用 AbortController 统一控制监听器生命周期,比手动 removeEventListener 更可靠
  • Promise.race 确保最先完成的 Promise 决定结果,超时或事件任一发生即结束
  • 现代浏览器均支持 AbortSignal 传入 addEventListener

封装 Node.js EventEmitter 类型(如 stream、net.Socket)

Node.js 中常见基于 EventEmitter 的 API,如 stream.Readable 的 'data' 或 'end' 事件:

const { once } = require('events');

// Node.js 15.4+ 内置的 once 函数,返回 Promise
async function readOnce(stream) {
  const [chunk] = await once(stream, 'data');
  return chunk;
}

// 手动封装(兼容旧版本)
function waitForEnd(stream) {
  return new Promise(resolve => {
    stream.once('end', resolve);
  });
}

提示:

  • Node.js ≥15.4 推荐直接用内置 events.once(),它已做好错误转发('error' 会 reject)
  • 若需等待多个事件(如先 data 再 end),可用 Promise.all([once(...), once(...)])

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

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

相关专题

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

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

4286

2023.06.20

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

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

1089

2023.07.04

js四舍五入
js四舍五入

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

4204

2023.07.04

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

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

860

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

1756

2023.09.04

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

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

3125

2023.09.04

如何启用JavaScript
如何启用JavaScript

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

4053

2023.09.12

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

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

2600

2023.09.20

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

160

2026.09.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn