Pinia 插件开发:如何实现自动化的 Action 日志记录?

云静吖_9106

云静吖_9106

2026-06-22

700人浏览

原创

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

pinia 插件开发:如何实现自动化的 action 日志记录?

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:

Multi-Brain Protocol
Multi-Brain Protocol

一款AI工具,主要用于在主代理响应前,并行运行Kimi K2.5和GPT 5.3 Codex,注入双方观点以增强认知多样性,适合需要提升相关任务效率的用户。

下载
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 后续流程

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

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

相关专题

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

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

2023.08.11

2283

5

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

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

2023.10.09

4943

6

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

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

2024.03.19

6030

13

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

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

2024.03.22

5538

10

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

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

2024.05.22

783

5

vue2.0和3.0区别
vue2.0和3.0区别

vue2.0和3.0区别:vue2的响应式原理是利⽤“Object.defineProperty()”对数据进⾏劫持结合发布订阅模式的⽅式来实现,vue3中使⽤了es6的proxy API对数据代理,实现对数据的监控。本专题为大家提供vue2.0和3.0区别的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.17

1634

5

vue3的生命周期有哪些
vue3的生命周期有哪些

vue3的生命周期:1、beforecreate;2、created;3、beforemount;4、mounted;5、beforeupdate;6、updated;7、beforedestroy;8、destroyed;9、activated;10、deactivated等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

11882

5

Vue3组合式API与组件开发实战
Vue3组合式API与组件开发实战

本专题讲解 Vue 3 组合式 API 的核心概念与应用技巧,深入分析响应式系统、生命周期管理、组件设计与复用策略。通过完整项目案例,指导前端开发者实现高性能、结构清晰的 Vue 应用,提升开发效率与代码可维护性。

2026.02.10

296

23

热门下载

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

精品课程

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

共6课时 | 54.6万人学习

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

共89课时 | 133.4万人学习