백그라운드 가져오기 소개

Jake Archibald
Jake Archibald

2015년에 Google은 서비스 워커가 사용자가 연결될 때까지 작업을 지연할 수 있는 백그라운드 동기화를 도입했습니다. 즉, 사용자는 메시지를 입력하고 '보내기'를 누른 후 사이트를 나가도 메시지가 지금 또는 연결이 되면 전송된다는 사실을 알 수 있습니다.

유용한 기능이지만 가져오기 기간 동안 서비스 워커가 활성 상태여야 합니다. 이는 메시지 전송과 같은 짧은 작업에는 문제가 되지 않지만 작업이 너무 오래 걸리면 브라우저에서 서비스 워커를 종료합니다. 그렇지 않으면 사용자의 개인 정보 보호 및 배터리가 위험해집니다.

영화, 팟캐스트, 게임 레벨과 같이 다운로드하는 데 시간이 오래 걸리는 항목이 있다면 어떻게 해야 하나요? 백그라운드 가져오기가 바로 이 역할을 합니다.

백그라운드 가져오기는 Chrome 74부터 기본적으로 사용할 수 있습니다.

다음은 기존 상태와 백그라운드 가져오기를 사용하는 상태를 보여주는 2분 길이의 간단한 데모입니다.

데모를 직접 사용해 보고 코드를 둘러보세요.

작동 방식

백그라운드 가져오기는 다음과 같이 작동합니다.

  1. 브라우저에 백그라운드에서 가져오기 그룹을 실행하도록 지시합니다.
  2. 브라우저는 이러한 항목을 가져와 사용자에게 진행 상황을 표시합니다.
  3. 가져오기가 완료되거나 실패하면 브라우저가 서비스 워커를 열고 이벤트를 실행하여 어떤 일이 발생했는지 알려줍니다. 여기에서 응답(있는 경우)으로 무엇을 할지 결정합니다.

사용자가 1단계 후에 사이트 페이지를 닫아도 괜찮습니다. 다운로드는 계속됩니다. 가져오기가 눈에 잘 띄고 쉽게 중단할 수 있으므로 너무 긴 백그라운드 동기화 작업과 관련된 개인 정보 보호 문제가 없습니다. 서비스 워커는 지속적으로 실행되지 않으므로 백그라운드에서 비트코인을 채굴하는 등 시스템을 악용할 수 있다는 우려가 없습니다.

Android와 같은 일부 플랫폼에서는 브라우저가 가져오기를 운영체제에 전달할 수 있으므로 1단계 후에 브라우저가 닫힐 수 있습니다.

사용자가 오프라인 상태에서 다운로드를 시작하거나 다운로드 중에 오프라인 상태가 되면 백그라운드 가져오기가 일시중지되고 나중에 다시 시작됩니다.

API

기능 감지

다른 새 기능과 마찬가지로 브라우저에서 이 기능을 지원하는지 감지해야 합니다. 백그라운드 가져오기의 경우 다음과 같이 간단합니다.

if ('BackgroundFetchManager' in self) {
  // This browser supports Background Fetch!
}

백그라운드 가져오기 시작

기본 API는 서비스 워커 등록에서 중단되므로 먼저 서비스 워커를 등록해야 합니다. 그런 다음 아래를 실행합니다.

navigator.serviceWorker.ready.then(async (swReg) => {
  const bgFetch = await swReg.backgroundFetch.fetch('my-fetch', ['/ep-5.mp3', 'ep-5-artwork.jpg'], {
    title: 'Episode 5: Interesting things.',
    icons: [{
      sizes: '300x300',
      src: '/ep-5-icon.png',
      type: 'image/png',
    }],
    downloadTotal: 60 * 1024 * 1024,
  });
});

backgroundFetch.fetch는 세 가지 인수를 사용합니다.

매개변수
id string
이 백그라운드 가져오기를 고유하게 식별합니다.

ID가 기존 백그라운드 가져오기와 일치하면 backgroundFetch.fetch가 거부합니다.

requests Array<Request|string>
가져올 항목입니다. 문자열은 URL로 처리되고 new Request(theString)를 통해 Request로 변환됩니다.

리소스가 CORS를 통해 허용하는 한 다른 출처에서 항목을 가져올 수 있습니다.

참고: Chrome은 현재 CORS 실행 전이 필요한 요청을 지원하지 않습니다.

options 다음을 포함할 수 있는 객체입니다.
options.title string
브라우저에서 진행률과 함께 표시할 제목입니다.
options.icons Array<IconDefinition>
`src`, `size`, `type`이 있는 객체 배열입니다.
options.downloadTotal number
응답 본문의 총 크기 (Gzip을 해제한 후)입니다.

이는 선택사항이지만 제공하는 것이 좋습니다. 사용자에게 다운로드 크기를 알리고 진행 상황 정보를 제공하는 데 사용됩니다. 이를 제공하지 않으면 브라우저에서 사용자에게 크기를 알 수 없다고 알리므로 사용자가 다운로드를 중단할 가능성이 높아집니다.

백그라운드 가져오기 다운로드가 여기에 지정된 수를 초과하면 중단됩니다. 다운로드가 downloadTotal보다 작으면 괜찮습니다. 따라서 다운로드 총량을 잘 모르겠다면 더 작은 값을 사용하는 것이 좋습니다.

backgroundFetch.fetchBackgroundFetchRegistration로 확인되는 프로미스를 반환합니다. 자세한 내용은 나중에 다루겠습니다. 사용자가 오프라인 저장을 선택 해제했거나 제공된 매개변수 중 하나가 유효하지 않으면 프라미스가 거부됩니다.

단일 백그라운드 가져오기에 여러 요청을 제공하면 사용자에게 논리적으로 하나인 항목을 결합할 수 있습니다. 예를 들어 영화는 수천 개의 리소스로 분할될 수 있으며 (MPEG-DASH의 일반적인 경우) 이미지와 같은 추가 리소스가 포함될 수 있습니다. 게임의 한 수준은 여러 JavaScript, 이미지, 오디오 리소스에 걸쳐 있을 수 있습니다. 하지만 사용자에게는 단지 '영화' 또는 '레벨'일 뿐입니다.

기존 백그라운드 가져오기 가져오기

다음과 같이 기존 백그라운드 가져오기를 가져올 수 있습니다.

navigator.serviceWorker.ready.then(async (swReg) => {
  const bgFetch = await swReg.backgroundFetch.get('my-fetch');
});

원하는 백그라운드 가져오기의 id를 전달합니다. 해당 ID로 활성 백그라운드 가져오기가 없으면 getundefined를 반환합니다.

백그라운드 가져오기는 등록된 시점부터 가져오기가 성공하거나 실패하거나 중단될 때까지 '활성'으로 간주됩니다.

getIds를 사용하여 모든 활성 백그라운드 가져오기 목록을 가져올 수 있습니다.

navigator.serviceWorker.ready.then(async (swReg) => {
  const ids = await swReg.backgroundFetch.getIds();
});

백그라운드 가져오기 등록

BackgroundFetchRegistration (위 예시에서는 bgFetch)에는 다음이 있습니다.

속성
id string
백그라운드 가져오기의 ID입니다.
uploadTotal number
서버로 전송할 바이트 수입니다.
uploaded number
전송에 성공한 바이트 수입니다.
downloadTotal number
백그라운드 가져오기가 등록될 때 제공된 값 또는 0입니다.
downloaded number
수신에 성공한 바이트 수입니다.

이 값은 감소할 수 있습니다. 예를 들어 연결이 끊어져 다운로드를 재개할 수 없는 경우 브라우저가 해당 리소스의 가져오기를 처음부터 다시 시작합니다.

result

다음 중 하나입니다.

  • "" - 백그라운드 가져오기가 활성 상태이므로 아직 결과가 없습니다.
  • "success" - 백그라운드 가져오기에 성공했습니다.
  • "failure" - 백그라운드 가져오기에 실패했습니다. 이 값은 브라우저에서 다시 시도/재개할 수 없는 경우와 같이 백그라운드 가져오기가 완전히 실패한 경우에만 표시됩니다.
failureReason

다음 중 하나입니다.

  • "" - 백그라운드 가져오기에 실패하지 않았습니다.
  • "aborted" – 사용자가 백그라운드 가져오기를 중단했거나 abort()이 호출되었습니다.
  • "bad-status" - 응답 중 하나의 상태가 정상이 아닙니다(예: 404).
  • "fetch-error" - 가져오기 중 하나가 다른 이유로 실패했습니다(예: CORS, MIX, 잘못된 부분 응답, 재시도할 수 없는 가져오기에 대한 일반적인 네트워크 오류).
  • "quota-exceeded" - 백그라운드 가져오기 중에 스토리지 한도에 도달했습니다.
  • "download-total-exceeded" - 제공된 `downloadTotal` 이 초과되었습니다.
recordsAvailable boolean
기본 요청/응답에 액세스할 수 있나요?

이 값이 false이면 matchmatchAll를 사용할 수 없습니다.

메서드
abort() Promise<boolean>를 반환합니다.
백그라운드 가져오기를 중단합니다.

가져오기가 성공적으로 중단되면 반환된 프로미스는 true로 확인됩니다.

matchAll(request, opts) Promise<Array<BackgroundFetchRecord>> 반환
요청 및 응답을 가져옵니다.

여기서 인수는 캐시 API와 동일합니다. 인수 없이 호출하면 모든 레코드에 대한 약속이 반환됩니다.

자세한 내용은 아래를 참조하세요.

match(request, opts) Promise<BackgroundFetchRecord> 반환
위와 같지만 첫 번째 일치로 확인됩니다.
이벤트
progress uploaded, downloaded, result 또는 failureReason 중 하나가 변경될 때 실행됩니다.

진행 상황 추적

progress 이벤트를 통해 할 수 있습니다. downloadTotal는 개발자가 제공한 값이거나 값을 제공하지 않은 경우 0입니다.

bgFetch.addEventListener('progress', () => {
  // If we didn't provide a total, we can't provide a %.
  if (!bgFetch.downloadTotal) return;

  const percent = Math.round(bgFetch.downloaded / bgFetch.downloadTotal * 100);
  console.log(`Download progress: ${percent}%`);
});

요청 및 응답 가져오기

bgFetch.match('/ep-5.mp3').then(async (record) => {
  if (!record) {
    console.log('No record found');
    return;
  }

  console.log(`Here's the request`, record.request);
  const response = await record.responseReady;
  console.log(`And here's the response`, response);
});

recordBackgroundFetchRecord이며 다음과 같이 표시됩니다.

속성
request Request
제공된 요청입니다.
responseReady Promise<Response>
가져온 응답입니다.

응답이 아직 수신되지 않았을 수 있으므로 약속 뒤에 있습니다. 가져오기에 실패하면 프라미스가 거부됩니다.

서비스 워커 이벤트

이벤트
backgroundfetchsuccess 모든 항목이 가져와졌습니다.
backgroundfetchfailure 가져오기가 하나 이상 실패했습니다.
backgroundfetchabort 가져오기가 하나 이상 실패했습니다.

이는 관련 데이터를 정리하려는 경우에만 유용합니다.

backgroundfetchclick 사용자가 다운로드 진행률 UI를 클릭했습니다.

이벤트 객체에는 다음이 있습니다.

속성
registration BackgroundFetchRegistration
메서드
updateUI({ title, icons }) 처음에 설정한 제목/아이콘을 변경할 수 있습니다. 이는 선택사항이지만 필요한 경우 더 많은 맥락을 제공할 수 있습니다. backgroundfetchsuccessbackgroundfetchfailure 이벤트 중에 *한 번만* 할 수 있습니다.

성공/실패에 대한 반응

progress 이벤트는 이미 살펴봤지만, 이 이벤트는 사용자가 사이트의 페이지를 열어 두고 있는 동안에만 유용합니다. 백그라운드 가져오기의 주요 이점은 사용자가 페이지를 나가거나 브라우저를 닫은 후에도 계속 작동한다는 것입니다.

백그라운드 가져오기가 완료되면 서비스 워커는 backgroundfetchsuccess 이벤트를 수신하고 event.registration는 백그라운드 가져오기 등록이 됩니다.

이 이벤트 후에는 가져온 요청 및 응답에 더 이상 액세스할 수 없으므로 요청 및 응답을 유지하려면 cache API와 같은 위치로 이동하세요.

대부분의 서비스 워커 이벤트와 마찬가지로 서비스 워커가 이벤트가 완료되었음을 알 수 있도록 event.waitUntil를 사용하세요.

예를 들어 서비스 워커에서 다음과 같이 합니다.

addEventListener('backgroundfetchsuccess', (event) => {
  const bgFetch = event.registration;

  event.waitUntil(async function() {
    // Create/open a cache.
    const cache = await caches.open('downloads');
    // Get all the records.
    const records = await bgFetch.matchAll();
    // Copy each request/response across.
    const promises = records.map(async (record) => {
      const response = await record.responseReady;
      await cache.put(record.request, response);
    });

    // Wait for the copying to complete.
    await Promise.all(promises);

    // Update the progress notification.
    event.updateUI({ title: 'Episode 5 ready to listen!' });
  }());
});

실패가 단일 404로 인한 것일 수 있으며 이는 중요하지 않을 수 있으므로 위와 같이 일부 응답을 캐시로 복사하는 것이 좋습니다.

클릭에 대한 반응

다운로드 진행률과 결과를 표시하는 UI는 클릭할 수 있습니다. 서비스 워커의 backgroundfetchclick 이벤트를 사용하면 이에 반응할 수 있습니다. 위와 같이 event.registration는 백그라운드 가져오기 등록입니다.

이 이벤트와 관련하여 일반적으로 수행하는 작업은 창을 여는 것입니다.

addEventListener('backgroundfetchclick', (event) => {
  const bgFetch = event.registration;

  if (bgFetch.result === 'success') {
    clients.openWindow('/latest-podcasts');
  } else {
    clients.openWindow('/download-progress');
  }
});

추가 리소스

수정사항: 이 도움말의 이전 버전에서 백그라운드 가져오기를 '웹 표준'으로 잘못 언급했습니다. 이 API는 현재 표준 트랙에 있지 않으며 사양은 WICG에서 커뮤니티 그룹 보고서 초안으로 확인할 수 있습니다.