Skip to content
⚠️ This article was written in 2018. Some content may be outdated.

IndexedDB:前端本地儲存進階

localStorage 只能存字串,容量 5MB,查詢不方便。IndexedDB 是瀏覽器內建的 NoSQL 資料庫,容量可達幾百 MB,支援事務和索引查詢,適合離線應用。

基本概念

Database(資料庫)
  └── ObjectStore(類似表)
        ├── Record(記錄)
        └── Index(索引,用於查詢)

封裝一個簡單的工具類

IndexedDB 的原生 API 是基於事件的,比較繁瑣,先封裝成 Promise:

javascript
class IDB {
  constructor(dbName, version, onUpgrade) {
    this.dbName = dbName;
    this.version = version;
    this.onUpgrade = onUpgrade;
    this._db = null;
  }

  open() {
    return new Promise((resolve, reject) => {
      const request = indexedDB.open(this.dbName, this.version);

      request.onupgradeneeded = (e) => {
        this.onUpgrade(e.target.result);
      };

      request.onsuccess = (e) => {
        this._db = e.target.result;
        resolve(this);
      };

      request.onerror = () => reject(request.error);
    });
  }

  add(storeName, data) {
    return new Promise((resolve, reject) => {
      const tx = this._db.transaction(storeName, "readwrite");
      const store = tx.objectStore(storeName);
      const request = store.add(data);
      request.onsuccess = () => resolve(request.result);
      request.onerror = () => reject(request.error);
    });
  }

  get(storeName, key) {
    return new Promise((resolve, reject) => {
      const tx = this._db.transaction(storeName, "readonly");
      const store = tx.objectStore(storeName);
      const request = store.get(key);
      request.onsuccess = () => resolve(request.result);
      request.onerror = () => reject(request.error);
    });
  }

  getAll(storeName) {
    return new Promise((resolve, reject) => {
      const tx = this._db.transaction(storeName, "readonly");
      const store = tx.objectStore(storeName);
      const request = store.getAll();
      request.onsuccess = () => resolve(request.result);
      request.onerror = () => reject(request.error);
    });
  }

  delete(storeName, key) {
    return new Promise((resolve, reject) => {
      const tx = this._db.transaction(storeName, "readwrite");
      const store = tx.objectStore(storeName);
      const request = store.delete(key);
      request.onsuccess = () => resolve();
      request.onerror = () => reject(request.error);
    });
  }
}

使用示例

javascript
const db = await new IDB("myApp", 1, (db) => {
  const store = db.createObjectStore("articles", {
    keyPath: "id",
    autoIncrement: false,
  });
  store.createIndex("category", "category", { unique: false });
  store.createIndex("date", "date", { unique: false });
}).open();

await db.add("articles", {
  id: "vue-reactivity",
  title: "Vue 響應式原理",
  category: "vue",
  date: "2018-01-01",
  content: "...",
});

const article = await db.get("articles", "vue-reactivity");
const all = await db.getAll("articles");

實際場景:離線草稿

javascript
class DraftManager {
  async saveDraft(content) {
    await db.put("drafts", {
      id: "current",
      content,
      savedAt: Date.now(),
    });
  }

  async loadDraft() {
    return db.get("drafts", "current");
  }

  async clearDraft() {
    return db.delete("drafts", "current");
  }
}

// 編輯時自動儲存(防抖)
editor.on(
  "change",
  debounce(async (content) => {
    await draftManager.saveDraft(content);
  }, 1000),
);

localStorage vs IndexedDB

               localStorage    IndexedDB
容量            5MB             250MB+(因瀏覽器而異)
資料型別        只能字串       JS 物件(二進位制也支援)
API             同步            非同步
查詢            只能按 key      支援索引查詢
事務            不支援          支援
適用場景        配置、token     離線資料、大量結構化資料

小結

  • IndexedDB 是瀏覽器內建 NoSQL,支援大容量結構化資料
  • 原生 API 基於事件,用 Promise 封裝後更好用
  • 適合:離線草稿、快取 API 資料、減少重複網路請求
  • Service Worker + IndexedDB 是構建 PWA 的關鍵組合

MIT Licensed