业务层hooks封装useSessionStorage实例介绍_F11 - 专业站长和开发者的学习网站

分享到

业务层hooks封装useSessionStorage实例介绍

JavaScript 来源：互联网作者：佚名发布时间：2022-08-22 09:39:00 人浏览

摘要

封装原因：名称：useSessionStorage 功能开发过程中，需要进行数据的临时存储，正常情况下，使用localStorage或者 sessionStorage，存在于 window 对象中，使用场景不一样。 sessionStorage的生命周

封装原因：

名称：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 && 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进行获取和赋值。

您可能感兴趣的文章 :

详细介绍React Hooks是如何工作的

原文链接 : https://juejin.cn/post/7133013844473053214

Tag :

vue el-switch初始值(默认值)不能正确显示状态问题

el-switch 初始值（默认值）不能正确显示状态先去检查一下接口返回格式如果是字符串不需要加冒号 1 active-value=1 inactive-value=2 如果是数字
微信小程序跳转外部链接的实现方法

微信小程序跳转外部链接在开发小程序过程中，我们可能会有这样的需求，在小程序中打开H5或者外部链接实现方法如下： 1、配置业务域
自己写一个uniapp全局弹窗(APP端)

效果图： uniapp自带的提示框不符合我们的要求，需要自己写一个提示框，且全局通用。解决思路: 使用 plus.nativeObj 来绘制窗口以及事件监听
JavaScript console对象与控制台使用介绍

1. console对象 console对象是JavaScript的原生对象,提供了很多用于调试的方法,如console.log输出信息,console.count记录执行次数 1 console.log(console); 2.
JavaScript错误处理机制全面分析介绍

1. Error 实例 JavaScript在运行错误时会抛出一个错误,JS提供了Error构造函数,所有抛出的错误都是这个构造函数的实例 1 2 const err = new Error(代码出
JavaScript Object.defineProperty与proxy代理模式的使用详

1. Object.defineProperty 1 2 const obj = {}; Object.defineProperty(obj,prop,descript); 参数 obj 要定义属性的对象 prop 要定义的属性 descript 属性描述符返回值
Javascript Object对象类型使用介绍

1. 生成方法对象是javaScript中的一种数据类型,它是key-value的合集，是无序的 1 2 3 4 const obj = { name: ian,age: 21}; //key使用变量 const gender = gender
JavaScript代码不能被阻断的稳定性建设

背景稳定性建设之JavaScript代码不能被阻断 js代码可能会因为某些原因，导致出错，进而整个后续代码有可能都被阻断。直接影响线上的稳定
JavaScript前端学算法题解LeetCode最大重复子字符串

最大重复子字符串给你一个字符串sequence，如果字符串word连续重复k次形成的字符串是sequence的一个子字符串，那么单词word的重复值为k。单
uni-app小程序沉浸式导航实现的全过程

项目要在多个页面上加自定义导航栏，还要有渐变效果，就是随着页面上滑，导航栏透明度由0逐渐变为1。这里面有几个基本点需要注意下。

业务层hooks封装useSessionStorage实例介绍

封装原因：

建议：

工具库封装模式:

工具库目录：

API设计：

代码实践：

Hooks设计方式

useSessionStorage.js

简介：

注意点

Api

Params

Options

Result

总结：

您可能感兴趣的文章 :

vue el-switch初始值(默认值)不能正确显示状态问题

微信小程序跳转外部链接的实现方法

自己写一个uniapp全局弹窗(APP端)

JavaScript console对象与控制台使用介绍

JavaScript错误处理机制全面分析介绍

JavaScript Object.defineProperty与proxy代理模式的使用详

Javascript Object对象类型使用介绍

JavaScript代码不能被阻断的稳定性建设

JavaScript前端学算法题解LeetCode最大重复子字符串

uni-app小程序沉浸式导航实现的全过程

React配置子路由的实现

微信小程序地图(map)组件点击(tap)获取

微信小程序实现工作时间段选择

用js实现猜数字小游戏的代码

vue与react的介绍