業務層hooks封裝useSessionStorage範例詳解

2022-08-19 14:00:24

封裝原因：

名稱：useSessionStorage

功能開發過程中，需要進行資料的臨時儲存，正常情況下，使用localStorage或者 sessionStorage，存在於 window 物件中，使用場景不一樣。

sessionStorage的生命週期是在瀏覽器關閉前，瀏覽器關閉後自動清理，頁面重新整理不會清理。

localStorage的生命週期是永久性的，儲存的資料需要手動刪除。

建議：

儲存業務資料，登入對談內，使用sessionStorage。
需要持久化話的資料，比如token標記之類的可以使用localStorage，使用時需要謹慎對待，以及考慮清理時機。

工具庫封裝模式:

工具庫目錄：

API設計：

獲取本地儲存 getCache
寫入本地儲存 setCache
設定使用者快取 setUserCache
獲取使用者快取getUserCache
移除cookie removeCookies

程式碼實踐：

import Cookie from 'js-cookie';
/**
 * 獲取快取資料
 * @param {string} key
 * @param {string} type: 快取型別 'local'(預設) / cookie / session;
 */
function getCache(key, type = 'local') {
  let data;
  switch (type) {
    case 'cookie':
      data = Cookie.get(key);
      break;
    case 'session':
      // eslint-disable-next-line no-case-declarations
      let strS = sessionStorage.getItem(key);
      try {
        data = JSON.parse(strS);
      } catch (e) {
        data = strS;
      }
      break;
    default:
      // eslint-disable-next-line no-case-declarations
      let strL = localStorage.getItem(key);
      try {
        data = JSON.parse(strL);
      } catch (e) {
        data = strL;
      }
      break;
  }
  return data;
}
/**
 * 獲取快取資料
 * @param {string} key
 * @param {any} value
 * @param {string} type: 快取型別 'local'(預設) / cookie / session;
 */
function setCache(key, value, type = 'local') {
  switch (type) {
    case 'cookie':
      Cookie.set(key, value, { expires: 7 });
      break;
    case 'session':
      sessionStorage.setItem(key, JSON.stringify(value));
      break;
    default:
      localStorage.setItem(key, JSON.stringify(value));
      break;
  }
}
/**
 * 獲取使用者快取
 * @param {*} key
 * @param {*} type
 */
function getUserCache(key, type = 'local') {
  const id = getCache('userId', 'session');
  if (!id) {
    console.error('無法獲取使用者資訊！');
    return;
  }
  return getCache(`${id}-${key}`, type);
}
/**
 * 設定使用者快取
 * @param {*} key
 * @param {*} value
 * @param {*} type
 */
function setUserCache(key, value, type = 'local') {
  const id = getCache('userId', 'session');
  if (!id) {
    console.error('無法獲取使用者資訊！');
    return;
  }
  return setCache(`${id}-${key}`, value, type);
}
function removeCookies(key) {
  key &amp;&amp; Cookie.remove(key);
}
export default {
  getCache,
  setCache,
  getUserCache,
  setUserCache,
  removeCookies
};

以上設計屬於框架層，提供操作本地儲存的能力，但是為什麼業務側需要封裝hooks呢？

主要原因：

使用起來有點麻煩，需要import引入工具庫，但是hooks使用也需要import引入，因為功能頁面大部分引入的都是hooks，使用解構，程式碼量就會縮減，而且使用認知會減少，引入hooks即可，“你需要用到的都在hooks裡面”

Hooks設計方式

那我們開始設計

useSessionStorage.js

import { ref, Ref, isRef, watch as vueWatch } from "vue";
const storage = sessionStorage;
const defaultOptions = {
    watch: true
}
/**
 * 獲取資料型別
 * @param defaultValue
 * @returns
 */
const getValueType = (defaultValue) => {
  return defaultValue == null
    ? "any"
    : typeof defaultValue === "boolean"
    ? "boolean"
    : typeof defaultValue === "string"
    ? "string"
    : typeof defaultValue === "object"
    ? "object"
    : Array.isArray(defaultValue)
    ? "object"
    : !Number.isNaN(defaultValue)
    ? "number"
    : "any";
};
/**
 * 按照型別格式資料的常數Map
 */
const TypeSerializers = {
  boolean: {
    read: (v) => (v != null ? v === "true" : null),
    write: (v) => String(v),
  },
  object: {
    read: (v) => (v ? JSON.parse(v) : null),
    write: (v) => JSON.stringify(v),
  },
  number: {
    read: (v) => (v != null ? Number.parseFloat(v) : null),
    write: (v) => String(v),
  },
  any: {
    read: (v) => (v != null && v !== "null" ? v : null),
    write: (v) => String(v),
  },
  string: {
    read: (v) => (v != null ? v : null),
    write: (v) => String(v),
  },
};
/**
 * 快取操作
 */
const useSessionStorage = (key, initialValue, options) => {
  const { watch } = { ...defaultOptions, ...options };
  const data = ref(null);
  try {
    if (initialValue !== undefined) {
      data.value = isRef(initialValue) ? initialValue.value : initialValue;
    } else {
      data.value = JSON.parse(storage.getItem(key) || "{}");
    }
  } catch (error) {
    console.log(error, "useLocalStorage初始化失敗");
  }
  const type = getValueType(data.value);
  // 判斷型別取格式化方法
  let serializer = TypeSerializers[type];
  const setStorage = () => storage.setItem(key, serializer.write(data.value));
  // 狀態監聽
  if (watch) {
    vueWatch(
      data,
      (newValue) => {
        if (newValue === undefined || newValue === null) {
          storage.removeItem(key);
          return;
        }
        setStorage();
      },
      {
        deep: true,
      }
    );
  }
  setStorage();
  return data;
};
export default useSessionStorage;

簡介：

useSessionStorage接受一個key和一個value，匯出一個響應式的state, 使用者直接賦值state.value可自動修改本地sessionStorage。

注意點

不設定value可用於獲取本地sessionStorage 例：useSessionStorage('useSessionStorage')
value等於undefined或者null可用於刪除本地Storage 例：state.value = undefined;

Api

const state = useSessionStorage(
  key: string,
  initialValue?: any,
  options?: Options
);

Params

引數	說明	型別	預設值
key	sessionStorage儲存鍵名	any	-
initialValue	初始值	any	{}
options	設定	Options	-

Options

引數	說明	型別	預設值
watch	是否實時修改sessionStorage	boolean	true

Result

引數	說明	型別
state	可以被修改的資料來源	Ref

總結：

這種使用方式，是針對業務側vue3的，自帶響應式繫結，和使用 Ref一樣，利用.value進行獲取和賦值。

以上就是業務層hooks封裝useSessionStorage範例詳解的詳細內容，更多關於hooks封裝useSessionStorage的資料請關注it145.com其它相關文章！