一、簡介
Java知名的日志有很多,比如:JUL、Log4j、JCL、SLF4J、Logback、Log4j2,那麼這些日志架構之間有着怎樣的關系?誕生的原因又是解決什麼問題?下面一起來看。
1.1 JUL
Java有自己的日志架構JUL(Java Util Logging)在java.util.logging下,因為對開發者不友好,使用成本太高和日志級别分類不清晰的問題,所有很少有開發者用。
1.2 Log4j
因為JUL的缺陷問題,這就給了Log4j機會,所有Log4j一經推出就迅速風靡全球。
1.3 JCL
JCL是Jakarta Commons-Logging的縮寫,Jakarta在這裡指的是一個組織,而不是印度的首都雅加達,Jakarta,一個早期的Apache開源項目,用于管理各個Java子項目,諸如Tomcat, Ant, Maven, Struts, JMeter, Velocity, JMeter, Commons等。2011年12月,在所有子項目都被遷移為獨立項目後,Jakarta名稱就不再使用了。
JCL誕生的初衷是因為Java自身的一些包用了JUL,而Log4j使用者使用的有很多,那麼JCL就是提供一套API來實作不同Logger之間的切換。
1.4 SLF4J
SLF4J(Simple Logging Facade For Java)簡單日志門面,和JCL功能類似,但JCL有一個緻命的缺點就是算法複雜,出現問題難以排除,而SLF4J的誕生就是為了解決JCL的缺點。
值得一提的是SLF4J的作者就是Log4j的作者。
1.5 Logback
Logback是Log4j的作者的另一個開源日志元件,與Log4j相比,Logback重新了核心,使它的性能提升了很多,大約是Log4j的10倍,同時占用更小的記憶體,并且完整的實作了SLF4J API是你可以很友善的切換日志架構。
1.6 Log4j2
Log4j2有着和Logback相同的功能,但又有自己單用的功能,比如:插件式結構、配置檔案優化、異步日志等。
Log4j2是Log4j的更新,它比其前身Log4j 1.x提供了重大改進,并提供了Logback中可用的許多改進,同時修複了Logback架構中的一些固有問題。
從GitHub的更新日志來看,Logback已經有半年沒有更新了,而作為知名組織的Apache下的Log4j2的更新卻是非常活躍的,Log4j 1.x 于2015年8月停止維護更新了。
GitHub位址
Logback:https://github.com/qos-ch/logback
log4j2:https://github.com/apache/logging-log4j2
本文分别來看Logback和Log4j2在Spring Boot中的實作。
二、Logback使用
開發環境
- JDK 8
- Spring Boot 2.0.4 RELEASE
- Maven
- Windows 10
- IDEA 2018.2
2.1 Logback的使用
Spring Boot預設內建了Logback,可以開箱即用,非常友善。因為spring-boot-starter-logging是Logback的日志實作,而Spring Boot啟動項spring-boot-starter又依賴了spring-boot-starter-logging,是以Spring Boot就預設內建了Logback,包依賴如下圖:
![](https://img.laitimes.com/img/9ZDMuAjOiMmIsIjOiQnIsICMyYTMvw1dvwlMvwlM3VWaWV2Zh1Wa-cmbw5SMtZTZshneyAjevwVMzADM0cTMtUGall3LcVmdhNXLwRHdo9CXt92YucWbpRWdvx2Yx5yazF2Lc9CX6MHc0RHaiojIsJye.png)
日志是預設控制台輸出的,我們程式啟動的時候就使用Logback,如下圖所示:
日志組成解讀:
- 日期和時間:毫秒精度,易于排序
- 日志級别:trace、debug、info、warn、error(日志級别依次從低到高)
- 程序ID
-
分隔符---
- 線程名稱:括在方括号中(可以截斷控制台輸出)
- 記錄器名稱:這通常是源類名(通常縮寫)
- 日志具體資訊
2.2 輸入檔案
如果需要輸出日志到檔案,隻需要在application.properties配置檔案設定:logging.file或logging.path,示例如下:
logging.level.root=info
logging.file=D:\\log\\my.log
複制
可以通過設定日志的級别,忽略更低級别的日志輸出。
注意: logging.file和logging.path設定一個屬性即可,如果兩個都設定,則以logging.file為主,logging.path無效。
日志檔案容量設定:使用“logging.file.max-history”屬性為日志最大容量設定,預設10M超過則分割為多個檔案。
2.3 自定義日志配置
日志服務在ApplicationContext建立前就初始化了,是以通過設定屬性和傳統的配置XML檔案,可以對日志進行管理和控制。
隻需要在src/main/resources下,建立好約定名稱的XML檔案,即可完成對日志系統的設定,不同的日志系統有不同的約定名稱,如下清單:
日志 | 名稱 |
---|---|
logback | logback-spring.xml, logback-spring.groovy, logback.xml, 或者 logback.groovy |
log4j2 | log4j2-spring.xml 或者 log4j2.xml |
Spring Boot官方建議使用“-spring”的命名規則,進行日志配置,如:logback-spring.xml而不是logback.xml。
當然你也可以自定義日志名稱,隻需要在application.properties配置即可,代碼如下:
logging.config=classpath:logging-config.xml
來看一個logback-spring.xml示例檔案:
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!-- 日志根目錄-->
<springProperty scope="context" name="LOG_HOME" source="logging.path" defaultValue="/data/logs/spring-boot-logback"/>
<!-- 日志級别 -->
<springProperty scope="context" name="LOG_ROOT_LEVEL" source="logging.level.root" defaultValue="DEBUG"/>
<!-- 辨別這個"STDOUT" 将會添加到這個logger -->
<springProperty scope="context" name="STDOUT" source="log.stdout" defaultValue="STDOUT"/>
<!-- 日志檔案名稱-->
<property name="LOG_PREFIX" value="spring-boot-logback" />
<!-- 日志檔案編碼-->
<property name="LOG_CHARSET" value="UTF-8" />
<!-- 日志檔案路徑+日期-->
<property name="LOG_DIR" value="${LOG_HOME}/%d{yyyyMMdd}" />
<!--對日志進行格式化-->
<property name="LOG_MSG" value="- | [%X{requestUUID}] | [%d{yyyyMMdd HH:mm:ss.SSS}] | [%level] | [${HOSTNAME}] | [%thread] | [%logger{36}] | --> %msg|%n "/>
<!--檔案大小,預設10MB-->
<property name="MAX_FILE_SIZE" value="50MB" />
<!-- 配置日志的滾動時間 ,表示隻保留最近 10 天的日志-->
<property name="MAX_HISTORY" value="10"/>
<!--輸出到控制台-->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<!-- 輸出的日志内容格式化-->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>${LOG_MSG}</pattern>
</layout>
</appender>
<!--輸出到檔案-->
<appender name="0" class="ch.qos.logback.core.rolling.RollingFileAppender">
</appender>
<!-- 定義 ALL 日志的輸出方式:-->
<appender name="FILE_ALL" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--日志檔案路徑,日志檔案名稱-->
<File>${LOG_HOME}/all_${LOG_PREFIX}.log</File>
<!-- 設定滾動政策,當天的日志大小超過 ${MAX_FILE_SIZE} 檔案大小時候,新的内容寫入新的檔案, 預設10MB -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志檔案路徑,新的 ALL 日志檔案名稱,“ i ” 是個變量 -->
<FileNamePattern>${LOG_DIR}/all_${LOG_PREFIX}%i.log</FileNamePattern>
<!-- 配置日志的滾動時間 ,表示隻保留最近 10 天的日志-->
<MaxHistory>${MAX_HISTORY}</MaxHistory>
<!--當天的日志大小超過 ${MAX_FILE_SIZE} 檔案大小時候,新的内容寫入新的檔案, 預設10MB-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>${MAX_FILE_SIZE}</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 輸出的日志内容格式化-->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>${LOG_MSG}</pattern>
</layout>
</appender>
<!-- 定義 ERROR 日志的輸出方式:-->
<appender name="FILE_ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 下面為配置隻輸出error級别的日志 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<OnMismatch>DENY</OnMismatch>
<OnMatch>ACCEPT</OnMatch>
</filter>
<!--日志檔案路徑,日志檔案名稱-->
<File>${LOG_HOME}/err_${LOG_PREFIX}.log</File>
<!-- 設定滾動政策,當天的日志大小超過 ${MAX_FILE_SIZE} 檔案大小時候,新的内容寫入新的檔案, 預設10MB -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志檔案路徑,新的 ERR 日志檔案名稱,“ i ” 是個變量 -->
<FileNamePattern>${LOG_DIR}/err_${LOG_PREFIX}%i.log</FileNamePattern>
<!-- 配置日志的滾動時間 ,表示隻保留最近 10 天的日志-->
<MaxHistory>${MAX_HISTORY}</MaxHistory>
<!--當天的日志大小超過 ${MAX_FILE_SIZE} 檔案大小時候,新的内容寫入新的檔案, 預設10MB-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>${MAX_FILE_SIZE}</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 輸出的日志内容格式化-->
<layout class="ch.qos.logback.classic.PatternLayout">
<Pattern>${LOG_MSG}</Pattern>
</layout>
</appender>
<!-- additivity 設為false,則logger内容不附加至root ,配置以配置包下的所有類的日志的列印,級别是 ERROR-->
<logger name="org.springframework" level="ERROR" />
<logger name="org.apache.commons" level="ERROR" />
<logger name="org.apache.zookeeper" level="ERROR" />
<logger name="com.alibaba.dubbo.monitor" level="ERROR"/>
<logger name="com.alibaba.dubbo.remoting" level="ERROR" />
<!-- ${LOG_ROOT_LEVEL} 日志級别 -->
<root level="${LOG_ROOT_LEVEL}">
<!-- 辨別這個"${STDOUT}"将會添加到這個logger -->
<appender-ref ref="${STDOUT}"/>
<!-- FILE_ALL 日志輸出添加到 logger -->
<appender-ref ref="FILE_ALL"/>
<!-- FILE_ERROR 日志輸出添加到 logger -->
<appender-ref ref="FILE_ERROR"/>
</root>
</configuration>
複制
2.4 代碼中使用日志
在代碼中使用日志,隻需要使用如下代碼:
private Logger logger = LoggerFactory.getLogger(this.getClass());
//...
logger.debug("this is debug");
logger.info("this is info");
複制
三、Log4j2內建
3.1 配置依賴元件
Spring Boot添加Log4j2依賴的同時,需要排除Logback依賴,配置pom.xml代碼如下:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions><!-- 去掉logback配置 -->
<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>
</dependencies>
複制
3.2 自定義日志配置
添加log4j2-spring.xml檔案在src/main/resources檔案下,配置檔案代碼如下:
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<Appenders>
<Console name="CONSOLE" target="SYSTEM_OUT">
<PatternLayout charset="UTF-8" pattern="[%-5p] %d %c - %m%n" />
</Console>
<File name="File" fileName="D:\\mylog.log">
<PatternLayout pattern="%m%n" />
</File>
</Appenders>
<Loggers>
<root level="info">
<AppenderRef ref="CONSOLE" />
<AppenderRef ref="File" />
</root>
</Loggers>
</configuration>
複制
輸入日志到控制台和D盤mylog.log檔案中。
到此為止,已經完成了log4j2的內建,運作項目,檢視日志。
示例源碼:https://github.com/vipstone/springboot-example/tree/master/springboot-logging
參考資料
JAVA日志的前世今生:https://www.cnblogs.com/xiexj/p/9417128.html