Skip to content

@neosjs/pinia-sync-store ​

多窗口间 Pinia store 状态共享插件。基于 BroadcastChannel 在同一来源的多个浏览器窗口(含 iframe)之间实时同步 Pinia store 的状态变化,并可选持久化到 Storage。

安装 ​

sh
pnpm add @neosjs/pinia-sync-store
sh
npm i @neosjs/pinia-sync-store
sh
yarn add @neosjs/pinia-sync-store

快速上手 ​

在创建 pinia 实例后,通过 store.use() 注册插件。

ts
import type { App } from 'vue'
import { createPiniaSyncStore } from '@neosjs/pinia-sync-store'
import { createPinia } from 'pinia'

const store = createPinia()

function install(app: App<Element>): any {
  // 使用插件
  store.use(createPiniaSyncStore({
    enable: true, // 是否启用
    persist: false // 是否持久化
  }))
  app.use(store)
}

export { install, store }

注册后,任意窗口修改 store 状态,其他窗口会通过 BroadcastChannel 收到变更并自动 $patch 更新,无需额外代码。

插件选项 ​

createPiniaSyncStore(options) 支持的选项:

参数类型默认值说明
enablebooleantrue是否启用同步
persistbooleanfalse是否将状态持久化到 storage
storageStoragelocalStorage持久化使用的存储引擎
keystring'@neosjs-sync-store'存储 / 广播频道的前缀,最终 key 为 `${key}#${store.$id}`

按 store 单独配置 ​

defineStore 的第三个参数支持 syncState 选项,可对单个 store 覆盖全局配置。

ts
import { defineStore } from 'pinia'

export const useAppStore = defineStore('app', {
  state: () => ({
    theme: 'light'
  }),
  syncState: {
    enable: true, // 该 store 是否启用同步
    persist: true, // 该 store 是否持久化
    storage: localStorage // 该 store 使用的存储引擎
  }
})

工作机制 ​

  • 插件为每个 store 创建名为 `${key}#${store.$id}` 的 BroadcastChannel;本窗口状态变化时序列化整个 state 并广播,其他窗口收到消息后 $patch 合并。
  • persist 开启时,每次状态变化同时写入 storage;插件初始化时若开启持久化,会先从 storage 恢复数据。
  • 外部窗口发来的更新不会再次广播,避免循环同步。

TIP

需要浏览器支持 BroadcastChannel API;不支持时插件不生效(静默降级)。