JavaScript架構localStorage特殊場景下二次封裝操作

2022-06-16 18:03:04

前言

很多人在用 localStorage 或 sessionStorage 的時候喜歡直接用，明文儲存，直接將資訊暴露在；瀏覽器中，雖然一般場景下都能應付得了且簡單粗暴，但特殊需求情況下，比如設定定時功能，就不能實現。就需要對其進行二次封裝，為了在使用上增加些安全感，那加密也必然是少不了的了。為方便專案使用，特對常規操作進行封裝。不完善之處會進一步更新...(更新於：2022.06.02 16:30)

設計

封裝之前先梳理下所需功能，並要做成什麼樣，採用什麼樣的規範，部分主要程式碼片段是以 localStorage作為範例，最後會貼出完整程式碼的。可以結合專案自行優化，也可以直接使用。

// 區分儲存型別 type
// 自定義名稱字首 prefix
// 支援設定過期時間 expire
// 支援加密可選，開發環境下未方便偵錯可關閉加密
// 支援資料加密 這裡採用 crypto-js 加密 也可使用其他方式
// 判斷是否支援 Storage isSupportStorage
// 設定 setStorage
// 獲取 getStorage
// 是否存在 hasStorage
// 獲取所有key getStorageKeys
// 根據索引獲取key getStorageForIndex
// 獲取localStorage長度 getStorageLength
// 獲取全部 getAllStorage
// 刪除 removeStorage
// 清空 clearStorage
//定義引數 型別 window.localStorage,window.sessionStorage,
const config = {
    type: 'localStorage', // 本地儲存型別 localStorage/sessionStorage
    prefix: 'SDF_0.0.1', // 名稱字首 建議：專案名 + 專案版本
    expire: 1, //過期時間 單位：秒
    isEncrypt: true // 預設加密 為了偵錯方便, 開發過程中可以不加密
}

設定 setStorage

Storage 本身是不支援過期時間設定的，要支援設定過期時間，可以效仿 Cookie 的做法，setStorage(key,value,expire) 方法，接收三個引數，第三個引數就是設定過期時間的，用相對時間，單位秒，要對所傳引數進行型別檢查。可以設定統一的過期時間，也可以對單個值得過期時間進行單獨設定。兩種方式按需設定。

程式碼實現：

// 設定 setStorage
export const setStorage = (key,value,expire=0) => {
    if (value === '' || value === null || value === undefined) {
        value = null;
    }
    if (isNaN(expire) || expire < 1) throw new Error("Expire must be a number");
    expire = (expire?expire:config.expire) * 60000;
    let data = {
        value: value, // 儲存值
        time: Date.now(), //存值時間戳
        expire: expire // 過期時間
    }
    window[config.type].setItem(key, JSON.stringify(data));
}

獲取 getStorage

首先要對 key 是否存在進行判斷，防止獲取不存在的值而報錯。對獲取方法進一步擴充套件，只要在有效期內獲取 Storage 值，就對過期時間進行續期，如果過期則直接刪除該值。並返回 null

// 獲取 getStorage
export const getStorage = (key) => {
    // key 不存在判斷
    if (!window[config.type].getItem(key) || JSON.stringify(window[config.type].getItem(key)) === 'null'){
        return null;
    }
    // 優化 持續使用中續期
    const storage = JSON.parse(window[config.type].getItem(key));
    console.log(storage)
    let nowTime = Date.now();
    console.log(config.expire*6000 ,(nowTime - storage.time))
    // 過期刪除
    if (storage.expire && config.expire*6000 < (nowTime - storage.time)) {
        removeStorage(key);
        return null;
    } else {
        // 未過期期間被呼叫 則自動續期 進行保活
        setStorage(key,storage.value);
        return storage.value;
    }
}

獲取所有值

// 獲取全部 getAllStorage
export const getAllStorage = () => {
    let len = window[config.type].length // 獲取長度
    let arr = new Array() // 定義資料集
    for (let i = 0; i < len; i++) {
        // 獲取key 索引從0開始
        let getKey = window[config.type].key(i)
        // 獲取key對應的值
        let getVal = window[config.type].getItem(getKey)
        // 放進陣列
        arr[i] = { 'key': getKey, 'val': getVal, }
    }
    return arr
}

刪除 removeStorage

// 名稱前自動新增字首
const autoAddPrefix = (key) => {
    const prefix = config.prefix ? config.prefix + '_' : '';
    return  prefix + key;
}
// 刪除 removeStorage
export const removeStorage = (key) => {
    window[config.type].removeItem(autoAddPrefix(key));
}

清空 clearStorage

// 清空 clearStorage
export const clearStorage = () => {
    window[config.type].clear();
}

加密、解密

加密採用的是 crypto-js

// 安裝crypto-js
npm install crypto-js
// 引入 crypto-js 有以下兩種方式
import CryptoJS from "crypto-js";
// 或者
const CryptoJS = require("crypto-js");

對 crypto-js 設定金鑰和金鑰偏移量,可以採用將一個私鑰經 MD5 加密生成16位元金鑰獲得。

// 十六位十六進位制數作為金鑰
const SECRET_KEY = CryptoJS.enc.Utf8.parse("3333e6e143439161");
// 十六位十六進位制數作為金鑰偏移量
const SECRET_IV = CryptoJS.enc.Utf8.parse("e3bbe7e3ba84431a");

對加密方法進行封裝

/**
 * 加密方法
 * @param data
 * @returns {string}
 */
export function encrypt(data) {
  if (typeof data === "object") {
    try {
      data = JSON.stringify(data);
    } catch (error) {
      console.log("encrypt error:", error);
    }
  }
  const dataHex = CryptoJS.enc.Utf8.parse(data);
  const encrypted = CryptoJS.AES.encrypt(dataHex, SECRET_KEY, {
    iv: SECRET_IV,
    mode: CryptoJS.mode.CBC,
    padding: CryptoJS.pad.Pkcs7
  });
  return encrypted.ciphertext.toString();
}

對解密方法進行封裝

/**
 * 解密方法
 * @param data
 * @returns {string}
 */
export function decrypt(data) {
  const encryptedHexStr = CryptoJS.enc.Hex.parse(data);
  const str = CryptoJS.enc.Base64.stringify(encryptedHexStr);
  const decrypt = CryptoJS.AES.decrypt(str, SECRET_KEY, {
    iv: SECRET_IV,
    mode: CryptoJS.mode.CBC,
    padding: CryptoJS.pad.Pkcs7
  });
  const decryptedStr = decrypt.toString(CryptoJS.enc.Utf8);
  return decryptedStr.toString();
}

在儲存資料及獲取資料中進行使用：

這裡我們主要看下進行加密和解密部分，部分方法在下面程式碼段中並未展示，請注意，不能直接執行。

const config = {
    type: 'localStorage', // 本地儲存型別 sessionStorage
    prefix: 'SDF_0.0.1', // 名稱字首 建議：專案名 + 專案版本
    expire: 1, //過期時間 單位：秒
    isEncrypt: true // 預設加密 為了偵錯方便, 開發過程中可以不加密
}
// 設定 setStorage
export const setStorage = (key, value, expire = 0) => {
    if (value === '' || value === null || value === undefined) {
        value = null;
    }
    if (isNaN(expire) || expire < 0) throw new Error("Expire must be a number");
    expire = (expire ? expire : config.expire) * 1000;
    let data = {
        value: value, // 儲存值
        time: Date.now(), //存值時間戳
        expire: expire // 過期時間
    }
    // 對儲存資料進行加密 加密為可選設定
    const encryptString = config.isEncrypt ? encrypt(JSON.stringify(data)): JSON.stringify(data);
    window[config.type].setItem(autoAddPrefix(key), encryptString);
}
// 獲取 getStorage
export const getStorage = (key) => {
    key = autoAddPrefix(key);
    // key 不存在判斷
    if (!window[config.type].getItem(key) || JSON.stringify(window[config.type].getItem(key)) === 'null') {
        return null;
    }
    // 對儲存資料進行解密
    const storage = config.isEncrypt ? JSON.parse(decrypt(window[config.type].getItem(key))) : JSON.parse(window[config.type].getItem(key));
    let nowTime = Date.now();
    // 過期刪除
    if (storage.expire && config.expire * 6000 < (nowTime - storage.time)) {
        removeStorage(key);
        return null;
    } else {
        //  持續使用時會自動續期
        setStorage(autoRemovePrefix(key), storage.value);
        return storage.value;
    }
}

使用

使用的時候你可以通過 import 按需引入，也可以掛載到全域性上使用，一般建議少用全域性方式或全域性變數，為後來接手專案繼續開發維護的人，追查程式碼留條便捷之路！不要為了封裝而封裝，儘可能基於專案需求和後續的通用，以及使用上的便捷。比如獲取全部儲存變數，如果你專案上都未曾用到過，倒不如刪減掉，留著過年也不見得有多香，不如為減小體積做點貢獻！

import {isSupportStorage, hasStorage, setStorage,getStorage,getStorageKeys,getStorageForIndex,getStorageLength,removeStorage,getStorageAll,clearStorage} from '@/utils/storage'

完整程式碼

該程式碼已進一步完善，需要的可以直接進一步優化，也可以將可優化或可延伸的建議，留言說明，我會進一步迭代的。可以根據自己的需要刪除一些不用的方法，以減小檔案大小。

/***
 * title: storage.js
 * Author: Gaby
 * Email: xxx@126.com
 * Time: 2022/6/1 17:30
 * last: 2022/6/2 17:30
 * Desc: 對儲存的簡單封裝
 */
import CryptoJS from 'crypto-js';
// 十六位十六進位制數作為金鑰
const SECRET_KEY = CryptoJS.enc.Utf8.parse("3333e6e143439161");
// 十六位十六進位制數作為金鑰偏移量
const SECRET_IV = CryptoJS.enc.Utf8.parse("e3bbe7e3ba84431a");
// 型別 window.localStorage,window.sessionStorage,
const config = {
    type: 'localStorage', // 本地儲存型別 sessionStorage
    prefix: 'SDF_0.0.1', // 名稱字首 建議：專案名 + 專案版本
    expire: 1, //過期時間 單位：秒
    isEncrypt: true // 預設加密 為了偵錯方便, 開發過程中可以不加密
}
// 判斷是否支援 Storage
export const isSupportStorage = () => {
    return (typeof (Storage) !== "undefined") ? true : false
}
// 設定 setStorage
export const setStorage = (key, value, expire = 0) => {
    if (value === '' || value === null || value === undefined) {
        value = null;
    }
    if (isNaN(expire) || expire < 0) throw new Error("Expire must be a number");
    expire = (expire ? expire : config.expire) * 1000;
    let data = {
        value: value, // 儲存值
        time: Date.now(), //存值時間戳
        expire: expire // 過期時間
    }
    const encryptString = config.isEncrypt 
    ? encrypt(JSON.stringify(data))
    : JSON.stringify(data);
    window[config.type].setItem(autoAddPrefix(key), encryptString);
}
// 獲取 getStorage
export const getStorage = (key) => {
    key = autoAddPrefix(key);
    // key 不存在判斷
    if (!window[config.type].getItem(key) || JSON.stringify(window[config.type].getItem(key)) === 'null') {
        return null;
    }
    // 優化 持續使用中續期
    const storage = config.isEncrypt 
    ? JSON.parse(decrypt(window[config.type].getItem(key))) 
    : JSON.parse(window[config.type].getItem(key));
    let nowTime = Date.now();
    // 過期刪除
    if (storage.expire && config.expire * 6000 < (nowTime - storage.time)) {
        removeStorage(key);
        return null;
    } else {
        // 未過期期間被呼叫 則自動續期 進行保活
        setStorage(autoRemovePrefix(key), storage.value);
        return storage.value;
    }
}
// 是否存在 hasStorage
export const hasStorage = (key) => {
    key = autoAddPrefix(key);
    let arr = getStorageAll().filter((item)=>{
        return item.key === key;
    })
    return arr.length ? true : false;
}
// 獲取所有key
export const getStorageKeys = () => {
    let items = getStorageAll()
    let keys = []
    for (let index = 0; index < items.length; index++) {
        keys.push(items[index].key)
    }
    return keys
}
// 根據索引獲取key
export const getStorageForIndex = (index) => {
    return window[config.type].key(index)
}
// 獲取localStorage長度
export const getStorageLength = () => {
    return window[config.type].length
}
// 獲取全部 getAllStorage
export const getStorageAll = () => {
    let len = window[config.type].length // 獲取長度
    let arr = new Array() // 定義資料集
    for (let i = 0; i < len; i++) {
        // 獲取key 索引從0開始
        let getKey = window[config.type].key(i)
        // 獲取key對應的值
        let getVal = window[config.type].getItem(getKey)
        // 放進陣列
        arr[i] = {'key': getKey, 'val': getVal,}
    }
    return arr
}
// 刪除 removeStorage
export const removeStorage = (key) => {
    window[config.type].removeItem(autoAddPrefix(key));
}
// 清空 clearStorage
export const clearStorage = () => {
    window[config.type].clear();
}
// 名稱前自動新增字首
const autoAddPrefix = (key) => {
    const prefix = config.prefix ? config.prefix + '_' : '';
    return  prefix + key;
}
// 移除已新增的字首
const autoRemovePrefix = (key) => {
    const len = config.prefix ? config.prefix.length+1 : '';
    return key.substr(len)
    // const prefix = config.prefix ? config.prefix + '_' : '';
    // return  prefix + key;
}
/**
 * 加密方法
 * @param data
 * @returns {string}
 */
const encrypt = (data) => {
    if (typeof data === "object") {
        try {
            data = JSON.stringify(data);
        } catch (error) {
            console.log("encrypt error:", error);
        }
    }
    const dataHex = CryptoJS.enc.Utf8.parse(data);
    const encrypted = CryptoJS.AES.encrypt(dataHex, SECRET_KEY, {
        iv: SECRET_IV,
        mode: CryptoJS.mode.CBC,
        padding: CryptoJS.pad.Pkcs7
    });
    return encrypted.ciphertext.toString();
}
/**
 * 解密方法
 * @param data
 * @returns {string}
 */
const decrypt = (data) => {
    const encryptedHexStr = CryptoJS.enc.Hex.parse(data);
    const str = CryptoJS.enc.Base64.stringify(encryptedHexStr);
    const decrypt = CryptoJS.AES.decrypt(str, SECRET_KEY, {
        iv: SECRET_IV,
        mode: CryptoJS.mode.CBC,
        padding: CryptoJS.pad.Pkcs7
    });
    const decryptedStr = decrypt.toString(CryptoJS.enc.Utf8);
    return decryptedStr.toString();
}

以上就是JavaScript架構localStorage特殊場景下二次封裝操作的詳細內容，更多關於JavaScript localStorage二次封裝的資料請關注it145.com其它相關文章！