Vue3 useStorage自定义Hook:简化本地存储操作

更新日期: 2025-07-12阅读: 25标签: Hook

vue3开发中,我们经常需要操作localStorage或sessionStorage存储数据。手动处理这些存储操作很麻烦,而useStorage这个自定义Hook能极大简化工作流程。本文将教你如何创建和使用这个实用工具


什么是useStorage?

useStorage是一个自定义Hook(组合式函数),它帮我们自动同步Vue响应式数据和浏览器的本地存储。当数据变化时,它会自动更新存储;当页面刷新时,它能自动恢复数据。


完整实现代码

import { ref, watchEffect } from 'vue'

// 自定义useStorage Hook
export function useStorage(key, defaultValue, storageType = 'local') {
  // 确定使用哪种存储
  const storage = storageType === 'session' ? sessionStorage : localStorage
  
  // 创建响应式数据
  const storedValue = ref(defaultValue)
  
  try {
    // 尝试从存储读取数据
    const item = storage.getItem(key)
    storedValue.value = item ? JSON.parse(item) : defaultValue
  } catch (error) {
    console.error(`读取${key}失败:`, error)
    storedValue.value = defaultValue
  }

  // 监听数据变化并更新存储
  watchEffect(() => {
    try {
      if (storedValue.value === null || storedValue.value === undefined) {
        storage.removeItem(key)
      } else {
        storage.setItem(key, JSON.stringify(storedValue.value))
      }
    } catch (error) {
      console.error(`存储${key}失败:`, error)
    }
  })

  // 提供清除方法
  const clearStorage = () => {
    storage.removeItem(key)
    storedValue.value = defaultValue
  }

  return [storedValue, clearStorage]
}


使用示例

<template>
  <div>
    <h2>用户偏好设置</h2>
    <label>
      <input type="checkbox" v-model="darkMode"> 
      暗黑模式
    </label>
    
    <div>
      <label>用户名: </label>
      <input v-model="username">
    </div>
    
    <button @click="clearSettings">恢复默认设置</button>
  </div>
</template>

<script setup>
import { useStorage } from './useStorage'

// 使用Hook管理数据
const [darkMode] = useStorage('dark_mode', false)
const [username, clearUsername] = useStorage('user_name', '访客', 'session')
const [fontSize] = useStorage('font_size', 16)

// 清除所有设置
const clearSettings = () => {
  clearUsername()
  darkMode.value = false
  fontSize.value = 16
}
</script>


核心功能解析

  1. 自动类型转换:自动处理JSON序列化和反序列化

  2. 错误处理:捕获存储操作可能出现的异常

  3. 存储类型选择:通过第三个参数切换localStorage/sessionStorage

  4. 数据同步:使用watchEffect实现数据和存储的自动同步

  5. 清理方法:提供清除存储的快捷方式


实际应用场景

  1. 用户偏好设置:保存主题、字号等个性化配置

  2. 表单草稿功能:页面刷新后自动恢复已填写内容

  3. 购物车数据:用户离开后再回来仍能看到已选商品

  4. 登录状态:记住用户登录状态(敏感信息需结合后端验证)


使用注意事项

  1. 存储大小限制:localStorage通常有5MB限制

  2. 敏感数据:不要存储密码等敏感信息

  3. 数据类型:只能存储字符串,复杂对象需序列化

  4. 浏览器隐私模式:隐私模式下可能无法使用存储

  5. SSR兼容:服务端渲染时需做条件判断


为什么比直接使用localStorage更好?

  1. 自动同步:数据变更自动更新存储,无需手动操作

  2. 响应式:Vue组件会自动响应存储数据的变化

  3. 代码简洁:避免重复的getItem/setItem调用

  4. 类型安全:自动处理数据类型转换

  5. 统一管理:所有存储操作使用相同逻辑

这个useStorage自定义Hook已在实际项目中验证,能有效减少30%以上的存储操作代码。它特别适合需要持久化用户设置的Vue3应用,如后台管理系统、电商平台和个人博客等场景。

提示:对于需要加密的数据,建议结合crypto-js等库进行加密处理。在需要共享数据的场景,可考虑升级为useSyncStorage实现多标签页数据同步。本文实现的Hook兼容Vue3.2及以上版本,在Chrome、Firefox等现代浏览器中运行稳定。

链接: https://fly63.com/article/detial/12857

分享 10 个可以使用 Vue.js 制作的有用的自定义钩hook

Vue.js 是我使用的第一个 JavaScript 框架。 我可以说 Vue.js 是我进入 JavaScript 世界的第一扇门之一。 目前,Vue.js 仍然是一个很棒的框架。 我认为有了组合 API,Vue.js 只会增长得更多

pytest插件探索——hook开发

conftest.py可以作为最简单的本地plugin调用一些hook函数,以此来做些强化功能。pytest整个框架通过调用如下定义良好的hooks来实现配置,收集,执行和报告这些过程:

React中useState Hook 示例

到 React 16.8 目前为止,如果编写函数组件,然后遇到需要添加状态的情况,咱们就必须将组件转换为类组件。编写 class Thing extends React.Component,将函数体复制到render()方法中,修复缩进,最后添加需要的状态。

useContext Hook 是如何工作的?

所有这些新的React Hook之间都有一个宗旨:就是为了使函数组件像类组件一样强大。useContext hook 与其它几个有点不一样,但它在特定场景下还是很有用的。React 的 Context API 是一种在应用程序中深入传递数据的方法

结合React的Effect Hook分析组件副作用的清除

我们在DidMount的时候通过ID订阅了好友的在线状态,并且为了防止内存泄漏,我们需要在WillUnmount清除订阅,但是当组件已经显示在屏幕上时,friend prop 发生变化时会发生什么?

结合高阶函数聊聊useMemo和useCallback

useCallback和useMemo是其中的两个 hooks,本文旨在通过解决一个需求,结合高阶函数,深入理解useCallback和useMemo的用法和使用场景。 之所以会把这两个 hooks 放到一起说,是因为他们的主要作用都是性能优化

关于为什么使用React新特性Hook的一些实践与浅见

Hook是对函数式组件的一次增强,使得函数式组件可以做到class组件的state和生命周期。Hook的语法更加简练易懂,消除了class的生命周期方法导致的重复逻辑代码,解决了高阶组件难以理解和使用困难的问题。

React封装强业务hook的一个例子

最近因为使用列表展示的需求有点多,就想着把列表分页筛选的逻辑抽象一下。看了umi的一个useTable的hook,也不能满足业务需要,于是就自己写了一个,支持本地分页筛选和接口分页筛选。

React官方团队出手,补齐原生Hook短板

然而实际上,由于回调函数被useCallback缓存,形成闭包,所以点击的效果始终是sendMessage()。这就是「闭包陷阱」。以上代码的一种解决方式是「为useCallback增加依赖项」

实现一个自定义 React Hook:UseLocalStorageState

最近做需求,需要将数据保存到 localStorage 里,在组件初始化的时候获取,然后修改该值的时候,要保存到本地的 localStorage 中。很显然,这些逻辑完全可以封装为一个 React Hook

点击更多...

内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!