手寫一個前端儲存工具庫

在專案開發的過程中，為了減少提高效能，減少請求，開發者往往需要將一些不易改變的資料放入本地快取中。如把使用者使用的模板資料放入 localStorage 或者 IndexedDB。程式碼往往如下書寫。

// 這裡將資料放入記憶體中
let templatesCache = null;

// 使用者id，用於多賬號系統
const userId: string = '1';

const getTemplates = ({
  refresh = false
} = {
  refresh: false
}) => {
  // 不需要立即重新整理，走儲存
  if (!refresh) {
    // 記憶體中有資料，直接使用記憶體中資料
    if (templatesCache) {
      return Promise.resolve(templatesCache)
    }

    const key = `templates.${userId}`
    // 從 localStorage 中獲取資料
    const templateJSONStr = localStroage.getItem(key)
    
    if (templateJSONStr) {
      try {
        templatesCache = JSON.parse(templateJSONStr);
        return Promise.resolve(templatesCache)
      } catch () {
        // 解析失敗，清除 storage 中資料
        localStroage.removeItem(key)
      }
    }
  }

  // 進行服務端掉用獲取資料
  return api.get('xxx').then(res => {
    templatesCache = cloneDeep(res)
    // 存入 本地快取
    localStroage.setItem(key, JSON.stringify(templatesCache))
    return res
  })
};

可以看到，程式碼非常冗餘，同時這裡的程式碼還沒有處理資料版本、過期時間以及資料寫入等功能。如果再把這些功能點加入，程式碼將會更加複雜，不易維護。

於是個人寫了一個小工具 storage-tools 來處理這個問題。

使用 storage-tools 快取資料

該庫預設使用 localStorage 作為資料來源，開發者從庫中獲取 StorageHelper 工具類。

import { StorageHelper } from "storage-tools";

// 當前使用者 id
const userId = "1";

// 構建模版 store
// 構建時候就會獲取 localStorage 中的資料放入記憶體
const templatesStore = new StorageHelper({
  // 多賬號使用者使用 key
  storageKey: `templates.${userId}`,
  // 當前資料版本號，可以從後端獲取並傳入
  version: 1,
  // 超時時間，單位為 秒
  timeout: 60 * 60 * 24,
});

// 從記憶體中獲取資料
const templates = templatesStore.getData();

// 沒有資料，表明資料過期或者沒有儲存過
if (templates === null) {
  api.get("xxx").then((val) => {
    // 儲存資料到記憶體中去，之後的 getData 都可以獲取到資料
    store.setData(val);

    // 閒暇時間將當前記憶體資料儲存到 localStorage 中
    requestIdleCallback(() => {
      // 期間內可以多次掉用 setData
      store.commit();
    });
  });
}

StorageHelper 工具類支援了其他快取源，程式碼如下：

import { IndexedDBAdaptor, StorageAdaptor, StorageHelper } from "storage-tools";

// 當前使用者 id
const userId = "1";

const sessionStorageStore = new StorageHelper({
  // 配置同上
  storageKey: `templates.${userId}`,
  version: 1,
  timeout: 60 * 60 * 24,
  // 介面卡，傳入 sessionStorage
  adapter: sessionStorage,
});

const indexedDBStore = new StorageHelper({
  storageKey: `templates.${userId}`,
  version: 1,
  timeout: 60 * 60 * 24,
  // 介面卡，傳入 IndexedDBAdaptor
  adapter: new IndexedDBAdaptor({
    dbName: "userInfo",
    storeName: "templates",
  }),
});

// IndexedDB 只能非同步構建，所以現在只能等待獲取構建獲取完成
indexedDBStore.whenReady().then(() => {
  // 準備完成後，我們就可以 getData 和 setData 了
  const data = indexedDBStore.getData();

  // 其餘程式碼
});

// 只需要有 setItem 和 getItem 就可以構建 adaptor
class MemoryAdaptor implements StorageAdaptor {
  readonly cache = new Map();

  // 獲取 map 中資料
  getItem(key: string) {
    return this.cache.get(key);
  }

  setItem(key: string, value: string) {
    this.cache.set(key, value);
  }
}

const memoryStore = new StorageHelper({
  // 配置同上
  storageKey: `templates.${userId}`,
  version: 1,
  timeout: 60 * 60 * 24,
  // 介面卡，傳入攜帶 getItem 和 setItem 物件
  adapter: new MemoryAdaptor(),
});

當然了，我們還可以繼承 StorageHelper 構建業務類。

// 也可以基於 StorageHelper 構建業務類
class TemplatesStorage extends StorageHelper {
  // 傳入 userId 以及 版本
  constructor(userId: number, version: number) {
    super({
      storageKey: `templates.${userId}`,
      // 如果需要執行時候更新，則可以動態傳遞
      version,
      timeout: 60 * 60 * 24,
    });
  }

  // TemplatesStorage 例項
  static instance: TemplatesStorage;

  // 如果需要版本資訊的話，
  static version: number = 0;

  static getStoreInstance() {
    // 獲取版本資訊
    return getTemplatesVersion().then((newVersion) => {
      // 沒有構建例項或者版本資訊不相等，直接重新構建
      if (
        newVersion !== TemplatesStorage.version || !TemplatesStorage.instance
      ) {
        TemplatesStorage.instance = new TemplatesStorage("1", newVersion);
        TemplatesStorage.version = newVersion;
      }

      return TemplatesStorage.instance;
    });
  }

  /**
   * 獲取模板快取和 api 請求結合
   */
  getTemplates() {
    const data = super.getData();
    if (data) {
      return Promise.resolve(data);
    }
    return api.get("xxx").then((val) => {
      this.setTemplates(val);
      return super.getData();
    });
  }

  /**
   * 儲存資料到記憶體後提交到資料來源
   */
  setTemplats(templates: any[]) {
    super.setData(templates);
    super.commit();
  }
}

/**
 * 獲取模版資訊函式
 */
const getTemplates = () => {
  return TemplatesStorage.getStoreInstance().then((instance) => {
    return instance.getTemplates();
  });
};

針對於某些特定列表順序需求，我們還可以構建 ListStorageHelper。

import { ListStorageHelper, MemoryAdaptor } from "../src";

// 當前使用者 id
const userId = "1";

const store = new ListStorageHelper({
  storageKey: `templates.${userId}`,
  version: 1,
  // 設定唯一鍵 key，預設為 'id'
  key: "searchVal",
  // 列表儲存最大資料量，預設為 10
  maxCount: 100,
  // 修改資料後是否移動到最前面，預設為 true
  isMoveTopWhenModified: true,
  // 新增資料後是否是最前面, 預設為 true
  isUnshiftWhenAdded: true,
});

store.setItem({ searchVal: "new game" });
store.getData();
// [{
//   searchVal: 'new game'
// }]

store.setItem({ searchVal: "new game2" });
store.getData();
// 會插入最前面
// [{
//   searchVal: 'new game2'
// }, {
//   searchVal: 'new game'
// }]

store.setItem({ searchVal: "new game" });
store.getData();
// 會更新到最前面
// [{
//   searchVal: 'new game'
// }, {
//   searchVal: 'new game2'
// }]

// 提交到 localStorage
store.commit();

storage-tools 專案演進

任何專案都不是一觸而就的，下面是關於 storage-tools 庫的編寫思路。希望能對大家有一些幫助。

StorageHelper 支援 localStorage 儲存

專案的第一步就是支援本地儲存 localStorage 的存取。

// 獲取從 1970 年 1 月 1 日 00:00:00 UTC 到使用者機器時間的秒數
// 後續有需求也會向外提供時間函式配置，可以結合 sync-time 庫一起使用
const getCurrentSecond = () => parseInt(`${new Date().getTime() / 1000}`);

// 獲取當前空資料
const getEmptyDataStore = (version: number): DataStore<any> => {
  const currentSecond = getCurrentSecond();
  return {
    // 當前資料的建立時間
    createdOn: currentSecond,
    // 當前資料的修改時間
    modifiedOn: currentSecond,
    // 當前資料的版本
    version,
    // 資料,空資料為 null
    data: null,
  };
};

class StorageHelper<T> {
  // 儲存的 key
  private readonly storageKey: string;
  // 儲存的版本資訊
  private readonly version: number;

  // 記憶體中資料，方便隨時讀寫
  store: DataStore<T> | null = null;

  constructor({ storageKey, version }) {
    this.storageKey = storageKey;
    this.version = version || 1;

    this.load();
  }

  load() {
    const result: string | null = localStorage.getItem(this.storageKey);

    // 初始化記憶體資訊資料
    this.initStore(result);
  }

  private initStore(storeStr: string | null) {
    // localStorage 沒有資料，直接構建 空資料放入 store
    if (!storeStr) {
      this.store = getEmptyDataStore(this.version);
      return;
    }

    let store: DataStore<T> | null = null;

    try {
      // 開始解析 json 字串
      store = JSON.parse(storeStr);

      // 沒有資料或者 store 沒有 data 屬性直接構建空資料
      if (!store || !("data" in store)) {
        store = getEmptyDataStore(this.version);
      } else if (store.version !== this.version) {
        // 版本不一致直接升級
        store = this.upgrade(store);
      }
    } catch (_e) {
      // 解析失敗了，構建空的資料
      store = getEmptyDataStore(this.version);
    }

    this.store = store || getEmptyDataStore(this.version);
  }

  setData(data: T) {
    if (!this.store) {
      return;
    }
    this.store.data = data;
  }

  getData(): T | null {
    if (!this.store) {
      return null;
    }
    return this.store?.data;
  }

  commit() {
    // 獲取記憶體中的 store
    const store = this.store || getEmptyDataStore(this.version);
    store.version = this.version;

    const now = getCurrentSecond();
    if (!store.createdOn) {
      store.createdOn = now;
    }
    store.modifiedOn = now;

    // 儲存資料到 localStorage
    localStorage.setItem(this.storageKey, JSON.stringify(store));
  }

  /**
   * 獲取記憶體中 store 的資訊
   * 如 modifiedOn createdOn version 等資訊
   */
  get(key: DataStoreInfo) {
    return this.store?.[key];
  }

  upgrade(store: DataStore<T>): DataStore<T> {
    // 獲取當前的秒數
    const now = getCurrentSecond();
    // 看起來很像 getEmptyDataStore 程式碼，但實際上是不同的業務
    // 不應該因為程式碼相似而合併，不利於後期擴充套件
    return {
      // 只獲取之前的建立時間，如果沒有使用當前的時間
      createdOn: store?.createdOn || now,
      modifiedOn: now,
      version: this.version,
      data: null,
    };
  }
}

StorageHelper 新增超時機制

新增超時機制很簡單，只需要在 getData 的時候檢查一下資料即可。

class StorageHelper<T> {
  // 其他程式碼 ...

  // 超時時間，預設為 -1，即不超時
  private readonly timeout: number = -1;

  constructor({ storageKey, version, timeout }: StorageHelperParams) {
    // 傳入的資料是數字型別，且大於 0，就設定超時時間
    if (typeof timeout === "number" && timeout > 0) {
      this.timeout = timeout;
    }
  }

  getData(): T | null {
    if (!this.store) {
      return null;
    }

    // 如果小於 0 就沒有超時時間，直接返回資料，事實上不可能小於0
    if (this.timeout < 0) {
      return this.store?.data;
    }

    // 修改時間加超時時間大於當前時間，則表示沒有超時
    // 注意，每次 commit 都會更新 modifiedOn
    if (getCurrentSecond() < (this.store?.modifiedOn || 0) + this.timeout) {
      return this.store?.data;
    }

    // 版本資訊在最開始時候處理過了，此處直接返回 null
    return null;
  }
}

StorageHelper 新增其他儲存適配

此時我們可以新增其他資料來源適配，方便開發者自定義 storage。

/**
 * 介面卡介面，存在 getItem 以及 setItem
 */
interface StorageAdaptor {
  getItem: (key: string) => string | Promise<string> | null;
  setItem: (key: string, value: string) => void;
}

class StorageHelper<T> {
  // 其他程式碼 ...

  // 非瀏覽器環境不具備 localStorage，所以不在此處直接構造
  readonly adapter: StorageAdaptor;

  constructor({ storageKey, version, adapter, timeout }: StorageHelperParams) {
    // 此處沒有傳遞 adapter 就會使用 localStorage
    // adapter 物件必須有 getItem 和 setItem
    // 此處沒有進一步判斷 getItem 是否為函式以及 localStorage 是否存在
    // 沒有辦法限制住所有的異常
    this.adapter = adapter && "getItem" in adapter && "setItem" in adapter
      ? adapter
      : localStorage;

    this.load();
  }

  load() {
    // 此處改為 this.adapter
    const result: Promise<string> | string | null = this.adapter.getItem(
      this.storageKey,
    );
  }

  commit() {
    // 此處改為 this.adapter
    this.adapter.setItem(this.storageKey, JSON.stringify(store));
  }
}

StorageHelper 新增非同步獲取

如有些資料來源需要非同步構建並獲取資料，例如 IndexedDB 。這裡我們先建立一個 IndexedDBAdaptor 類。

import { StorageAdaptor } from "../utils";

// 把 indexedDB 的回撥改為 Promise
function promisifyRequest<T = undefined>(
  request: IDBRequest<T> | IDBTransaction,
): Promise<T> {
  return new Promise<T>((resolve, reject) => {
    // @ts-ignore
    request.oncomplete = request.onsuccess = () => resolve(request.result);
    // @ts-ignore
    request.onabort = request.onerror = () => reject(request.error);
  });
}

/**
 * 建立並返回 indexedDB 的控制程式碼
 */
const createStore = (
  dbName: string,
  storeName: string,
  upgradeInfo: IndexedDBUpgradeInfo = {},
): UseStore => {
  const request = indexedDB.open(dbName);

  /**
   * 建立或者升級時候會呼叫 onupgradeneeded
   */
  request.onupgradeneeded = () => {
    const { result: store } = request;
    if (!store.objectStoreNames.contains(storeName)) {
      const { options = {}, indexList = [] } = upgradeInfo;
      // 基於 配置項生成 store
      const store = request.result.createObjectStore(storeName, { ...options });

      // 建立索引
      indexList.forEach((index) => {
        store.createIndex(index.name, index.keyPath, index.options);
      });
    }
  };

  const dbp = promisifyRequest(request);

  return (txMode, callback) =>
    dbp.then((db) =>
      callback(db.transaction(storeName, txMode).objectStore(storeName))
    );
};

export class IndexedDBAdaptor implements StorageAdaptor {
  private readonly store: UseStore;

  constructor({ dbName, storeName, upgradeInfo }: IndexedDBAdaptorParams) {
    this.store = createStore(dbName, storeName, upgradeInfo);
  }

  /**
   * 獲取資料
   */
  getItem(key: string): Promise<string> {
    return this.store("readonly", (store) => promisifyRequest(store.get(key)));
  }

  /**
   * 設定資料
   */
  setItem(key: string, value: string) {
    return this.store("readwrite", (store) => {
      store.put(value, key);
      return promisifyRequest(store.transaction);
    });
  }
}

對 StorageHelper 類做如下改造

type CreateDeferredPromise = <TValue>() => CreateDeferredPromiseResult<TValue>;

// 劫持一個 Promise 方便使用
export const createDeferredPromise: CreateDeferredPromise = <T>() => {
  let resolve!: (value: T | PromiseLike<T>) => void;
  let reject!: (reason?: any) => void;

  const promise = new Promise<T>((res, rej) => {
    resolve = res;
    reject = rej;
  });

  return {
    currentPromise: promise,
    resolve,
    reject,
  };
};

export class StorageHelper<T> {
  // 是否準備好了
  ready: CreateDeferredPromiseResult<boolean> = createDeferredPromise<
    boolean
  >();

  constructor({ storageKey, version, adapter, timeout }: StorageHelperParams) {
    this.load();
  }

  load() {
    const result: Promise<string> | string | null = this.adapter.getItem(
      this.storageKey,
    );

    // 檢查一下當前的結果是否是 Promise 物件
    if (isPromise(result)) {
      result
        .then((res) => {
          this.initStore(res);
          // 準備好了
          this.ready.resolve(true);
        })
        .catch(() => {
          this.initStore(null);
          // 準備好了
          this.ready.resolve(true);
        });
    } else {
      // 不是 Promise 直接構建 store
      this.initStore(result);
      // 準備好了
      this.ready.resolve(true);
    }
  }

  // 詢問是否做好準備
  whenReady() {
    return this.ready.currentPromise;
  }
}

如此，我們就完成了 StorageHelper 全部程式碼。

列表輔助類 ListStorageHelper

ListStorageHelper 基於 StorageHelper 構建，方便特定業務使用。

// 陣列最大數量
const STORE_MAX_COUNT: number = 10;

export class ListStorageHelper<T> extends StorageHelper<T[]> {
  // 主鍵，預設為 id
  readonly key: string = "id";
  // 儲存最大數量，預設為 10
  readonly maxCount: number = STORE_MAX_COUNT;

  // 是否新增在最前面
  readonly isUnshiftWhenAdded: boolean = true;
  // 修改後是否放入最前面
  readonly isMoveTopWhenModified: boolean = true;

  constructor({
    maxCount,
    key,
    isMoveTopWhenModified = true,
    isUnshiftWhenAdded = true,
    storageKey,
    version,
    adapter,
    timeout,
  }: ListStorageHelperParams) {
    super({ storageKey, version, adapter, timeout });
    this.key = key || "id";

    // 設定配置項
    if (typeof maxCount === "number" && maxCount > 0) {
      this.maxCount = maxCount;
    }

    if (typeof isMoveTopWhenModified === "boolean") {
      this.isMoveTopWhenModified = isMoveTopWhenModified;
    }

    if (typeof this.isUnshiftWhenAdded === "boolean") {
      this.isUnshiftWhenAdded = isUnshiftWhenAdded;
    }
  }

  load() {
    super.load();
    // 沒有資料，設定為空陣列方便統一
    if (!this.store!.data) {
      this.store!.data = [];
    }
  }

  getData = (): T[] => {
    const items = super.getData() || [];
    // 檢查資料長度並移除超過的資料
    this.checkThenRemoveItem(items);
    return items;
  };

  setItem(item: T) {
    if (!this.store) {
      throw new Error("Please complete the loading load first");
    }

    const items = this.getData();

    // 利用 key 去查詢存在資料索引
    const index = items.findIndex(
      (x: any) => x[this.key] === (item as any)[this.key],
    );

    // 當前有資料，是更新
    if (index > -1) {
      const current = { ...items[index], ...item };
      // 更新移動陣列資料
      if (this.isMoveTopWhenModified) {
        items.splice(index, 1);
        items.unshift(current);
      } else {
        items[index] = current;
      }
    } else {
      // 新增
      this.isUnshiftWhenAdded ? items.unshift(item) : items.push(item);
    }
    // 檢查並移除資料
    this.checkThenRemoveItem(items);
  }

  removeItem(key: string | number) {
    if (!this.store) {
      throw new Error("Please complete the loading load first");
    }
    const items = this.getData();
    const index = items.findIndex((x: any) => x[this.key] === key);
    // 移除資料
    if (index > -1) {
      items.splice(index, 1);
    }
  }

  setItems(items: T[]) {
    if (!this.store) {
      return;
    }
    this.checkThenRemoveItem(items);
    // 批次設定資料
    this.store.data = items || [];
  }

  /**
   * 多新增一個方法 getItems，等同於 getData 方法
   */
  getItems() {
    if (!this.store) {
      return null;
    }
    return this.getData();
  }

  checkThenRemoveItem = (items: T[]) => {
    if (items.length <= this.maxCount) {
      return;
    }
    items.splice(this.maxCount, items.length - this.maxCount);
  };
}

該類繼承了 StorageHelper，我們依舊可以直接呼叫 commit 提交資料。如此我們就不需要維護複雜的 storage 存取邏輯了。

程式碼都在 storage-tools 中，歡迎各位提交 issue 以及 pr。

鼓勵一下

如果你覺得這篇文章不錯，希望可以給與我一些鼓勵，在我的 github 部落格下幫忙 star 一下。

部落格地址

參考資料

storage-tools

sync-time