สร้างหน้าสำรองแบบออฟไลน์

Pete LePage

Thomas Steiner

แอป Google Assistant, แอป Slack, แอป Zoom และเกือบทุกแอปเฉพาะแพลตฟอร์มบนโทรศัพท์หรือคอมพิวเตอร์มีสิ่งใดเหมือนกัน ใช่ อย่างน้อยก็ให้อะไรสักอย่าง แม้จะไม่มีการเชื่อมต่อเครือข่าย คุณยังคงเปิดแอป Assistant, ป้อน Slack หรือเปิด Zoom ได้ คุณอาจไม่ได้อะไรที่มีความหมายมากนักหรืออาจทำสิ่งที่ต้องการไม่ได้ แต่อย่างน้อยคุณก็ได้บางอย่างและควบคุมแอปได้

ในทางตรงกันข้าม เดิมทีบนเว็บคุณจะไม่เห็นข้อมูลใดๆ เมื่อออฟไลน์ Chrome มีเกมไดโนเสาร์ออฟไลน์ให้คุณเล่นเท่านั้น

หน้าสำรองสำหรับใช้ออฟไลน์ที่มี Service Worker ที่กําหนดเอง

แต่ไม่จำเป็นต้องเป็นเช่นนั้น Service Worker และ Cache Storage API ช่วยให้คุณมอบประสบการณ์การใช้งานแบบออฟไลน์ที่ปรับแต่งเองให้แก่ผู้ใช้ได้ หน้านี้อาจเป็นหน้าเว็บที่มีแบรนด์ง่ายๆ พร้อมข้อมูลว่าผู้ใช้ออฟไลน์อยู่ หรืออาจเป็นโซลูชันที่สร้างสรรค์มากขึ้นก็ได้ เช่น เกมเขาวงกตออฟไลน์ของ 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.
});

หน้าสำรองสำหรับใช้เมื่อออฟไลน์

ไฟล์ offline.html เป็นไฟล์ที่คุณสามารถสร้างสรรค์และปรับให้เหมาะกับความต้องการ รวมถึงเพิ่มการสร้างแบรนด์ ตัวอย่างด้านล่างแสดงข้อมูลขั้นต่ำที่สุดที่เป็นไปได้ ตัวอย่างนี้แสดงทั้งการโหลดซ้ำด้วยตนเองตามการกดปุ่ม และการโหลดซ้ำอัตโนมัติตามเหตุการณ์ online และการเรียกข้อมูลเซิร์ฟเวอร์ตามปกติ

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />

    <title>You are offline</title>

    <!-- Inline the page's stylesheet. -->
    <style>
      body {
        font-family: helvetica, arial, sans-serif;
        margin: 2em;
      }

      h1 {
        font-style: italic;
        color: #373fff;
      }

      p {
        margin-block: 1rem;
      }

      button {
        display: block;
      }
    </style>
  </head>
  <body>
    <h1>You are offline</h1>

    <p>Click the button below to try reloading.</p>
    <button type="button">⤾ Reload</button>

    <!-- Inline the page's JavaScript file. -->
    <script>
      // Manual reload feature.
      document.querySelector("button").addEventListener("click", () => {
        window.location.reload();
      });

      // Listen to changes in the network state, reload when online.
      // This handles the case when the device is completely offline.
      window.addEventListener('online', () => {
        window.location.reload();
      });

      // Check if the server is responding and reload the page if it is.
      // This handles the case when the device is online, but the server
      // is offline or misbehaving.
      async function checkNetworkAndReload() {
        try {
          const response = await fetch('.');
          // Verify we get a valid response from the server
          if (response.status >= 200 && response.status < 500) {
            window.location.reload();
            return;
          }
        } catch {
          // Unable to connect to the server, ignore.
        }
        window.setTimeout(checkNetworkAndReload, 2500);
      }

      checkNetworkAndReload();
    </script>
  </body>
</html>

สาธิต

คุณดูหน้าสำรองสำหรับใช้ออฟไลน์ได้ในการเดโมที่ฝังไว้ด้านล่าง หากสนใจ คุณสามารถดูซอร์สโค้ดได้ใน Glitch

หมายเหตุเกี่ยวกับวิธีทำให้แอปติดตั้งได้

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

หมายเหตุเกี่ยวกับการแสดงหน้าสำรองสำหรับใช้ออฟไลน์ด้วย Workbox.js

คุณอาจเคยได้ยินเกี่ยวกับ Workbox Workbox คือชุดไลบรารี JavaScript สำหรับเพิ่มการรองรับการทำงานแบบออฟไลน์ลงในเว็บแอป หากต้องการเขียนโค้ด Service Worker เองให้น้อยลง คุณสามารถใช้สูตร Workbox สำหรับหน้าเว็บออฟไลน์เท่านั้น

หัวข้อถัดไปคือวิธีกําหนดกลยุทธ์การติดตั้งสําหรับแอป