springboot整合log4j2

參考：https://www.cnblogs.com/keeya/p/10101547.html#%E5%8F%82%E8%80%83%E6%96%87%E7%AB%A0

 

1、常用日志框架

• java.util.logging：是JDK在1.4版本中引入的Java原生日志框架
• Log4j：Apache的一個開源項目，可以控制日志信息輸送的目的地是控制台、文件、GUI組件等，可以控制每一條日志的輸出格式，這些可以通過一個配置文件來靈活地進行配置，而不需要修改應用的代碼。雖然已經停止維護了，但目前絕大部分企業都是用的log4j。
• LogBack：是Log4j的一個改良版本
• Log4j2：Log4j2已經不僅僅是Log4j的一個升級版本了，它從頭到尾都被重寫了

 

2、日志門面slf4j

上述介紹的是一些日志框架的實現，這里我們需要用日志門面來解決系統與日志實現框架的耦合性。SLF4J，即簡單日志門面（Simple Logging Facade for Java），它不是一個真正的日志實現，而是一個抽象層（ abstraction layer），它允許你在后台使用任意一個日志實現。

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

使用了slf4j后，對於應用程序來說，無論底層的日志框架如何變，應用程序不需要修改任意一行代碼，就可以直接上線了。

 

3、整合步驟

　　3.1、引入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>

　　3.2、配置文件模板

　　　　log4j是通過一個.properties的文件作為主配置文件的，而現在的log4j2則已經棄用了這種方式，采用的是.xml，.json或者.jsn這種方式來做，可能這也是技術發展的一個必然性，因為properties文件的可閱讀性 真的是有點差。

　　　

<?xml version="1.0" encoding="utf-8" ?>
<configuration status="OFF" monitorInterval="5">
    <!-- 配置變量-->
    <Properties>
        <!--格式化輸出：%date表示日期、%thread表示線程名、%-5level表示從左顯示5個字符寬度、%logger{36} 表示Logger名字最長為36個字符、%l表示輸出語句所在的行數, 包括類名、方法名、文件名、行數 %msg表示輸出的信息、%n表示換行-->
        <property name="LOG_PATTERN" value="%date{yyyy-MM-dd HH:mm:ss.SSS} {%thread} %-5level %l - %msg%n"/>
        <!--定義日志存儲的路徑-->
        <property name="FILE_PATH" value="F:\springboot-logger\log"/>
        <property name="FILE_NAME" value="springboot-logger"/>
    </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="rollingFile" 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 day-->
                <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
                <SizeBasedTriggeringPolicy size="1MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy屬性如不設置，則默認為最多同一文件夾下7個文件開始覆蓋-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>
    </appenders>
    <loggers>
        <!--Loggers節點用來單獨指定日志的形式，比如要為指定包下的class指定不同的日志級別等。-->
        <!--然后定義logger，只有定義了logger並引入的appender，appender才會生效-->
        <logger name="logger.LoggerController" level="error" additivity="false">
            <appender-ref ref="Console"/>
        </logger>
        <root level="info">
            <appender-ref ref="Console"/>
            <appender-ref ref="rollingFile"/>
            <appender-ref ref="Filelog"/>
        </root>
    </loggers>
</configuration>

 

3、配置參數簡介

　　日志級別

• 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地址

 

4、Log4j2配置詳解

根節點Configuration有兩個屬性:　　　　　　

• status
• monitorinterval

有兩個子節點

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

　　status用來指定log4j本身的打印日志的級別.（日志級別以及優先級排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL）
　　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中進行輸出。