Istnieje nowy interfejs API do wysyłania żądań z JavaScript: fetch (). Czy istnieje wbudowany mechanizm anulowania tych żądań podczas lotu?

TL / DR:

fetchobsługuje teraz signalparametr od 20 września 2017 r., ale obecnie nie wszystkie przeglądarki obsługują ten parametr .

AKTUALIZACJA 2020: Większość głównych przeglądarek (Edge, Firefox, Chrome, Safari, Opera i kilka innych) obsługuje tę funkcję , która stała się częścią standardu DOM . (od 5 marca 2020 r.)

Jest to zmiana, którą wkrótce zobaczymy, więc powinieneś być w stanie anulować żądanie za pomocą AbortControllers AbortSignal.

Długa wersja

Jak:

Sposób działania jest następujący:

Krok 1 : Tworzysz AbortController(na razie właśnie tego użyłem )

const controller = new AbortController()

Krok 2 : Otrzymasz AbortControllersygnał s w ten sposób:

const signal = controller.signal

Krok 3 : Przekazujesz signaldo pobrania tak:

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

Krok 4 : Porzuć, gdy tylko chcesz:

controller.abort();

Oto przykład jego działania (działa w przeglądarce 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>

Źródła:

• Ostateczna wersja AbortController została dodana do specyfikacji DOM
• Odpowiada PR do określenia zwrcania połączą.
• Błędy przeglądarki śledzące implementację AbortController są dostępne tutaj: Firefox: # 1378342 , Chromium: # 750599 , WebKit: # 174980 , Edge: # 13009916 .

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();

działa w Edge 16 (2017-10-17), Firefox 57 (14.11.2017), Desktop Safari 11.1 (2018-03-29), iOS Safari 11.4 (2018-03-29), Chrome 67 (2018-05 -29) i później.

w starszych przeglądarkach możesz używać wielopełniacza github whatwg-fetch i wielopełniacza AbortController . możesz wykrywać starsze przeglądarki i warunkowo korzystać z wypełniaczy :

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

Od lutego 2018 r. fetch()Można go anulować za pomocą poniższego kodu w Chrome (przeczytaj Korzystanie z czytelnych strumieni, aby włączyć obsługę przeglądarki Firefox). Błąd nie jest zgłaszany catch()do odebrania, a jest to rozwiązanie tymczasowe, dopóki nie AbortControllerzostanie w pełni przyjęte.

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();
        })
      }
    }
  }
}

Na razie nie ma właściwego rozwiązania, jak mówi @spro.

Jeśli jednak masz odpowiedź w locie i używasz ReadableStream, możesz zamknąć strumień, aby anulować żądanie.

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();
});

Let's polyfill:

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;
}

Pamiętaj, że kod nie jest testowany! Daj mi znać, jeśli go przetestowałeś i coś nie działało. Może wyświetlać ostrzeżenia, że ​​próbujesz zastąpić funkcję „pobierania” z oficjalnej biblioteki JavaScript.