명령형 캐싱 가이드

Andrew Guan
Andrew Guan
Demián Renzulli
Demián Renzulli

일부 웹사이트는 결과에 대해 알리지 않고 서비스 워커와 통신해야 할 수 있습니다. 예를 들면 다음과 같습니다.

  • 페이지는 서비스 워커에 미리 가져올 URL 목록을 전송하므로 사용자가 링크를 클릭하면 문서 또는 페이지 하위 리소스를 이미 캐시에서 사용할 수 있으므로 후속 탐색이 훨씬 빨라집니다.
  • 페이지에서는 서비스 워커에게 인기 기사 집합을 검색하고 캐시하여 오프라인에서 사용할 수 있도록 요청합니다.

이러한 유형의 중요하지 않은 작업을 서비스 워커에 위임하면 기본 스레드를 확보하여 사용자 상호작용에 응답과 같이 더 긴급한 작업을 더 잘 처리할 수 있습니다.

서비스 워커에 캐시할 리소스를 요청하는 페이지의 다이어그램

이 가이드에서는 표준 브라우저 API와 Workbox 라이브러리를 사용하여 페이지에서 서비스 워커로 단방향 통신 기술을 구현하는 방법을 살펴봅니다. 이러한 유형의 사용 사례를 명령적 캐싱이라고 합니다.

프로덕션 케이스

1-800-Flowers.com은 제품 세부정보 페이지로의 후속 탐색 속도를 높이기 위해 카테고리 페이지의 상위 항목을 미리 가져오는 postMessage()를 통해 서비스 워커와 함께 명령적 캐싱 (미리 가져오기)을 구현했습니다.

1-800 Flowers 로고

어떤 항목을 미리 가져올지 결정하기 위해 혼합된 접근 방식을 사용합니다.

  • 페이지 로드 시 서비스 작업자는 상위 9개 항목에 대한 JSON 데이터를 검색하고 결과 응답 객체를 캐시에 추가하도록 서비스 워커에게 요청합니다.
  • 나머지 항목의 경우 mouseover 이벤트를 수신 대기하므로 사용자가 항목 위로 커서를 이동할 때 '주문형'에 따라 리소스 가져오기를 트리거할 수 있습니다.

Cache API를 사용하여 JSON 응답을 저장합니다.

1-800 Flowers 로고
1-800Flowers.com의 제품 등록정보 페이지에서 JSON 제품 데이터 미리 가져오기

사용자가 항목을 클릭하면 네트워크로 이동할 필요 없이 항목과 연결된 JSON 데이터를 캐시에서 선택할 수 있으므로 더 빠르게 탐색할 수 있습니다.

Workbox 사용

Workbox를 사용하면 창 컨텍스트에서 실행할 일련의 모듈인 workbox-window 패키지를 통해 서비스 워커에 쉽게 메시지를 보낼 수 있습니다. 서비스 워커에서 실행되는 다른 Workbox 패키지를 보완합니다.

페이지를 서비스 워커와 통신하려면 먼저 등록된 서비스 워커에 대한 Workbox 객체 참조를 가져옵니다.

const wb = new Workbox('/sw.js');
wb.register();

그런 다음 등록을 가져오거나 활성화를 확인하거나 기본 통신 API를 고려하는 번거로움 없이 선언적으로 메시지를 직접 전송할 수 있습니다.

wb.messageSW({"type": "PREFETCH", "payload": {"urls": ["/data1.json", "data2.json"]}}); });

서비스 워커는 message 핸들러를 구현하여 이러한 메시지를 수신합니다. 선택적으로 응답을 반환할 수 있지만 다음과 같은 경우에는 필요하지 않습니다.

self.addEventListener('message', (event) => {
  if (event.data && event.data.type === 'PREFETCH') {
    // do something
  }
});

브라우저 API 사용

Workbox 라이브러리가 요구사항에 충분하지 않은 경우 브라우저 API를 사용하여 창에서 서비스 워커 간 통신을 구현하는 방법은 다음과 같습니다.

postMessage API는 페이지에서 서비스 워커로의 단방향 통신 메커니즘을 설정하는 데 사용할 수 있습니다.

페이지는 서비스 워커 인터페이스에서 postMessage()를 호출합니다.

navigator.serviceWorker.controller.postMessage({
  type: 'MSG_ID',
  payload: 'some data to perform the task',
});

서비스 워커는 message 핸들러를 구현하여 이러한 메시지를 수신합니다.

self.addEventListener('message', (event) => {
  if (event.data && event.data.type === MSG_ID) {
    // do something
  }
});

{type : 'MSG_ID'} 속성은 반드시 필요한 것은 아니지만 페이지에서 서비스 워커에 다양한 유형의 명령을 전송할 수 있는 한 가지 방법입니다 (즉, '미리 가져오기' 또는 '저장소 비우기'). 서비스 워커는 이 플래그를 기반으로 여러 실행 경로로 분기할 수 있습니다.

작업이 성공하면 사용자는 이점을 얻을 수 있지만 그렇지 않으면 기본 사용자 흐름이 변경되지 않습니다. 예를 들어 1-800-Flowers.com이 사전 캐시하려고 할 때 페이지는 서비스 워커의 성공 여부를 알 필요가 없습니다. 그래야만 사용자가 더 빠르게 탐색할 수 있습니다. 그래도 페이지가 표시되지 않으면 새 페이지로 이동해야 합니다. 시간이 조금 더 걸릴 뿐입니다.

간단한 미리 가져오기 예시

명령형 캐싱의 가장 일반적인 용도 중 하나는 탐색 속도를 높이기 위해 사용자가 이동하기 전에 지정된 URL의 리소스를 가져오는 미리 가져오기입니다.

사이트에서 미리 가져오기를 구현하는 방법에는 여러 가지가 있습니다.

문서나 특정 애셋 (JS, CSS 등)을 미리 가져오는 것과 같이 비교적 간단한 미리 가져오기 시나리오에는 이러한 방법이 가장 좋습니다.

내부 URL을 가져오기 위해 미리 가져오기 리소스 (JSON 파일 또는 페이지)를 파싱하는 등의 추가 로직이 필요한 경우 이 작업 전체를 서비스 워커에 위임하는 것이 더 적절합니다.

이러한 유형의 작업을 서비스 워커에 위임하면 다음과 같은 이점이 있습니다.

  • 가져오기 및 후처리 처리 (나중에 소개됨)와 같은 어려운 작업을 보조 스레드로 오프로드합니다. 이렇게 하면 기본 스레드에서 사용자 상호작용에 응답과 같은 더 중요한 작업을 처리할 수 있습니다.
  • 여러 클라이언트 (예: 탭)가 공통 기능을 재사용할 수 있고, 심지어 기본 스레드를 차단하지 않고 서비스를 동시에 호출할 수도 있습니다.

제품 세부정보 페이지 미리 가져오기

먼저 서비스 워커 인터페이스에서 postMessage()을 사용하고 캐시할 URL 배열을 전달합니다.

navigator.serviceWorker.controller.postMessage({
  type: 'PREFETCH',
  payload: {
    urls: [
      'www.exmaple.com/apis/data_1.json',
      'www.exmaple.com/apis/data_2.json',
    ],
  },
});

서비스 워커에서 message 핸들러를 구현하여 활성 탭에서 보낸 메시지를 가로채서 처리합니다.

addEventListener('message', (event) => {
  let data = event.data;
  if (data && data.type === 'PREFETCH') {
    let urls = data.payload.urls;
    for (let i in urls) {
      fetchAsync(urls[i]);
    }
  }
});

이전 코드에서는 fetchAsync()이라는 작은 도우미 함수를 도입하여 URL 배열을 반복하고 각 URL의 가져오기 요청을 실행합니다.

async function fetchAsync(url) {
  // await response of fetch call
  let prefetched = await fetch(url);
  // (optionally) cache resources in the service worker storage
}

응답을 얻으면 리소스의 캐싱 헤더를 사용할 수 있습니다. 하지만 제품 세부정보 페이지와 마찬가지로 리소스는 캐시되지 않는 경우가 많습니다. 즉, no-cacheCache-control 헤더를 가집니다. 이 경우 가져온 리소스를 서비스 워커 캐시에 저장하여 이 동작을 재정의할 수 있습니다. 이렇게 하면 오프라인 시나리오에서 파일을 제공할 수 있다는 추가적인 이점이 있습니다.

JSON 데이터 그 이상

서버 엔드포인트에서 JSON 데이터를 가져오면 이 1차 수준 데이터와 연결된 이미지 또는 기타 엔드포인트 데이터와 같이 미리 가져올 가치가 있는 다른 URL이 포함되는 경우가 많습니다.

이 예에서 반환된 JSON 데이터가 식료품 쇼핑 사이트의 정보라고 가정해 보겠습니다.

{
  "productName": "banana",
  "productPic": "https://cdn.example.com/product_images/banana.jpeg",
  "unitPrice": "1.99"
 }

fetchAsync() 코드를 수정하여 제품 목록을 반복하고 각 제품의 히어로 이미지를 캐시합니다.

async function fetchAsync(url, postProcess) {
  // await response of fetch call
  let prefetched = await fetch(url);

  //(optionally) cache resource in the service worker cache

  // carry out the post fetch process if supplied
  if (postProcess) {
    await postProcess(prefetched);
  }
}

async function postProcess(prefetched) {
  let productJson = await prefetched.json();
  if (productJson && productJson.product_pic) {
    fetchAsync(productJson.product_pic);
  }
}

404와 같은 상황에서는 이 코드 주위에 몇 가지 예외 처리를 추가할 수 있습니다. 하지만 미리 가져오기에 서비스 워커를 사용하는 것의 장점은 페이지와 기본 스레드에 큰 영향을 미치지 않고 실패할 수 있다는 것입니다. 또한 미리 가져온 콘텐츠의 후처리에 더 정교한 로직이 있어서 유연성이 높아지고 콘텐츠가 처리하는 데이터와 분리될 수 있습니다. 원하는 대로 자유롭게 결정할 수 있습니다.

결론

이 문서에서는 페이지와 서비스 워커 간 단방향 통신의 일반적인 사용 사례인 명령적 캐싱을 다루었습니다. 설명된 예는 이 패턴을 사용하는 한 가지 방법을 설명하기 위한 것이며 동일한 접근 방식을 다른 사용 사례에도 동일하게 적용할 수 있습니다(예: 주문형으로 주요 기사를 오프라인 소비, 북마크 등).

페이지 및 서비스 워커 통신의 더 많은 패턴을 보려면 다음을 확인하세요.

  • 업데이트 브로드캐스트: 서비스 워커에서 페이지를 호출하여 중요한 업데이트 (예: 웹 앱의 새 버전 사용 가능)를 알립니다.
  • 양방향 통신: 서비스 워커에 작업 위임 (예: 대용량 다운로드) 및 진행 상황을 페이지에 계속 알림