1. 程式人生 > >Spring Boot學習之Logback和Log4j2整合與日誌發展史

Spring Boot學習之Logback和Log4j2整合與日誌發展史

一、簡介

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,包依賴如下圖:

日誌是預設控制檯輸出的,我們程式啟動的時候就使用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