首页 > 网络编程 > JavaScript > javascript类库 > vue.js > Vue简化本地存储

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

2023-12-01 15:15:54 作者：北凉温华

这篇文章主要为大家详细介绍了如何通过使用 Vue 3 的 Composition API 创建一个强大而灵活的自定义 Hook,简化了在 localStorage 或 sessionStorage 中管理数据的流程,需要的可以参考下

引言

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

背景知识

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

本地存储的重要性

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

Vue 3 的 Composition API 优势

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

解决方案设计

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

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