Cache API: คู่มือฉบับย่อ

เรียนรู้วิธีใช้ API แคชเพื่อทำให้ข้อมูลแอปพลิเคชันของคุณใช้งานแบบออฟไลน์ได้

Pete LePage

Cache API คือระบบสำหรับจัดเก็บและเรียกคำขอเครือข่ายและการตอบสนองที่เกี่ยวข้อง ซึ่งอาจเป็นคําขอและคําตอบปกติที่สร้างในระหว่างการเรียกใช้แอปพลิเคชัน หรืออาจสร้างขึ้นเพื่อวัตถุประสงค์ในการเก็บข้อมูลไว้ใช้ภายหลังเท่านั้น

Cache API สร้างขึ้นเพื่อให้ Service Worker แคชคำขอเครือข่ายได้เพื่อให้สามารถตอบกลับได้อย่างรวดเร็ว ไม่ว่าจะมีความเร็วหรือความพร้อมของเครือข่ายเพียงใด อย่างไรก็ตาม คุณยังใช้ API นี้เป็นกลไกการจัดเก็บข้อมูลทั่วไปได้ด้วย

พร้อมให้บริการที่ไหนบ้าง

Cache API พร้อมใช้งานในเบราว์เซอร์สมัยใหม่ทั้งหมด จะแสดงผ่านพร็อพเพอร์ตี้ caches ส่วนกลางเพื่อให้คุณทดสอบการมีอยู่ของ API ได้ด้วยการตรวจหาฟีเจอร์แบบง่ายๆ

const cacheAvailable = 'caches' in self;

คุณสามารถเข้าถึง Cache API ได้จากหน้าต่าง, iframe, Worker หรือ Service Worker

สิ่งที่จัดเก็บได้

แคชจะจัดเก็บเฉพาะคู่ออบเจ็กต์ Request และ Response ซึ่งแสดงถึงคำขอและการตอบกลับ HTTP ตามลำดับ แต่คำขอและการตอบกลับอาจมีข้อมูลประเภทใดก็ได้ที่โอนผ่าน HTTP ได้

คุณจะจัดเก็บได้มากแค่ไหน

กล่าวโดยย่อคือ มาก อย่างน้อย 2-3 ร้อยเมกะไบต์ และอาจมากถึงหลายร้อยกิกะไบต์ขึ้นไป การใช้งานเบราว์เซอร์จะแตกต่างกันไป แต่ปริมาณพื้นที่เก็บข้อมูลที่ใช้ได้มักจะขึ้นอยู่กับปริมาณพื้นที่เก็บข้อมูลที่มีในอุปกรณ์

การสร้างและเปิดแคช

หากต้องการเปิดแคช ให้ใช้เมธอด caches.open(name) โดยส่งชื่อแคชเป็นพารามิเตอร์เดียว หากไม่มีแคชที่มีชื่อ ระบบจะสร้างแคชนั้น เมธอดนี้จะแสดงผล Promise ที่แก้ไขได้ด้วยออบเจ็กต์ Cache

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

การเพิ่มลงในแคช

การเพิ่มรายการลงในแคชทำได้ 3 วิธี ได้แก่ add, addAll และ put ทั้ง 3 วิธีจะแสดงผลเป็น Promise

cache.add

รายการแรกคือ cache.add() โดยจะใช้พารามิเตอร์ 1 รายการ ซึ่งอาจเป็น Request หรือ URL (string) จากนั้นจะส่งคําขอไปยังเครือข่ายและจัดเก็บคําตอบไว้ในแคช หากการดึงข้อมูลไม่สำเร็จ หรือรหัสสถานะของการตอบกลับไม่ได้อยู่ในช่วง 200 ระบบจะไม่จัดเก็บข้อมูลใดๆ และ Promise จะปฏิเสธ โปรดทราบว่าระบบจะจัดเก็บคำขอข้ามแหล่งที่มาที่ไม่ได้อยู่ในโหมด CORS ไม่ได้ เนื่องจากคำขอดังกล่าวจะแสดงผล status ของ 0 คำขอดังกล่าวจะจัดเก็บไว้กับ 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() แต่จะรับอาร์เรย์ของออบเจ็กต์หรือ URL Request รายการ (string) ซึ่งทํางานคล้ายกับการเรียก cache.add สําหรับคําขอแต่ละรายการ ยกเว้นว่า Promise จะปฏิเสธหากไม่มีการแคชคําขอใดก็ตาม

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

ในแต่ละกรณีเหล่านี้ รายการใหม่จะเขียนทับรายการที่มีอยู่ซึ่งตรงกัน ซึ่งจะใช้กฎการจับคู่เดียวกันกับที่อธิบายไว้ในส่วนการดึงข้อมูล

cache.put

สุดท้ายคือ cache.put() ซึ่งช่วยให้คุณจัดเก็บคําตอบจากเครือข่าย หรือสร้างและจัดเก็บ Response ของคุณเองได้ ต้องใช้ 2 พารามิเตอร์ รายการแรกอาจเป็นออบเจ็กต์ 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 ของสิ่งที่จะจัดเก็บ

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

การทำงานกับออบเจ็กต์การตอบกลับ

ตัวสร้างออบเจ็กต์ Response ยอมรับข้อมูลหลายประเภท ซึ่งรวมถึงBlob, ArrayBuffer, ออบเจ็กต์ FormData และสตริง

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

คุณสามารถตั้งค่าประเภท MIME ของ Response ได้โดยการตั้งค่าส่วนหัวที่เหมาะสม

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

หากดึงข้อมูล Response มาแล้วและต้องการเข้าถึงเนื้อหา คุณสามารถใช้เมธอดตัวช่วยได้หลายวิธี โดยแต่ละรายการจะแสดงผล Promise ที่แก้ไขแล้วซึ่งมีค่าประเภทอื่น

เช่น

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 เป็นสตริง เบราว์เซอร์จะแปลงเป็น Request โดยการเรียกใช้ new Request(request) ฟังก์ชันจะแสดงผล Promise ที่แปลงเป็น Response หากพบรายการที่ตรงกัน หรือแสดง undefined ในกรณีอื่นๆ

ในการพิจารณาว่า Requests 2 รายการตรงกันหรือไม่ เบราว์เซอร์จะใช้มากกว่าแค่ URL ระบบจะถือว่าคำขอ 2 รายการแตกต่างกันหากมีสตริงการค้นหา, Varyส่วนหัว หรือเมธอด HTTP (GET, POST, PUT ฯลฯ) ที่แตกต่างกัน

คุณละเว้นสิ่งเหล่านี้บางส่วนหรือทั้งหมดได้โดยส่งออบเจ็กต์ตัวเลือกเป็นพารามิเตอร์ที่ 2

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

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

หากคำขอที่แคชไว้ตรงกันมากกว่า 1 รายการ ระบบจะแสดงคำขอที่สร้างไว้ก่อน หากต้องการดึงข้อมูลคำตอบที่ตรงกันทั้งหมด ให้ใช้ 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.`);

คุณจะค้นหาแคชทั้งหมดพร้อมกันได้โดยใช้ caches.match() เป็นทางลัด คุณจึงค้นหาแคชแต่ละรายการแทนการเรียก cache.match() ได้

กำลังค้นหา

Cache API ไม่มีวิธีค้นหาคําขอหรือการตอบกลับ ยกเว้นการจับคู่รายการกับออบเจ็กต์ Response อย่างไรก็ตาม คุณสามารถใช้การค้นหาของคุณเองได้โดยใช้การกรองหรือสร้างดัชนี

การกรอง

วิธีหนึ่งในการใช้การค้นหาของคุณเองคือการวนซ้ำรายการทั้งหมดและกรองรายการที่ต้องการ สมมติว่าคุณต้องการค้นหารายการทั้งหมดที่มี 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 เพื่อกรองรายการ โปรดทราบว่าการค้นหานี้จะช้าหากคุณค้นหาชุดข้อมูลขนาดใหญ่

การสร้างดัชนี

อีกวิธีในการใช้การค้นหาของคุณเองคือการบำรุงรักษาดัชนีแยกต่างหากของรายการที่ค้นหาได้ และจัดเก็บดัชนีใน IndexedDB เนื่องจากการดำเนินการประเภทนี้เป็นการดำเนินการที่ IndexedDB ออกแบบมาเพื่อให้คำสั่งนี้มีประสิทธิภาพดีกว่ามากเมื่อมีรายการจำนวนมาก

หากจัดเก็บ URL ของ Request ไว้ข้างๆ พร็อพเพอร์ตี้ที่ค้นหาได้ คุณจะเรียกข้อมูลรายการแคชที่ถูกต้องได้อย่างง่ายดายหลังจากทำการค้นหา

การลบรายการ

วิธีลบรายการออกจากแคช

cache.delete(request);

โดยที่คําขออาจเป็น Request หรือสตริง URL วิธีนี้ยังใช้ออบเจ็กต์ตัวเลือกเดียวกับ cache.match ซึ่งช่วยให้คุณลบคู่ Request/Response หลายคู่สำหรับ URL เดียวกันได้

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

การลบแคช

หากต้องการลบแคช ให้โทรหา caches.delete(name) ฟังก์ชันนี้จะแสดงผลเป็น Promise ซึ่งจะเปลี่ยนเป็น true หากมีแคชอยู่และถูกลบไปแล้ว หรือจะเปลี่ยนเป็น false ในกรณีอื่นๆ

ขอขอบคุณ

ขอขอบคุณ Mat Scales ผู้เขียนบทความเวอร์ชันต้นฉบับนี้ ซึ่งปรากฏขึ้นครั้งแรกใน WebFundamentals