網頁儲存空間

在瀏覽器中儲存資料的方式有很多種。哪種最符合你的需求?

外出時,網際網路連線可能不穩定或不存在,因此離線支援和可靠效能是漸進式網頁應用程式的常見功能。即使在完美的無線環境中,謹慎使用快取和其他儲存技術,也能大幅改善使用者體驗。您可以透過多種方式快取靜態應用程式資源 (HTML、JavaScript、CSS、圖片等) 和資料 (使用者資料、新聞報導等)。但哪一個是最佳解決方案?可以儲存多少資料?如何防止 Pod 遭到淘汰?

我該使用哪一種?

以下是儲存資源的一般建議:

所有新式瀏覽器都支援 IndexedDB、OPFS 和 Cache Storage API。這類 API 採用非同步方式,不會封鎖主執行緒 (但 OPFS 也有同步變體,僅適用於 Web Worker)。您可以透過 window 物件、Web Worker 和 Service Worker 存取這些 API,因此可以在程式碼中的任何位置使用。

其他儲存機制呢?

瀏覽器中還有其他幾種儲存機制,但用途有限,且可能導致嚴重的效能問題。

SessionStorage 僅限於特定分頁,且範圍限於分頁的生命週期。這項功能適合用來儲存少量的工作階段專屬資訊,例如 IndexedDB 金鑰。由於這項方法為同步性質,且會封鎖主執行緒,因此請謹慎使用。大小限制約為 5 MB,且只能包含字串。由於這是分頁專屬,因此無法透過 Web Worker 或 Service Worker 存取。

請避免使用 LocalStorage,因為它是同步的,會封鎖主執行緒。大小限制約為 5 MB,且只能包含字串。無法從 Web Worker 或 Service Worker 存取 LocalStorage。

Cookie 有其用途,但不應用於儲存。Cookie 會隨每個 HTTP 要求傳送,因此只要儲存的資料量超過少量,每個網頁要求的大小就會大幅增加。這些 API 是同步的,無法從 Web Worker 存取。與 LocalStorage 和 SessionStorage 一樣,Cookie 僅限字串。

File System Access API 的設計目的是讓使用者能夠讀取及編輯本機檔案系統上的檔案。使用者必須先授予權限,網頁才能讀取或寫入任何本機檔案,且權限不會在工作階段之間保留,除非檔案控制代碼快取在 IndexedDB 中。File System Access API 最適合用於編輯器等用途,您需要開啟檔案、修改檔案,然後將變更儲存回檔案。

File System API 和 FileWriter API 提供在沙箱檔案系統中讀取及寫入檔案的方法。雖然這項功能是非同步,但僅適用於 Chromium 瀏覽器,因此不建議使用。

我可以儲存多少內容?

簡而言之,非常多,至少幾百 MB,甚至可能達到數百 GB 以上。瀏覽器實作方式不盡相同,但可用儲存空間量通常取決於裝置上的可用儲存空間量。

  • Chrome 允許瀏覽器最多使用總磁碟空間的 80%。來源最多可使用總磁碟空間的 60%。您可以使用 StorageManager API 判斷可用的配額上限。其他 Chromium 瀏覽器可能有所不同。
    • 在無痕模式下,Chrome 會將來源可用的儲存空間量減少至磁碟空間總量的 5% 左右。
    • 如果使用者在 Chrome 中啟用「關閉所有視窗時清除 Cookie 和網站資料」,儲存空間配額會大幅減少,上限約為 300 MB。
  • Firefox 允許瀏覽器使用最多 50% 的可用磁碟空間。eTLD+1 群組 (例如 example.com、www.example.com 和 foo.bar.example.com) 最多可使用 2 GB。您可以使用 StorageManager API 判斷還有多少可用空間。
  • Safari (電腦版和行動版) 似乎允許約 1 GB。達到上限時,Safari 會提示使用者,並以 200 MB 為單位提高上限。我找不到任何相關的官方說明文件。
    • 如果將 PWA 新增至行動版 Safari 的主畫面,系統會建立新的儲存容器,且 PWA 和行動版 Safari 之間不會共用任何內容。安裝的 PWA 達到配額後,似乎無法要求額外儲存空間。

過去,如果網站儲存的資料超過特定門檻,瀏覽器會提示使用者授予權限,以便使用更多資料。舉例來說,如果來源使用的儲存空間超過 50 MB,瀏覽器會提示使用者允許儲存最多 100 MB,然後在儲存空間達到 50 MB 時再次詢問。

目前,大多數新式瀏覽器不會提示使用者,並允許網站使用其分配的配額。Safari 似乎是例外,當超出儲存空間配額時,會提示要求提高分配配額的權限。如果來源嘗試使用的配額超過分配量,後續寫入資料的嘗試就會失敗。

如何查看可用儲存空間?

在許多瀏覽器中,您可以使用 StorageManager API 判斷來源可用的儲存空間量,以及使用的儲存空間量。這個 API 會回報 IndexedDB 和 Cache API 使用的總位元組數,並可計算出大約剩餘的可用儲存空間。

if (navigator.storage && navigator.storage.estimate) {
  const quota = await navigator.storage.estimate();
  // quota.usage -> Number of bytes used.
  // quota.quota -> Maximum number of bytes available.
  const percentageUsed = (quota.usage / quota.quota) * 100;
  console.log(`You've used ${percentageUsed}% of the available storage.`);
  const remaining = quota.quota - quota.usage;
  console.log(`You can write up to ${remaining} more bytes.`);
}

您必須擷取超出配額的錯誤 (請見下方)。在某些情況下,可用配額可能會超過實際可用的儲存空間。

檢查

在開發期間,您可以使用瀏覽器的開發人員工具檢查不同的儲存空間類型,並清除所有儲存的資料。

Chrome 88 新增了一項功能,可讓您在「Storage」窗格中覆寫網站的儲存空間配額。這項功能可讓您模擬不同的裝置,並在磁碟可用性偏低的情況下測試應用程式行為。依序前往「Application」和「Storage」,勾選「Simulate custom storage quota」核取方塊,然後輸入任何有效數字,模擬儲存空間配額。

如何處理超出配額的情況?

超出配額時該怎麼辦?最重要的是,無論是 QuotaExceededError 還是其他錯誤,您都應一律擷取並處理寫入錯誤。接著,請根據應用程式設計,決定如何處理。例如刪除長時間未存取的內容、根據大小移除資料,或提供使用者選擇要刪除內容的方式。

當您超出可用配額時,IndexedDB 和 Cache API 都會擲回名為 QuotaExceededError 的 DOMError。

IndexedDB

如果來源超過配額,寫入 IndexedDB 的嘗試就會失敗。系統會呼叫交易的 onabort() 處理常式,並傳遞事件。事件的 error 屬性會包含 DOMException。檢查錯誤 name 會傳回 QuotaExceededError。

const transaction = idb.transaction(['entries'], 'readwrite');
transaction.onabort = function(event) {
  const error = event.target.error; // DOMException
  if (error.name == 'QuotaExceededError') {
    // Fallback code goes here
  }
};

Cache API

如果來源超出配額,嘗試寫入 Cache API 時會遭到拒絕,並傳回 QuotaExceededError DOMException。

try {
  const cache = await caches.open('my-cache');
  await cache.add(new Request('/sample1.jpg'));
} catch (err) {
  if (error.name === 'QuotaExceededError') {
    // Fallback code goes here
  }
}

如何驅逐?

網頁儲存空間分為「盡力而為」和「永久」兩種。「盡力而為」表示瀏覽器可以清除儲存空間,不會干擾使用者,但對於長期或重要資料而言,耐用性較低。儲存空間不足時,系統不會自動清除永久儲存空間。使用者必須透過瀏覽器設定,手動清除這個儲存空間。

根據預設,網站資料 (包括 IndexedDB、Cache API 等) 屬於「盡力而為」類別,也就是說,除非網站要求永久儲存空間,否則瀏覽器可能會自行決定是否要移除網站資料,例如在裝置儲存空間不足時。

盡力而為的淘汰政策如下:

  • 當瀏覽器空間不足時,Chromium 瀏覽器會開始清除資料,首先從最近最少使用的來源清除所有網站資料,然後再清除下一個來源,直到瀏覽器不再超過限制為止。
  • 當可用磁碟空間用盡時,Firefox 會開始清除資料,首先從最近最少使用的來源清除所有網站資料,然後再清除下一個來源,直到瀏覽器不再超過限制為止。
  • Safari 先前不會清除資料,但最近對所有可寫入儲存空間實施新的七天上限 (請參閱下文)。

從 iOS 和 iPadOS 13.4 以及 macOS 上的 Safari 13.1 開始,所有指令碼可寫入儲存空間 (包括 IndexedDB、Service Worker 註冊和 Cache API) 都有七天的上限。也就是說,如果使用者未與網站互動,Safari 會在使用 Safari 七天後,從快取中移除所有內容。這項淘汰政策不適用於已安裝並新增至主畫面的 PWA。如需完整詳細資料,請參閱 WebKit 網誌上的「Full Third-Party Cookie Blocking and More」(全面封鎖第三方 Cookie 等)。

Storage bucket

Storage Buckets API 的核心概念是讓網站能夠建立多個儲存空間值區,瀏覽器可以選擇刪除每個值區,而不影響其他值區。開發人員可以指定優先淘汰順序,確保不會刪除最有價值的資料。

額外資訊:為什麼要使用 IndexedDB 包裝函式

IndexedDB 是低階 API,使用前需要進行大量設定,對於儲存低複雜度資料來說,可能特別麻煩。與大多數現代以 Promise 為基礎的 API 不同,它是以事件為基礎。IndexedDB 的 idb 等 Promise 包裝函式會隱藏部分強大功能,但更重要的是,會隱藏 IndexedDB 程式庫隨附的複雜機制 (例如交易、結構定義版本管理)。

額外好處:SQLite Wasm

Web SQL 遭到淘汰並從 Chrome 移除後,Google 與熱門 SQLite 資料庫的維護人員合作,提供以 SQLite 為基礎的 Web SQL 替代方案。如要瞭解如何使用,請參閱「瀏覽器中由來源私人檔案系統支援的 SQLite Wasm」。

結論

儲存空間有限、提示使用者儲存越來越多資料的日子已不復存在。網站可以有效儲存執行所需的所有資源和資料。您可以使用 StorageManager API 判斷可用空間和已用空間。此外,您可以使用永久儲存空間,防止資料遭到移除,除非使用者自行移除。

其他資源

謝謝

特別感謝 Jarryd Goodman、Phil Walton、Eiji Kitamura、Daniel Murphy、Darwin Huang、Josh Bell、Marijn Kruisselbrink 和 Victor Costan 審查本指南。感謝 Eiji Kitamura、Addy Osmani 和 Marc Cohen 撰寫本文所依據的原創文章。Eiji 撰寫了名為 Browser Storage Abuser 的實用工具,可用於驗證目前的行為。這項功能可讓您盡可能儲存資料,並查看瀏覽器的儲存空間限制。感謝 François Beaufort 深入研究 Safari,找出其儲存空間限制,以及 Thomas Steiner 新增來源私人檔案系統、儲存空間 bucket、SQLite Wasm 的相關資訊,並在 2024 年全面更新內容。