Springboot - log4j2

log4j2

springboot中默認的日誌框架是logback，如果要使用log4j2，需要先去除默認的日誌框架

<!-- 去除系統默認的logback日誌框架，使用自己配置的框架 -->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter</artifactId>
   <exclusions>
      <exclusion>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-logging</artifactId>
      </exclusion>
   </exclusions>
</dependency>

<!-- 配置 log4j2 -->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-log4j2</artifactId>
   <version>2.0.2.RELEASE</version>
</dependency>

配置文件節點解析

根節點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:指定新建日誌文件的名稱格式.

• 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 < Fatal < OFF.

• 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中進行輸出。

關於日誌level.

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

• All:最低等級的，用於打開所有日誌記錄.

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

• Debug:指出細粒度信息事件對調試應用程序是非常有幫助的.

• Info:消息在粗粒度級別上突出強調應用程序的運行過程.

• Warn:輸出警告及warn以下級別的日誌.

• Error:輸出錯誤信息日誌.

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

• OFF:最高等級的，用於關閉所有日誌記錄.

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

<?xml version="1.0" encoding="UTF-8"?><!--Configuration後面的status，這個用於設置log4j2自身內部的信息輸出，可以不設置，當設置成trace時，你會看到log4j2內部各種詳細輸出-->
<!--monitorInterval：Log4j能夠自動檢測修改配置 文件和重新配置本身，設置間隔秒數-->
<configuration monitorInterval="5" status="warn">
   <!--日誌級別以及優先級排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
   <!--Configuration後面的status，這個用於設置log4j2自身內部的信息輸出，可以不設置，當設置成trace時，你會看到log4j2內部各種詳細輸出-->
   <!--monitorInterval：Log4j能夠自動檢測修改配置 文件和重新配置本身，設置間隔秒數-->

   <!--變量配置-->
   <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="LOG_PATTERN" value="%clr{%d{yyyy-MM-dd HH:mm:ss.SSS}}{faint} %clr{[%5p]} %clr{[%thread]}{magenta} %clr{---}{faint} %clr{%logger{36}}{cyan} %clr{:::}{faint} %m%n%xwEx" />-->
      <!-- 定義日誌存儲的路徑，不要配置相對路徑 -->
      <property name="FILE_PATH" value="c:/logs" />
      <property name="FILE_NAME" value="log-dimples" />
   </properties>

   <appenders>

      <console name="Console" target="SYSTEM_OUT">
         <!--輸出日誌的格式-->
         <PatternLayout pattern="${LOG_PATTERN}" />
         <!--控制檯只輸出level及其以上級別的信息（onMatch），其他的直接拒絕（onMismatch）-->
         <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY" />
      </console>

      <!--文件會打印出所有信息，這個log每次運行程序會自動清空，由append屬性決定，適合臨時測試用-->
      <File name="FileLog" fileName="${FILE_PATH}/test/test.log" append="false">
         <PatternLayout pattern="${LOG_PATTERN}" />
      </File>

      <!-- 這個會打印出所有的debug及以下級別的信息，每次大小超過size，則這size大小的日誌會自動存入按年份-月份建立的文件夾下面並進行壓縮，作爲存檔-->
      <RollingFile name="RollingFileDebug" fileName="${FILE_PATH}/debug/debug.log"
         filePattern="${FILE_PATH}/debug/${FILE_NAME}-DEBUG-%d{yyyy-MM-dd}_%i.log.gz">
         <!--控制檯只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）-->
         <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY" />
         <PatternLayout pattern="${LOG_PATTERN}" />
         <Policies>
            <!--interval屬性用來指定多久滾動一次，默認是1 hour-->
            <TimeBasedTriggeringPolicy interval="1" />
            <SizeBasedTriggeringPolicy size="10MB" />
         </Policies>
         <!-- DefaultRolloverStrategy屬性如不設置，則默認爲最多同一文件夾下7個文件開始覆蓋-->
         <DefaultRolloverStrategy max="100" />
      </RollingFile>

      <!-- 這個會打印出所有的info及以下級別的信息，每次大小超過size，則這size大小的日誌會自動存入按年份-月份建立的文件夾下面並進行壓縮，作爲存檔-->
      <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info/info.log"
         filePattern="${FILE_PATH}/info/${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="100" />
      </RollingFile>

      <!-- 這個會打印出所有的warn及以下級別的信息，每次大小超過size，則這size大小的日誌會自動存入按年份-月份建立的文件夾下面並進行壓縮，作爲存檔-->
      <RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn/warn.log"
         filePattern="${FILE_PATH}/warn/${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="100" />
      </RollingFile>

      <!-- 這個會打印出所有的error及以下級別的信息，每次大小超過size，則這size大小的日誌會自動存入按年份-月份建立的文件夾下面並進行壓縮，作爲存檔-->
      <RollingFile name="RollingFileError" fileName="${FILE_PATH}/error/error.log"
         filePattern="${FILE_PATH}/error/${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="100" />
      </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="RollingFileDebug"/>
         <appender-ref ref="RollingFileInfo" />
         <appender-ref ref="RollingFileWarn" />
         <appender-ref ref="RollingFileError" />
      </root>
   </loggers>

</configuration>

<?xml version="1.0" encoding="UTF-8" ?>
<Configuration>
   <!-- Configuration後面的status，這個用於設置log4j2自身內部的信息輸出，可以不設置，當設置成trace時，
    你會看到log4j2內部各種詳細輸出。可以設置成OFF(關閉)或Error(只輸出錯誤信息) -->
   <status>warn</status>
   <monitorInterval>30</monitorInterval>
   <!-- 定義全局的變量 -->
   <Properties>
      <!-- 控制檯日誌輸出級別 -->
      <Property>
         <name>log.level.console</name>
         <value>debug</value>
      </Property>
      <!-- 日誌輸出路徑 -->
      <Property>
         <name>log.path</name>
         <value>c:/log_dimples</value>
      </Property>
      <!-- 日誌輸出名字 -->
      <Property>
         <name>project.name</name>
         <value>dimples-log</value>
      </Property>
      <!-- 日誌輸出格式 -->
      <Property>
         <name>log.pattern</name>
         <value>%d{yyyy-MM-dd HH:mm:ss.SSS} -%5p ${PID:-} [%15.15t] %-30.30C{1.} : %m%n</value>
      </Property>
   </Properties>
   <Appenders>
      <!-- 定義控制檯輸出配置 -->
      <Console>
         <name>CONSOLE</name>
         <target>SYSTEM_OUT</target>
         <PatternLayout>
            <pattern>${log.pattern}</pattern>
         </PatternLayout>
      </Console>
      <RollingRandomAccessFile>
         <name>ROLLING_FILE</name>
         <fileName>${log.path}/${project.name}.log</fileName>
         <filePattern>
            ${log.path}/historyRunLog/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz
         </filePattern>
         <PatternLayout>
            <pattern>${log.pattern}</pattern>
         </PatternLayout>
         <Filters>
            <ThresholdFilter>
               <level>debug</level>
               <onMatch>ACCEPT</onMatch>
               <onMismatch>ACCEPT</onMismatch>
            </ThresholdFilter>
         </Filters>
         <!-- 日誌切分規則 -->
         <Policies>
            <TimeBasedTriggeringPolicy>
               <modulate>true</modulate>
               <interval>1</interval>
            </TimeBasedTriggeringPolicy>
         </Policies>
         <!-- 指定每天的最大壓縮包個數，默認7個，超過了會覆蓋之前的 -->
         <DefaultRolloverStrategy>
            <max>100</max>
         </DefaultRolloverStrategy>
      </RollingRandomAccessFile>
      <RollingRandomAccessFile>
         <name>PLATFORM_ROLLING_FILE</name>
         <ignoreExceptions>false</ignoreExceptions>
         <fileName>${log.path}/platform/${project.name}_platform.log</fileName>
         <filePattern>
            ${log.path}/platform/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz
         </filePattern>
         <PatternLayout>
            <pattern>${log.pattern}</pattern>
         </PatternLayout>
         <Policies>
            <TimeBasedTriggeringPolicy>
               <modulate>true</modulate>
               <interval>1</interval>
            </TimeBasedTriggeringPolicy>
         </Policies>
         <DefaultRolloverStrategy>
            <max>100</max>
         </DefaultRolloverStrategy>
      </RollingRandomAccessFile>
      <RollingRandomAccessFile>
         <name>BUSINESS_ROLLING_FILE</name>
         <ignoreExceptions>false</ignoreExceptions>
         <fileName>${log.path}/business/${project.name}_business.log</fileName>
         <filePattern>
            ${log.path}/business/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz
         </filePattern>
         <PatternLayout>
            <pattern>${log.pattern}</pattern>
         </PatternLayout>
         <Policies>
            <TimeBasedTriggeringPolicy>
               <modulate>true</modulate>
               <interval>1</interval>
            </TimeBasedTriggeringPolicy>
         </Policies>
         <DefaultRolloverStrategy>
            <max>100</max>
         </DefaultRolloverStrategy>
      </RollingRandomAccessFile>
      <RollingRandomAccessFile>
         <name>EXCEPTION_ROLLING_FILE</name>
         <ignoreExceptions>false</ignoreExceptions>
         <fileName>${log.path}/exception/${project.name}_exception.log</fileName>
         <filePattern>
            ${log.path}/exception/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz
         </filePattern>
         <ThresholdFilter>
            <level>error</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
         </ThresholdFilter>
         <PatternLayout>
            <pattern>${log.pattern}</pattern>
         </PatternLayout>
         <Policies>
            <TimeBasedTriggeringPolicy>
               <modulate>true</modulate>
               <interval>1</interval>
            </TimeBasedTriggeringPolicy>
         </Policies>
         <DefaultRolloverStrategy>
            <max>100</max>
         </DefaultRolloverStrategy>
      </RollingRandomAccessFile>
      <RollingRandomAccessFile>
         <name>DB_ROLLING_FILE</name>
         <ignoreExceptions>false</ignoreExceptions>
         <fileName>${log.path}/db/${project.name}_db.log</fileName>
         <filePattern>${log.path}/db/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz
         </filePattern>
         <PatternLayout>
            <pattern>${log.pattern}</pattern>
         </PatternLayout>
         <Policies>
            <TimeBasedTriggeringPolicy>
               <modulate>true</modulate>
               <interval>1</interval>
            </TimeBasedTriggeringPolicy>
         </Policies>
         <DefaultRolloverStrategy>
            <max>100</max>
         </DefaultRolloverStrategy>
      </RollingRandomAccessFile>
   </Appenders>
   <Loggers>
      <Root>
         <level>info</level>
         <AppenderRef>
            <ref>CONSOLE</ref>
         </AppenderRef>
         <AppenderRef>
            <ref>ROLLING_FILE</ref>
         </AppenderRef>
         <AppenderRef>
            <ref>EXCEPTION_ROLLING_FILE</ref>
         </AppenderRef>
      </Root>
      <Logger>
         <name>platform</name>
         <level>info</level>
         <additivity>false</additivity>
         <AppenderRef>
            <ref>CONSOLE</ref>
         </AppenderRef>
         <AppenderRef>
            <ref>PLATFORM_ROLLING_FILE</ref>
         </AppenderRef>
      </Logger>
      <Logger>
         <name>business</name>
         <level>info</level>
         <additivity>false</additivity>
         <AppenderRef>
            <ref>BUSINESS_ROLLING_FILE</ref>
         </AppenderRef>
      </Logger>
      <Logger>
         <name>exception</name>
         <level>debug</level>
         <additivity>true</additivity>
         <AppenderRef>
            <ref>EXCEPTION_ROLLING_FILE</ref>
         </AppenderRef>
      </Logger>
      <Logger>
         <name>db</name>
         <level>info</level>
         <additivity>false</additivity>
         <AppenderRef>
            <ref>DB_ROLLING_FILE</ref>
         </AppenderRef>
      </Logger>
   </Loggers>
</Configuration>