fetch() umożliwia wysyłanie żądań sieciowych podobnych do XMLHttpRequest (XHR). Główna różnica polega na tym, że interfejs Fetch API używa obiektów Promise, które mają prostszy interfejs API, co pozwala uniknąć skomplikowanych wywołań zwrotnych w interfejsie XMLHttpRequest API.
Jeśli nie masz doświadczenia z obiektami Promise, zapoznaj się z wprowadzeniem do obiektów Promise w języku JavaScript.
Podstawowe żądanie pobierania
Oto przykład implementacji z użyciem XMLHttpRequest, a następnie fetch. Chcemy wysłać żądanie adresu URL, otrzymać odpowiedź i przeanalizować ją jako JSON.
XMLHttpRequest
XMLHttpRequest wymaga 2 detektorów do obsługi przypadków powodzenia i błędu oraz wywołania open() i send().
Przykład z dokumentacji MDN
function reqListener () {
const data = JSON.parse(this.responseText);
console.log(data);
}
function reqError (err) {
console.log('Fetch Error :-S', err);
}
const oReq = new XMLHttpRequest();
oReq.onload = reqListener;
oReq.onerror = reqError;
oReq.open('get', './api/some.json', true);
oReq.send();
Pobierz
Żądanie pobrania wygląda tak:
fetch('./api/some.json')
.then(response => {
if (response.status !== 200) {
console.log(`Looks like there was a problem. Status Code: ${response.status}`);
return;
}
// Examine the text in the response
response.json().then(function(data) {
console.log(data);
});
})
.catch(err => {
console.log('Fetch Error :-S', err);
});
Żądanie fetch() wymaga tylko jednego wywołania, aby wykonać to samo zadanie co w przykładzie z XHR. Aby przetworzyć odpowiedź, najpierw sprawdzamy, czy jej stan to 200, a następnie analizujemy ją jako JSON. Odpowiedzią na żądanie fetch() jest obiekt Stream, co oznacza, że po wywołaniu metody json() zwracany jest obiekt Promise.
Strumień jest przesyłany asynchronicznie.
Metadane odpowiedzi
W poprzednim przykładzie pokazaliśmy stan obiektu Response i sposób analizowania odpowiedzi jako JSON. Oto jak postępować z innymi metadanymi, do których możesz chcieć uzyskać dostęp, takimi jak nagłówki:
fetch('users.json').then(response => {
console.log(response.headers.get('Content-Type'));
console.log(response.headers.get('Date'));
console.log(response.status);
console.log(response.statusText);
console.log(response.type);
console.log(response.url);
});
Typy odpowiedzi
Gdy wysyłamy żądanie pobrania, odpowiedź otrzymuje response.type „basic”, „cors” lub „opaque”.
Te types pokazują, skąd pochodzi zasób, i możesz ich użyć do określenia, jak traktować obiekt odpowiedzi.
Gdy przeglądarka żąda zasobu z tego samego źródła, odpowiedź ma typ basic z ograniczeniami dotyczącymi tego, co można wyświetlić z odpowiedzi.
Jeśli żądanie dotyczy zasobu w innym źródle, a to źródło zwraca nagłówki CORS, typem jest cors. cors
Odpowiedzi są podobne do odpowiedzi basic, ale ograniczają nagłówki, które możesz wyświetlać, do Cache-Control, Content-Language, Content-Type, Expires, Last-Modified i Pragma.
Odpowiedzi opaque pochodzą z innego źródła, które nie zwraca nagłówków CORS. W przypadku nieprzezroczystej odpowiedzi nie będziemy mogli odczytać zwróconych danych ani wyświetlić stanu żądania, co oznacza, że nie będzie można sprawdzić, czy żądanie zostało zrealizowane.
Możesz zdefiniować tryb żądania pobrania, aby rozwiązywane były tylko określone typy żądań. Możesz ustawić te tryby:
same-origindziała tylko w przypadku żądań dotyczących zasobów z tego samego źródła i odrzuca wszystkie inne żądania.corszezwala na żądania dotyczące zasobów z tego samego źródła i innych źródeł, które zwracają odpowiednie nagłówki CORS.cors-with-forced-preflightwykonuje kontrolę wstępną przed wysłaniem żądania.no-corsma wysyłać żądania do innych źródeł, które nie mają nagłówków CORS, i zwracać odpowiedźopaque, ale jak wspomniano, nie jest to obecnie możliwe w zakresie globalnym okna.
Aby zdefiniować tryb, dodaj obiekt opcji jako drugi parametr w żądaniu fetch i zdefiniuj tryb w tym obiekcie:
fetch('http://some-site.com/cors-enabled/some.json', {mode: 'cors'})
.then(response => response.text())
.then(text => {
console.log('Request successful', text);
})
.catch(error => {
log('Request failed', error)
});
Łączenie obietnic
Jedną z najlepszych cech obietnic jest możliwość ich łączenia. W przypadku fetch() umożliwia to udostępnianie logiki między żądaniami pobierania.
Jeśli pracujesz z interfejsem JSON API, musisz sprawdzić stan i przeanalizować kod JSON każdej odpowiedzi. Możesz uprościć kod, definiując stan i analizę JSON w osobnych funkcjach, które zwracają obietnice, i używając żądania pobrania do obsługi tylko ostatecznych danych i przypadku błędu.
function status (response) {
if (response.status >= 200 && response.status < 300) {
return Promise.resolve(response)
} else {
return Promise.reject(new Error(response.statusText))
}
}
function json (response) {
return response.json()
}
fetch('users.json')
.then(status)
.then(json)
.then(data => {
console.log('Request succeeded with JSON response', data);
}).catch(error => {
console.log('Request failed', error);
});
W tym przykładzie zdefiniowano funkcję status, która sprawdza response.status i zwraca rozwiązany obiekt Promise jako Promise.resolve() lub odrzucony obiekt Promise jako Promise.reject().
Jest to pierwsza metoda wywoływana w łańcuchu fetch().
Jeśli obiekt Promise zostanie rozwiązany, skrypt wywoła metodę json(), która zwraca drugi obiekt Promise z wywołania response.json() i tworzy obiekt zawierający przeanalizowany kod JSON. Jeśli analiza się nie powiedzie, obiekt Promise zostanie odrzucony i zostanie wykonana instrukcja catch.
Taka struktura pozwala udostępniać logikę we wszystkich żądaniach pobierania, co ułatwia utrzymanie, odczytywanie i testowanie kodu.
żądanie POST
Czasami aplikacja internetowa musi wywołać interfejs API za pomocą metody POST i uwzględnić w treści żądania pewne parametry. Aby to zrobić, ustaw parametry method i body w opcjach fetch():
fetch(url, {
method: 'post',
headers: {
"Content-type": "application/x-www-form-urlencoded; charset=UTF-8"
},
body: 'foo=bar&lorem=ipsum'
})
.then(json)
.then(data => {
console.log('Request succeeded with JSON response', data);
})
.catch(error => {
console.log('Request failed', error);
});
Wysyłanie danych logowania z żądaniem pobrania
Aby wysłać żądanie pobrania z danymi logowania, takimi jak pliki cookie, ustaw wartość credentials żądania na "include":
fetch(url, {
credentials: 'include'
})