如何利用 watchEffect 监听 LocalStorage 变化?多标签页同步技巧

夜枫大大_1144

夜枫大大_1144

2026-04-27

299人浏览

原创

watchEffect 无法监听 localStorage 变化,因其非 Vue 响应式数据;需用 storage 事件捕获跨标签页修改,并通过 ref 代理实现响应式同步。

如何利用 watcheffect 监听 localstorage 变化?多标签页同步技巧

watchEffect 本身无法直接监听 LocalStorage 的变化,因为 LocalStorage 的修改不会触发 Vue 响应式系统。要实现多标签页同步,需结合 storage 事件 + 响应式状态 + watchEffect 主动追踪。

为什么 watchEffect 看不到 LocalStorage 变化

watchEffect 只响应 Vue 的响应式数据(ref、reactive 等)。localStorage 是浏览器全局 API,写入时既不改变响应式变量,也不派发事件给 Vue,所以单纯把 localStorage.getItem() 写在 watchEffect 里——它只在首次执行时读取一次,后续 localStorage 被其他标签页修改,watchEffect 完全无感。

正确做法:用 storage 事件 + 响应式代理

核心思路:把 localStorage 封装成一个响应式“代理”,所有读写都经过它;当其他标签页修改 localStorage 时,当前页通过 window.addEventListener('storage') 捕获事件,并手动更新这个响应式变量,从而触发 watchEffect 重新运行。

  • 定义一个 ref 存储实际值(如 const theme = ref(localStorage.getItem('theme') || 'light'))
  • 封装 setItem 方法:先更新 ref,再调用 localStorage.setItem,确保本地状态和存储一致
  • 监听 storage 事件:当同域下其他标签页修改该 key,当前页收到事件后,用 localStorage.getItem 重新读取并更新 ref
  • 在 watchEffect 中直接使用该 ref —— 它现在是真正响应式的

完整示例(组合式 API)

(Vue 3 + TypeScript)

import { ref, watchEffect, onMounted, onUnmounted } from 'vue'

export function useLocalStorage(key, initialValue) {
  const data = ref(initialValue)

  // 初始化:从 localStorage 读取
  const init = () => {
    const saved = localStorage.getItem(key)
    if (saved !== null) {
      try {
        data.value = JSON.parse(saved)
      } catch {
        data.value = saved
      }
    }
  }

  // 写入:同步更新 ref 和 localStorage
  const setItem = (value) => {
    data.value = value
    try {
      localStorage.setItem(key, JSON.stringify(value))
    } catch {
      localStorage.setItem(key, String(value))
    }
  }

  // 监听其他标签页的修改
  const handleStorage = (e) => {
    if (e.key === key) {
      init()
    }
  }

  onMounted(() => {
    init()
    window.addEventListener('storage', handleStorage)
  })

  onUnmounted(() => {
    window.removeEventListener('storage', handleStorage)
  })

  return {
    data,
    setItem
  }
}

// 在组件中使用
export default {
  setup() {
    const { data: theme, setItem: setTheme } = useLocalStorage('theme', 'light')

    watchEffect(() => {
      console.log('主题已切换为:', theme.value)
      document.documentElement.setAttribute('data-theme', theme.value)
    })

    return { theme, setTheme }
  }
}

注意事项与增强点

  • storage 事件只在其他标签页修改时触发,本页调用 localStorage.setItem 不会触发自身监听 —— 所以必须手动同步 ref(如上例中的 setItem)
  • 事件对象 e.newValue 是字符串,null 表示被 clear 或 remove,注意判空处理
  • 避免高频触发:如果多个 key 共享同一套逻辑,可用 Map 缓存 handler,统一管理
  • 服务端渲染(SSR)场景下 localStorage 不存在,需加 typeof window !== 'undefined' 判断
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.08.11

3083

5

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

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

2023.10.09

6783

6

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

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

2024.03.19

7590

13

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

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

2024.03.22

7558

10

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

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

2024.05.22

1083

5

C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4009

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2548

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1480

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1418

4

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.3万人学习