AbortController 取消请求

change_fate2025-05-05 8:45

‌AbortController‌是JavaScript中的一个全局类，主要用于中止各种异步操作，包括网络请求、事件监听器、可写流和数据库事务等。通过提供一个AbortSignal对象，AbortController允许开发者在需要时自由地终止这些操作，避免不必要的开销或冗长的等待‌

基本用法

‌创建AbortController实例‌：通过new AbortController()创建一个控制器实例。

‌获取signal对象‌：通过controller.signal获取一个AbortSignal对象，该对象可以传递给需要中止的API。

‌中止操作‌：调用controller.abort()方法会触发与该控制器关联的所有操作的中止。可选地，可以传递一个原因或错误给abort()方法，以便进行更细粒度的处理‌

常见使用场景

‌网络请求‌：在发起fetch请求时，可以将AbortController的signal对象作为fetch选项的第二个参数，从而可以在需要时通过调用abort()方法来取消请求‌

‌事件监听器‌：在添加事件监听器时，可以将signal对象作为选项传递给addEventListener，这样当调用abort()方法时，所有绑定到该信号的事件监听器都会被触发中止事件‌

‌定时器和间隔调用‌：在设置定时器或间隔调用时，可以将signal对象传递给相关函数，从而可以在需要时通过调用abort()方法来取消定时器或间隔调用‌

示例代码

以下是一个使用AbortController中止fetch请求的示例代码：

javascript 复制代码

async function fetchWithTimeout(url, timeout = 5000) {
  const controller = new AbortController();
  const signal = controller.signal;
  const timeoutId = setTimeout(() => controller.abort(), timeout);
  try {
    const response = await fetch(url, { signal });
    clearTimeout(timeoutId);
    return await response.json();
  } catch (error) {
    if (error.name === 'AbortError') {
      console.log('请求被中止');
    } else {
      console.error('请求失败', error);
    }
  }
}

在这个示例中，我们创建了一个AbortController实例，并将其signal对象传递给fetch选项。如果超过指定的超时时间，定时器会调用abort()方法中止fetch请求‌