Java?Log框架源碼分析

這篇文章主要講解了“Java Log框架源碼分析”，文中的講解內(nèi)容簡單清晰，易于學習與理解，下面請大家跟著小編的思路慢慢深入，一起來研究和學習“Java Log框架源碼分析”吧！

Log4J、Log4J2和LogBack的歷史故事

使用過Log4J和LogBack的同學肯定能發(fā)現(xiàn)，這兩個框架的設計理念極為相似，使用方法也如出一轍。其實這個兩個框架的作者都是一個人，Ceki Gülcü，俄羅斯程序員。

Log4J 最初是基于Java開發(fā)的日志框架，發(fā)展一段時間后，作者Ceki Gülcü將Log4j捐獻給了Apache軟件基金會，使之成為了Apache日志服務的一個子項目。 又由于Log4J出色的表現(xiàn)，后續(xù)又被孵化出了支持C, C++, C#, Perl, Python, Ruby等語言的子框架。

然而，偉大的程序員好像都比較有個性。Ceki Gülcü由于不滿Apache對Log4J的管理，決定不再參加Log4J的開發(fā)維護?！俺鲎摺焙蟮腃eki Gülcü另起爐灶，開發(fā)出了LogBack這個框架（SLF4J是和LogBack一起開發(fā)出來的）。LogBack改進了很多Log4J的缺點，在性能上有了很大的提升，同時使用方式幾乎和Log4J一樣，許多用戶開始慢慢開始使用LogBack。

由于受到LogBack的沖擊，Log4J開始式微。終于，2015年9月，Apache軟件基金業(yè)宣布，Log4j不在維護，建議所有相關項目升級到Log4j2。Log4J2是Apache開發(fā)的一個新的日志框架，改進了很多Log4J的缺點，同時也借鑒了LogBack，號稱在性能上也是完勝LogBack。性能這塊后面我會仔細分析。

那slf4j和這些有什么關系？

SLF4J的全稱是Simple Logging Facade for Java，slf4j是門面模式的典型應用，因此在講slf4j前，需要簡單介紹下門面模式。

看看門面模式再說

下面是門面模式的一個典型調(diào)用過程，其核心為外部與一個子系統(tǒng)的通信必須通過一個統(tǒng)一的外觀對象進行，使得子系統(tǒng)更易于使用。 下圖中客戶端不需要直接調(diào)用幾個子系統(tǒng)，只需要與統(tǒng)一的門面進行通信即可。

門面模式的核心為Facade即門面對象，核心為幾個點：

• 知道所有子角色的功能和責任。

• 將客戶端發(fā)來的請求委派到子系統(tǒng)中，沒有實際業(yè)務邏輯。

• 不參與子系統(tǒng)內(nèi)業(yè)務邏輯的實現(xiàn)。

為什么要使用slf4j ？

回答這個問題之前，我們先看看如果需要用上面幾個日志框架來打印日志，一般怎么做，具體代碼如下：

// 使用log4j，需要log4j.jar
import org.apache.log4j.Logger;
Logger logger_log4j = Logger.getLogger(Test.class);
logger_log4j.info("Hello World!");

// 使用log4j2，需要log4j-api.jar、log4j-core.jar
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
Logger logger_log4j2 = LogManager.getLogger(Test.class);
logger_log4j2.info("Hello World!");

// logback，需要logback-classic.jar、logback-core.jar
import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.LoggerContext;
Logger logger_logback = new LoggerContext().getLogger(Test.class);
logger_logback.info("Hello World!");

從上面不難看出，使用不同的日志框架，就要引入不同的jar包，使用不同的代碼獲取Logger。如果項目升級需要更換不同的框架，那么就需要修改所有的地方來獲取新的Logger，這將會產(chǎn)生巨大的工作量。

基于此，我們需要一種接口來將不同的日志框架的使用統(tǒng)一起來，這也是為什么要使用slf4j的原因。

SLF4J，即簡單日志門面（Simple Logging Facade for Java），不是具體的日志解決方案，它只服務于各種各樣的日志系統(tǒng)。按照官方的說法，SLF4J是一個用于日志系統(tǒng)的簡單Facade，允許最終用戶在部署其應用時使用其所希望的日志系統(tǒng)。

注意：類似的日志門面還有Jakarta Common logging（JCL），主要區(qū)別在于，SLF4J是一個比較新的日志框架，它更加靈活，性能更好，支持更多的日志實現(xiàn)，而且JCL基于classLoader在運行時動態(tài)加載日志框架，可能會產(chǎn)生很多意想不到的安全問題。

通過上面的介紹，我們可以知道JCL和SLF4J都是日志門面（Facade），而Log4J、Log4J2和LogBack都是子系統(tǒng)角色（SunSystem），也就是具體的日志實現(xiàn)框架。他們的關系如下，JUL是JDK本身提供的一種實現(xiàn)。

使用日志門面引入日志組件的最大優(yōu)勢是：將系統(tǒng)和具體的日志實現(xiàn)框架解耦合。

slf4j怎么和日志框架結合使用？

使用slf4j后，當我們在打印日志時，就可以使用下面的方式：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
Logger logger = LoggerFactory.getLogger(Test.class);
logger.info("Hello World!")

這又引入了另外一個問題，slf4j如何決定使用哪個框架日志呢，并且引入哪些jar包呢？官方為我們準備了下面的組合依賴結構圖：

總結來說，就是一下幾種：

• slf4j + logback： slf4j-api.jar + logback-classic.jar + logback-core.jar

• slf4j + log4j： slf4j-api.jar + slf4j-log412.jar + log4j.jar

• slf4j + jul： slf4j-api.jar + slf4j-jdk14.jar

• 也可以只用slf4j無日志實現(xiàn)：slf4j-api.jar + slf4j-nop.jar

注意到這里沒有l(wèi)og4j2依賴jar的關系，和log4j2配合需要導入log4j2的log4j-api.jar、log4j-core.jar和橋接包log4j-slf4j-impl.jar。

所謂的橋接包，就是實現(xiàn)StaticLoggerBinder類，用來連接slf4j和日志框架。因為log4j和log4j2剛開始沒有StaticLoggerBinder這個類，為了不改變程序結構，只能重新寫一個新的jar來實現(xiàn)StaticLoggerBinder。而logback出現(xiàn)slf4j之后，于是在logback本身的jar中實現(xiàn)了StaticLoggerBinder，所以就不需要橋接包。

現(xiàn)在為什么推薦Log4j2？

Apache Log4j 2 是 Log4j(1) 的升級版，比它的祖先 Log4j 1.x和logback 有了很大的改進。除了內(nèi)部設計的調(diào)整外，主要有以下幾點的大升級：

• 更簡化的配置

• 更強大的參數(shù)格式化

• 最夸張的異步性能

Log4j2 中，分為 API(log4j-api）和實現(xiàn) (log4j-core) 兩個模塊。API 和 slf4j 是一個類型，屬于日志抽象 / 門面，而實現(xiàn)部分，才是 Log4j 2 的核心。

• org.apache.logging.log4j » log4j-api

• org.apache.logging.log4j » log4j-core

log4j2 在目前 JAVA 中的日志框架里，異步日志的性能是最高的，具體可以看下面的對比圖：

log4j2采用了字符串復用等手段來實現(xiàn)零GC模式運行，另外提供了MemoryMappedFileAppender實現(xiàn)了極高的IO性能，而且API相比slf4j，有更豐富的參數(shù)格式化功能。

怎么使用Log4j2？

說了半天，那怎么去使用Log4j2呢，這部分我仔細介紹一下。

常規(guī)使用步驟

下面以Maven配置為例進行介紹。

首先需要加入log4j的依賴，注意2.17.1以下的版本會有遠程代碼執(zhí)行的安全漏洞，具體參考Apache官方文檔（https://logging.apache.org/log4j/2.x/security.html）。推薦使用最新的版本。

	<dependency>
		<groupId>org.apache.logging.log4j</groupId>
		<artifactId>log4j-api</artifactId>
		<version>2.17.2</version>
	</dependency>
		
	<dependency>
		<groupId>org.apache.logging.log4j</groupId>
		<artifactId>log4j-core</artifactId>
		<version>2.17.2</version>
	</dependency>

配置好log4j2.xml配置文件，并放到項目的classpath里面，一般會放到resources目錄里面。下面是一個參考的配置，當然也可以使用properties文件和yaml文件來進行配置。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="LogToConsole" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Logger name="com.malaoshi" level="debug" additivity="false">
            <AppenderRef ref="LogToConsole"/>
        </Logger>
        <Root level="error">
            <AppenderRef ref="LogToConsole"/>
        </Root>
    </Loggers>
</Configuration>

在程序中打印log。使用下面的方式來打印log即可。

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class HelloWorld {

    private static final Logger logger = LogManager.getLogger(HelloWorld.class);

    public static void main(String[] args) {

        logger.debug("Hello from Log4j 2");

        // in old days, we need to check the log level to increase performance
        /*if (logger.isDebugEnabled()) {
            logger.debug("{}", getNumber());
        }*/

        // with Java 8, we can do this, no need to check the log level
        logger.debug("{}", () -> getNumber());

    }

    static int getNumber() {
        return 5;
    }

}

輸出如下：

19:12:25.337 [main] DEBUG com.malaoshi.HelloWorld - Hello from Log4j 2
19:12:25.340 [main] DEBUG com.malaoshi.HelloWorld - 5

配置文件詳解

首先給大家看一個比較全面的配置文件，可能看起來比較頭大，不急我后面會一點點仔細分析。

<?xml version="1.0" encoding="UTF-8"?>
 <!--日志級別以及優(yōu)先級排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
 <!--Configuration后面的status，這個用于設置log4j2自身內(nèi)部的信息輸出，可以不設置，當設置成trace時，你會看到log4j2內(nèi)部各種詳細輸出-->
 <!--monitorInterval：Log4j能夠自動檢測修改配置 文件和重新配置本身，設置間隔秒數(shù)-->
 <configuration status="WARN" monitorInterval="30">
     <!--先定義所有的appender-->
     <appenders>
     <!--這個輸出控制臺的配置-->
         <console name="Console" target="SYSTEM_OUT">
         <!--輸出日志的格式-->
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
         </console>
     <!--文件會打印出所有信息，這個log每次運行程序會自動清空，由append屬性決定，這個也挺有用的，適合臨時測試用-->
     <File name="log" fileName="log/test.log" append="false">
        <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
     </File>
     <!-- 這個會打印出所有的info及以下級別的信息，每次大小超過size，則這size大小的日志會自動存入按年份-月份建立的文件夾下面并進行壓縮，作為存檔-->
         <RollingFile name="RollingFileInfo" fileName="${sys:user.home}/logs/info.log"
                      filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
             <!--控制臺只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）-->        
             <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
             <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
             </Policies>
         </RollingFile>
         <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log"
                      filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
             <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
             <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
             </Policies>
         <!-- DefaultRolloverStrategy屬性如不設置，則默認為最多同一文件夾下7個文件，這里設置了20 -->
             <DefaultRolloverStrategy max="20"/>
         </RollingFile>
         <RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log"
                      filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
             <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
             <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
             </Policies>
         </RollingFile>
     </appenders>
     <!--然后定義logger，只有定義了logger并引入的appender，appender才會生效-->
     <loggers>
         <!--過濾掉spring和mybatis的一些無用的DEBUG信息-->
         <logger name="org.springframework" level="INFO"></logger>
         <logger name="org.mybatis" level="INFO"></logger>
         <root level="all">
             <appender-ref ref="Console"/>
             <appender-ref ref="RollingFileInfo"/>
             <appender-ref ref="RollingFileWarn"/>
             <appender-ref ref="RollingFileError"/>
         </root>
     </loggers>
 </configuration>

下面為大家仔細解析這個配置文件，

1. 根節(jié)點

Configuration有兩個屬性:status和monitorinterval,有兩個子節(jié)點:Appenders和Loggers(表明可以定義多個Appender和Logger)。

• status用來指定log4j本身的打印日志的級別.

• monitorinterval用于指定log4j自動重新配置的監(jiān)測間隔時間，單位是s,最小是5s.

2. Appenders節(jié)點

Appenders節(jié)點，常見的子節(jié)點有：Console、RollingFile、File。

Console節(jié)點用來定義輸出到控制臺的Appender。

• name：指定Appender的名字。

• target：SYSTEM_OUT 或 SYSTEM_ERR，一般只設置默認：SYSTEM_OUT。

• PatternLayout：輸出格式，不設置默認為:%m%n。

File節(jié)點用來定義輸出到指定位置的文件的Appender。

• name：指定Appender的名字。

• fileName：指定輸出日志的目的文件帶全路徑的文件名。

• PatternLayout：輸出格式，不設置默認為:%m%n。

RollingFile節(jié)點用來定義超過指定大小自動刪除舊的創(chuàng)建新的的Appender。

• name：指定Appender的名字。

• fileName：指定輸出日志的目的文件帶全路徑的文件名。

• PatternLayout：輸出格式，不設置默認為:%m%n。

• filePattern：指定新建日志文件的名稱格式。

• Policies是指定滾動日志的策略，就是什么時候進行新建日志文件輸出日志。

TimeBasedTriggeringPolicy：Policies子節(jié)點，基于時間的滾動策略，interval屬性用來指定多久滾動一次，默認是1 hour。modulate=true用來調(diào)整時間：比如現(xiàn)在是早上3am，interval是4，那么第一次滾動是在4am，接著是8am，12am...而不是7am。
SizeBasedTriggeringPolicy：Policies子節(jié)點，基于指定文件大小的滾動策略，size屬性用來定義每個日志文件的大小。

DefaultRolloverStrategy：用來指定同一個文件夾下最多有幾個日志文件時開始刪除最舊的，創(chuàng)建新的(通過max屬性)。

3. Loggers

Loggers節(jié)點，常見子節(jié)點有：Root和Logger。

Root節(jié)點用來指定項目的根日志，如果沒有單獨指定Logger，那么就會默認使用該Root日志輸出

• level：日志輸出級別，共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF。

• AppenderRef：Root的子節(jié)點，用來指定該日志輸出到哪個Appender。

Logger節(jié)點用來單獨指定日志的形式，比如要為指定包下的class指定不同的日志級別等。

• level：日志輸出級別，共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF。

• name：用來指定該Logger所適用的類或者類所在的包全路徑,繼承自Root節(jié)點。

• AppenderRef：Logger的子節(jié)點，用來指定該日志輸出到哪個Appender，如果沒有指定，就會默認繼承自Root.如果指定了，那么會在指定的這個Appender和Root的Appender中都會輸出，此時我們可以設置Logger的additivity="false"只在自定義的Appender中進行輸出。

4. 日志Level

共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF。

• All:最低等級的，用于打開所有日志記錄。

• Trace:是追蹤，就是程序推進以下，你就可以寫個trace輸出，所以trace應該會特別多，不過沒關系，我們可以設置最低日志級別不讓他輸出。

• Debug:指出細粒度信息事件對調(diào)試應用程序是非常有幫助的。

• Info:消息在粗粒度級別上突出強調(diào)應用程序的運行過程。

• Warn:輸出警告及warn以下級別的日志。

• Error:輸出錯誤信息日志。

• Fatal:輸出每個嚴重的錯誤事件將會導致應用程序的退出的日志。

• OFF:最高等級的，用于關閉所有日志記錄。

程序會打印高于或等于所設置級別的日志，設置的日志等級越高，打印出來的日志就越少。

參考范例

這部分給大家提供幾個常用的配置，直接放到項目里面改一下包名就可以用。

1. 輸出日志到Console

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="DEBUG">
    <Appenders>
        <Console name="LogToConsole" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
    </Appenders>
    <Loggers>
		<!-- avoid duplicated logs with additivity=false -->
        <Logger name="com.mkyong" level="debug" additivity="false">
            <AppenderRef ref="LogToConsole"/>
        </Logger>
        <Root level="error">
            <AppenderRef ref="LogToConsole"/>
        </Root>
    </Loggers>
</Configuration>

2. 輸出日志到文件

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="DEBUG">
    <Appenders>
        <Console name="LogToConsole" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
        <File name="LogToFile" fileName="logs/app.log">
            <PatternLayout>
                <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
            </PatternLayout>
        </File>
    </Appenders>
    <Loggers>
        <Logger name="com.malaoshi" level="debug" additivity="false">
            <AppenderRef ref="LogToFile"/>
            <AppenderRef ref="LogToConsole"/>
        </Logger>
        <Logger name="org.springframework.boot" level="error" additivity="false">
            <AppenderRef ref="LogToConsole"/>
        </Logger>
        <Root level="error">
            <AppenderRef ref="LogToFile"/>
            <AppenderRef ref="LogToConsole"/>
        </Root>
    </Loggers>
</Configuration>

3. 輸出到文件并滾動生成新的日志文件

<Configuration status="DEBUG">
    <Appenders>
        <Console name="LogToConsole" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
        <RollingFile name="LogToRollingFile" fileName="logs/app.log"
                    filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz">
			<PatternLayout>
				<Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
			</PatternLayout>
			<Policies>
				<TimeBasedTriggeringPolicy />
				<SizeBasedTriggeringPolicy size="10 MB"/>
			</Policies>
		</RollingFile>
    </Appenders>
	
    <Loggers>
        <!-- avoid duplicated logs with additivity=false -->
        <Logger name="com.malaoshi" level="debug" additivity="false">
            <AppenderRef ref="LogToRollingFile"/>
        </Logger>
        <Root level="error">
            <AppenderRef ref="LogToConsole"/>
        </Root>
    </Loggers>
</Configuration>

感謝各位的閱讀，以上就是“Java Log框架源碼分析”的內(nèi)容了，經(jīng)過本文的學習后，相信大家對Java Log框架源碼分析這一問題有了更深刻的體會，具體使用情況還需要大家實踐驗證。這里是億速云，小編將為大家推送更多相關知識點的文章，歡迎關注！