blob: 98e161364bb10fad338cac68959c180e4d643851 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
---
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
---
<div>{{APIRef("DOM")}}{{SeeCompatTable}}</div>
<p><strong><code>AbortController</code></strong> 接口表示一个控制器对象，允许你根据需要中止一个或多个 Web 请求。</p>
<p>你可以使用 {{domxref("AbortController.AbortController()")}} 构造函数创建一个新的 <code>AbortController</code>。使用 {{domxref("AbortSignal")}} 对象可以完成与 DOM 请求的通信。</p>
<h2 id="构造函数">构造函数</h2>
<dl>
<dt>{{domxref("AbortController.AbortController()")}}</dt>
<dd><font>创建一个新的</font> <code>AbortController</code> <font>对象实例。</font></dd>
</dl>
<h2 id="属性">属性</h2>
<dl>
<dt>{{domxref("AbortController.signal")}} {{readonlyInline}}</dt>
<dd><font>返回一个</font> {{domxref("AbortSignal")}} <font>对象实例，</font>它可以用来 with/abort 一个 Web(网络)请求。</dd>
</dl>
<h2 id="方法">方法</h2>
<dl>
<dt>{{domxref("AbortController.abort()")}}</dt>
<dd>中止一个尚未完成的 Web(网络)请求。这能够中止 <a href="https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch">fetch</a> 请求及任何响应体的消费和流。</dd>
</dl>
<h2 id="示例">示例</h2>
<p><font>在下面的代码片段中，我们想通过</font> <a href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</a> 下载一段视频。</p>
<p><font>我们先使用</font> {{domxref("AbortController.AbortController","AbortController()")}} 构造函数<font>创建一个控制器，然后使用</font> {{domxref("AbortController.signal")}} 属性<font>获取其关联</font> {{domxref("AbortSignal")}} 对象的引用。</p>
<p>当一个 <a href="https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch">fetch request</a> 初始化，我们把 <code>AbortSignal</code> 作为一个选项传递到到请求对象（如下 <code>{ signal }</code>）。这将 <code>signal<code> 和 <code>controller<code> 与这个 <code>fetch request</code> 相关联，然后允许我们通过调用 {{domxref("AbortController.abort()")}} 中止请求，如下第二个事件监听函数。</p>
<pre class="brush: js notranslate">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;
})
}</pre>
<div class="note">
<p><strong>注意：</strong>当 <code>abort()</code> 被调用时，这个 <code>fetch()</code> promise 将 <code>reject</code> 一个名为 <code>AbortError</code> 的 <code>DOMException</code>。</p>
</div>
<p>您可以在 <a href="https://github.com/mdn/dom-examples/tree/master/abort-api">GitHub</a> 上找到这个示例的完整源代码(也可以<a href="https://mdn.github.io/dom-examples/abort-api/">在线运行</a>)。</p>
<h2 id="规范">规范</h2>
<table class="standard-table">
<tbody>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
<th scope="col">Comment</th>
</tr>
<tr>
<td>{{SpecName('DOM WHATWG', '#interface-abortcontroller', 'AbortController')}}</td>
<td>{{Spec2('DOM WHATWG')}}</td>
<td>Initial definition</td>
</tr>
</tbody>
</table>
<h2 id="浏览器兼容">浏览器兼容</h2>
<p>{{Compat("api.AbortController")}}</p>
<h2 id="参见">参见</h2>
<ul>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</a></li>
<li><a href="https://developers.google.com/web/updates/2017/09/abortable-fetch">Abortable Fetch</a> by Jake Archibald</li>
</ul>
<div id="gtx-trans" style="position: absolute; left: 542px; top: 1890px;">
<div class="gtx-trans-icon"></div>
</div>
|
