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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Electron-store本地存储功能用法详解

    Electron-store本地存储功能用法详解

    这篇文章主要为大家介绍了Electron-store本地存储功能的用法详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-06-06
  • Vue3根据动态字段绑定v-model的操作代码

    Vue3根据动态字段绑定v-model的操作代码

    最近在学习vue技术,开发表格的时候,想把表格做成组件,那查询条件就需要动态生成,这就遇到一个问题,vue怎么动态给v-model变量值,本文通过实例代码给大家介绍,对Vue3动态绑定v-model实例代码感兴趣的朋友一起看看吧
    2022-10-10
  • 如何使用RoughViz可视化Vue.js中的草绘图表

    如何使用RoughViz可视化Vue.js中的草绘图表

    这篇文章主要介绍了如何使用RoughViz可视化Vue.js中的草绘图表,帮助大家更好的理解和使用roughViz,感兴趣的朋友可以了解下
    2021-01-01
  • 浅谈Vue2.0父子组件间事件派发机制

    浅谈Vue2.0父子组件间事件派发机制

    本篇文章主要介绍了浅谈Vue2.0父子组件间事件派发机制,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-01-01
  • vue实现可改变购物数量的购物车

    vue实现可改变购物数量的购物车

    这篇文章主要为大家详细介绍了vue实现可改变购物数量的购物车,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-07-07
  • vue.js el-tooltip根据文字长度控制是否提示toolTip问题

    vue.js el-tooltip根据文字长度控制是否提示toolTip问题

    这篇文章主要介绍了vue.js el-tooltip根据文字长度控制是否提示toolTip问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-02-02
  • ajax请求+vue.js渲染+页面加载的示例

    ajax请求+vue.js渲染+页面加载的示例

    下面小编就为大家分享一篇ajax请求+vue.js渲染+页面加载的示例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-02-02
  • vue项目部署自动清除缓存方式

    vue项目部署自动清除缓存方式

    这篇文章主要介绍了vue项目部署自动清除缓存方式,包括清除文件缓存,清除浏览器 localStorage 缓存方式,本文结合示例代码给大家介绍的非常详细,需要的朋友可以参考下
    2023-07-07
  • Vue使用CDN引用项目组件,减少项目体积的步骤

    Vue使用CDN引用项目组件,减少项目体积的步骤

    这篇文章主要介绍了Vue使用CDN引用项目组件,减少项目体积的步骤,帮助大家提高项目加载速度,感兴趣的朋友可以了解下
    2020-10-10
  • vue动态路由加载时出现Cannot find module xxx问题

    vue动态路由加载时出现Cannot find module xxx问题

    这篇文章主要介绍了vue动态路由加载时出现Cannot find module xxx问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-01-01

最新评论