当前位置：首页 > news >正文

JavaScript 中的 AbortController

news 来源：原创 2025/5/5 18:05:55

AbortController 接口是 JavaScript 中 Fetch API 的一部分，引入它是为了处理和控制中止 fetch 请求的信号。这在需要取消正在进行的网络请求时特别有用，例如用户发起的动作取消，通过避免不必要的请求来提高性能，或优雅地处理超时。在本文中，我们将探索 AbortController 的工作原理、其优势以及实际使用场景。

什么是 AbortController？

AbortController 是一个允许你根据需要中止一个或多个 Web 请求的对象。它主要由两个部分组成：

AbortController：用于创建一个可以发出中止信号的对象。
AbortSignal：这是一个信号实例，用于与 fetch 请求关联，当发出中止信号时，该信号会通知关联的请求。

AbortController 的基本用法

下面是一个基本的使用示例，展示了如何使用 AbortController 来中止一个 fetch 请求：

// 创建一个 AbortController 实例
const controller = new AbortController();

// 获取与这个控制器关联的信号对象
const signal = controller.signal;

// 开始一个 fetch 请求，并将信号对象传递给请求
fetch('https://api.example.com/data', { signal })
  .then(response => {
    return response.json();
  })
  .then(data => {
    console.log(data);
  })
  .catch(error => {
    if (error.name === 'AbortError') {
      console.log('请求被中止');
    } else {
      console.error('请求失败', error);
    }
  });

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

在这个示例中，我们首先创建了一个 AbortController 实例，并从中获取了一个 AbortSignal 对象。然后，我们在 fetch 请求中传递这个信号对象。当调用 controller.abort() 时，请求会被中止，并抛出一个 AbortError 异常。

AbortController 的实际应用场景

用户取消操作：
在用户界面中，用户可能会中途取消一个操作，例如文件上传或表单提交。在这种情况下，使用 AbortController 可以立即中止相关的网络请求，提供更好的用户体验。
性能优化：
在某些情况下，可以发出多个请求以获取数据，但只需要第一个响应的数据。此时，可以在获取到第一个响应后中止其他请求，从而减少不必要的网络流量和资源消耗。

处理超时：
使用 AbortController 可以更好地管理请求超时。可以在设置一个超时时间，到达超时时间后自动中止请求。

const controller = new AbortController();
const timeoutId = setTimeout(() => controller.abort(), 5000); // 5 秒后中止请求

fetch('https://api.example.com/data', { signal: controller.signal })
  .then(response => response.json())
  .then(data => {
    clearTimeout(timeoutId); // 清除超时定时器
    console.log(data);
  })
  .catch(error => {
    if (error.name === 'AbortError') {
      console.log('请求超时并被中止');
    } else {
      console.error('请求失败', error);
    }
  });