在SpringBoot中使用logback優化異常堆棧的輸出
- 2022 年 5 月 9 日
- 筆記
- springboot
一、背景
在我們在編寫程式的過程中，無法保證自己的程式碼不拋出異常。當我們拋出異常的時候，通常會將整個異常堆棧的資訊使用日誌記錄下來。通常一整個異常堆棧的資訊是比較多的，而且存在一些沒用的資訊。那麼我們如何優化一些異常堆棧的資訊列印，過濾掉不必要的資訊呢？
二、需求
1、現有的異常堆棧資訊
2、我們想優化成如下
三、使用的技術
1、此處我們是在SpringBoot中使用logback來實現日誌的列印。
2、默認情況下，重寫異常堆棧的列印比較複雜，此處我們採用第三方實現 ogstash-logback-encoder 來實現。
3、那麼此處我們就採用 ogstash-logback-encoder 的 ShortenedThrowableConverter來實現。這個可以在以json格式的日誌輸出中使用，也可以使用到非json格式的日誌中使用。我們將會用在以非json格式日誌的輸出。
四、技術實現
1、引入依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 引入此jar包，可以將日誌以json的格式輸出，可以簡化異常資訊的輸出 -->
<dependency>
<groupId>net.logstash.logback</groupId>
<artifactId>logstash-logback-encoder</artifactId>
<version>7.1.1</version>
</dependency>
注意：
使用logstash-logback-encoder有一些依賴項，我當前使用的依賴項如下：
1、如果發生了異常
2、jdk的版本依賴
版本不同，可能依賴的版本也不一樣，推薦查看官方網址：//github.com/logfellow/logstash-logback-encoder#java-version-requirements
2、程式碼實現
3、使用 ShortenedThrowableConverter 來優化異常堆棧
1、新建 logback-spring.xml配置文件
2、通過 conversionRule來使用
3、具體用法
參數解釋：
stack{100,16,2048,rootFirst,regex1,regex2,evaluatorName}
參數解釋： 建議查看源碼 net.logstash.logback.stacktrace.ShortenedThrowableConverter#parseOptions() 方法
第1參數： maxDepthPerThrowable：值可以是 full或者short或者int值，表示每個異常最多列印多少個 stackTraceElements 元素
第2參數： shortenedClassNameLength：值可以是 full或者short或者int值，將嘗試將類名長度縮短到小於此值
com.huan.springboot.service.ExceptionService 可能會變成 c.h.s.s.ExceptionService
第3參數： maxLength：值可以是 full或者short或者int值，指的輸出到日誌中整個堆棧最大能存在多少個字元。
後面這些參數沒有固定順序
第4參數： rootFirst： 可選參數，如果使用該參數，值就是 rootFirst ,表示應首先列印堆棧的根本原因
第5參數： inlineHash： 可選參數，如果使用該參數，值就是 inlineHash, 指示應該計算和內聯十六進位錯誤哈希
如果參數都不是上方的類型，那麼可能是 evaluator 或者 exclude 類型，這2個都是判斷這個 stackTraceElement 是否應該被列印，這2個參數沒有順序關係
evaluator： 值的是需要實現 EventEvaluator<ILoggingEvent> 的類
exclude： 指的是需要排除的正則表達式， 如果存在.需要轉義成 \.
4、查看運行結果
和我們的需求對比，發現已經實現了我們想要的結果，這樣異常堆棧資訊也簡化了。
五、完整程式碼
六、參考文檔
1、//github.com/logstash/logstash-logback-encoder
2、//github.com/logfellow/logstash-logback-encoder/blob/main/stack-hash.md
3、//www.srccodes.com/shorten-logger-name-customize-optimize-exception-stack-traces-logback-logstashencoder-shortenedthrowableconverter/
