Pinia 日志插件应使用 $onAction 而非手动重写 actions,因其自动监听所有 action、原生支持 Promise/错误捕获、提供 name/args/store 上下文,且可全局注册、类型安全。

Pinia 插件实现自动化 Action 日志记录,核心是利用 $onAction 这个内置的 AOP 监听机制,而不是手动重写每个 action —— 它天然支持在所有 actions 执行前、成功后、失败时插入逻辑,且不侵入业务代码。
为什么用 $onAction 而不是重写 actions?
手动包装每个 action(比如用高阶函数包裹)容易遗漏、难以维护,还破坏类型推导。而 $onAction 是 Pinia 官方提供的标准扩展点,它:
- 自动作用于 store 中所有定义在
actions里的方法(不包括$patch、$reset等 state 操作) - 原生支持 Promise 和同步错误捕获(
onError可捕获throw和reject) - 回调中可访问
name(action 名)、args(参数数组)、store(当前实例)等上下文信息 - 可在插件中统一注册,一次编写,全局生效
一个轻量但完整的日志插件写法
以下是一个生产可用的日志插件示例,支持开始、完成、失败三阶段打印,并兼容异步 action:
export function loggerPlugin({ store }) {
store.$onAction(({ name, args, after, onError }) => {
console.group(`【${name}】执行中`);
console.log('? 参数:', args);
<pre class='brush:php;toolbar:false;'>const start = Date.now();
after((result) => {
console.log(`✅ 成功 | 耗时: ${Date.now() - start}ms`);
console.log('? 返回:', result);
console.groupEnd();
});
onError((error) => {
console.warn(`❌ 失败 | 耗时: ${Date.now() - start}ms`);
console.error('? 错误:', error);
console.groupEnd();
});}); }
使用方式:在创建 Pinia 实例时通过 use() 注册即可
import { createPinia } from 'pinia';
import { loggerPlugin } from './plugins/logger';
<p>const pinia = createPinia();
pinia.use(loggerPlugin); // 全局启用</p>进阶:按 action 类型差异化日志
实际项目中,你可能希望对某些敏感操作(如 login、deleteUser)打更详细的日志,或过滤掉高频低价值 action(如 updateLocalCache)。只需加一层判断:
- 用
name.startsWith('fetch')统一标记接口类 action - 用
['login', 'logout', 'submitForm'].includes(name)精确匹配关键路径 - 结合
import.meta.env.DEV控制仅开发环境输出,避免影响生产性能
注意事项与避坑点
几个容易踩的细节:
-
$onAction不监听store.$patch({})或直接赋值store.count++,只管actions方法调用 - 多个插件调用
$onAction互不影响,钩子按注册顺序依次触发 - 若需在日志中显示用户身份、请求 ID 等上下文,建议从全局状态(如另一个 userStore)读取,而非依赖 action 参数
- 避免在
after或onError中执行耗时操作(如发请求),否则会阻塞 action 后续流程

















