很多人在用 localStorage 或 sessionStorage 的時(shí)候喜歡直接用，明文存儲(chǔ)，直接將信息暴露在；瀏覽器中，雖然一般場(chǎng)景下都能應(yīng)付得了且簡(jiǎn)單粗暴，但特殊需求情況下，比如設(shè)置定時(shí)功能，就不能實(shí)現(xiàn)。就需要對(duì)其進(jìn)行二次封裝，為了在使用上增加些安全感，那加密也必然是少不了的了。為方便項(xiàng)目使用，特對(duì)常規(guī)操作進(jìn)行封裝。
設(shè)計(jì)
封裝之前先梳理下所需功能，并要做成什么樣，采用什么樣的規(guī)范，部分主要代碼片段是以 localStorage作為示例，最后會(huì)貼出完整代碼的。可以結(jié)合項(xiàng)目自行優(yōu)化，也可以直接使用。
// 區(qū)分存儲(chǔ)類型 type// 自定義名稱前綴 prefix// 支持設(shè)置過(guò)期時(shí)間 expire// 支持加密可選，開發(fā)環(huán)境下未方便調(diào)試可關(guān)閉加密// 支持數(shù)據(jù)加密 這里采用 crypto-js 加密 也可使用其他方式// 判斷是否支持 Storage isSupportStorage// 設(shè)置 setStorage// 獲取 getStorage// 是否存在 hasStorage// 獲取所有key getStorageKeys// 根據(jù)索引獲取key getStorageForIndex// 獲取localStorage長(zhǎng)度 getStorageLength// 獲取全部 getAllStorage// 刪除 removeStorage// 清空 clearStorage//定義參數(shù) 類型 window.localStorage,window.sessionStorage,const config = { type: ‘localStorage’, // 本地存儲(chǔ)類型 localStorage/sessionStorage prefix: ‘SDF_0.0.1’, // 名稱前綴 建議：項(xiàng)目名 + 項(xiàng)目版本 expire: 1, //過(guò)期時(shí)間 單位：秒 isEncrypt: true // 默認(rèn)加密 為了調(diào)試方便, 開發(fā)過(guò)程中可以不加密}
設(shè)置 setStorage
Storage 本身是不支持過(guò)期時(shí)間設(shè)置的，要支持設(shè)置過(guò)期時(shí)間，可以效仿 Cookie 的做法，setStorage(key,value,expire) 方法，接收三個(gè)參數(shù)，第三個(gè)參數(shù)就是設(shè)置過(guò)期時(shí)間的，用相對(duì)時(shí)間，單位秒，要對(duì)所傳參數(shù)進(jìn)行類型檢查?？梢栽O(shè)置統(tǒng)一的過(guò)期時(shí)間，也可以對(duì)單個(gè)值得過(guò)期時(shí)間進(jìn)行單獨(dú)配置。兩種方式按需配置。
代碼實(shí)現(xiàn)：
// 設(shè)置 setStorageexport 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, // 存儲(chǔ)值 time: Date.now(), //存值時(shí)間戳 expire: expire // 過(guò)期時(shí)間 } window[config.type].setItem(key, JSON.stringify(data));}
獲取 getStorage
首先要對(duì) key 是否存在進(jìn)行判斷，防止獲取不存在的值而報(bào)錯(cuò)。對(duì)獲取方法進(jìn)一步擴(kuò)展，只要在有效期內(nèi)獲取 Storage 值，就對(duì)過(guò)期時(shí)間進(jìn)行續(xù)期，如果過(guò)期則直接刪除該值。并返回 null
// 獲取 getStorageexport const getStorage = (key) => { // key 不存在判斷 if (!window[config.type].getItem(key) || JSON.stringify(window[config.type].getItem(key)) === ‘null’){ return null; } // 優(yōu)化 持續(xù)使用中續(xù)期 const storage = JSON.parse(window[config.type].getItem(key)); console.log(storage) let nowTime = Date.now(); console.log(config.expire*6000 ,(nowTime – storage.time)) // 過(guò)期刪除 if (storage.expire && config.expire*6000 < (nowTime – storage.time)) { removeStorage(key); return null; } else { // 未過(guò)期期間被調(diào)用 則自動(dòng)續(xù)期 進(jìn)行?；? setStorage(key,storage.value); return storage.value; }}
獲取所有值
// 獲取全部 getAllStorageexport const getAllStorage = () => { let len = window[config.type].length // 獲取長(zhǎng)度 let arr = new Array() // 定義數(shù)據(jù)集 for (let i = 0; i < len; i++) { // 獲取key 索引從0開始 let getKey = window[config.type].key(i) // 獲取key對(duì)應(yīng)的值 let getVal = window[config.type].getItem(getKey) // 放進(jìn)數(shù)組 arr[i] = { 'key': getKey, 'val': getVal, } } return arr}
刪除 removeStorage
// 名稱前自動(dòng)添加前綴const autoAddPrefix = (key) => { const prefix = config.prefix ? config.prefix + ‘_’ : ”; return prefix + key;}// 刪除 removeStorageexport const removeStorage = (key) => { window[config.type].removeItem(autoAddPrefix(key));}
清空 clearStorage
// 清空 clearStorageexport const clearStorage = () => { window[config.type].clear();}
加密、解密
加密采用的是 crypto-js
// 安裝crypto-jsnpm install crypto-js// 引入 crypto-js 有以下兩種方式import CryptoJS from “crypto-js”;// 或者const CryptoJS = require(“crypto-js”);
對(duì) crypto-js 設(shè)置密鑰和密鑰偏移量,可以采用將一個(gè)私鑰經(jīng) MD5 加密生成16位密鑰獲得。
// 十六位十六進(jìn)制數(shù)作為密鑰const SECRET_KEY = CryptoJS.enc.Utf8.parse(“3333e6e143439161”);// 十六位十六進(jìn)制數(shù)作為密鑰偏移量const SECRET_IV = CryptoJS.enc.Utf8.parse(“e3bbe7e3ba84431a”);
對(duì)加密方法進(jìn)行封裝
/** * 加密方法 * @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();}
對(duì)解密方法進(jìn)行封裝
/** * 解密方法 * @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();}
在存儲(chǔ)數(shù)據(jù)及獲取數(shù)據(jù)中進(jìn)行使用：
這里我們主要看下進(jìn)行加密和解密部分，部分方法在下面代碼段中并未展示，請(qǐng)注意，不能直接運(yùn)行。
const config = { type: ‘localStorage’, // 本地存儲(chǔ)類型 sessionStorage prefix: ‘SDF_0.0.1’, // 名稱前綴 建議：項(xiàng)目名 + 項(xiàng)目版本 expire: 1, //過(guò)期時(shí)間 單位：秒 isEncrypt: true // 默認(rèn)加密 為了調(diào)試方便, 開發(fā)過(guò)程中可以不加密}// 設(shè)置 setStorageexport const setStorage = (key, value, expire = 0) => { if (value === ” || value === null || value === undefined) { value = null; } if (isNaN(expire) || expire { key = autoAddPrefix(key); // key 不存在判斷 if (!window[config.type].getItem(key) || JSON.stringify(window[config.type].getItem(key)) === ‘null’) { return null; } // 對(duì)存儲(chǔ)數(shù)據(jù)進(jìn)行解密 const storage = config.isEncrypt ? JSON.parse(decrypt(window[config.type].getItem(key))) : JSON.parse(window[config.type].getItem(key)); let nowTime = Date.now(); // 過(guò)期刪除 if (storage.expire && config.expire * 6000 < (nowTime – storage.time)) { removeStorage(key); return null; } else { // 持續(xù)使用時(shí)會(huì)自動(dòng)續(xù)期 setStorage(autoRemovePrefix(key), storage.value); return storage.value; }}
使用
使用的時(shí)候你可以通過(guò) import 按需引入，也可以掛載到全局上使用，一般建議少用全局方式或全局變量，為后來(lái)接手項(xiàng)目繼續(xù)開發(fā)維護(hù)的人，追查代碼留條便捷之路！不要為了封裝而封裝，盡可能基于項(xiàng)目需求和后續(xù)的通用，以及使用上的便捷。比如獲取全部存儲(chǔ)變量，如果你項(xiàng)目上都未曾用到過(guò)，倒不如刪減掉，留著過(guò)年也不見得有多香，不如為減小體積做點(diǎn)貢獻(xiàn)！
import {isSupportStorage, hasStorage, setStorage,getStorage,getStorageKeys,getStorageForIndex,getStorageLength,removeStorage,getStorageAll,clearStorage} from ‘@/utils/storage’
完整代碼
該代碼已進(jìn)一步完善，需要的可以直接進(jìn)一步優(yōu)化，也可以將可優(yōu)化或可擴(kuò)展的建議，留言說(shuō)明，我會(huì)進(jìn)一步迭代的?？梢愿鶕?jù)自己的需要?jiǎng)h除一些不用的方法，以減小文件大小。
/*** * title: storage.js * Author: Gaby * Email: [email protected] * Time: 2022/6/1 17:30 * last: 2022/6/2 17:30 * Desc: 對(duì)存儲(chǔ)的簡(jiǎn)單封裝 */ import CryptoJS from ‘crypto-js’;// 十六位十六進(jìn)制數(shù)作為密鑰const SECRET_KEY = CryptoJS.enc.Utf8.parse(“3333e6e143439161”);// 十六位十六進(jìn)制數(shù)作為密鑰偏移量const SECRET_IV = CryptoJS.enc.Utf8.parse(“e3bbe7e3ba84431a”);// 類型 window.localStorage,window.sessionStorage,const config = { type: ‘localStorage’, // 本地存儲(chǔ)類型 sessionStorage prefix: ‘SDF_0.0.1’, // 名稱前綴 建議：項(xiàng)目名 + 項(xiàng)目版本 expire: 1, //過(guò)期時(shí)間 單位：秒 isEncrypt: true // 默認(rèn)加密 為了調(diào)試方便, 開發(fā)過(guò)程中可以不加密}// 判斷是否支持 Storageexport const isSupportStorage = () => { return (typeof (Storage) !== “undefined”) ? true : false}// 設(shè)置 setStorageexport const setStorage = (key, value, expire = 0) => { if (value === ” || value === null || value === undefined) { value = null; } if (isNaN(expire) || expire { key = autoAddPrefix(key); // key 不存在判斷 if (!window[config.type].getItem(key) || JSON.stringify(window[config.type].getItem(key)) === ‘null’) { return null; } // 優(yōu)化 持續(xù)使用中續(xù)期 const storage = config.isEncrypt ? JSON.parse(decrypt(window[config.type].getItem(key))) : JSON.parse(window[config.type].getItem(key)); let nowTime = Date.now(); // 過(guò)期刪除 if (storage.expire && config.expire * 6000 { key = autoAddPrefix(key); let arr = getStorageAll().filter((item)=>{ return item.key === key; }) return arr.length ? true : false;}// 獲取所有keyexport const getStorageKeys = () => { let items = getStorageAll() let keys = [] for (let index = 0; index { return window[config.type].key(index)}// 獲取localStorage長(zhǎng)度export const getStorageLength = () => { return window[config.type].length}// 獲取全部 getAllStorageexport const getStorageAll = () => { let len = window[config.type].length // 獲取長(zhǎng)度 let arr = new Array() // 定義數(shù)據(jù)集 for (let i = 0; i { window[config.type].removeItem(autoAddPrefix(key));}// 清空 clearStorageexport const clearStorage = () => { window[config.type].clear();}// 名稱前自動(dòng)添加前綴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();}
