このページは Cloud Translation API によって翻訳されました。

オフラインの代替ページを作成する

Pete LePage

Thomas Steiner

Google アシスタントアプリ、Slack アプリ、Zoom アプリ、スマートフォンやパソコン上のほぼすべてのプラットフォーム固有のアプリに共通する点は何ですか？少なくとも何かはもらえるしね。ネットワークに接続していなくても、アシスタントアプリを開いたり、Slack にアクセスしたり、Zoom を起動したりできます。特に有意なものが得られなかったり、目的を達成できなかったりすることもありますが、少なくとも何かは得られ、アプリは制御されています。

オフライン時の Google アシスタントモバイルアプリ。 — Google アシスタント。

一方、ウェブでは、従来はオフラインになると何も表示されませんでした。Chrome にはオフラインの恐竜ゲームがありますが、それ以外はありません。

オフラインの恐竜ゲームが表示されている Google Chrome モバイルアプリ。 — Google Chrome for iOS。

オフラインの恐竜ゲームが表示されている Google Chrome デスクトップアプリ。 — Google Chrome for iOS。

カスタム Service Worker を使用したオフラインフォールバックページ

ただし、必ずしもこのようにする必要はありません。サービスワーカーと Cache Storage API を使用すると、ユーザーにカスタマイズされたオフラインエクスペリエンスを提供できます。ユーザーが現在オフラインであるという情報を含むシンプルなブランドページでもかまいませんが、手動の再接続ボタンと自動再接続試行のカウントダウンを備えた有名な trivago のオフライン迷路ゲームなど、よりクリエイティブなソリューションでもかまいません。

Trivago のオフラインページと Trivago のオフラインラビリンス。 — トリバゴのオフライン迷路。

Service Worker の登録

これを実現するには、Service Worker を使用します。以下のコードサンプルのように、メインページから Service Worker を登録できます。通常、この操作はアプリの読み込み後に行います。

window.addEventListener("load", () => {
  if ("serviceWorker" in navigator) {
    navigator.serviceWorker.register("service-worker.js");
  }
});

Service Worker のコード

実際の Service Worker ファイルの内容は一見複雑に見えますが、以下のサンプルのコメントを参照するとわかりやすくなります。主なアイデアは、offline.html という名前のファイルをプリキャッシュに保存し、ナビゲーションリクエストが失敗した場合にのみ配信し、他のすべてのケースをブラウザに処理させることです。

/*
Copyright 2015, 2019, 2020, 2021 Google LLC. All Rights Reserved.
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 http://www.apache.org/licenses/LICENSE-2.0
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
*/

// Incrementing OFFLINE_VERSION will kick off the install event and force
// previously cached resources to be updated from the network.
// This variable is intentionally declared and unused.
// Add a comment for your linter if you want:
// eslint-disable-next-line no-unused-vars
const OFFLINE_VERSION = 1;
const CACHE_NAME = "offline";
// Customize this with a different URL if needed.
const OFFLINE_URL = "offline.html";

self.addEventListener("install", (event) => {
  event.waitUntil(
    (async () => {
      const cache = await caches.open(CACHE_NAME);
      // Setting {cache: 'reload'} in the new request ensures that the
      // response isn't fulfilled from the HTTP cache; i.e., it will be
      // from the network.
      await cache.add(new Request(OFFLINE_URL, { cache: "reload" }));
    })()
  );
  // Force the waiting service worker to become the active service worker.
  self.skipWaiting();
});

self.addEventListener("activate", (event) => {
  event.waitUntil(
    (async () => {
      // Enable navigation preload if it's supported.
      // See https://developers.google.com/web/updates/2017/02/navigation-preload
      if ("navigationPreload" in self.registration) {
        await self.registration.navigationPreload.enable();
      }
    })()
  );

  // Tell the active service worker to take control of the page immediately.
  self.clients.claim();
});

self.addEventListener("fetch", (event) => {
  // Only call event.respondWith() if this is a navigation request
  // for an HTML page.
  if (event.request.mode === "navigate") {
    event.respondWith(
      (async () => {
        try {
          // First, try to use the navigation preload response if it's
          // supported.
          const preloadResponse = await event.preloadResponse;
          if (preloadResponse) {
            return preloadResponse;
          }

          // Always try the network first.
          const networkResponse = await fetch(event.request);
          return networkResponse;
        } catch (error) {
          // catch is only triggered if an exception is thrown, which is
          // likely due to a network error.
          // If fetch() returns a valid HTTP response with a response code in
          // the 4xx or 5xx range, the catch() will NOT be called.
          console.log("Fetch failed; returning offline page instead.", error);

          const cache = await caches.open(CACHE_NAME);
          const cachedResponse = await cache.match(OFFLINE_URL);
          return cachedResponse;
        }
      })()
    );
  }

  // If our if() condition is false, then this fetch handler won't
  // intercept the request. If there are any other fetch handlers
  // registered, they will get a chance to call event.respondWith().
  // If no fetch handlers call event.respondWith(), the request
  // will be handled by the browser as if there were no service
  // worker involvement.
});