$subscribe是Pinia监听状态变更最轻量推荐方式,监听mutation提交而非响应式赋值,接收mutation和state参数,支持埋点、过滤、聚合、防抖及插件化全局注册。

Pinia 的 $subscribe 是监听 store 状态变更最轻量、最推荐的方式,适合做无侵入式埋点监控——它不修改原有逻辑,只在状态提交(commit)后触发回调,天然支持批量变更聚合、来源识别和防抖控制。
理解 $subscribe 的触发时机与参数
$subscribe 监听的是 mutation 提交行为,不是响应式属性的每次赋值。也就是说,只有通过 store.$patch、store.$state = ... 或 action 内显式修改 state 并完成 commit 后才会触发(Pinia 默认开启 devtools 支持,所有变更都会被记录为 mutation)。
回调函数接收两个参数:
-
mutation:包含
type(如 "direct" 或 action 名)、storeId、payload(实际变更数据,仅限$patch({})形式有值)、events(内部用,一般忽略) - state:当前最新 state 快照(注意:是引用,勿直接修改)
基础埋点:记录变更类型与时间戳
最简埋点只需捕获“什么 store、什么动作、何时发生”:
store.$subscribe((mutation, state) => {
console.log({
store: store.$id,
type: mutation.type,
timestamp: Date.now(),
payload: mutation.payload // 仅 $patch 时有
})
})
这个模式可对接日志系统或上报服务。注意:mutation.type === 'direct' 表示是直接赋值(如 store.count = 5),而 mutation.type 为字符串(如 'increment')表示来自 action 调用。
进阶埋点:过滤 + 聚合 + 防抖
真实场景需避免重复上报、聚焦关键字段、合并高频变更:
-
按字段过滤:用
store.$state和上一次快照对比,只上报关心的 key(如cart.items.length或user.token) -
变更聚合:用
setTimeout缓存最近 200ms 的变更,合并为一条日志(尤其适合表单多字段连续输入) -
排除调试行为:检查
mutation.type是否为'devtools'(Vue Devtools 触发)或跳过特定 action(如'hydrateFromStorage')
示例(带简单防抖):
let pending = null
store.$subscribe((mutation, state) => {
if (mutation.type === 'devtools') return
if (pending) clearTimeout(pending)
pending = setTimeout(() => {
reportToAnalytics({
event: 'state_change',
store: store.$id,
keys: Object.keys(mutation.payload || {}),
timestamp: Date.now()
})
}, 150)
})
全局注册:在插件中统一管理埋点
避免每个 store 单独调用 $subscribe,推荐封装为 Pinia 插件:
export function createAnalyticsPlugin() {
return ({ store }) => {
store.$subscribe((mutation) => {
if (shouldTrack(mutation)) {
trackStateChange(store.$id, mutation)
}
})
}
}
// 使用
const pinia = createPinia()
pinia.use(createAnalyticsPlugin())
这样所有 store 自动接入埋点,后续还可基于 store.$id 做白名单/黑名单配置,或结合路由信息补充上下文(如当前页面 path)。
不复杂但容易忽略:$subscribe 不会监听 computed 或 getter 变更,也不捕获异步 action 内部未提交的中间状态——这恰恰保证了埋点反映的是“真实生效的状态”,而非开发过程中的临时值。

















