AbortController

用法解释

  AbortController 接口表示一个控制器对象，允许你根据需要中止一个或多个 Web 请求。可以使用AbortController.AbortController()构造函数创建一个新的 AbortController 。使用AbortSignal对象可以完成与 DOM 请求的通信。

  构造函数

AbortController.AbortController()

创建一个新的 AbortController 对象实例。

  属性

AbortController.signal (en-US) 只读

返回一个 AbortSignal 对象实例，它可以用来 with/abort 一个 Web(网络) 请求。

  方法

AbortController.abort()

中止一个尚未完成的 Web(网络) 请求。这能够中止 fetch 请求及任何响应体的消费和流。

用例

在下面的代码片段中，我们想通过 Fetch API 下载一段视频。

我们先使用 AbortController() 构造函数创建一个控制器，然后使用 AbortController.signal (en-US) 属性获取其关联 AbortSignal 对象的引用。

当一个 fetch request 初始化，我们把 AbortSignal 作为一个选项传递到到请求对象（如下 { signal }）。这将 signal 和 controller 与这个 fetch request 相关联，然后允许我们通过调用 AbortController.abort() 中止请求，如下第二个事件监听函数。

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

const downloadBtn = document.querySelector('.download');
const abortBtn = document.querySelector('.abort');

downloadBtn.addEventListener('click', fetchVideo);

abortBtn.addEventListener('click', function() {
  controller.abort();
  console.log('Download aborted');
});

function fetchVideo() {
  //...
  fetch(url, {signal}).then(function(response) {
    //...
  }).catch(function(e) {
    reports.textContent = 'Download error: ' + e.message;
  })
}