Cache API: クイックガイド

Cache API を使用して、アプリケーション データをオフラインで使用可能にする方法について説明します。

Cache API は、ネットワーク リクエストとそれに対応するレスポンスを保存および取得するためのシステムです。アプリケーションの実行中に作成される定期的なリクエストやレスポンスの場合もあれば、後で使用するためにデータを保存することのみを目的として作成される場合もあります。

Cache API は、Service Worker がネットワーク リクエストをキャッシュに保存し、ネットワークの速度や可用性に関係なく迅速なレスポンスを提供できるように作成されました。ただし、この API は一般的なストレージ メカニズムとして使用することもできます。

どこで利用できますか?

Cache API は最新のすべてのブラウザで使用できます。これはグローバル caches プロパティを介して公開されるため、シンプルな特徴検出で API の有無をテストできます。

const cacheAvailable = 'caches' in self;

対応ブラウザ

  • 40
  • 16
  • 41
  • 11.1

ソース

Cache API には、ウィンドウ、iframe、ワーカー、Service Worker のいずれかからアクセスできます。

保存できるデータ

キャッシュには、HTTP リクエストとレスポンスをそれぞれ表す Request オブジェクトと Response オブジェクトのペアのみが格納されます。ただし、リクエストとレスポンスには、HTTP 経由で転送できるあらゆる種類のデータを含めることができます。

保存できる容量

少なくとも数百 GB、場合によっては数百 GB 以上になります。ブラウザの実装はさまざまですが、利用可能なストレージ容量は通常、デバイスで使用可能なストレージ容量によって異なります。

キャッシュの作成とオープン

キャッシュを開くには、caches.open(name) メソッドを使用して、キャッシュの名前を単一のパラメータとして渡します。名前付きキャッシュが存在しない場合は作成されます。このメソッドは、Cache オブジェクトで解決される Promise を返します。

const cache = await caches.open('my-cache');
// do something with cache...

キャッシュへの追加

キャッシュにアイテムを追加するには、addaddAllput の 3 つの方法があります。3 つのメソッドはすべて Promise を返します。

cache.add

まず、cache.add() があります。このメソッドは、Request または URL(string)のいずれかのパラメータを取ります。ネットワークに対してリクエストを行い、レスポンスをキャッシュに保存します。取得が失敗した場合、またはレスポンスのステータス コードが 200 の範囲外の場合、何も保存されず、Promise は拒否します。CORS モードでないクロスオリジン リクエストは、0status を返すため、保存できません。このようなリクエストは、put でのみ保存できます。

// Retreive data.json from the server and store the response.
cache.add(new Request('/data.json'));

// Retreive data.json from the server and store the response.
cache.add('/data.json');

cache.addAll

次は、cache.addAll() です。機能は add() と似ていますが、Request オブジェクトまたは URL(string)の配列を受け取ります。これは、個々のリクエストで cache.add を呼び出す場合と同様に機能しますが、単一のリクエストがキャッシュに保存されていない場合、Promise は拒否します。

const urls = ['/weather/today.json', '/weather/tomorrow.json'];
cache.addAll(urls);

いずれの場合も、一致する既存のエントリが新しいエントリによって上書きされます。これには、retrievingのセクションで説明したものと同じマッチング ルールを使用します。

cache.put

最後に、cache.put() があり、ネットワークからのレスポンスの保存や、独自の Response の作成と保存ができます。これは 2 つのパラメータを取ります。1 つ目は Request オブジェクトまたは URL(string)です。2 つ目は、ネットワークから生成された、またはコードによって生成された Response です。

// Retrieve data.json from the server and store the response.
cache.put('/data.json');

// Create a new entry for test.json and store the newly created response.
cache.put('/test.json', new Response('{"foo": "bar"}'));

// Retrieve data.json from the 3rd party site and store the response.
cache.put('https://example.com/data.json');

put() メソッドは、add()addAll() よりも制限が緩く、非 CORS レスポンス、またはレスポンスのステータス コードが 200 の範囲外のレスポンスを保存できます。これにより、同じリクエストに対する以前のレスポンスが上書きされます。

Request オブジェクトの作成

保存対象の URL を使用して Request オブジェクトを作成します。

const request = new Request('/my-data-store/item-id');

Response オブジェクトを操作する

Response オブジェクト コンストラクタは、BlobArrayBufferFormData オブジェクト、文字列など、多くの種類のデータを受け入れます。

const imageBlob = new Blob([data], {type: 'image/jpeg'});
const imageResponse = new Response(imageBlob);
const stringResponse = new Response('Hello world');

適切なヘッダーを設定することで、Response の MIME タイプを設定できます。

  const options = {
    headers: {
      'Content-Type': 'application/json'
    }
  }
  const jsonResponse = new Response('{}', options);

Response を取得済みで、その本文にアクセスしたい場合、使用できるヘルパー メソッドがいくつかあります。それぞれが異なる型の値で解決される Promise を返します。

メソッド 説明
arrayBuffer バイトにシリアル化された本文を含む ArrayBuffer を返します。
blob Blob を返します。ResponseBlob で作成された場合、この新しい Blob も同じ型になります。それ以外の場合は、ResponseContent-Type が使用されます。
text 本文のバイトを UTF-8 でエンコードされた文字列として解釈します。
json 本文のバイトを UTF-8 エンコード文字列として解釈し、JSON として解析します。結果のオブジェクトを返します。文字列を JSON として解析できない場合は TypeError をスローします。
formData 本文のバイトを HTML 形式として解釈し、multipart/form-data または application/x-www-form-urlencoded としてエンコードします。FormData オブジェクトを返すか、データを解析できない場合は TypeError をスローします。
body 本文データの ReadableStream を返します。

次に例を示します。

const response = new Response('Hello world');
const buffer = await response.arrayBuffer();
console.log(new Uint8Array(buffer));
// Uint8Array(11) [72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100]

キャッシュからの取得

キャッシュ内のアイテムを検索するには、match メソッドを使用します。

const response = await cache.match(request);
console.log(request, response);

request が文字列の場合、ブラウザは new Request(request) を呼び出して Request に変換します。この関数は、一致するエントリが見つかった場合は Response に解決される Promise を返し、見つからない場合は undefined を返します。

2 つの Requests が一致するかどうかを判断するために、ブラウザは URL 以外の情報も使用します。クエリ文字列、Vary ヘッダー、HTTP メソッド(GETPOSTPUT など)が異なる場合、2 つのリクエストは異なるものと見なされます。

これらの一部またはすべては、オプション オブジェクトを 2 番目のパラメータとして渡すことで無視できます。

const options = {
  ignoreSearch: true,
  ignoreMethod: true,
  ignoreVary: true
};

const response = await cache.match(request, options);
// do something with the response

キャッシュに保存されているリクエストが複数ある場合は、最初に作成されたリクエストが返されます。一致するすべてのレスポンスを取得するには、cache.matchAll() を使用します。

const options = {
  ignoreSearch: true,
  ignoreMethod: true,
  ignoreVary: true
};

const responses = await cache.matchAll(request, options);
console.log(`There are ${responses.length} matching responses.`);

ショートカットとして、キャッシュごとに cache.match() を呼び出す代わりに、caches.match() を使用してすべてのキャッシュを一度に検索できます。

検索機能

Cache API には、Response オブジェクトとエントリを照合する場合を除き、リクエストやレスポンスを検索する方法はありません。ただし、フィルタリングを使用するか、インデックスを作成して、独自の検索を実装することもできます。

フィルタリング

独自の検索を実装する 1 つの方法は、すべてのエントリを反復処理し、必要なエントリに絞り込むことです。たとえば、URL が .png で終わるすべてのアイテムを検索するとします。

async function findImages() {
  // Get a list of all of the caches for this origin
  const cacheNames = await caches.keys();
  const result = [];

  for (const name of cacheNames) {
    // Open the cache
    const cache = await caches.open(name);

    // Get a list of entries. Each item is a Request object
    for (const request of await cache.keys()) {
      // If the request URL matches, add the response to the result
      if (request.url.endsWith('.png')) {
        result.push(await cache.match(request));
      }
    }
  }

  return result;
}

このように、Request オブジェクトと Response オブジェクトの任意のプロパティを使用してエントリをフィルタリングできます。大規模なデータセットを検索する場合は、処理に時間がかかります。

インデックスの作成

独自の検索を実装するもう 1 つの方法は、検索可能なエントリの個別のインデックスを維持し、インデックスを IndexedDB に保存することです。これは IndexedDB が設計した種類のオペレーションであり、多数のエントリがある場合のパフォーマンスが格段に向上します。

Request の URL を検索可能なプロパティとともに格納すると、検索後に正しいキャッシュ エントリを簡単に取得できます。

アイテムの削除

キャッシュからアイテムを削除するには:

cache.delete(request);

ここで、request には Request または URL 文字列を指定できます。このメソッドは、cache.match と同じオプション オブジェクトも受け取ります。これにより、同じ URL の複数の Request/Response ペアを削除できます。

cache.delete('/example/file.txt', {ignoreVary: true, ignoreSearch: true});

キャッシュの削除

キャッシュを削除するには、caches.delete(name) を呼び出します。この関数は、キャッシュが存在して削除された場合は true に解決される Promise を返し、それ以外の場合は false を返します。

ありがとう

WebFundamentals に初めて掲載されたこの記事のオリジナル版を作成した Mat Scales に感謝します。