前言

作為后端開(kāi)發(fā)者，項(xiàng)目上線之后難免會(huì)遇到各種問(wèn)題，一個(gè)良好且及時(shí)的異常通知機(jī)制可以讓我們?cè)陧?xiàng)目的維護(hù)上避免很多不必要的麻煩。

本項(xiàng)目的開(kāi)發(fā)愿景是為了給使用者在線上項(xiàng)目的問(wèn)題排查方面能夠帶來(lái)幫助，簡(jiǎn)單配置，做到真正的開(kāi)箱即用，同時(shí)異常信息盡量詳細(xì)，幫助開(kāi)發(fā)者快速定位問(wèn)題。

目前支持基于釘釘和郵箱的異常通知，以后有時(shí)間還會(huì)擴(kuò)展其他通知方式，同時(shí)也歡迎有興趣的開(kāi)發(fā)者能夠參與進(jìn)來(lái)，共同完善

使用方式

pom.xml中增加項(xiàng)目依賴(lài)

本項(xiàng)目現(xiàn)已發(fā)布到maven中央倉(cāng)庫(kù)，可以直接通過(guò)以下坐標(biāo)引入依賴(lài)

<dependency><groupId>com.github.kongchong</groupId><artifactId>exception-notice-spring-boot-starter</artifactId><version>版本號(hào)</version></dependency>

釘釘配置

第一步：創(chuàng)建釘釘群 并在群中添加自定義機(jī)器人 對(duì)于不太了解釘釘機(jī)器人配置的同學(xué)可以參考：釘釘機(jī)器人

第二步：增加配置文件

以下以yml配置文件的配置方式為例

exception:notice:enable: 啟用開(kāi)關(guān) false或不配置的話本項(xiàng)目不會(huì)生效projectName: 指定異常信息中的項(xiàng)目名，不填的話默認(rèn)取 spring.application.name的值included-trace-package: 追蹤信息的包含的包名，配置之后只通知此包下的異常信息period: 異常信息發(fā)送的時(shí)間周期 以秒為單位 默認(rèn)值5，異常信息通知并不是立即發(fā)送的，默認(rèn)設(shè)置了5s的周期，主要為了防止異常過(guò)多通知刷屏，同時(shí)釘釘針對(duì)異常通知刷屏的情況也增加了限流措施，建議不要修改exclude-exceptions:- 需要排除的異常通知，注意 這里是異常類(lèi)的全路徑，可多選## 釘釘配置ding-talk:web-hook: 釘釘機(jī)器人的webHook地址，可依次點(diǎn)擊釘釘軟件的頭像，機(jī)器人管理，選中機(jī)器人來(lái)查看at-phones: - 釘釘機(jī)器人發(fā)送通知時(shí) 需要@的釘釘用戶(hù)賬戶(hù)，可多選

郵箱配置

這里以qq郵箱為例

第一步：項(xiàng)目中引入郵箱相關(guān)依賴(lài)

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-mail</artifactId></dependency>

第二步：增加配置文件

exception:notice:enable: 啟用開(kāi)關(guān) false或不配置的話本項(xiàng)目不會(huì)生效projectName: 指定異常信息中的項(xiàng)目名，不填的話默認(rèn)取 spring.application.name的值included-trace-package: 追蹤信息的包含的包名，配置之后只通知此包下的異常信息period: 異常信息發(fā)送的時(shí)間周期 以秒為單位 默認(rèn)值5，異常信息通知并不是立即發(fā)送的，默認(rèn)設(shè)置了5s的周期，主要為了防止異常過(guò)多通知刷屏，同時(shí)釘釘針對(duì)異常通知刷屏的情況也增加了限流措施，建議不要修改exclude-exceptions:- 需要排除的異常通知，注意 這里是異常類(lèi)的全路徑，可多選## 郵箱配置mail:from: 發(fā)送人地址to: 接收人地址cc: 抄送人地址 spring:mail:host: smtp.qq.com 郵箱server地址 username: 1182701220@qq.com server端發(fā)送人郵箱地址password: 郵箱授權(quán)碼

郵箱授權(quán)碼可以按以下方法獲取

打開(kāi)QQ郵箱網(wǎng)頁(yè)→設(shè)置→賬戶(hù)→POP3/IMAP/SMTP/Exchange/CardDAV/CalDAV服務(wù)→開(kāi)啟POP3/SMTP服務(wù)，然后就能看到授權(quán)碼了

注意：釘釘和郵箱配置支持單獨(dú)和同時(shí)啟用

配置好了配置文件，接下來(lái)可以寫(xiě)個(gè)例子測(cè)試一下了

如上圖所示，在一個(gè)測(cè)試方法中手動(dòng)拋出了一個(gè)參數(shù)錯(cuò)誤異常，接下來(lái)運(yùn)行一下看一下效果

釘釘效果：

郵箱效果：

由于報(bào)錯(cuò)太多沒(méi)有全部截圖下來(lái)，感興趣的同學(xué)可以自行測(cè)試一下

注意

本工具僅支持集成在springboot+mvc項(xiàng)目中，同時(shí)需要jdk版本1.8+

致謝

本項(xiàng)目參考以下項(xiàng)目：

prometheus-spring-boot-starter

作者

• 孔沖 1182701220@qq.com
• 博客 http://www.kcblog.cn

總結(jié)

以上是生活随笔為你收集整理的异常信息_一个针对异常信息通知的springboot starter的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。