API синхронизации в фоновом режиме

API синхронизации в фоновом режиме позволяет веб-приложению откладывать задачи, чтобы они выполнялись в сервисном рабочем процессе после того, как пользователь подключится к стабильному сетевому соединению.

API синхронизации в фоновом режиме позволяет веб-приложениям откладывать работу по синхронизации с сервером до обработки их сервисными рабочими процессами в более позднее время, если устройство отключено от сети. Это может включать отправку запросов в фоновом режиме, если их нельзя было отправить во время использования приложения.

Например, приложение-клиент электронной почты может позволить пользователям составлять и отправлять сообщения в любое время, даже когда устройство не подключено к сети. Фронтенд приложения просто регистрирует запрос на синхронизацию, и сервисный рабочий процесс получает уведомление о наличии сети и обрабатывает синхронизацию.

Интерфейс SyncManager доступен через ServiceWorkerRegistration.sync. Уникальный идентификатор тега используется для именования события синхронизации, которое затем можно прослушивать в скрипте ServiceWorker. После получения события вы можете выполнить любые доступные функции, такие как отправка запросов на сервер.

Так как этот API опирается на сервисные рабочие процессы, функции, предоставляемые этим API, доступны только в безопасном контексте.

SyncManager Экспериментальный

Регистрирует задачи, которые должны быть выполнены в сервисном рабочем процессе в более позднее время, когда устройство будет подключено к сети. Эти задачи называются *запросами синхронизации в фоновом режиме*.

SyncEvent Экспериментальный

Представляет событие синхронизации, отправляемое в глобальную область ServiceWorker. Это предоставляет способ выполнения задач в сервисном рабочем процессе, как только устройство получит сетевое подключение.

Следующие дополнения к API сервисных рабочих процессов предоставляют точку входа для настройки синхронизации в фоновом режиме.

ServiceWorkerRegistration.sync Только для чтения

Возвращает ссылку на интерфейс SyncManager для регистрации задач, которые должны выполняться после подключения устройства к сети.

sync событие

Обработчик событий, срабатывающий всякий раз, когда происходит событие sync. Это происходит сразу же, как только доступна сеть.

В следующих примерах показано, как использовать интерфейс.

Следующая асинхронная функция регистрирует синхронизацию в фоновом режиме из контекста просмотра:

async function syncMessagesLater() {
  const registration = await navigator.serviceWorker.ready;
  try {
    await registration.sync.register("sync-messages");
  } catch {
    console.log("Background Sync could not be registered!");
  }
}

Этот код проверяет, зарегистрирована ли задача синхронизации в фоновом режиме с заданным тегом.

navigator.serviceWorker.ready.then((registration) => {
  registration.sync.getTags().then((tags) => {
    if (tags.includes("sync-messages")) {
      console.log("Messages sync already requested");
    }
  });
});

Следующий пример демонстрирует, как реагировать на событие синхронизации в фоновом режиме в сервисном рабочем процессе.

self.addEventListener("sync", (event) => {
  if (event.tag === "sync-messages") {
    event.waitUntil(sendOutboxMessages());
  }
});

• Представление фоновой синхронизации