一、背景

在我們在編寫程序的過程中，無法保證自己的代碼不拋出異常。當(dāng)我們拋出異常的時候，通常會將整個異常堆棧的信息使用日志記錄下來。通常一整個異常堆棧的信息是比較多的，而且存在一些沒用的信息。那么我們?nèi)绾蝺?yōu)化一些異常堆棧的信息打印，過濾掉不必要的信息呢？

二、需求

1、現(xiàn)有的異常堆棧信息

2、我們想優(yōu)化成如下

三、使用的技術(shù)

1、此處我們是在SpringBoot中使用logback來實現(xiàn)日志的打印。

2、默認(rèn)情況下，重寫異常堆棧的打印比較復(fù)雜，此處我們采用第三方實現(xiàn) ogstash-logback-encoder 來實現(xiàn)。

3、那么此處我們就采用 ogstash-logback-encoder 的 ShortenedThrowableConverter來實現(xiàn)。這個可以在以json格式的日志輸出中使用，也可以使用到非json格式的日志中使用。我們將會用在以非json格式日志的輸出。

四、技術(shù)實現(xiàn)

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有一些依賴項，我當(dāng)前使用的依賴項如下：

1、如果發(fā)生了異常

2、jdk的版本依賴

版本不同，可能依賴的版本也不一樣，推薦查看官方網(wǎng)址：https://github.com/logfellow/logstash-logback-encoder#java-version-requirements

2、代碼實現(xiàn)

3、使用 ShortenedThrowableConverter 來優(yōu)化異常堆棧

1、新建 logback-spring.xml配置文件

2、通過 conversionRule來使用

3、具體用法

參數(shù)解釋：

stack{100,16,2048,rootFirst,regex1,regex2,evaluatorName}
        參數(shù)解釋： 建議查看源碼 net.logstash.logback.stacktrace.ShortenedThrowableConverter#parseOptions() 方法
            第1參數(shù)： maxDepthPerThrowable：值可以是 full或者short或者int值，表示每個異常最多打印多少個 stackTraceElements 元素
            第2參數(shù)： shortenedClassNameLength：值可以是 full或者short或者int值，將嘗試將類名長度縮短到小于此值
                     com.huan.springboot.service.ExceptionService 可能會變成 c.h.s.s.ExceptionService
            第3參數(shù)： maxLength：值可以是 full或者short或者int值，指的輸出到日志中整個堆棧最大能存在多少個字符。
            后面這些參數(shù)沒有固定順序
            第4參數(shù)： rootFirst： 可選參數(shù)，如果使用該參數(shù)，值就是 rootFirst ,表示應(yīng)首先打印堆棧的根本原因
            第5參數(shù)： inlineHash： 可選參數(shù)，如果使用該參數(shù)，值就是 inlineHash, 指示應(yīng)該計算和內(nèi)聯(lián)十六進(jìn)制錯誤哈希
            如果參數(shù)都不是上方的類型，那么可能是 evaluator 或者 exclude 類型，這2個都是判斷這個 stackTraceElement 是否應(yīng)該被打印，這2個參數(shù)沒有順序關(guān)系
                evaluator： 值的是需要實現(xiàn) EventEvaluator<ILoggingEvent> 的類
                exclude： 指的是需要排除的正則表達(dá)式， 如果存在.需要轉(zhuǎn)義成 \.

4、查看運行結(jié)果

和我們的需求對比，發(fā)現(xiàn)已經(jīng)實現(xiàn)了我們想要的結(jié)果，這樣異常堆棧信息也簡化了。

五、完整代碼

https://gitee.com/huan1993/spring-cloud-parent/tree/master/springboot/springboot-logback-json-optimize-exception

六、參考文檔

1、https://github.com/logstash/logstash-logback-encoder

2、https://github.com/logfellow/logstash-logback-encoder/blob/main/stack-hash.md

3、https://www.srccodes.com/shorten-logger-name-customize-optimize-exception-stack-traces-logback-logstashencoder-shortenedthrowableconverter/

總結(jié)

到此這篇關(guān)于如何在SpringBoot中使用logback優(yōu)化異常堆棧的輸出的文章就介紹到這了,更多相關(guān)SpringBoot logback優(yōu)化異常堆棧輸出內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論