Cache API: Panduan cepat

Pelajari cara menggunakan Cache API untuk membuat data aplikasi Anda tersedia secara offline.

Pete LePage

Cache API adalah sistem untuk menyimpan dan mengambil permintaan jaringan beserta responsnya yang terkait. Permintaan ini dapat berupa permintaan dan respons reguler yang dibuat selama menjalankan aplikasi Anda, atau dapat dibuat hanya untuk tujuan menyimpan data untuk digunakan nanti.

Cache API dibuat untuk memungkinkan pekerja layanan meng-cache permintaan jaringan sehingga dapat memberikan respons yang cepat, terlepas dari kecepatan atau ketersediaan jaringan. Namun, API juga dapat digunakan sebagai mekanisme penyimpanan umum.

Tersedia di mana saja?

Cache API tersedia di semua browser modern. API ini ditampilkan melalui properti caches global, sehingga Anda dapat menguji keberadaan API dengan deteksi fitur sederhana:

const cacheAvailable = 'caches' in self;

Cache API dapat diakses dari jendela, iframe, worker, atau pekerja layanan.

Data yang dapat disimpan

Cache hanya menyimpan pasangan objek Request dan Response, yang masing-masing mewakili permintaan dan respons HTTP. Namun, permintaan dan respons dapat berisi jenis data apa pun yang dapat ditransfer melalui HTTP.

Berapa banyak yang dapat disimpan?

Singkatnya, sangat besar, setidaknya beberapa ratus megabyte, dan bisa ratusan gigabyte atau lebih. Implementasi browser bervariasi, tetapi jumlah penyimpanan yang tersedia biasanya didasarkan pada jumlah penyimpanan yang tersedia pada perangkat.

Membuat dan membuka cache

Untuk membuka cache, gunakan metode caches.open(name), dengan meneruskan nama cache sebagai parameter tunggal. Jika cache yang diberi nama tidak ada, cache tersebut akan dibuat. Metode ini menampilkan Promise yang di-resolve dengan objek Cache.

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

Menambahkan ke cache

Ada tiga cara untuk menambahkan item ke cache - add, addAll, dan put. Ketiga metode tersebut akan menampilkan Promise.

cache.add

Pertama, ada cache.add(). Fungsi ini mengambil satu parameter, Request atau URL (string). Klien membuat permintaan ke jaringan dan menyimpan respons dalam cache. Jika pengambilan gagal, atau jika kode status respons tidak berada dalam rentang 200, tidak ada yang disimpan dan Promise akan menolak. Perlu diperhatikan bahwa permintaan lintas asal yang tidak berada dalam mode CORS tidak dapat disimpan karena menampilkan status sebesar 0. Permintaan tersebut hanya dapat disimpan dengan 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

Berikutnya, ada cache.addAll(). Fungsinya mirip dengan add(), tetapi menggunakan array objek atau URL Request (string). Cara kerjanya mirip dengan memanggil cache.add untuk setiap permintaan, kecuali bahwa Promise akan menolak jika ada satu permintaan yang tidak di-cache.

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

Dalam setiap kasus ini, entri baru akan menimpa entri yang sudah ada yang cocok. Proses ini menggunakan aturan pencocokan yang sama seperti yang dijelaskan di bagian tentang retrieving.

cache.put

Terakhir, terdapat cache.put(), yang memungkinkan Anda menyimpan respons dari jaringan, atau membuat dan menyimpan Response Anda sendiri. Dibutuhkan dua parameter. Yang pertama dapat berupa objek Request atau URL (string). Yang kedua harus berupa Response, baik dari jaringan, atau yang dihasilkan oleh kode Anda.

// 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');

Metode put() lebih permisif daripada add() atau addAll(), dan akan memungkinkan Anda menyimpan respons non-CORS, atau respons lain yang kode status responsnya tidak dalam rentang 200. Tindakan ini akan menimpa respons sebelumnya untuk permintaan yang sama.

Membuat objek Request

Buat objek Request menggunakan URL untuk objek yang disimpan:

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

Menangani objek Response

Konstruktor objek Response menerima banyak jenis data, termasuk Blob, ArrayBuffer, objek FormData, dan string.

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

Anda dapat menetapkan jenis MIME Response dengan menyetel header yang sesuai.

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

Jika Anda telah mengambil Response dan ingin mengakses isinya, ada beberapa metode bantuan yang dapat Anda gunakan. Masing-masing menampilkan Promise yang di-resolve dengan nilai jenis yang berbeda.

Contoh:

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]

Mengambil dari cache

Untuk menemukan item di cache, Anda dapat menggunakan metode match.

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

Jika request adalah string, browser akan mengonversinya menjadi Request dengan memanggil new Request(request). Fungsi ini menampilkan Promise yang di-resolve ke Response jika ditemukan entri yang cocok, atau undefined jika tidak ditemukan.

Untuk menentukan apakah dua Requests cocok, browser menggunakan lebih dari sekadar URL. Dua permintaan dianggap berbeda jika memiliki string kueri, header Vary, atau metode HTTP yang berbeda (GET, POST, PUT, dll.).

Anda dapat mengabaikan beberapa atau semua hal ini dengan meneruskan objek opsi sebagai parameter kedua.

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

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

Jika lebih dari satu permintaan yang di-cache cocok, permintaan yang dibuat pertama kali akan ditampilkan. Jika ingin mengambil semua respons yang cocok, Anda dapat menggunakan 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.`);

Sebagai pintasan, Anda dapat menelusuri semua cache sekaligus menggunakan caches.match(), bukan memanggil cache.match() untuk setiap cache.

Menelusuri

Cache API tidak menyediakan cara untuk menelusuri permintaan atau respons, kecuali untuk entri yang cocok terhadap objek Response. Namun, Anda dapat menerapkan penelusuran sendiri menggunakan pemfilteran atau dengan membuat indeks.

Pemfilteran

Salah satu cara untuk menerapkan penelusuran Anda sendiri adalah dengan melakukan iterasi pada semua entri dan memfilter ke entri yang Anda inginkan. Misalkan Anda ingin menemukan semua item yang URL-nya diakhiri dengan .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;
}

Dengan cara ini, Anda dapat menggunakan properti objek Request dan Response untuk memfilter entri. Perhatikan bahwa proses ini akan lambat jika Anda menelusuri kumpulan data yang besar.

Membuat indeks

Cara lain untuk mengimplementasikan penelusuran Anda sendiri adalah dengan mempertahankan indeks entri terpisah yang dapat dicari dan menyimpan indeks di IndexedDB. Karena ini adalah jenis operasi yang dirancang untuk Nexus, performa yang jauh lebih baik dengan jumlah entri yang besar.

Jika Anda menyimpan URL Request bersama dengan properti yang dapat ditelusuri, Anda dapat dengan mudah mengambil entri cache yang benar setelah melakukan penelusuran.

Menghapus item

Untuk menghapus item dari cache:

cache.delete(request);

Permintaan dapat berupa Request atau string URL. Metode ini juga menggunakan objek opsi yang sama seperti cache.match, yang memungkinkan Anda menghapus beberapa pasangan Request/Response untuk URL yang sama.

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

Menghapus cache

Untuk menghapus cache, panggil caches.delete(name). Fungsi ini menampilkan Promise yang di-resolve ke true jika cache sudah ada dan telah dihapus, atau false jika tidak.

Terima kasih

Terima kasih kepada Mat Scales yang menulis versi asli artikel ini, yang pertama kali muncul di WebFundamentals.