JavaScript中怎么用Promise封装XMLHttpRequest实现一个轻量级的Ajax工具

风杰小哥_8288

风杰小哥_8288

2026-07-24

182人浏览

原创

promise 封装 xmlhttprequest 是实现轻量 ajax 工具的核心:通过返回 promise 的 request 函数统一处理 onload/onerror,自动解析 json、支持超时/取消/错误分类,并导出 get/post/put/delete 语义化方法。

javascript中怎么用promise封装xmlhttprequest实现一个轻量级的ajax工具

用 Promise 封装 XMLHttpRequest 是实现现代、可链式调用的轻量 Ajax 工具的核心思路:把原生异步请求包装成返回 Promise 的函数,让成功/失败逻辑更清晰、更易组合。

基础封装:一个通用的 request 函数

核心是创建一个返回 Promise 的函数,内部用 XMLHttpRequest 发起请求,并在 onload / onerror 中 resolve 或 reject。

  • 手动设置请求方法、URL、请求头
  • 监听 load 事件判断状态码(2xx 视为成功)
  • 监听 error、timeout、abort 等异常情况统一 reject
  • 响应体自动解析为 JSON(若 Content-Type 包含 application/json),否则保留为字符串

示例代码:

function request(url, options = {}) {
  return new Promise((resolve, reject) => {
    const xhr = new XMLHttpRequest();
    const { method = 'GET', headers = {}, timeout = 10000, body } = options;

    xhr.open(method.toUpperCase(), url);
    xhr.timeout = timeout;

    // 自动设置 Content-Type(仅 POST/PUT 等有 body 时)
    if (body && !headers['Content-Type']) {
      xhr.setRequestHeader('Content-Type', 'application/json');
    }

    // 设置其他请求头
    Object.keys(headers).forEach(key => {
      xhr.setRequestHeader(key, headers[key]);
    });

    xhr.onload = () => {
      if (xhr.status >= 200 && xhr.status  reject(new Error('Network error'));
    xhr.ontimeout = () => reject(new Error('Request timeout'));
    xhr.onabort = () => reject(new Error('Request aborted'));

    xhr.send(body ? JSON.stringify(body) : null);
  });
}

封装常用 HTTP 方法:get / post / put / delete

基于 request 函数,导出语义化方法,减少重复传参,提升调用体验。

  • get:默认 method='GET',参数拼接在 URL 后(支持对象自动序列化)
  • post:默认发送 JSON,body 直接作为 payload
  • 其余方法类似,保持接口一致

简单辅助函数示例(含 URL 参数序列化):

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
function serialize(obj) {
  return Object.keys(obj)
    .map(k => `${encodeURIComponent(k)}=${encodeURIComponent(obj[k])}`)
    .join('&');
}

export const get = (url, params = {}) => {
  const query = serialize(params);
  const finalUrl = query ? `${url}?${query}` : url;
  return request(finalUrl, { method: 'GET' });
};

export const post = (url, data = {}) => 
  request(url, { method: 'POST', body: data });

export const put = (url, data = {}) => 
  request(url, { method: 'PUT', body: data });

export const del = (url) => 
  request(url, { method: 'DELETE' });

支持取消请求(AbortController 兼容方案)

XMLHttpRequest 原生不支持标准 AbortController,但可通过 xhr.abort() 模拟取消逻辑。可在 Promise 外层加一层 cancelable 包装。

  • 返回一个带 cancel() 方法的对象
  • 调用 cancel 时触发 xhr.abort(),并 reject 一个特定错误
  • 注意:已响应的请求无法取消,只能中断未完成传输

增强版 request 示例:

function requestCancelable(url, options = {}) {
  const xhr = new XMLHttpRequest();
  let isAborted = false;

  const promise = new Promise((resolve, reject) => {
    xhr.onload = () => {
      if (isAborted) return;
      // ... 同上处理逻辑
    };
    xhr.onerror = () => !isAborted && reject(new Error('Network error'));
    xhr.ontimeout = () => !isAborted && reject(new Error('Timeout'));
    xhr.onabort = () => reject(new Error('Canceled'));

    xhr.open(options.method || 'GET', url);
    xhr.timeout = options.timeout || 10000;

    // ... 设置 header 和 send
  });

  return {
    promise,
    cancel() {
      isAborted = true;
      xhr.abort();
    }
  };
}

使用示例与错误处理建议

实际调用时推荐配合 try/catch 或 .catch() 统一处理异常,避免未捕获 rejection。

  • 成功时解构响应对象:{ data, status }
  • 服务端业务错误(如 400/500)已在 Promise reject 中抛出,需主动捕获
  • 可配合 loading 状态、重试逻辑、请求拦截(如 token 注入)进一步扩展

调用示例:

async function fetchData() {
  try {
    const res = await get('/api/users', { page: 1 });
    console.log(res.data); // ✅
  } catch (err) {
    console.error('请求失败:', err.message); // ❌
  }
}

// 链式调用
post('/api/login', { username: 'a', password: 'b' })
  .then(res => console.log(res.data))
  .catch(err => alert(err.message));

不复杂但容易忽略细节:状态码判断、JSON 安全解析、超时控制、请求头自动适配、取消能力——把这些补全,就是一个真正可用的轻量 Ajax 工具。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

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

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

2023.06.20

4546

5

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

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

2023.07.04

1129

3

js四舍五入
js四舍五入

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

2023.07.04

4464

6

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

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

2023.09.01

900

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1796

5

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

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

2023.09.04

3265

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4233

6

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

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

2023.09.20

2740

5

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

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

2023.09.20

888

7

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.1万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习