封装本地缓存localStorage与sessionStorage

当前许多项目对localStorage与sessionStorage的使用是直接调用,由于是明文存储,存在暴露信息的情况,本文对这两种本地存储方式进行了基本的加密与封装。为了方便用户使用,使用了TS语法进行限制与提示,查看本文时可以根据自己实际项目进行调整或是优化

参数

/** key 值 */
type StorageKey = 'token' | 'userInfo';

/** storage存储类型 */
type StorageType = 'localStorage' | 'sessionStorage';

/** 是否需要加密 */
const isEncrypt = true;

/** key值统一前缀 */
const PREFIX = 'my_project_';

设置本地缓存 setStorage

由于storage本身不支持设置过期时间,如果需要配置过期时间,可以效仿Cookie传入当前时间与时间戳进行计算,此处不做过多说明

/** 默认使用localStorage类型 */
export const setStorage = (key: StorageKey, value: any, type = 'localStorage') => {
  try {
    if (!value) value = null;

    // 判断是否开启加密 
    const data = isEncrypt
      ? encrypt(JSON.stringify(value))
      : JSON.stringify(value);

    window[type].setItem(PREFIX + key, data);
  } catch (err) {
    console.error(`Error set ${PREFIX + key} from ${type}`);
  }
}

获取本地数据 getStorage

export const getStorage = (key: StorageKey, type: StorageType = 'localStorage') => {
  if (!key) return null;

  isSupStorage(type);
  try {
    const storageStr = window[type].getItem(PREFIX + key);
    // 不存在数据或数据为null时直接返回null
    if (!storageStr || JSON.stringify(storageStr) === 'null') return null;
    
    // 判断是否需要解密
    const data = isEncrypt ? decrypt(storageStr) : storageStr;
    return JSON.parse(data);
  } catch (err) {
    console.error(`Error get ${PREFIX + key} from ${type}`);
  }
}

获取全部缓存

export const getStorageAll = (type: StorageType = 'localStorage') => {
  // 获取type类型缓存所有内容长度
  const length = window[type].length;
  const storageArr = [];

  for (let i = 0; i < length; i++) {
    const key = window[type].key[i];
    
    const storageStr = window[type].getItem(key);
    // 判断是否需要解密
    const data: any = isEncrypt ? decrypt(storageStr) : storageStr;
    storageArr.push({ key: key[i], value: JSON.parse(data) });
  }
  return storageArr;
}

删除指定storage

export const removeStorage = (key: StorageKey, type: StorageType = 'localStorage') => {
  window[type].removeItem(PREFIX + key);
}

清空storage

export const clearStorage = (type: StorageType = 'localStorage') => {
  window[type].clear();
}

当不确定项目运行环境时可以查看当前环境是否支持本地缓存

/** 判断是否支持Storage */
const isSupStorage = (type: string) => {
  if (!window) {
    throw new Error('当前环境非浏览器,无法使用window实例');
  }
  if (type === 'localStorage' && !window.localStorage) {
    throw new Error('当前环境无法使用localStorage');
  }
  if (type === 'sessionStorage' && !window.sessionStorage) {
    throw new Error('当前环境无法使用sessionStorage');
  }
}

加密 & 解密

本文使用了crypto-js进行加解密,安装路径:
npm install crypto-js
or
yarn add crypto-js

导入crypto-js

import CryptoJs from 'crypto-js'

设置秘钥和秘钥偏移量

// 十六位十六进制数作为秘钥
const KEY = CryptoJs.enc.Utf8.parse('0123456789abcdef');  
// 十六位十六进制数作为秘钥偏移量
const IV = CryptoJs.enc.Utf8.parse('1234567812345678');

封装加密方法

export const encrypt = (data: any) => {
  if (typeof data === 'object') {
    try {
      data = JSON.stringify(data);
    } catch (err) {
      console.error('Encrypt error:', err);
    }
  }
  const dataHex = CryptoJs.enc.Utf8.parse(data);
  const encrypted = CryptoJs.AES.encrypt(dataHex, KEY, {
    iv: IV,
    mode: CryptoJs.mode.CBC,
    padding: CryptoJs.pad.Pkcs7
  });

  return encrypted.ciphertext.toString();
}

封装解密方法

export const decrypt = (data: any) => {
  const encryptHexStr = CryptoJs.enc.Hex.parse(data);
  const str = CryptoJs.enc.Base64.stringify(encryptHexStr);
  const decrypted = CryptoJs.AES.decrypt(str, KEY, {
    iv: IV,
    mode: CryptoJs.mode.CBC,
    padding: CryptoJs.pad.Pkcs7
  });
  const decryptStr = decrypted.toString(CryptoJs.enc.Utf8);
  return decryptStr.toString();
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,142评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,298评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,068评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,081评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,099评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,071评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,990评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,832评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,274评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,488评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,649评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,378评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,979评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,625评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,643评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,545评论 2 352

推荐阅读更多精彩内容