fetch() を使用すると、XMLHttpRequest（XHR）と同様にネットワーク リクエストを実行できます。主な違いは、Fetch API が Promise を使用する点です。Promise は API がシンプルで、XMLHttpRequest API の複雑なコールバックを回避できます。
Promise を初めて使用する場合は、JavaScript Promise の概要をご覧ください。
基本的な取得リクエスト
XMLHttpRequest と fetch で実装された例を次に示します。URL をリクエストし、レスポンスを取得して JSON として解析します。
XMLHttpRequest
XMLHttpRequest には、成功とエラーのケースを処理する 2 つのリスナーと、open() と send() の呼び出しが必要です。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(); フェッチ
取得リクエストは次のようになります。
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); }); fetch() リクエストは、XHR の例と同じ作業を行うために 1 回の呼び出しで済みます。レスポンスを処理するには、まずレスポンス ステータスが 200 であることを確認してから、レスポンスを JSON として解析します。fetch() リクエストに対するレスポンスは Stream オブジェクトです。つまり、json() メソッドを呼び出した後、Promise が返されます。ストリームは非同期で発生します。
レスポンス メタデータ
前の例では、Response オブジェクトのステータスと、レスポンスを JSON として解析する方法を示しました。ヘッダーなど、アクセスする必要がある他のメタデータを処理する方法は次のとおりです。
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); }); レスポンス タイプ
取得リクエストを行うと、レスポンスに response.type「basic」、「cors」、「opaque」が付与されます。これらの types はリソースの取得元を示し、レスポンス オブジェクトの処理方法を決定するために使用できます。
ブラウザが同じオリジンのリソースをリクエストすると、レスポンスのタイプは basic になり、レスポンスから表示できる内容が制限されます。
別のオリジンのリソースに対してリクエストが送信され、そのオリジンが CORs ヘッダーを返す場合、タイプは cors です。cors レスポンスは basic レスポンスに似ていますが、表示できるヘッダーが Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma に制限されています。
opaque レスポンスは、CORS ヘッダーを返さない別のオリジンから送信されます。不透明なレスポンスでは、返されたデータを読み取ったり、リクエストのステータスを確認したりできないため、リクエストが成功したかどうかを確認できません。
特定のリクエスト タイプのみが解決されるように、フェッチ リクエストのモードを定義できます。設定できるモードは次のとおりです。
same-originは、同じオリジンのアセットのリクエストでのみ成功し、他のすべてのリクエストを拒否します。corsは、適切な CORS ヘッダーを返す同じオリジンと他のオリジンのアセットのリクエストを許可します。cors-with-forced-preflightは、リクエストを送信する前にプリフライト チェックを実行します。no-corsは、CORS ヘッダーのない他のオリジンにリクエストを行い、opaqueレスポンスを返すことを目的としていますが、前述のように、現時点ではウィンドウのグローバル スコープでこれを行うことはできません。
モードを定義するには、fetch リクエストの 2 番目のパラメータとしてオプション オブジェクトを追加し、そのオブジェクトでモードを定義します。
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) }); Promise の連鎖
Promise の優れた機能の 1 つは、Promise を連鎖できることです。fetch() の場合、フェッチ リクエスト間でロジックを共有できます。
JSON API を使用している場合は、ステータスを確認し、各レスポンスを JSON で解析する必要があります。ステータスと JSON 解析を Promise を返す別の関数で定義し、フェッチ リクエストを使用して最終データとエラーケースのみを処理することで、コードを簡素化できます。
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); }); この例では、response.status を確認し、解決された Promise を Promise.resolve() として、または拒否された Promise を Promise.reject() として返す status 関数を定義します。これは、fetch() チェーンで最初に呼び出されるメソッドです。
Promise が解決すると、スクリプトは json() メソッドを呼び出します。このメソッドは、response.json() 呼び出しから 2 番目の Promise を返して、解析された JSON を含むオブジェクトを作成します。解析に失敗した場合、Promise は拒否され、catch ステートメントが実行されます。
この構造により、すべての取得リクエストでロジックを共有できるため、コードのメンテナンス、読み取り、テストが容易になります。
POST リクエスト
ウェブアプリで POST メソッドを使用して API を呼び出し、リクエストの本文にパラメータを追加する必要がある場合があります。これを行うには、fetch() オプションで method パラメータと body パラメータを設定します。
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); }); 取得リクエストで認証情報を送信する
Cookie などの認証情報を使用して取得リクエストを行うには、リクエストの credentials 値を "include" に設定します。
fetch(url, { credentials: 'include' })