Vue setup 组合式 API 怎么编写封装本地存储操作的逻辑函数

舞姬之光

舞姬之光

2026-08-04

428人浏览

原创

推荐用自定义 hook 封装 localstorage 逻辑,实现 usestorage 组合函数,接收 key 和默认值,返回响应式 data、setdata 和 clear 方法,自动同步读写删并支持 json 与基础类型。

vue setup 组合式 api 怎么编写封装本地存储操作的逻辑函数

直接在 setup 中封装本地存储逻辑,推荐用自定义 Hook(即组合函数),把 localStorage 的读、写、删、清空能力抽离成可复用、带响应式支持的函数。

定义 useStorage 组合函数

创建一个 useStorage 函数,接收 key 和默认值,返回响应式的值及 setter/clearer 方法。核心是用 ref 包裹数据,并同步到 localStorage;同时监听 ref 变化,自动持久化。

  • 读取时优先从 localStorage 解析,失败则用默认值
  • 写入时先更新 ref,再存入 localStorage(字符串化)
  • 删除时清空对应 key,并将 ref 重置为默认值
  • 支持 JSON 类型自动序列化/反序列化,基础类型(string/number/boolean)也兼容

基础实现示例

以下是一个轻量、健壮的 useStorage 实现:

import { ref, watch } from 'vue'

export function useStorage(key, initialValue) {
  // 从 localStorage 读取并解析
  let storedValue
  try {
    const item = localStorage.getItem(key)
    storedValue = item ? JSON.parse(item) : initialValue
  } catch (e) {
    storedValue = initialValue
  }

  const data = ref(storedValue)

  // 写入 localStorage
  const setData = (value) => {
    data.value = value
  }

  // 监听响应式数据变化并持久化
  watch(data, (newValue) => {
    try {
      localStorage.setItem(key, JSON.stringify(newValue))
    } catch (e) {
      console.warn(`Failed to save ${key} to localStorage`, e)
    }
  }, { immediate: true })

  // 删除该 key
  const clear = () => {
    localStorage.removeItem(key)
    data.value = initialValue
  }

  return {
    data,
    setData,
    clear
  }
}

在 setup 中使用

在组件的 setup() 里直接调用,获得响应式状态和操作方法:

Vue-router参考手册
Vue-router参考手册

Vue-router参考手册下载

下载
import { useStorage } from './useStorage'

export default {
  setup() {
    const { data: userName, setData: setUserName, clear: clearName } = useStorage('user-name', '')
    const { data: theme, setData: setTheme } = useStorage('app-theme', 'light')

    const handleLogin = () => {
      setUserName('Alice')
      setTheme('dark')
    }

    const handleLogout = () => {
      clearName()
    }

    return {
      userName,
      theme,
      handleLogin,
      handleLogout
    }
  }
}

模板中可直接绑定 userNametheme,修改它们会自动同步到 localStorage。

增强建议:支持 sessionStorage 和类型提示

如需扩展,可让 useStorage 接收第三个参数 storageType = 'localStorage',动态选择 localStoragesessionStorage;TypeScript 用户可补充泛型约束,确保初始值与返回 data 类型一致。

不复杂但容易忽略:避免在服务端渲染(SSR)环境直接访问 localStorage —— 可加 if (typeof window !== 'undefined') 安全判断,或在 onMounted 后初始化。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1111

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

2285

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

2154

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

2345

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

357

5

TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

2026.02.13

125

17

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

2026.02.25

355

17

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

2026.03.13

208

19

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

2026.06.03

98

29

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Vue 教程
Vue 教程

共42课时 | 15.6万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.3万人学习

Vue.js 微实战--十天技能课堂
Vue.js 微实战--十天技能课堂

共18课时 | 1.5万人学习