Vue自定义Hook实现简化本地存储

 更新时间:2023年12月01日 15:15:54   作者:北凉温华  
这篇文章主要为大家详细介绍了如何通过使用 Vue 3 的 Composition API 创建一个强大而灵活的自定义 Hook,简化了在 localStorage 或 sessionStorage 中管理数据的流程,需要的可以参考下

引言

在现代Web开发中,客户端的本地存储是一个重要的工具,用于在浏览器中保存和检索用户数据。本文将介绍如何通过使用 Vue 3 的 Composition API 创建一个强大而灵活的自定义 Hook,简化了在 localStoragesessionStorage 中管理数据的流程。

背景知识

在讨论具体实现之前,让我们回顾一下本地存储的重要性以及为什么使用 Vue 3 的 Composition API 能够更好地组织代码。

本地存储的重要性

在Web应用程序中,客户端本地存储是一种在浏览器中存储数据的机制,它允许我们将信息保存在用户的设备上。这对于存储用户首选项、会话状态、缓存数据等方面都非常有用。通过在本地存储中保留数据,用户在关闭浏览器或刷新页面后,仍能保留一些状态和信息。

Vue 3 的 Composition API 优势

Vue 3 引入了 Composition API,这是一种新的组织组件逻辑的方式。相比于以前的选项 API,Composition API 提供更直观、灵活和可组合的代码结构。使用 Composition API,我们能够更容易地组织和重用代码块,使代码更清晰易懂。

解决方案设计

在我们深入讨论代码实现之前,让我们先了解一下本地存储是如何在现代Web应用中发挥作用的。考虑到本地存储的重要性,我们将使用 Vue 3 的 Composition API 来创建一个灵活且易于使用的自定义 Hook,简化了在不同存储类型(localStoragesessionStorage)中存储和检索数据的过程。

import { onUnmounted, ref, watch } from 'vue';

/**
 * 自定义 hook 函数,用于使用 localStorage 或 sessionStorage
 * @param {string} key - 存储的键名
 * @param {*} defaultVal - 默认值
 * @param {string} storage - 存储类型,可选值为 'localStorage' 或 'sessionStorage'
 * @return {object} - 响应式对象,包含 value、setValue 属性
 */
export function useLocalStorage(key, defaultVal, storage) {
  const storageType = storage === 'localStorage' ? localStorage : sessionStorage;

  // 使用 ref 创建响应式对象
  const value = ref(JSON.parse(storageType.getItem(key)) || defaultVal);

  /**
   * 更新 value 的值,并将新的值存储到 localStorage 或 sessionStorage 中
   * @param {*} newVal - 新的值
   */
  const setValue = (newVal) => {
    storageType.setItem(key, JSON.stringify(newVal));
    value.value = newVal;
  };

  /**
   * 监听 value 的变化,即时将 value 的值存储到 localStorage 或 sessionStorage 中
   */
  const stopWatch = watch(
    () => JSON.stringify(value.value),
    () => {
      storageType.setItem(key, JSON.stringify(value.value));
    },
    { immediate: true }
  );

  // 使用 onUnmounted 钩子停止监听,防止内存泄漏
  onUnmounted(stopWatch);

  /**
   * 清除存储在 localStorage 或 sessionStorage 中的值
   */
  const clearValue = () => {
    storageType.removeItem(key)
    value.value = defaultVal
  }
  
  return {
    value,
    setValue,
  };
}

如何使用

现在,让我们看看如何在 Vue 组件中使用这个自定义 Hook:

<template>
    <el-button type="primary" v-throttle="{ time: 1000, fn: updateStoredValue }">update</el-button>
    <el-button type="primary" v-throttle="{ time: 1000, fn: clearStorage }">clearStorage</el-button>
</template>

<script setup>
  import { useLocalStorage } from 'hooks/index.js'

  //赋值
  const localStorageExample = useLocalStorage(`localStorageExample`, `localStorageExample`, `localStorage`)
  const sessionStorageExample = useLocalStorage(`sessionStorageExample`, `sessionStorageExample`, `sessionStorage`)
  //更新
  const updateStoredValue = () => {
    console.log(`11`)
    localStorageExample.setValue(`localStorageExample改变了`)
    sessionStorageExample.setValue(`sessionStorageExample改变了`)
  }
  //清除
  const clearStorage = () => {
    console.log(`11`)
    localStorageExample.clearValue()
    sessionStorageExample.clearValue()
  }
</script>

<style lang="scss" scoped></style>

实际应用场景

想象一下,在你的 Vue 项目中,你需要保存用户的偏好设置或用户登录状态。使用这个自定义 Hook,你可以轻松地实现这些功能,让你的代码更加清晰和易维护。

性能考虑

在这个自定义 Hook 中,我们通过使用 watch 来监听数据的变化,并在组件卸载时使用 onUnmounted 停止监听,以避免内存泄漏。这种设计确保了性能和稳定性。

结论

通过本文,我们学习了如何使用 Vue 3 的 Composition API 创建一个强大的自定义 Hook,用于简化本地存储的管理。这个 Hook 提供了一个清晰、灵活的解决方案,使得在 Vue 组件中使用本地存储变得更加容易。

到此这篇关于Vue自定义Hook实现简化本地存储的文章就介绍到这了,更多相关Vue自定义Hook内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • vue中引入mousewheel事件及兼容性处理方式

    vue中引入mousewheel事件及兼容性处理方式

    这篇文章主要介绍了vue中引入mousewheel事件及兼容性处理方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • 详解Vue3子组件向父组件传递消息

    详解Vue3子组件向父组件传递消息

    这篇文章主要介绍了Vue3子组件向父组件传递消息,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-07-07
  • Vue进度条progressbar组件功能

    Vue进度条progressbar组件功能

    progressbar组件在一个可以直接运行的npm包,通过Yeoman进行构建,再通过Gulp+Webpack构建工具。这篇文章给大家介绍了Vue进度条progressbar组件
    2018-04-04
  • Vue3基础篇之常用的循环示例详解

    Vue3基础篇之常用的循环示例详解

    filter 方法会创建一个新的数组,其中包含满足指定条件的所有元素,这个方法非常适合循环遍历数组并根据特定条件过滤元素的情况,这篇文章主要介绍了Vue3基础[常用的循环],需要的朋友可以参考下
    2024-01-01
  • 浅谈Vue组件单元测试究竟测试什么

    浅谈Vue组件单元测试究竟测试什么

    这篇文章主要介绍了浅谈Vue组件单元测试究竟测试什么,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-02-02
  • vue实现滑动超出指定距离回顶部功能

    vue实现滑动超出指定距离回顶部功能

    这篇文章主要为大家详细介绍了vue实现滑动超出指定距离回顶部功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-07-07
  • 详解vue组件中使用路由方法

    详解vue组件中使用路由方法

    在本篇文章里小编给大家分享了关于vue组件中使用路由的详细步骤内容,有需要的朋友们跟着学习下。
    2019-02-02
  • Elementui如何限制el-input框输入小数点

    Elementui如何限制el-input框输入小数点

    这篇文章主要介绍了Elementui如何限制el-input框输入小数点,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-08-08
  • vue 折叠展示多行文本组件的实现代码

    vue 折叠展示多行文本组件的实现代码

    这篇文章主要介绍了vue 折叠展示多行文本组件,自动根据传入的expand判断是否需要折叠,非常完美,文章通过实例代码给大家介绍的非常详细,需要的朋友可以参考下
    2021-10-10
  • Vxe-Table开发中的各种坑以及避坑指南

    Vxe-Table开发中的各种坑以及避坑指南

    vxe-table是一个全功能的Vue表格,满足绝大部分对Table的一切需求,与任意组件库完美兼容,下面这篇文章主要给大家介绍了关于Vxe-Table开发中各种坑以及避坑的相关资料,需要的朋友可以参考下
    2022-09-09

最新评论