返回顶部
首页 > 资讯 > 前端开发 > JavaScript >ahooks封装cookie localStorage sessionStorage方法
  • 286
分享到

ahooks封装cookie localStorage sessionStorage方法

2024-04-02 19:04:59 286人浏览 八月长安
摘要

目录引言cookielocalStorage/sessionStorage总结与归纳引言 本文是深入浅出 ahooks 源码系列文章的第九篇,这个系列的目标主要有以下几点: 加深对

引言

本文是深入浅出 ahooks 源码系列文章的第九篇,这个系列的目标主要有以下几点:

  • 加深对 React hooks 的理解。
  • 学习如何抽象自定义 hooks。构建属于自己的 React hooks 工具库。
  • 培养阅读学习源码的习惯,工具库是一个对源码阅读不错的选择。

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

cookie

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

该 hook 使用了 js-cookie 这个 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 中可以看到 cookie 被 disabled 的时候,也是访问不了 localStorage 的。stackoverflow 也有这个讨论。(奇怪的知识又增加了)
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 的封装整体比较简,以上就是ahooks封装cookie localStorage sessionStorage方法的详细内容,更多关于ahooks封装cookie localStorage sessionStorage的资料请关注编程网其它相关文章!

--结束END--

本文标题: ahooks封装cookie localStorage sessionStorage方法

本文链接: https://lsjlt.com/news/154139.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

猜你喜欢
  • ahooks封装cookie localStorage sessionStorage方法
    目录引言cookielocalStorage/sessionStorage总结与归纳引言 本文是深入浅出 ahooks 源码系列文章的第九篇,这个系列的目标主要有以下几点: 加深对 ...
    99+
    2024-04-02
  • LocalStorage封装一次解决方法示例
    目录1. 封装基础的方法2. 使用的封装3. 清除总结1. 封装基础的方法 首先对于localStorage做一个基础的封装,封装出 get 、set 、del 这几个基本的方法。这...
    99+
    2024-04-02
  • html5本地存储中的localstorage和本地数据库与sessionStorage的使用方法
    这篇文章给大家介绍html5本地存储中的localstorage和本地数据库与sessionStorage的使用方法,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。html5的一个非常c...
    99+
    2024-04-02
  • php封装app的方法
    本文操作环境:windows7系统、PHP7.4版、DELL G3电脑使用php封装APP接口php封装APP接口我们先来介绍Json的封装方法 json_encode函数传递中文的话,输出后是乱码的,针对这个问题我觉得有必要做一个解释: ...
    99+
    2016-12-05
    php app
  • RedisTemplate常用方法封装
    RedisTemplate常用方法封装 序列化和配置 package com.gitee.ccsert.mall.common.redis.config; import com.fasterxml.jackson.annotation....
    99+
    2014-05-04
    RedisTemplate常用方法封装
  • promise封装wx.request的方法
    上篇文章给大家介绍了使用Promise封装小程序wx.request的实现方法,本文重点给大家介绍promise封装wx.request的方法,具体内容如下所示: 为什么要封装wx....
    99+
    2024-04-02
  • javascript怎么封装方法
    这篇文章主要讲解了“javascript怎么封装方法”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“javascript怎么封装方法”吧!什么是封装方法?封装方法是一种将一段代码封装成单个可重...
    99+
    2023-07-06
  • uni-app封装请求方法与api封装调用
    封装请求创建request.js文件,把一下内容根据自己的需求更改。 //封装请求方法//声明一个请求函数const api_request=(url, method, parm)=>{ con...
    99+
    2023-09-03
    前端 php 开发语言 javascript vue.js
  • vue方法封装并使用
    Vue是一种流行的JavaScript框架,它将数据和UI进行了强大的绑定,并提供了许多有用的功能。在Vue应用程序中,您可能需要编写一些通用的方法,这些方法将在整个应用程序中使用。为了提高代码的可重用性和可维护性,最好将这些方法封装成Vu...
    99+
    2023-05-20
  • vue封装axios的几种方法
    目录基础版第一步:配置axios 第二步:封装请求 第三步:使用 进阶版基础版 第一步:配置axios 首先,创建一个Service.js,这里面存放的时axios的配置以及拦截器...
    99+
    2024-04-02
  • PHP常见方法封装总结
    目录1.get请求2.post请求3.随机字符串4.返回json数据5.数据过滤6.重定向7.获取客户端ip1.get请求 function get_curl($url, $time...
    99+
    2024-04-02
  • angular8封装http服务的方法
    这篇文章将为大家详细讲解有关angular8封装http服务的方法,小编觉得挺实用的,因此分享给大家做个参考,希望大家阅读完这篇文章后可以有所收获。HttpClientModule要在angular里使用http服务必须先在app.modu...
    99+
    2023-06-09
  • Java类、封装、继承的方法
    这篇文章主要讲解了“Java类、封装、继承的方法”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“Java类、封装、继承的方法”吧!什么是类成员使用static修饰的成员方法和成员变量称为类成员...
    99+
    2023-06-29
  • C++的封装方法是什么
    本篇内容介绍了“C++的封装方法是什么”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!封装c++认为万事万物皆为对象,对象上有其属性和行为封装...
    99+
    2023-06-29
  • php封装数组去重方法
    在PHP中,对数组进行去重是一项非常基础的任务之一。然而,在某些情况下,我们需要对数组进行封装,以方便我们的代码复用和维护。本文将介绍如何使用类方法封装数组去重方法。首先,我们需要创建一个名为ArrayUtils的类,并添加一个名为uniq...
    99+
    2023-05-19
  • react-native弹窗封装的方法
    本文实例为大家分享了react-native弹窗封装的具体代码,供大家参考,具体内容如下 上图 仿苹果弹窗组件(android+ios均可用) 以上效果均基于本文的弹窗组件,后...
    99+
    2024-04-02
  • react封装Dialog弹框的方法
    本文实例为大家分享了react封装Dialog弹框的具体代码,供大家参考,具体内容如下 Dialog.js import React, { Component, Children ...
    99+
    2024-04-02
  • php封装方法怎么实现
    这篇文章主要介绍了php封装方法怎么实现的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇php封装方法怎么实现文章都会有所收获,下面我们一起来看看吧。什么是封装方法?封装方法是一种将代码组织成一个单独的、可重复使...
    99+
    2023-07-05
  • php封装的方法有哪些
    在PHP中,我们可以封装方法(函数)来实现代码的模块化和复用。以下是一些常见的PHP封装方法的方式: 函数:使用function关...
    99+
    2024-04-02
  • Node.js模块封装及使用方法
    Node.js中也有一些功能的封装,类似C#的类库,封装成模块这样方便使用,安装之后用require()就能引入调用. 一、Node.js模块封装 1.创建一个名为censorify的文件夹 2.在ce...
    99+
    2022-06-04
    使用方法 模块 Node
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作