社区编辑申请
注册/登录
如何封装 Cookie/LocalStorage/SessionStorage Hook?你明白了吗?
开发 前端
在使用 updateState 方法的时候,开发者可以传入新的 options —— newOptions。会与 useCookieState 设置的 options 进行 merge 操作。最后除了 defaultValue 会透传给 js-cookie 的 set 方法的第三个参数。

今天来看看 ahooks 是怎么封装 cookie/localStorage/sessionStorage 的。

cookie

ahooks 封装了 useCookieState,一个可以将状态存储在 Cookie 中的 Hook 。

该 hook 使用了 js-cookie[1] 这个 npm 库。我认为选择它的理由有以下:

  • 包体积小。压缩后小于 800 字节。自身是没有其它依赖的。这对于原本就是一个工具库的 ahooks 来讲是很重要的。
  • 更好的兼容性。支持所有的浏览器。并支持任意的字符。

当然,它还有其他的特点,比如支持 ESM/AMD/CommonJS 方式导入等等。

封装的代码并不复杂,先看默认值的设置,其优先级如下:

  • 本地 cookie 中已有该值,则直接取。
  • 设置的值为字符串,则直接返回。
  • 设置的值为函数,执行该函数,返回函数执行结果。
  • 返回 options 中设置的 defaultValue。
const [state, setState] = useState<State>(() => {
// 假如有值,则直接返回
const cookieValue = Cookies.get(cookieKey);

if (isString(cookieValue)) return cookieValue;
// 定义 Cookie 默认值,但不同步到本地 Cookie
// 可以自定义默认值
if (isFunction(options.defaultValue)) {
return options.defaultValue();
}

return options.defaultValue;
});

再看设置 cookie 的逻辑 —— updateState 方法。

  • 在使用updateState 方法的时候,开发者可以传入新的 options —— newOptions。会与 useCookieState 设置的 options 进行 merge 操作。最后除了 defaultValue 会透传给 js-cookie 的 set 方法的第三个参数。
  • 获取到 cookie 的值,判断传入的值,假如是函数,则取执行后返回的结果,否则直接取该值。
  • 如果值为 undefined,则清除 cookie。否则,调用 js-cookie 的 set 方法。
  • 最终返回 cookie 的值以及设置的方法。
// 设置 Cookie 值
const updateState = useMemoizedFn(
(
newValue: State | ((prevState: State) => State),
newOptions: Cookies.CookieAttributes = {},
) => {
const { defaultValue, ...restOptions } = { ...options, ...newOptions };
setState((prevState) => {
const value = isFunction(newValue) ? newValue(prevState) : newValue;
// 值为 undefined 的时候,清除 cookie
if (value === undefined) {
Cookies.remove(cookieKey);
} else {
Cookies.set(cookieKey, value, restOptions);
}
return value;
});
},
);

return [state, updateState] as const;

localStorage/sessionStorage

ahooks 封装了 useLocalStorageState 和 useSessionStorageState。将状态存储在 localStorage 和 sessionStorage 中的 Hook 。

两者的使用方法是一样的,因为官方都是用的同一个方法去封装的。我们以 useLocalStorageState 为例。

可以看到 useLocalStorageState 其实是调用 createUseStorageState 方法返回的结果。该方法的入参会判断是否为浏览器环境,以决定是否使用 localStorage,原因在于 ahooks 需要支持服务端渲染。

import { createUseStorageState } from '../createUseStorageState';
import isBrowser from '../utils/isBrowser';

const useLocalStorageState = createUseStorageState(() => (isBrowser ? localStorage : undefined));

export default useLocalStorageState;

我们重点关注一下,createUseStorageState 方法。

  • 先是调用传入的参数。假如报错会及时 catch。这是因为:

这里返回的 storage 可以看到其实可能是 undefined 的,后面都会有 catch 的处理。

另外,从这个issue[2]中可以看到 cookie 被 disabled 的时候,也是访问不了 localStorage 的。stackoverflow[3]也有这个讨论。(奇怪的知识又增加了)

export function createUseStorageState(getStorage: () => Storage | undefined) {
function useStorageState<T>(key: string, options?: Options<T>) {
let storage: Storage | undefined;
// https://github.com/alibaba/hooks/issues/800
try {
storage = getStorage();
} catch (err) {
console.error(err);
}
// 代码在后面讲解
}
  • 支持自定义序列化方法。没有则直接 JSON.stringify。
  • 支持自定义反序列化方法。没有则直接 JSON.parse。
  • getStoredValue 获取 storage 的默认值,如果本地没有值,则返回默认值。
  • 当传入 key 更新的时候,重新赋值。
// 自定义序列化方法
const serializer = (value: T) => {
if (options?.serializer) {
return options?.serializer(value);
}
return JSON.stringify(value);
};

// 自定义反序列化方法
const deserializer = (value: string) => {
if (options?.deserializer) {
return options?.deserializer(value);
}
return JSON.parse(value);
};

function getStoredValue() {
try {
const raw = storage?.getItem(key);
if (raw) {
return deserializer(raw);
}
} catch (e) {
console.error(e);
}
// 默认值
if (isFunction(options?.defaultValue)) {
return options?.defaultValue();
}
return options?.defaultValue;
}

const [state, setState] = useState<T | undefined>(() => getStoredValue());

// 当 key 更新的时候执行
useUpdateEffect(() => {
setState(getStoredValue());
}, [key]);

最后是更新 storage 的函数:

  • 如果是值为 undefined,则 removeItem,移除该 storage。
  • 如果为函数,则取执行后结果。
  • 否则,直接取值。
// 设置 State
const updateState = (value?: T | IFuncUpdater<T>) => {
// 如果是 undefined,则移除选项
if (isUndef(value)) {
setState(undefined);
storage?.removeItem(key);
// 如果是function,则用来传入 state,并返回结果
} else if (isFunction(value)) {
const currentState = value(state);
try {
setState(currentState);
storage?.setItem(key, serializer(currentState));
} catch (e) {
console.error(e);
}
} else {
// 设置值
try {
setState(value);
storage?.setItem(key, serializer(value));
} catch (e) {
console.error(e);
}
}
};

总结与归纳

对 cookie/localStorage/sessionStorage 的封装是我们经常需要去做的,ahooks 的封装整体比较简单,大家可以参考借鉴。

参考资料

[1]js-cookie: https://www.npmjs.com/package/js-cookie[2]

issue: https://github.com/alibaba/hooks/issues/800

[3]stackoverflow: https://stackoverflow.com/questions/26550770/can-session-storage-local-storage-be-disabled-and-cookies-enabled

[4]大家都能看得懂的源码(一)ahooks 整体架构篇: https://juejin.cn/post/7105396478268407815

[5]如何使用插件化机制优雅的封装你的请求hook : https://juejin.cn/post/7105733829972721677

[6]ahooks 是怎么解决 React 的闭包问题的?: https://juejin.cn/post/7106061970184339464

[7]ahooks 是怎么解决用户多次提交问题?: https://juejin.cn/post/7106461530232717326

[8]ahooks 中那些控制“时机”的hook都是怎么实现的?: https://juejin.cn/post/7107189225509879838

[9]如何让 useEffect 支持 async...await?: https://juejin.cn/post/7108675095958126629

[10]如何让定时器在页面最小化的时候不执行?: https://juejin.cn/post/7109399243202232357

[11]记录第一次给开源项目提 PR: https://juejin.cn/post/7110144695098933284​

责任编辑:武晓燕 来源: 前端杂货铺
相关推荐

2022-02-09 14:47:28

2022-06-28 08:01:26

hook状态管理state

2022-06-13 09:45:51

Hook技术移动应用响应速度

2020-10-29 11:04:28

缓存浏览器LocalStorag

2022-06-28 07:41:38

useMountReactahooks

2022-06-06 09:28:36

2022-06-27 08:00:49

2022-06-07 08:59:58

hookuseRequestReact 项目

2022-06-13 08:39:21

Vue3API

2020-06-17 07:56:19

前端存储数据

2020-08-13 06:43:41

React前端开发

2022-06-10 08:01:01

ahookshook代码

2015-08-13 15:56:44

HTML5本地存储Localstorag

2022-06-12 21:36:57

Hooksreact

2022-03-21 08:32:13

2015-06-10 10:18:27

2016-09-13 21:59:09

Html5Http缓存

2017-07-13 13:56:16

前端黑科技缓存数据

2022-06-23 08:01:48

2021-07-01 07:05:31

同话题下的热门内容

哪个版本的JVM最快?无代码软件发展简史及未来趋势携程基于 GraphQL 的前端 BFF 服务开发实践为什么会存在 1px 问题?怎么解决?一文搞定常考Vue-Router知识点EcmaScript 2022 正式发布,有哪些新特性?一文详解|增长那些事儿远程医疗:优势、前景和现有IT解决方案

编辑推荐

太厉害了,终于有人能把TCP/IP协议讲的明明白白了!牛人5次面试腾讯不成功的经验HBase原理–所有Region切分的细节都在这里了Javascript如何监听页面刷新和关闭事件如何搭建一个HTTPS服务端
我收藏的内容
点赞
收藏

51CTO技术栈公众号