百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

为 fetch 请求添加超时功能的两种方案

nanshan 2024-11-21 18:46 17 浏览 0 评论

fetch 是现代 JavaScript 中进行网络请求的强大工具,它简洁的 API 和原生 Promise 支持使得开发者能够更方便地处理 HTTP 请求。然而,fetch 并没有原生支持请求超时功能。为了确保请求在一定时间内得到响应,尤其是在处理网络波动或响应延迟的情况下,我们通常需要为 fetch 手动添加超时控制。

在本文中,我将介绍如何为 fetch 添加超时功能,分析其实现的原理,常见的处理方式以及完整的示例代码。我们将讨论以下内容:

  1. fetch 请求的基本概念
  2. 为什么需要为 fetch 添加超时
  3. 使用 Promise.race 实现超时功能
  4. 基于 AbortController 优化超时处理
  5. 完整的代码示例和注意事项

1. fetch 请求的基本概念

fetch 是用于发起网络请求的 API,返回一个 Promise,可以处理 HTTP 请求和响应。通常,我们可以使用如下方式进行 GET 请求:

fetch('https://api.example.com/data')
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

这种方式虽然简洁,但是存在一个问题:如果服务器响应时间过长,fetch 会一直等待,直到收到响应或网络错误才会被拒绝。默认情况下,它不会因为超时而自动终止。

2. 为什么需要为 fetch 添加超时

在现代 Web 应用中,网络请求超时是非常常见的场景。比如:

  • 用户网络状态较差时,响应时间可能会过长。
  • 服务端出现问题,可能会导致响应异常缓慢。

为了提升用户体验,确保应用的响应性,我们通常希望请求在指定的时间内无响应时能自动中止。这种机制不仅可以避免用户长时间等待,还可以优化应用的资源使用。

3. 使用 Promise.race 实现超时功能

一种常见的实现超时的方法是使用 Promise.race,它可以并行执行多个 Promise,并返回第一个完成的 Promise 结果。我们可以构造一个基于超时的 Promise,与 fetch 竞争,达到超时控制的效果。

下面是一个示例,展示了如何使用 Promise.race 来实现超时功能:

function fetchWithTimeout(url, options = {}, timeout = 5000) {
  // 创建一个超时 Promise
  const timeoutPromise = new Promise((_, reject) =>
    setTimeout(() => reject(new Error('Request timed out')), timeout)
  );

  // 使用 Promise.race 处理超时
  return Promise.race([
    fetch(url, options),
    timeoutPromise
  ]);
}

// 使用示例
fetchWithTimeout('https://api.example.com/data', {}, 3000)
  .then(response => {
    if (!response.ok) {
      throw new Error('Network response was not ok');
    }
    return response.json();
  })
  .then(data => console.log('Data:', data))
  .catch(error => console.error('Error:', error));

解释

  • Promise.race 会同时运行 fetch 和 timeoutPromise。若 fetch 在超时之前完成,则返回其结果。若超时,则 timeoutPromise 会首先 reject,导致请求失败。
  • 这种方法虽然简单,但无法真正中止 fetch 请求。超时后 fetch 仍然会在后台继续执行,浪费网络资源。

4. 基于 AbortController 优化超时处理

AbortController 是一个可以中止正在进行中的 fetch 请求的 API。通过结合 AbortController 和超时机制,我们可以在超时后真正终止请求,而不仅仅是返回一个超时错误。

AbortController 的基本使用

const controller = new AbortController();
const signal = controller.signal;

fetch('https://api.example.com/data', { signal })
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => {
    if (error.name === 'AbortError') {
      console.error('Fetch aborted');
    } else {
      console.error('Fetch failed:', error);
    }
  });

// 在某个条件下中止请求
controller.abort();

结合 AbortController 和超时功能

通过将 AbortController 和 Promise.race 结合,我们可以在超时后中止请求:

function fetchWithTimeout(url, options = {}, timeout = 5000) {
  const controller = new AbortController();
  const signal = controller.signal;

  const timeoutPromise = new Promise((_, reject) =>
    setTimeout(() => {
      controller.abort(); // 超时后中止 fetch
      reject(new Error('Request timed out'));
    }, timeout)
  );

  return Promise.race([
    fetch(url, { ...options, signal }),
    timeoutPromise
  ]);
}

// 使用示例
fetchWithTimeout('https://api.example.com/data', {}, 3000)
  .then(response => {
    if (!response.ok) {
      throw new Error('Network response was not ok');
    }
    return response.json();
  })
  .then(data => console.log('Data:', data))
  .catch(error => console.error('Error:', error));

解释

  • 在 timeoutPromise 被触发时,AbortController 会中止 fetch 请求,释放网络资源。
  • 超时后,fetch 会被 AbortError 捕获到,我们可以在 .catch 中处理这个错误。

5. 完整的代码示例和注意事项

以下是一个完整的代码示例,展示了如何结合 Promise.race 和 AbortController 实现超时功能的 fetch 请求:

function fetchWithTimeout(url, options = {}, timeout = 5000) {
  const controller = new AbortController();
  const signal = controller.signal;

  const timeoutPromise = new Promise((_, reject) =>
    setTimeout(() => {
      controller.abort();
      reject(new Error('Request timed out'));
    }, timeout)
  );

  return Promise.race([
    fetch(url, { ...options, signal }),
    timeoutPromise
  ]);
}

// 调用 fetchWithTimeout 进行请求
fetchWithTimeout('https://api.example.com/data', {}, 3000)
  .then(response => {
    if (!response.ok) {
      throw new Error('Network response was not ok');
    }
    return response.json();
  })
  .then(data => console.log('Data:', data))
  .catch(error => {
    if (error.name === 'AbortError') {
      console.error('Fetch aborted');
    } else {
      console.error('Error:', error);
    }
  });

注意事项:

  1. 支持性:AbortController 在较旧的浏览器或某些环境中可能不被支持,开发者应检查其兼容性或提供 polyfill。
  2. 取消请求后处理:当请求被取消时,fetch 的 Promise 会抛出 AbortError,因此需要在错误处理中专门捕获此错误。
  3. 资源管理:当请求较多时,合理设置超时时间可以节约资源并提升用户体验。

结论

为 fetch 请求添加超时功能是提升用户体验的一个重要优化手段。虽然 fetch 并不直接支持超时,但通过 Promise.race 和 AbortController,我们可以轻松实现这一功能。合理设置超时可以避免应用程序陷入长期等待状态,并确保用户得到更快的响应反馈。

这种方式不仅可以用于网络请求,也适用于其他基于 Promise 的异步任务中。希望通过本文,读者能更好地理解如何在实际项目中应用超时控制,提升应用的稳定性和用户体验。

相关推荐

基于 Linux 快速搭建企业级 DNS 服务器(Bind9 ...

一、引言在大型企业网络或自建系统中,搭建一套高可用、自控的DNS解析服务器至关重要。本文将带你基于Linux环境,从零搭建企业级DNS服务平台,采用Bind9实战配置,确保解析稳定、安...

Linux无法解析域名的解决办法(linux无法解析域名的解决办法有哪些)

如果由于误操作,删除了系统原有的dhcp相关设置就无法正常解析域名。  此时,需要手动修改配置文件:  /etc/resolv.conf  将域名解析服务器手动添加到配置文件中  该文件是DNS域名解...

在centos7 创建基于域名的虚拟主机nginx服务器

直接用ip地址访问首先是不安全,其次不太容易记住,如果你的服务器上的项目有很多个,你创建多个基于Ip的虚拟主机,很容易导致公网ip冲突或乱用的情况。这时候我们就可以选择基于域名的虚拟主机。第一步、安装...

Linux之DNS服务(linux dnsserver)

一、学习路线如下二、DNS介绍1.域名的概念域名由特定的格式组成,用来表示互联网中某一台计算机或者计算机组的名称,能够使人更方便的访问互联网,而不用记住能够被机器直接读取的IP地址。2.DNS(dom...

Linux环境下DNS服务器配置图文详细教程

测试环境为vmware虚拟机下,linux系统为RedHatEnterpriseLinuxServer6.0(Santiago),内核版本Linux2.6.32-71.el6.i686...

构建基于 Linux 的高性能 DNS 服务器

在现代网络架构中,DNS(域名解析)是访问互联网的关键环节。搭建一个高性能、低延迟、可缓存加速的私有DNS服务器,不仅可以提升访问速度,还能增强网络隐私和安全性。本文将基于Linux系统,详细...

从运维的角度带你初识neo4j图形数据库的安装及配置

前言随着公司业务架构的改变,以前我部署环境的时候,一般只是部署Mysql,jdk,tomcat即可,现在还要部署一些nosql,如redis,neo4j,在之前从来没了解过,随着学习的深入而做了一些笔...

[超全整理] Java 程序员必备的 100 条 Linux 命令大全

一、基础操作(10条)#1.ls-查看目录内容ls-l#长格式显示文件和目录ls-a#显示隐藏文件ls-lh#带单位显示文件大小#2.cd-切换目录...

软件测试|一文教你轻松搭建docker环境

前言Docker提供轻量的虚拟化,你能够从Docker获得一个额外抽象层,你能够在单台机器上运行多个Docker微容器,而每个微容器里都有一个微服务或独立应用,例如你可以将Tomcat运行在一个Do...

docker基础知识/尚硅谷docker学习笔记

最近看了好多docker的资料,找了一些尚硅谷docker的教学视频,大概总结了一下前前后后的学习笔记。分享给大家。安装Docker的基本组成镜像Docker镜像(Image)就是一个只读的模板。镜...

前端_react项目从windows部署到centos

前言:从工程角度来讲,本地开发完就要把项目部署到生产环境,此过程的快慢也直接影响着整体的效率。所以也有很多人做持续集成的工作,例如:CI/CD/一键部署。但对于个人开发者而言,如果能有工具支撑是最好的...

Springboot项目使用docker部署(docker中运行springboot项目)

环境:SpringBoot2.2.10.RELEASE+Docker+Centos7+JDK8安装配置Dockeryum包更新到最新yumupdate卸载旧版本dockeryumre...

Spring Boot 3.x + Redis 7.x,轻松掌握Redisson分布式锁实战技巧

大家好,我是袁庭新。在分布式环境中,确保数据的一致性和正确性是至关重要的。对于需要高性能、高并发和分布式数据存储的应用程序来说,Redisson是一个很好的选择。同时,Redisson提供的分布式锁功...

Docker篇(二):Docker实战,命令解析

大家好,我是杰哥上周我们通过几个问题,让大家对于Docker有了一个全局的认识。然而,说跟练往往是两个概念。从学习的角度来说,理论知识的学习,往往只是第一步,只有经过实战,才能真正掌握一门技术所以,本...

新手快速入门Docker,轻松掌握Docker安装与使用

安装使用官方安装脚本自动安装curl-fsSLhttps://get.docker.com|bash-sdocker--mirrorAliyun手动安装CentOS7(使用yum进...

取消回复欢迎 发表评论: