如何取消 HTTP fetch() 请求?

IT技术 javascript ajax fetch-api
2021-01-27 04:10:10

有一个用于从 JavaScript 发出请求的新 API:fetch(). 是否有任何内置机制可以取消这些正在进行的请求?

6个回答

TL/DR:

fetch现在支持signal截至 2017 年 9 月 20 日参数,但目前似乎并非所有浏览器都支持此参数

2020 更新:大多数主要浏览器(Edge、Firefox、Chrome、Safari、Opera 和其他一些浏览器)都支持该功能,该功能已成为DOM 生活标准的一部分(截至 2020 年 3 月 5 日)

这是我们很快就会看到的更改,因此您应该能够使用AbortControllers取消请求AbortSignal

长版

如何:

它的工作方式是这样的:

第 1 步:您创建一个AbortController(现在我只使用了这个

const controller = new AbortController()

第 2 步:您会AbortController像这样获得s 信号:

const signal = controller.signal

第 3 步:您通过signalfetch 像这样:

fetch(urlToFetch, {
    method: 'get',
    signal: signal, // <------ This is our AbortSignal
})

第 4 步:只需在需要时中止即可:

controller.abort();

这是它如何工作的示例(适用于 Firefox 57+):

<script>
    // Create an instance.
    const controller = new AbortController()
    const signal = controller.signal

    /*
    // Register a listenr.
    signal.addEventListener("abort", () => {
        console.log("aborted!")
    })
    */


    function beginFetching() {
        console.log('Now fetching');
        var urlToFetch = "https://httpbin.org/delay/3";

        fetch(urlToFetch, {
                method: 'get',
                signal: signal,
            })
            .then(function(response) {
                console.log(`Fetch complete. (Not aborted)`);
            }).catch(function(err) {
                console.error(` Err: ${err}`);
            });
    }


    function abortFetching() {
        console.log('Now aborting');
        // Abort.
        controller.abort()
    }

</script>



<h1>Example of fetch abort</h1>
<hr>
<button onclick="beginFetching();">
    Begin
</button>
<button onclick="abortFetching();">
    Abort
</button>

资料来源:

但现在它不适用于其他浏览器,即 Chrome,因为AbortController is not defined. 无论如何,这只是一个概念证明,至少使用 Firefox 57+ 的人可以看到它在工作
2021-03-21 04:10:10
这是纯 StackOverflow 黄金,感谢简洁的文章!还有 bugtracker 链接!
2021-03-23 04:10:10
这个答案是正确的,应该赞成。但是我冒昧地对代码片段进行了一些编辑,因为它实际上并没有在 Firefox 57+ 中工作——垫片似乎导致它失败(“错误:类型错误:RequestInit 的‘信号’成员没有实现接口 AbortSignal。”),而且对于slowwly.robertomurray.co.uk的证书似乎存在一些问题“该服务器无法证明它是 slowwly.robertomurray.co.uk;它的安全证书来自 * .herokuapp.com.”),所以我把它改成只使用slowwly.robertomurray.co.uk(普通http)。
2021-03-27 04:10:10
现在所有现代浏览器都支持它。developer.mozilla.org/en-US/docs/Web/API/AbortController/abort见底部表格
2021-04-02 04:10:10
谢谢,但我还有一个问题,我们是否应该手动将信号改回 true 以便下次获取?
2021-04-08 04:10:10

https://developers.google.com/web/updates/2017/09/abortable-fetch

https://dom.spec.whatwg.org/#aborting-ongoing-activities

// setup AbortController
const controller = new AbortController();
// signal to pass to fetch
const signal = controller.signal;

// fetch as usual
fetch(url, { signal }).then(response => {
  ...
}).catch(e => {
  // catch the abort if you like
  if (e.name === 'AbortError') {
    ...
  }
});

// when you want to abort
controller.abort();

适用于 edge 16 (2017-10-17), firefox 57 (2017-11-14), desktop safari 11.1 (2018-03-29), ios safari 11.4 (2018-03-29), chrome 67 (2018-05) -29),以及以后。


在较旧的浏览器上,您可以使用github 的 whatwg-fetch polyfillAbortController polyfill您也可以检测较旧的浏览器并有条件地使用 polyfill

import 'abortcontroller-polyfill/dist/abortcontroller-polyfill-only'
import {fetch} from 'whatwg-fetch'

// use native browser implementation if it supports aborting
const abortableFetch = ('signal' in new Request('')) ? window.fetch : fetch
@FábioSantos 您的评论应该是针对该问题,还是作为其本身的答案?它看起来并不特定于我的答案。
2021-03-11 04:10:10
如果使用 github 的 fetch polyfill,可以使用它,只需按照他们的自述文件中的说明进行操作:github.com/github/fetch#aborting-requests
2021-03-15 04:10:10
只是对使用 github fetch polyfill 的人的一个说明。我认为这与您的答案有关,因为 AFAIK 它是最流行的 fetch polyfill 可用,并且它填充了您正在使用的函数 fetch。由于旧的浏览器,很多人会使用这个 polyfill。我发现提一下很重要,因为人们只是假设 polyfill 可以解决所有问题,但这个特定的人并没有尝试对 AbortController 进行 polyfill。他们会尝试使用 AbortController 认为它会在旧浏览器中被填充,然后繁荣,在极端情况下有一个例外,并且只在旧浏览器上。
2021-03-27 04:10:10

截至 2018 年 2 月,fetch()可以在 Chrome 上使用以下代码取消(阅读使用可读流以启用 Firefox 支持)。没有错误被抛出catch(),这是一个临时解决方案,直到AbortController被完全采用。

fetch('YOUR_CUSTOM_URL')
.then(response => {
  if (!response.body) {
    console.warn("ReadableStream is not yet supported in this browser.  See https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream")
    return response;
  }

  // get reference to ReadableStream so we can cancel/abort this fetch request.
  const responseReader = response.body.getReader();
  startAbortSimulation(responseReader);

  // Return a new Response object that implements a custom reader.
  return new Response(new ReadableStream(new ReadableStreamConfig(responseReader)));
})
.then(response => response.blob())
.then(data => console.log('Download ended. Bytes downloaded:', data.size))
.catch(error => console.error('Error during fetch()', error))


// Here's an example of how to abort request once fetch() starts
function startAbortSimulation(responseReader) {
  // abort fetch() after 50ms
  setTimeout(function() {
    console.log('aborting fetch()...');
    responseReader.cancel()
    .then(function() {
      console.log('fetch() aborted');
    })
  },50)
}


// ReadableStream constructor requires custom implementation of start() method
function ReadableStreamConfig(reader) {
  return {
    start(controller) {
      read();
      function read() {
        reader.read().then(({done,value}) => {
          if (done) {
            controller.close();
            return;
          }
          controller.enqueue(value);
          read();
        })
      }
    }
  }
}
这不是 OP 所要求的。他们想取消读取而不是读取器。Fetch 的Promise直到请求完成后才会解析,这对于取消对服务器的请求为时已晚。
2021-03-14 04:10:10

至于现在没有适当的解决方案,正如@spro 所说。

但是,如果您有一个进行中的响应并且正在使用 ReadableStream,您可以关闭流以取消请求。

fetch('http://example.com').then((res) => {
  const reader = res.body.getReader();

  /*
   * Your code for reading streams goes here
   */

  // To abort/cancel HTTP request...
  reader.cancel();
});

让我们填充:

if(!AbortController){
  class AbortController {
    constructor() {
      this.aborted = false;
      this.signal = this.signal.bind(this);
    }
    signal(abortFn, scope) {
      if (this.aborted) {
        abortFn.apply(scope, { name: 'AbortError' });
        this.aborted = false;
      } else {
        this.abortFn = abortFn.bind(scope);
      }
    }
    abort() {
      if (this.abortFn) {
        this.abortFn({ reason: 'canceled' });
        this.aborted = false;
      } else {
        this.aborted = true;
      }
    }
  }

  const originalFetch = window.fetch;

  const customFetch = (url, options) => {
    const { signal } = options || {};

    return new Promise((resolve, reject) => {
      if (signal) {
        signal(reject, this);
      }
      originalFetch(url, options)
        .then(resolve)
        .catch(reject);
    });
  };

  window.fetch = customFetch;
}

请记住,代码未经测试!让我知道您是否已经测试过它并且某些东西不起作用。它可能会警告您尝试覆盖 JavaScript 官方库中的 'fetch' 函数。