Vue 3 组合式函数怎么实现异常日志自动上报的封装

小强同学_4294

小强同学_4294

2026-10-31

556人浏览

原创

组合式函数useErrorReporter实现异常日志自动上报,通过封装错误捕获、分类、格式化与发送逻辑,解耦业务代码,支持全局errorHandler联动、主动上报、防抖限流、离线缓存及敏感信息过滤。

vue 3 组合式函数怎么实现异常日志自动上报的封装

组合式函数实现异常日志自动上报,核心思路是:把错误捕获、分类、格式化、发送逻辑封装成独立的可复用函数,并与业务逻辑解耦。它不依赖具体组件,也不侵入业务代码,而是通过统一入口注入错误上下文,再交由基础设施层完成上报。

useErrorReporter:基础封装结构

这是一个典型的组合式函数签名:

命名规范:必须以 use 开头,如 useErrorReporter;
输入参数:通常接收一个配置对象,包含上报地址、是否启用、环境判断等;
返回值:暴露 report 方法和可选的全局监听器注册能力。

示例实现(简化版):

蓝湖代码转vue2.0+element-ui
蓝湖代码转vue2.0+element-ui

将静态 Vue 页面(index.vue)改造为动态页面(Custom.vue);稿源仅限 index.vue、其引用的 CSS 与资源路径,禁止参考仓库内其他文件。Invoke when user wants to transform a static Vue page into a dynamic data-driven page with Element UI components.

下载


import { onMounted, onUnmounted, ref } from 'vue'
export function useErrorReporter(options: {
  url: string;
  enabled?: boolean;
  envWhitelist?: string[];
}) {
  const isReady = ref(false)

  const report = async (error: any, context: Recordstring, any> = {}) => {
    if (!options.enabled || !isReady.value) return
    try {
      await fetch(options.url, {
        method: 'POST',
        headers: { 'Content-Type': 'application/json' },
        body: JSON.stringify({
          message: error?.message || 'Unknown error',
          stack: error?.stack,
          context,
          timestamp: Date.now(),
          env: import.meta.env.MODE
        })
      })
    } catch (e) {
      console.warn('Failed to send error log:', e)
    }
  }

  onMounted(() => {
    isReady.value = true
  })

  onUnmounted(() => {
    isReady.value = false
  })

  return { report }
}

与全局错误处理联动

Vue 3 的 app.config.errorHandler 是捕获组件内未处理异常的第一道防线。组合式函数本身不负责监听这个钩子,但可以被它调用:

  • 在 main.ts 中初始化 useErrorReporter 实例,并将其 report 方法绑定到 errorHandler
  • 这样所有 setup/render/watch 中抛出的同步/异步错误都会自动进入上报流程
  • 注意:该钩子无法捕获原生 Promise reject,需配合 window.addEventListener('unhandledrejection') 补充

业务侧主动上报错误

当业务代码中明确知道某处可能出错(比如手动调用接口失败),应避免直接 console.error,而是调用组合式函数暴露的 report:


const { report } = useErrorReporter({
  url: '/api/log/error',
  enabled: import.meta.env.PROD
})

const handleSubmit = async () => {
  try {
    await api.submitForm(data)
  } catch (err) {
    report(err, { action: 'submitForm', userId: currentUser.id })
  }
}

增强健壮性的关键细节

  • 防抖与限流:高频错误(如快速连续点击触发)应节流,避免日志服务被打爆;可用 lodash-es/debounce 封装 report
  • 离线缓存:网络不可用时,先存入 localStorage,恢复后重发;组合式函数内部可集成此逻辑
  • 敏感信息过滤:上报前清理 context 中的 token、密码字段,防止泄露
  • 类型安全:定义 ErrorPayload 接口,确保字段结构一致,便于后端解析

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

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

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

下载

相关标签:

vue.js vue vue 3

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

相关专题

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

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

2023.08.11

2743

5

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

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

2023.10.09

5983

6

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

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

2024.03.19

6930

13

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

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

2024.03.22

6678

10

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

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

2024.05.22

943

5

TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

2026.02.13

312

17

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

2026.02.25

520

17

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

2026.03.13

391

19

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

2026.06.03

306

29

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Vue 教程
Vue 教程

共42课时 | 17.3万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.4万人学习

Vue.js 微实战--十天技能课堂
Vue.js 微实战--十天技能课堂

共18课时 | 1.7万人学习