除 SPA 之外 - PWA 的替代架構

我們來聊聊... 建築吧?

我將探討一個重要但可能遭到誤解的主題:網頁應用程式使用的架構,特別是建構漸進式網頁應用程式時,架構決策如何發揮作用。

「架構」聽起來可能很模糊,而且可能無法立即清楚瞭解其重要性。思考架構的一種方式是問自己以下問題:當使用者造訪網站上的網頁時,會載入哪些 HTML?接著,當他們造訪其他網頁時,系統會載入什麼內容?

這些問題的答案不一定很簡單,一旦開始思考漸進式網頁應用程式,問題可能會變得更複雜。因此,我的目標是帶您瞭解我認為有效的架構。在本文中,我會將我做出的決策標示為建構漸進式網頁應用程式的「我的方法」。

建構自己的 PWA 時,您可以自由使用我的方法,但同時也有其他有效的替代方案。希望您在瞭解各個部分如何搭配運作後,能獲得靈感,並能根據需求自訂這項功能。

Stack Overflow PWA

為了搭配本文,我建構了 Stack Overflow PWA。我花了很多時間閱讀 Stack Overflow 上的內容並貢獻自己的知識,因此我想建構一個網頁應用程式,讓使用者能輕鬆瀏覽特定主題的常見問題。這個應用程式是以公開的 Stack Exchange API 為基礎建構而成。這項工具是開放原始碼,如要瞭解詳情,請造訪 GitHub 專案。

多頁應用程式 (MPA)

在深入探討細節之前,我們先定義一些術語,並說明部分基礎技術。首先,我會介紹我喜歡稱之為「多頁應用程式」或「MPA」的概念。

MPA 是自網路誕生以來,傳統架構的華麗名稱。每當使用者前往新網址,瀏覽器就會逐步轉譯該網頁專屬的 HTML。系統不會嘗試在導覽之間保留頁面狀態或內容。每次造訪新頁面時,系統都會重新開始。

這與建構網頁應用程式的單頁應用程式 (SPA) 模型相反,在 SPA 模型中,當使用者造訪新區段時,瀏覽器會執行 JavaScript 程式碼來更新現有網頁。SPA 和 MPA 都是同樣有效的模型,但本文想探討多頁應用程式中的 PWA 概念。

速度飛快,穩定可靠

您可能聽過我 (和無數其他人) 使用「漸進式網頁應用程式」或 PWA 這個詞。您可能已熟悉本網站其他部分的一些背景資料。

您可以將 PWA 視為提供一流使用者體驗的網頁應用程式,並在使用者主畫面中占有一席之地。「FIRE」是 Fast (快速)、Integrated (整合)、Reliable (可靠) 和 Engaging (吸引人) 的縮寫,總結了建構 PWA 時應考量的所有屬性。

本文將著重於其中一部分屬性:快速和可靠。

快速:雖然「快速」在不同情境下有不同意義,但我會說明盡可能減少從網路載入內容的速度優勢。

可靠: 但光有速度還不夠。網頁應用程式必須穩定可靠,才能提供 PWA 體驗。無論網路狀態為何,都必須有足夠的彈性,一律載入某些內容,即使只是自訂錯誤頁面也一樣。

穩定快速:最後,我會稍微重新定義 PWA,並探討如何建構穩定快速的應用程式。只有在低延遲網路中,才能提供快速可靠的服務,這是不夠的。「穩定快速」是指無論基礎網路條件為何,網頁應用程式的速度都保持一致。

啟用技術:Service Worker + Cache Storage API

PWA 對速度和韌性有很高的要求。幸好,網路平台提供一些建構模塊,可實現這類效能。我指的是 Service Worker 和 Cache Storage API。

您可以建構 Service Worker,監聽傳入的要求,將部分要求傳遞至網路,並透過 Cache Storage API 儲存回應副本,以供日後使用。

使用 Cache Storage API 儲存網路回應副本的 Service Worker。

下次網頁應用程式提出相同要求時,Service Worker 就能檢查快取,並直接傳回先前快取的回應。

使用 Cache Storage API 回應的 Service Worker,會略過網路。

盡可能避免使用網路,是提供可靠快速效能的重要一環。

「同構」JavaScript

我想介紹的另一個概念,有時稱為「同構」或「通用」JavaScript。簡單來說,就是可以在不同的執行階段環境之間共用相同的 JavaScript 程式碼。建構 PWA 時,我想在後端伺服器和 Service Worker 之間共用 JavaScript 程式碼。

透過這種方式共用程式碼有許多有效的方法,但我的方法是使用 ES 模組做為明確的原始碼。接著,我使用 Babel 和 Rollup 的組合,為伺服器和 Service Worker 轉譯並打包這些模組。在我的專案中,副檔名為 .mjs 的檔案是位於 ES 模組中的程式碼。

伺服器

瞭解這些概念和術語後,我們來深入探討如何實際建構 Stack Overflow PWA。我會先介紹後端伺服器,並說明它在整體架構中的角色。

我當時想找的是動態後端與靜態託管的組合,而我的做法是使用 Firebase 平台。

Firebase Cloud Functions 會在收到傳入要求時,自動啟動以 Node 為基礎的環境,並與我熟悉的熱門 Express HTTP 架構整合。此外,它還為我網站的所有靜態資源提供現成的託管服務。接著來看看伺服器如何處理要求。

瀏覽器向伺服器發出導覽要求時,會經過下列流程:

在伺服器端產生導覽回應的總覽。

伺服器會根據網址轉送要求,並使用範本邏輯建立完整的 HTML 文件。我結合使用 Stack Exchange API 的資料,以及伺服器儲存在本機的部分 HTML 片段。Service Worker 知道如何回應後,就會開始將 HTML 串流傳回網頁應用程式。

這張圖片有兩個部分值得深入探討:路由和範本。

轉送

在轉送方面,我採用 Express 架構的原生轉送語法。這項功能相當靈活,可比對簡單的網址前置字元,以及路徑中包含參數的網址。在這裡,我建立路徑名稱與基礎 Express 模式之間的對應關係,以便進行比對。

const routes = new Map([
  ['about', '/about'],
  ['questions', '/questions/:questionId'],
  ['index', '/'],
]);

export default routes;

接著,我可以直接從伺服器的程式碼參照這個對應。如果與指定的 Express 模式相符,適當的處理常式會以符合路徑專屬的範本邏輯回應。

import routes from './lib/routes.mjs';
app.get(routes.get('index'), async (req, res) => {
  // Templating logic.
});

伺服器端範本

範本邏輯是什麼樣子?我採用的方法是將部分 HTML 片段依序拼接在一起。這個模型非常適合串流。

伺服器會立即傳回一些初始 HTML 樣板,瀏覽器則能立即轉譯該部分網頁。伺服器會將其餘資料來源拼湊在一起,並串流至瀏覽器,直到文件完成。

為了說明這一點,請查看其中一個路徑的 Express 程式碼:

app.get(routes.get('index'), async (req, res) => {
  res.write(headPartial + navbarPartial);
  const tag = req.query.tag || DEFAULT_TAG;
  const data = await requestData(...);
  res.write(templates.index(tag, data.items));
  res.write(footPartial);
  res.end();
});

透過使用 response 物件的 write() 方法,並參照本機儲存的部分範本,我能立即啟動回應串流,而不會封鎖任何外部資料來源。瀏覽器會擷取這個初始 HTML,並立即顯示有意義的介面和載入訊息。

網頁的下一個部分會使用 Stack Exchange API 的資料。伺服器需要發出網路要求,才能取得資料。網頁應用程式在收到並處理回應前,無法顯示其他內容,但至少使用者不必盯著空白畫面等待。

網頁應用程式收到 Stack Exchange API 的回應後,會呼叫自訂範本函式,將 API 的資料轉譯為對應的 HTML。

範本語言

範本化可能是一個令人驚訝的爭議性主題,而我所採用的只是眾多方法中的一種。您可能需要替換自己的解決方案,尤其是與現有範本架構有舊版繫結時。

在我的用途中,最合理的做法是只依賴 JavaScript 的範本文字,並將部分邏輯拆分為輔助函式。建構 MPA 的好處之一,是不必追蹤狀態更新和重新轉譯 HTML,因此產生靜態 HTML 的基本方法對我來說很有效。

以下範例說明如何為網頁應用程式索引的動態 HTML 部分建立範本。與路徑一樣,範本邏輯儲存在 ES 模組中,可匯入伺服器和 Service Worker。

export function index(tag, items) {
  const title = `<h3>Top "${escape(tag)}" Questions</h3>`;
  const form = `<form method="GET">...</form>`;
  const questionCards = items
    .map(item =>
      questionCard({
        id: item.question_id,
        title: item.title,
      })
    )
    .join('');
  const questions = `<div id="questions">${questionCards}</div>`;
  return title + form + questions;
}

這些範本函式是純 JavaScript,建議您在適當情況下,將邏輯拆解成較小的輔助函式。在這裡,我將 API 回應中傳回的每個項目傳遞至這類函式,該函式會建立一個標準 HTML 元素,並設定所有適當的屬性。

function questionCard({id, title}) {
  return `<a class="card"
             href="/questions/${id}"
             data-cache-url="${questionUrl(id)}">${title}</a>`;
}

特別值得注意的是,我為每個連結新增了資料屬性 data-cache-url,並將其設為顯示對應問題所需的 Stack Exchange API 網址。請留意這一點。我稍後會再查看。

回到路徑處理常式,範本建立完成後,我會將網頁 HTML 的最後一部分串流至瀏覽器,並結束串流。這會提示瀏覽器漸進式算繪已完成。

app.get(routes.get('index'), async (req, res) => {
  res.write(headPartial + navbarPartial);
  const tag = req.query.tag || DEFAULT_TAG;
  const data = await requestData(...);
  res.write(templates.index(tag, data.items));
  res.write(footPartial);
  res.end();
});

以上就是伺服器設定的簡短介紹。首次造訪網頁應用程式的使用者一律會收到伺服器的回應,但當訪客返回網頁應用程式時,Service Worker 就會開始回應。我們來深入探討。

Service Worker

在 Service Worker 中生成導覽回應的總覽。

這張圖表應該很眼熟,先前介紹過的許多部分都出現在這裡,只是排列方式略有不同。接著,我們來看看要求流程,並將 Service Worker 納入考量。

Service Worker 會處理特定網址的傳入導覽要求,並像伺服器一樣,結合轉送和範本邏輯,判斷如何回應。

方法與之前相同,但使用不同的低階原始物件,例如 fetch() 和 Cache Storage API。我會使用這些資料來源建構 HTML 回應,並由 Service Worker 傳回網頁應用程式。

Workbox

我不會從頭開始使用低階原始物件,而是會在一組名為 Workbox 的高階程式庫上建構 Service Worker。為任何 Service Worker 的快取、轉送和回應生成邏輯奠定穩固基礎。

轉送

就像伺服器端程式碼一樣,Service Worker 需要知道如何將傳入的要求與適當的回應邏輯進行比對。

我的做法是使用名為 regexparam 的實用程式庫,將每個 Express 路徑轉譯為對應的規則運算式。完成轉譯後,我就可以利用 Workbox 內建的規則運算式轉送支援功能。

匯入含有規則運算式的模組後,我會向 Workbox 的路由器註冊每個規則運算式。在每個路徑中,我都能提供自訂範本邏輯來生成回應。在 Service Worker 中建立範本比在後端伺服器中更複雜,但 Workbox 可協助處理許多繁重的工作。

import regExpRoutes from './regexp-routes.mjs';

workbox.routing.registerRoute(
  regExpRoutes.get('index')
  // Templating logic.
);

靜態素材資源快取

範本故事的重要部分是確保我的部分 HTML 範本可透過 Cache Storage API 在本機使用,並在將變更部署至網頁應用程式時保持最新狀態。手動執行快取維護作業時,可能會發生錯誤,因此我會使用 Workbox 處理預先快取,做為建構程序的一部分。

我使用設定檔告訴 Workbox 要預先快取哪些網址,並指向包含所有本機資產的目錄,以及一組要比對的模式。每次重建網站時,Workbox 的 CLI 都會執行,並自動讀取這個檔案。

module.exports = {
  globDirectory: 'build',
  globPatterns: ['**/*.{html,js,svg}'],
  // Other options...
};

Workbox 會擷取每個檔案內容的快照,並自動將該網址和修訂版本清單插入最終的 Service Worker 檔案。Workbox 現在已具備所需的一切,可讓預先快取的檔案隨時可用,並保持最新狀態。結果會是 service-worker.js 檔案,其中包含類似下列內容:

workbox.precaching.precacheAndRoute([
  {
    url: 'partials/about.html',
    revision: '518747aad9d7e',
  },
  {
    url: 'partials/foot.html',
    revision: '69bf746a9ecc6',
  },
  // etc.
]);

如果建構程序較為複雜,Workbox 除了提供指令列介面,也提供 webpack 外掛程式和一般節點模組。

串流

接著,我希望 Service Worker 立即將預先快取的部分 HTML 串流回網頁應用程式。這是「可靠快速」的重要一環,我一律會立即在畫面上看到有意義的內容。幸好,在 Service Worker 中使用 Streams API 就能做到這一點。

您可能聽過 Streams API。我的同事 Jake Archibald 多年來一直對它讚譽有加。他大膽預測 2016 年將是網站串流之年。Streams API 現在和兩年前一樣出色,但有一個關鍵差異。

雖然當時只有 Chrome 支援 Streams,但 Streams API 現在已獲得更廣泛的支援。整體而言,這項功能相當實用,只要有適當的備用程式碼,您就能在 Service Worker 中使用串流。

不過,你可能會遇到一個阻礙,那就是理解 Streams API 的實際運作方式。它提供一組非常強大的原始物件,熟悉它的開發人員可以建立複雜的資料流程,例如:

const stream = new ReadableStream({
  pull(controller) {
    return sources[0]
      .then(r => r.read())
      .then(result => {
        if (result.done) {
          sources.shift();
          if (sources.length === 0) return controller.close();
          return this.pull(controller);
        } else {
          controller.enqueue(result.value);
        }
      });
  },
});

不過,並非所有人都能完全理解這段程式碼的含義。與其剖析這項邏輯,不如談談我對 Service Worker 串流的做法。

我使用的是全新的高階包裝函式 workbox-streams。這樣一來,我就可以在混合串流來源中傳遞,包括快取和可能來自網路的執行階段資料。Workbox 會負責協調個別來源,並將這些來源拼接成單一串流回應。

此外,Workbox 會自動偵測是否支援 Streams API,如果不支援,則會建立等效的非串流回應。這表示您不必擔心編寫備用方案,因為串流已接近 100% 瀏覽器支援。

執行階段快取

我們來看看 Service Worker 如何處理 Stack Exchange API 的執行階段資料。我使用 Workbox 內建的過時重新驗證快取策略,並設定到期時間,確保網頁應用程式的儲存空間不會無限成長。

我在 Workbox 中設定了兩種策略,用來處理構成串流回應的不同來源。只要呼叫幾個函式和設定,Workbox 就能完成原本需要數百行手寫程式碼的工作。

const cacheStrategy = workbox.strategies.cacheFirst({
  cacheName: workbox.core.cacheNames.precache,
});

const apiStrategy = workbox.strategies.staleWhileRevalidate({
  cacheName: API_CACHE_NAME,
  plugins: [new workbox.expiration.Plugin({maxEntries: 50})],
});

第一種策略會讀取預先快取的資料,例如部分 HTML 範本。

另一項策略則會實作 stale-while-revalidate 快取邏輯,並在達到 50 個項目時,採用最近最少使用的快取到期時間。

現在我已制定好這些策略,接下來只要告訴 Workbox 如何使用這些策略,建構完整的串流回應即可。我以函式的形式傳入來源陣列,每個函式都會立即執行。Workbox 會從每個來源取得結果,並依序串流至網頁應用程式,只有在陣列中的下一個函式尚未完成時,才會延遲。

workbox.streams.strategy([
  () => cacheStrategy.makeRequest({request: '/head.html'}),
  () => cacheStrategy.makeRequest({request: '/navbar.html'}),
  async ({event, url}) => {
    const tag = url.searchParams.get('tag') || DEFAULT_TAG;
    const listResponse = await apiStrategy.makeRequest(...);
    const data = await listResponse.json();
    return templates.index(tag, data.items);
  },
  () => cacheStrategy.makeRequest({request: '/foot.html'}),
]);

前兩個來源是直接從 Cache Storage API 讀取的預先快取部分範本,因此一律可立即使用。這可確保我們的 Service Worker 實作項目能像伺服器端程式碼一樣,可靠且快速地回應要求。

下一個來源函式會從 Stack Exchange API 擷取資料,並將回應處理成網頁應用程式預期的 HTML。

stale-while-revalidate 策略是指,如果我先前有這個 API 呼叫的快取回應,就能立即串流至網頁,同時「在背景」更新快取項目,以便下次要求時使用。

最後,我串流頁尾的快取副本,並關閉最後的 HTML 代碼,完成回應。

共用程式碼可確保資料同步

您會發現 Service Worker 程式碼的某些部分看起來很熟悉。Service Worker 使用的部分 HTML 和範本邏輯與伺服器端處理常式使用的邏輯相同。這種程式碼共用方式可確保使用者獲得一致的體驗,無論是首次造訪網頁應用程式,還是返回由 Service Worker 轉譯的網頁。這就是同構 JavaScript 的優點。

動態漸進增強

我已逐步介紹 PWA 的伺服器和 Service Worker,但還有最後一個邏輯要說明:在每個網頁完全串流後,會執行少量 JavaScript。

這段程式碼會逐步提升使用者體驗,但並非必要,即使不執行,網頁應用程式仍可正常運作。

網頁中繼資料

我的應用程式使用用戶端 JavaScript,根據 API 回應更新網頁的中繼資料。由於我為每個網頁使用相同的初始快取 HTML,網頁應用程式最終會在文件標頭中加入一般標記。不過,只要協調範本和用戶端程式碼,就能使用特定網頁的中繼資料更新視窗標題。

在範本程式碼中,我的做法是加入包含正確逸出字串的指令碼標記。

const metadataScript = `<script>
  self._title = '${escape(item.title)}';
</script>`;

接著,在網頁載入後,我會讀取該字串並更新文件標題。

if (self._title) {
  document.title = unescape(self._title);
}

如果您想在自己的網頁應用程式中更新其他特定網頁中繼資料,可以採用相同的方法。

離線使用者體驗

我新增的另一項漸進增強功能,是用來吸引使用者注意離線功能。我建構了可靠的 PWA,並希望使用者知道,即使離線,他們仍可載入先前造訪過的網頁。

首先,我使用 Cache Storage API 取得先前快取的所有 API 要求清單,並將其轉換為網址清單。

還記得我提過的特殊資料屬性嗎?每個屬性都包含 API 要求的網址,用於顯示問題。我可以將這些資料屬性與快取網址清單交叉比對,並建立不相符的所有問題連結陣列。

當瀏覽器進入離線狀態時,我會循環瀏覽未快取的連結清單,並將無法運作的連結調暗。請注意,這只是向使用者提供視覺提示,讓他們知道這些頁面會呈現什麼內容,我並未實際停用連結,或阻止使用者瀏覽。

const apiCache = await caches.open(API_CACHE_NAME);
const cachedRequests = await apiCache.keys();
const cachedUrls = cachedRequests.map(request => request.url);

const cards = document.querySelectorAll('.card');
const uncachedCards = [...cards].filter(card => {
  return !cachedUrls.includes(card.dataset.cacheUrl);
});

const offlineHandler = () => {
  for (const uncachedCard of uncachedCards) {
    uncachedCard.style.opacity = '0.3';
  }
};

const onlineHandler = () => {
  for (const uncachedCard of uncachedCards) {
    uncachedCard.style.opacity = '1.0';
  }
};

window.addEventListener('online', onlineHandler);
window.addEventListener('offline', offlineHandler);

常見陷阱

我已介紹建構多頁 PWA 的方法。在制定自己的方法時,您必須考量許多因素,最後可能會做出與我不同的選擇。這種彈性是建構網頁應用程式的一大優點。

在自行決定架構時,您可能會遇到一些常見問題,我想幫您省去一些麻煩。

不要快取完整的 HTML

建議不要在快取中儲存完整的 HTML 文件。首先,這會浪費空間。如果網頁應用程式的每個網頁都使用相同的基本 HTML 結構,您最終會一再儲存相同標記的副本。

更重要的是,如果您對網站的共用 HTML 結構部署變更,先前快取的每個網頁仍會停留在舊版面配置。想像一下,如果回訪者看到新舊網頁混雜,會有多沮喪。

伺服器/Service Worker 漂移

另一個要避免的陷阱是伺服器和 Service Worker 不同步。我的做法是使用同構 JavaScript,讓兩處執行相同的程式碼。視現有伺服器架構而定,這不一定可行。

無論您做出何種架構決策,都應制定策略,在伺服器和 Service Worker 中執行對等的轉送和範本程式碼。

最糟情況

版面配置/設計不一致

如果忽略這些陷阱,會發生什麼事?雖然各種失敗都有可能發生,但最糟的情況是回訪者造訪快取網頁,但版面配置非常過時,例如標題文字過時,或使用的 CSS 類別名稱已失效。

最糟情況:路徑中斷

或者,使用者可能會遇到由伺服器處理,但不是由 Service Worker 處理的網址。如果網站充滿殭屍版面配置和死胡同,就不是可靠的 PWA。

成功秘訣

但你不用獨自面對!以下提示可協助您避免這些問題:

使用支援多種語言的範本和轉送程式庫

請嘗試使用具有 JavaScript 實作的範本和轉送程式庫。我知道並非所有開發人員都能輕鬆遷移目前的網路伺服器和範本語言。

不過,許多熱門的範本和轉送架構都有多種語言的實作。如果能找到同時支援 JavaScript 和目前伺服器語言的範本引擎,就能更輕鬆地同步處理 Service Worker 和伺服器。

建議使用依序範本,而非巢狀範本

接下來,建議您使用一系列可依序串流的範本。只要能盡快串流 HTML 的初始部分,即使網頁後續部分使用更複雜的範本邏輯也沒關係。

在 Service Worker 中快取靜態和動態內容

為達到最佳效能,建議您預先快取網站的所有重要靜態資源。您也應設定執行階段快取邏輯,處理 API 要求等動態內容。使用 Workbox,您就能以經過充分測試、可用於正式環境的策略為基礎,不必從頭開始實作。

除非絕對必要,否則請勿在網路上封鎖

與此相關的是,只有在無法從快取串流回應時,才應在網路上封鎖。與等待最新資料相比,立即顯示快取的 API 回應通常能提供更優質的使用者體驗。

資源