天天看點

Springboot整合log4j2日志全解

在項目推進中,如果說第一件事是搭Spring架構的話,那麼第二件事情就是在Sring基礎上搭建日志架構,我想很多人都知道日志對于一個項目的重要性,尤其是線上Web項目,因為日志可能是我們了解應用如何執行的唯一方式。

越來越多的企業使用Springboot和Springcloud來搭建他們的企業微服務項目,此篇文章是部落客在實踐中用Springboot整合log4j2日志的總結。

java.util.logging:是JDK在1.4版本中引入的Java原生日志架構

Log4j:Apache的一個開源項目,可以控制日志資訊輸送的目的地是控制台、檔案、GUI元件等,可以控制每一條日志的輸出格式,這些可以通過一個配置檔案來靈活地進行配置,而不需要修改應用的代碼。雖然已經停止維護了,但目前絕大部分企業都是用的log4j。

LogBack:是Log4j的一個改良版本

Log4j2:Log4j2已經不僅僅是Log4j的一個更新版本了,它從頭到尾都被重寫了

上述介紹的是一些日志架構的實作,這裡我們需要用日志門面來解決系統與日志實作架構的耦合性。SLF4J,即簡單日志門面(Simple Logging Facade for Java),它不是一個真正的日志實作,而是一個抽象層( abstraction layer),它允許你在背景使用任意一個日志實作。

Springboot整合log4j2日志全解

前面介紹的幾種日志架構一樣,每一種日志架構都有自己單獨的API,要使用對應的架構就要使用其對應的API,這就大大的增加應用程式代碼對于日志架構的耦合性。

使用了slf4j後,對于應用程式來說,無論底層的日志架構如何變,應用程式不需要修改任意一行代碼,就可以直接上線了。

相比與其他的日志系統,log4j2丢資料這種情況少;disruptor技術,在多線程環境下,性能高于logback等10倍以上;利用jdk1.5并發的特性,減少了死鎖的發生;

在這列舉一下一些網上其他博文中對它們的性能評測:

Springboot整合log4j2日志全解

可以看到在同步日志模式下, Logback的性能是最糟糕的.

log4j2的性能無論在同步日志模式還是異步日志模式下都是最佳的.

Springboot整合log4j2日志全解

log4j2優越的性能其原因在于log4j2使用了LMAX,一個無鎖的線程間通信庫代替了,logback和log4j之前的隊列. 并發性能大大提升。

springboot預設是用logback的日志架構的,是以需要排除logback,不然會出現jar依賴沖突的報錯。

如果自定義了檔案名,需要在application.yml中配置

預設名log4j2-spring.xml,就省下了在application.yml中配置

log4j是通過一個.properties的檔案作為主配置檔案的,而現在的log4j2則已經棄用了這種方式,采用的是.xml,.json或者.jsn這種方式來做,可能這也是技術發展的一個必然性,因為properties檔案的可閱讀性真的是有點差。這裡給出部落客自配的一個模版,供大家參考。

在這裡簡單介紹下常用的配置參數

機制:如果一條日志資訊的級别大于等于配置檔案的級别,就記錄。

trace:追蹤,就是程式推進一下,可以寫個trace輸出

debug:調試,一般作為最低級别,trace基本不用。

info:輸出重要的資訊,使用較多

warn:警告,有些資訊不是錯誤資訊,但也要給程式員一些提示。

error:錯誤資訊。用的也很多。

fatal:緻命錯誤。

CONSOLE(輸出到控制台)

FILE(輸出到檔案)

SimpleLayout:以簡單的形式顯示

HTMLLayout:以HTML表格顯示

PatternLayout:自定義形式顯示

PatternLayout自定義日志布局:

有兩個屬性:

status

monitorinterval

有兩個子節點:

Appenders

Loggers(表明可以定義多個Appender和Logger).

status用來指定log4j本身的列印日志的級别.

monitorinterval用于指定log4j自動重新配置的監測間隔時間,機關是s,最小是5s.

常見的有三種子節點:Console、RollingFile、File

Console節點用來定義輸出到控制台的Appender.

name:指定Appender的名字.

target:SYSTEM_OUT 或 SYSTEM_ERR,一般隻設定預設:SYSTEM_OUT.

PatternLayout:輸出格式,不設定預設為:%m%n.

File節點用來定義輸出到指定位置的檔案的Appender.

fileName:指定輸出日志的目的檔案帶全路徑的檔案名.

RollingFile節點用來定義超過指定條件自動删除舊的建立新的Appender.

filePattern : 指定當發生Rolling時,檔案的轉移和重命名規則.

Policies:指定滾動日志的政策,就是什麼時候進行建立日志檔案輸出日志.

TimeBasedTriggeringPolicy:Policies子節點,基于時間的滾動政策,interval屬性用來指定多久滾動一次,預設是1 hour。modulate=true用來調整時間:比如現在是早上3am,interval是4,那麼第一次滾動是在4am,接着是8am,12am…而不是7am.

SizeBasedTriggeringPolicy:Policies子節點,基于指定檔案大小的滾動政策,size屬性用來定義每個日志檔案的大小.

DefaultRolloverStrategy:用來指定同一個檔案夾下最多有幾個日志檔案時開始删除最舊的,建立新的(通過max屬性)。

常見的有兩種:Root和Logger.

Root節點用來指定項目的根日志,如果沒有單獨指定Logger,那麼就會預設使用該Root日志輸出

level:日志輸出級别,共有8個級别,按照從低到高為:All < Trace < Debug < Info < Warn < Error < AppenderRef:Root的子節點,用來指定該日志輸出到哪個Appender.

Logger節點用來單獨指定日志的形式,比如要為指定包下的class指定不同的日志級别等。

level:日志輸出級别,共有8個級别,按照從低到高為:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

name:用來指定該Logger所适用的類或者類所在的包全路徑,繼承自Root節點.

AppenderRef:Logger的子節點,用來指定該日志輸出到哪個Appender,如果沒有指定,就會預設繼承自Root.如果指定了,那麼會在指定的這個Appender和Root的Appender中都會輸出,此時我們可以設定Logger的additivity="false"隻在自定義的Appender中進行輸出。

簡單使用

lombok就是一個注解工具jar包,能幫助我們省略一繁雜的代碼。

使用lombok後下面的代碼等效于上述的代碼,這樣會更友善的使用日志。

Springboot整合log4j2日志全解

我知道你 “在看”

Springboot整合log4j2日志全解