AbortController 中止一个或多个Web请求
AbortController 接口表示一个控制器对象,允许你根据需要中止一个或多个 Web 请求。
你可以使用 AbortController.AbortController() 构造函数创建一个新的 AbortController 。使用 AbortSignal 对象可以完成与 DOM 请求的通信。
用法介绍
1、构造函数
AbortController.AbortController()
创建一个新的 AbortController 对象实例。
2、属性
AbortController.signal 只读
返回一个 AbortSignal 对象实例,它可以用来 with/abort 一个 Web (网络)请求。
3、方法
AbortController.abort()
中止一个尚未完成的 Web (网络)请求。这能够中止 fetch 请求,任何响应 Body 的消费者和流。
快速上手
AbortController API 很简单:它暴露的 AbortSignal 是可以插入到我们的 fetch 中处理,就像这样:
const abortController = new AbortController()
const signal = abortController.signal
fetch(url, { signal })
在下面的代码片段中,我们想通过 Fetch API 下载一段视频。
我们先使用 AbortController() 构造函数创建一个控制器,然后使用 AbortController.signal 属性获取其关联 AbortSignal 对象的引用。
当一个 fetch request 初始化,我们把 AbortSignal 作为一个选项传递到到请求对象(如下 {signal})。这将信号和控制器与获取请求相关联然后允许我们通过调用 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 。这是一个实验中的功能,有可能被修改,还未标准化,建议不要在生产环境中使用。