Vue3學習與實踐 · 全局異常監控

每個web項目上線后，難免會出現各種奇奇怪怪的bug，或網絡，或系統無法，或兼容適配，或測試遺漏等等原因。為了能更快的定位問題，解決問題，所以添加前端異常監控至關重要。本文就具體介紹一下怎么在Vue3項目中配置全局異常監控。

一、方法介紹

在Vue項目中，錯誤異常監控可從以下三個方法入手：

1. JS全局onerror

特點：

• 全局監聽所有JS錯誤
• 無法識別 Vue 組件信息
• 可以捕獲一些 Vue 監聽不到的錯誤，如：異步錯誤

語法：

window.onerror = function(message, source, lineno, colno, error) {
  console.log(message, source, lineno, colno, error)
  // do something
}

// or

window.addEventListener('error', function(event) { 
  console.log(event)
  // do something
})

參數：

• message：錯誤消息（字符串）
• source：引發錯誤的腳本的URL（字符串）
• lineno：發生錯誤的行號（數值）
• colno：發生錯誤的行的列號（數值）
• error：錯誤對象（對象）

2. Vue配置方法errorHandler

特點：

• Vue全局錯誤監聽，所有組件錯誤都會匯總到這里
• errorCaptured 返回 false ，錯誤會被提前攔截阻止，這里無法捕獲

配置：

app.config.errorHandler = (err, vm, info) => {
  console.log(err, vm, info)
  // do something
}

參數：

• err：具體錯誤信息
• vm：當前錯誤所在的Vue實例
• info：Vue特定的錯誤信息，錯誤所在的生命周期鈎子

3. 生命周期鈎子errorCaptured

特點：

• 監聽所有 下級 組件的錯誤
• 返回 false 會阻止錯誤向上傳播

配置：

<script setup>
  import { onErrorCaptured } from 'vue'

  onErrorCaptured((err, vm, info)=>{
    console.log(err, vm, info)
    // do something
  })
</script>  

參數和全局 errorHandler 完全一致

二、方法封裝

1. 新建 commonApi.js 文件，封裝 http 接口請求

// src/api/commonApi.js

import store from '@/store';

const osType = (function () {
  const ua = window.navigator.userAgent;
  if (/(Android)/.test(ua)) {
    return 1;
  }
  if (/(iPhone|iPad)/.test(ua)) {
    return 2;
  }
  return 3;
}());

const isProd = process.env.NODE_ENV === 'production';

export default {
  postErrorLogs(prams) {
    /*
    * project 發生項目 可自行定義
    * errorType 錯誤類型: 1接口報錯 2代碼報錯
    * terminal 終端平台: 1安卓 2ios 3web
    * */
    if (!isProd) return;
    return ajax({
      url: '/api/common/log/error',
      method: 'POST',
      data: {
        ...prams,
        userInfo: store.getters['User/getUserInfo'].userId || '',
        pageUrl: window.location.href,
        project: 'xxx',
        terminal: osType,
      },
    });
  },
}

2. 新建 errorHandler.js 文件，封裝 error 監聽方法

// src/common/errorHandler.js

import { nextTick } from 'vue';
import CommonApi from '@/api/CommonApi';

export default {
  errorHandler(err, vm, info) {
    nextTick(async () => {
      await CommonApi.postErrorLogs({
        errorType: 2, // 錯誤類型: 1接口報錯 2代碼報錯
        errorInfo: err.toString(),
        note: `組件：${vm.$.vnode.type.__file} \n發生錯誤：${err} \n所在生命周期：${info}`,
      });
    });
  },
  
  async onerror(message, source, lineno, colno, error) {
    await CommonApi.postErrorLogs({
      errorType: 2, // 錯誤類型: 1接口報錯 2代碼報錯
      errorInfo: `錯誤原因：${message}\n錯誤URL: ${source}\n錯誤行號: ${lineno}`,
    });
  },
};

三、項目配置

在入口文件 main.js 中配置監控方法

// src/main.js

import { createApp } from 'vue'
import ErrorFn from './common/errorHandler';
import App from './App.vue'

const isProd = process.env.NODE_ENV === 'production';

// ...

const app = createApp(App)

if (isProd) {
  app.config.errorHandler = ErrorFn.errorHandler
  window.onerror = ErrorFn.onerror
}

// ...

app.mount('#app')

溫馨提示：

1. onErrorCaptured 鈎子監聽可以在一些業務比較重要的組件進行配置，收集詳細錯誤信息。
2. 使用了 onErrorCaptured 建議返回 false，避免收集重復的錯誤信息。
3. errorHandler 和 onErrorCaptured 不能收集異步錯誤。
4. Vue2 和 Vue3 中的使用方法類似，onErrorCaptured 是Vue3組合式API的方法，Vue2中使用 errorCaptured 鈎子即可。

---

《Vue3學習與實戰》系列

• Vue3學習與實戰 · 全局異常監控（本文）
• Vue3學習與實戰 · 組件通信
• Vue3學習與實戰 · 全局掛載使用Axios
• Vue3學習與實戰 · 配置使用vue-router路由
• Vue3學習與實戰 · Vuex狀態管理
• vue3 + vite實現異步組件和路由懶加載
• Vite+Vue3+Vant快速構建項目

---

歡迎訪問：天問博客