--- title: AbortController slug: Web/API/AbortController tags: - API - AbortController - Fetch - how to cancel a fetch request translation_of: Web/API/AbortController original_slug: Web/API/FetchController ---
{{APIRef("DOM")}}{{SeeCompatTable}}

AbortController接口表示一个控制器对象，允许你根据需要中止一个或多个 Web请求。

你可以使用 {{domxref("AbortController.AbortController()")}} 构造函数创建一个新的 AbortController 。使用{{domxref("AbortSignal")}} 对象可以完成与与DOM请求的通信。

构造函数

{{domxref("AbortController.AbortController()")}}
创建一个新的AbortController 对象实例。

属性

{{domxref("AbortController.signal")}} {{readonlyInline}}
返回一个{{domxref("AbortSignal")}}对象实例，它可以用来 with/abort 一个Web(网络)请求。

方法

{{domxref("AbortController.abort()")}}
中止一个尚未完成的Web(网络)请求。这能够中止fetch 请求，任何响应{{domxref("Body")}}的消费者和流。

示例

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

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

当一个 fetch request 初始化，我们把 AbortSignal 作为一个选项传递到到请求对象（如下 {signal}）。这将信号和控制器与获取请求相关联然后允许我们通过调用{{domxref("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;
  })
}

注意：当abort() 被调用时，fetch() promise 拒绝一个名为 AbortError 的DOMException 。

可以在GitHub上找到完整的工作示例 — 请参见 abort-api（另请参见实时运行）。

规范

Specification Status Comment
{{SpecName('DOM WHATWG', '#interface-abortcontroller', 'AbortController')}} {{Spec2('DOM WHATWG')}} Initial definition

浏览器兼容

{{Compat("api.AbortController")}}

参见