在項目推進中，如果說第一件事是搭Spring框架的話，那么第二件事情就是在Sring基礎上搭建日志框架，我想很多人都知道日志對於一個項目的重要性，尤其是線上Web項目，因為日志可能是我們了解應用如何執行的唯一方式。在18年大環境下，更多的企業使用Springboot和Springcloud來搭建他們的企業微服務項目，此篇文章是博主在實踐中用Springboot整合log4j2日志的總結。
目錄
Springboot整合log4j2日志全解
常用日志框架
- java.util.logging：是JDK在1.4版本中引入的Java原生日志框架
- Log4j：Apache的一個開源項目，可以控制日志信息輸送的目的地是控制台、文件、GUI組件等，可以控制每一條日志的輸出格式，這些可以通過一個配置文件來靈活地進行配置，而不需要修改應用的代碼。雖然已經停止維護了，但目前絕大部分企業都是用的log4j。
- LogBack：是Log4j的一個改良版本
- Log4j2：Log4j2已經不僅僅是Log4j的一個升級版本了，它從頭到尾都被重寫了
日志門面slf4j
上述介紹的是一些日志框架的實現，這里我們需要用日志門面來解決系統與日志實現框架的耦合性。SLF4J，即簡單日志門面（Simple Logging Facade for Java），它不是一個真正的日志實現，而是一個抽象層（ abstraction layer），它允許你在后台使用任意一個日志實現。
前面介紹的幾種日志框架一樣，每一種日志框架都有自己單獨的API，要使用對應的框架就要使用其對應的API，這就大大的增加應用程序代碼對於日志框架的耦合性。
使用了slf4j后，對於應用程序來說，無論底層的日志框架如何變，應用程序不需要修改任意一行代碼，就可以直接上線了。
為什么選用log4j2
相比與其他的日志系統，log4j2丟數據這種情況少；disruptor技術，在多線程環境下，性能高於logback等10倍以上；利用jdk1.5並發的特性，減少了死鎖的發生；
在這列舉一下一些網上其他博文中對它們的性能評測：
- 可以看到在同步日志模式下, Logback的性能是最糟糕的.
- log4j2的性能無論在同步日志模式還是異步日志模式下都是最佳的.
log4j2優越的性能其原因在於log4j2使用了LMAX,一個無鎖的線程間通信庫代替了,logback和log4j之前的隊列. 並發性能大大提升。
整合步驟
引入Jar包
springboot默認是用logback的日志框架的，所以需要排除logback，不然會出現jar依賴沖突的報錯。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions><!-- 去掉springboot默認配置 -->
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency> <!-- 引入log4j2依賴 -->
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
配置文件
- 如果自定義了文件名，需要在application.yml中配置
logging:
config: xxxx.xml
level:
cn.jay.repository: trace
- 默認名log4j2-spring.xml，就省下了在application.yml中配置
配置文件模版
log4j是通過一個.properties的文件作為主配置文件的，而現在的log4j2則已經棄用了這種方式，采用的是.xml，.json或者.jsn這種方式來做，可能這也是技術發展的一個必然性，因為properties文件的可閱讀性真的是有點差。這里給出博主自配的一個模版，供大家參考。
<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration后面的status，這個用於設置log4j2自身內部的信息輸出，可以不設置，當設置成trace時，你會看到log4j2內部各種詳細輸出-->
<!--monitorInterval：Log4j能夠自動檢測修改配置 文件和重新配置本身，設置間隔秒數-->
<configuration monitorInterval="5">
<!--日志級別以及優先級排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--變量配置-->
<Properties>
<!-- 格式化輸出：%date表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度 %msg：日志消息，%n是換行符-->
<!-- %logger{36} 表示 Logger 名字最長36個字符 -->
<property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" />
<!-- 定義日志存儲的路徑 -->
<property name="FILE_PATH" value="更換為你的日志路徑" />
<property name="FILE_NAME" value="更換為你的項目名" />
</Properties>
<appenders>
<console name="Console" target="SYSTEM_OUT">
<!--輸出日志的格式-->
<PatternLayout pattern="${LOG_PATTERN}"/>
<!--控制台只輸出level及其以上級別的信息（onMatch），其他的直接拒絕（onMismatch）-->
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
</console>
<!--文件會打印出所有信息，這個log每次運行程序會自動清空，由append屬性決定，適合臨時測試用-->
<File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
<PatternLayout pattern="${LOG_PATTERN}"/>
</File>
<!-- 這個會打印出所有的info及以下級別的信息，每次大小超過size，則這size大小的日志會自動存入按年份-月份建立的文件夾下面並進行壓縮，作為存檔-->
<RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info.log" filePattern="${FILE_PATH}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz">
<!--控制台只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）-->
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="${LOG_PATTERN}"/>
<Policies>
<!--interval屬性用來指定多久滾動一次，默認是1 hour-->
<TimeBasedTriggeringPolicy interval="1"/>
<SizeBasedTriggeringPolicy size="10MB"/>
</Policies>
<!-- DefaultRolloverStrategy屬性如不設置，則默認為最多同一文件夾下7個文件開始覆蓋-->
<DefaultRolloverStrategy max="15"/>
</RollingFile>
<!-- 這個會打印出所有的warn及以下級別的信息，每次大小超過size，則這size大小的日志會自動存入按年份-月份建立的文件夾下面並進行壓縮，作為存檔-->
<RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log" filePattern="${FILE_PATH}/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.gz">
<!--控制台只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）-->
<ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="${LOG_PATTERN}"/>
<Policies>
<!--interval屬性用來指定多久滾動一次，默認是1 hour-->
<TimeBasedTriggeringPolicy interval="1"/>
<SizeBasedTriggeringPolicy size="10MB"/>
</Policies>
<!-- DefaultRolloverStrategy屬性如不設置，則默認為最多同一文件夾下7個文件開始覆蓋-->
<DefaultRolloverStrategy max="15"/>
</RollingFile>
<!-- 這個會打印出所有的error及以下級別的信息，每次大小超過size，則這size大小的日志會自動存入按年份-月份建立的文件夾下面並進行壓縮，作為存檔-->
<RollingFile name="RollingFileError" fileName="${FILE_PATH}/error.log" filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.gz">
<!--控制台只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）-->
<ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="${LOG_PATTERN}"/>
<Policies>
<!--interval屬性用來指定多久滾動一次，默認是1 hour-->
<TimeBasedTriggeringPolicy interval="1"/>
<SizeBasedTriggeringPolicy size="10MB"/>
</Policies>
<!-- DefaultRolloverStrategy屬性如不設置，則默認為最多同一文件夾下7個文件開始覆蓋-->
<DefaultRolloverStrategy max="15"/>
</RollingFile>
</appenders>
<!--Logger節點用來單獨指定日志的形式，比如要為指定包下的class指定不同的日志級別等。-->
<!--然后定義loggers，只有定義了logger並引入的appender，appender才會生效-->
<loggers>
<!--過濾掉spring和mybatis的一些無用的DEBUG信息-->
<logger name="org.mybatis" level="info" additivity="false">
<AppenderRef ref="Console"/>
</logger>
<!--監控系統信息-->
<!--若是additivity設為false，則 子Logger 只會在自己的appender里輸出，而不會在 父Logger 的appender里輸出。-->
<Logger name="org.springframework" level="info" additivity="false">
<AppenderRef ref="Console"/>
</Logger>
<root level="info">
<appender-ref ref="Console"/>
<appender-ref ref="Filelog"/>
<appender-ref ref="RollingFileInfo"/>
<appender-ref ref="RollingFileWarn"/>
<appender-ref ref="RollingFileError"/>
</root>
</loggers>
</configuration>
配置參數簡介
在這里簡單介紹下常用的配置參數
- 日志級別
機制：如果一條日志信息的級別大於等於配置文件的級別，就記錄。
- trace：追蹤，就是程序推進一下，可以寫個trace輸出
- debug：調試，一般作為最低級別，trace基本不用。
- info：輸出重要的信息，使用較多
- warn：警告，有些信息不是錯誤信息，但也要給程序員一些提示。
- error：錯誤信息。用的也很多。
- fatal：致命錯誤。
- 輸出源
- CONSOLE（輸出到控制台）
- FILE（輸出到文件）
- 格式
- SimpleLayout：以簡單的形式顯示
- HTMLLayout：以HTML表格顯示
- PatternLayout：自定義形式顯示
PatternLayout自定義日志布局：
%d{yyyy-MM-dd HH:mm:ss, SSS} : 日志生產時間,輸出到毫秒的時間
%-5level : 輸出日志級別，-5表示左對齊並且固定輸出5個字符，如果不足在右邊補0
%c : logger的名稱(%logger)
%t : 輸出當前線程名稱
%p : 日志輸出格式
%m : 日志內容，即 logger.info("message")
%n : 換行符
%C : Java類名(%F)
%L : 行號
%M : 方法名
%l : 輸出語句所在的行數, 包括類名、方法名、文件名、行數
hostName : 本地機器名
hostAddress : 本地ip地址
Log4j2配置詳解
- 根節點Configuration
有兩個屬性:
- status
- monitorinterval
有兩個子節點:
- Appenders
- Loggers(表明可以定義多個Appender和Logger).
status用來指定log4j本身的打印日志的級別.
monitorinterval用於指定log4j自動重新配置的監測間隔時間，單位是s,最小是5s.
- Appenders節點
常見的有三種子節點:Console、RollingFile、File
Console節點用來定義輸出到控制台的Appender.
- name:指定Appender的名字.
- target:SYSTEM_OUT 或 SYSTEM_ERR,一般只設置默認:SYSTEM_OUT.
- PatternLayout:輸出格式，不設置默認為:%m%n.
File節點用來定義輸出到指定位置的文件的Appender.
- name:指定Appender的名字.
- fileName:指定輸出日志的目的文件帶全路徑的文件名.
- PatternLayout:輸出格式，不設置默認為:%m%n.
RollingFile節點用來定義超過指定條件自動刪除舊的創建新的Appender.
- name:指定Appender的名字.
- fileName:指定輸出日志的目的文件帶全路徑的文件名.
- PatternLayout:輸出格式，不設置默認為:%m%n.
- filePattern : 指定當發生Rolling時，文件的轉移和重命名規則.
- Policies:指定滾動日志的策略，就是什么時候進行新建日志文件輸出日志.
- TimeBasedTriggeringPolicy:Policies子節點，基於時間的滾動策略，interval屬性用來指定多久滾動一次，默認是1 hour。modulate=true用來調整時間：比如現在是早上3am，interval是4，那么第一次滾動是在4am，接着是8am，12am...而不是7am.
- SizeBasedTriggeringPolicy:Policies子節點，基於指定文件大小的滾動策略，size屬性用來定義每個日志文件的大小.
- DefaultRolloverStrategy:用來指定同一個文件夾下最多有幾個日志文件時開始刪除最舊的，創建新的(通過max屬性)。
Loggers節點，常見的有兩種: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中進行輸出。
簡單使用
public class LogExampleOther {
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExampleOther.class);
public static void main(String... args) {
log.error("Something else is wrong here");
}
}
使用lombok工具簡化創建Logger類
lombok就是一個注解工具jar包，能幫助我們省略一繁雜的代碼。具體介紹可以看我的這篇教程。
使用lombok后下面的代碼等效於上述的代碼，這樣會更方便的使用日志。
@Slf4j
public class LogExampleOther {
public static void main(String... args) {
log.error("Something else is wrong here");
}
}