Vue / 系统课时
调试与状态重置
调试与状态重置
Pinia 的问题往往不是“值错了”,而是“不知道谁在什么时候改了它”。本节用 Vue Devtools、订阅钩子和明确的重置边界追踪状态变更,并把退出登录、切换租户等场景恢复到可预测的初始状态。
学习目标
- 在 Vue Devtools 中定位 Store、Action 和状态变化
- 用
$onAction()与$subscribe()补充可检索的调试日志 - 为退出登录和上下文切换设计可重复执行的状态重置
先从 Devtools 找变更来源
开发环境中打开 Vue Devtools,进入 Pinia 相关面板,先确认当前 Store 的状态,再结合 Actions 或 Timeline 查看最近执行的动作。调试时优先追踪“哪个 action 改了哪些字段”,不要一看到异常值就直接在组件里加临时赋值覆盖。
如果一次操作触发了多个 Store,先按业务动作定位起点,再向下检查关联 Store。这样能区分“源头 action 写错”与“后续订阅、watch 或组件副作用覆盖了正确值”这两类问题。
增加可控的调试日志
Devtools 适合交互式排查,日志则适合复现偶发问题。可以只在开发环境安装 Pinia 插件,记录 action 名称和状态变更类型,避免把调试噪声带入生产环境。
import type { Pinia } from 'pinia'
export function installPiniaDebug(pinia: Pinia) {
if (!import.meta.env.DEV) return
pinia.use(({ store }) => {
store.$onAction(({ name, args, after, onError }) => {
const startedAt = performance.now()
after(() => {
console.debug(`[pinia:${store.$id}] action=${name}`, {
args,
durationMs: Math.round(performance.now() - startedAt),
})
})
onError((error) => {
console.error(`[pinia:${store.$id}] action=${name} failed`, error)
})
})
store.$subscribe((mutation) => {
console.debug(`[pinia:${store.$id}] mutation=${mutation.type}`)
}, { detached: true })
})
}在 createPinia() 后、app.use(pinia) 前调用 installPiniaDebug(pinia) 即可。具体的 mutation 次数会随 action 内部写法而变化,因此调试时关注 action 名、Store ID 和变更顺序,不要依赖日志条数作为业务断言。
预期结果
[pinia:<ID>] mutation=<VALUE>
[pinia:<ID>] action=<VALUE> { args: [...], durationMs: <TIME> }<ID>、<VALUE> 与 <TIME> 都取决于实际 Store、action 和运行时耗时,值会不同。
为可重置状态定义初始值
Option Store 自带 $reset(),它会重新执行 state() 并恢复初始状态。把租户、项目、筛选和选择项放进同一个上下文 Store 后,退出登录或切换租户都可以先回到干净基线,再建立新上下文。
import { defineStore } from 'pinia'
interface ContextState {
tenantId: string | null
projectId: string | null
filters: { status: 'all' | 'open' }
selectedIds: string[]
}
function createState(): ContextState {
return {
tenantId: null,
projectId: null,
filters: { status: 'all' },
selectedIds: [],
}
}
export const useContextStore = defineStore('context', {
state: createState,
actions: {
enterTenant(tenantId: string) {
this.$reset()
this.tenantId = tenantId
},
selectProject(projectId: string) {
this.projectId = projectId
},
logout() {
this.$reset()
},
},
})生效行为很明确:enterTenant() 会先清空上一个租户留下的项目、筛选和选择项,再写入新的租户 ID;logout() 则把整个上下文恢复为匿名初始值。
验证重置边界
下面是片段示例,依赖应用已经激活 Pinia,并能导入 useContextStore。在组件或测试代码中执行一次切换与退出,可以直接验证最终状态。
const context = useContextStore()
context.enterTenant('tenant-a')
context.selectProject('project-1')
context.filters.status = 'open'
context.selectedIds.push('row-42')
context.logout()
console.log(JSON.stringify(context.$state))预期输出
{"tenantId":null,"projectId":null,"filters":{"status":"all"},"selectedIds":[]}如果应用还有认证、草稿、权限缓存等多个 Store,不要用页面刷新代替重置。应在退出登录的统一入口中逐个调用它们的 $reset() 或自定义 reset(),并明确哪些全局偏好可以保留。
避免重置过度与调试污染
不是所有状态都应在切换上下文时清空。主题、语言等全局偏好通常与租户无关,可以保留;当前租户下的筛选、选中行、未提交草稿则必须根据业务规则决定清理或迁移。重置边界应按“用户级、租户级、页面级”拆分,而不是一次清空整个 Pinia。
Setup Store 默认没有自动生成的 $reset(),需要自己把每个 ref 恢复到初始值。如果一个 Store 的初始状态依赖路由、用户或远端配置,也不要把 $reset() 当成重新拉取数据的替代品;先回到可预测的空状态,再显式执行加载 action,更容易在 Devtools 中还原完整因果链。