聊一聊log4j2配置文件log4j2.xml

 1、背景

　　最近因爲項目的須要，咱們把log4j 1.x的版本所有遷移成log4j 2.x 的版本，那隨之而來的slf4j整合log4j的配置（使用Slf4j集成Log4j2構建項目日誌系統的完美解決方案）以及log4j2配置文件的詳解，就須要咱們來好好聊一聊了。本文就專門來說解下log4j2.xml配置文件的各項標籤的意義。

2、配置全解

　　1.關於配置文件的名稱以及在項目中的存放位置

　　　　log4j 2.x版本再也不支持像1.x中的.properties後綴的文件配置方式，2.x版本配置文件後綴名只能爲".xml",".json"或者".jsn".

　　　　系統選擇配置文件的優先級(從先到後)以下：

　　　　　　(1).classpath下的名爲log4j2-test.json 或者log4j2-test.jsn的文件.

　　　　　　(2).classpath下的名爲log4j2-test.xml的文件.

　　　　　　(3).classpath下名爲log4j2.json 或者log4j2.jsn的文件.

　　　　　　(4).classpath下名爲log4j2.xml的文件.

　　　　　咱們通常默認使用log4j2.xml進行命名。若是本地要測試，能夠把log4j2-test.xml放到classpath，而正式環境使用log4j2.xml，則在打包部署的時候不要打包log4j2-test.xml便可。

　　2.缺省默認配置文件

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <Configuration status="WARN">
 3   <Appenders>
 4     <Console name="Console" target="SYSTEM_OUT">
 5       <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
 6     </Console>
 7   </Appenders>
 8   <Loggers>
 9     <Root level="error">
10       <AppenderRef ref="Console"/>
11     </Root>
12   </Loggers>
13 </Configuration>

　　3.配置文件節點解析　　　　

　　　　(1).根節點Configuration有兩個屬性:status和monitorinterval,有兩個子節點:Appenders和Loggers(代表能夠定義多個Appender和Logger).

　　　　　　　status用來指定log4j自己的打印日誌的級別.

　　　　　　　monitorinterval用於指定log4j自動從新配置的監測間隔時間，單位是s,最小是5s.

　　　　(2).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屬性)。

　　　　(3).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中進行輸出。

　　　　(4).關於日誌level.

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

　　　　　　All:最低等級的，用於打開全部日誌記錄.

　　　　　　Trace:是追蹤，就是程序推動如下，你就能夠寫個trace輸出，因此trace應該會特別多，不過不要緊，咱們能夠設置最低日誌級別不讓他輸出.

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

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

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

　　　　　　Error:輸出錯誤信息日誌.

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

　　　　　　OFF:最高等級的，用於關閉全部日誌記錄.

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

　　4.比較完整的log4j2.xml配置模板

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <!--日誌級別以及優先級排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
 3 <!--Configuration後面的status，這個用於設置log4j2自身內部的信息輸出，能夠不設置，當設置成trace時，你會看到log4j2內部各類詳細輸出-->
 4 <!--monitorInterval：Log4j可以自動檢測修改配置 文件和從新配置自己，設置間隔秒數-->
 5 <configuration status="WARN" monitorInterval="30">
 6     <!--先定義全部的appender-->
 7     <appenders>
 8     <!--這個輸出控制檯的配置-->
 9         <console name="Console" target="SYSTEM_OUT">
10         <!--輸出日誌的格式-->
11             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
12         </console>
13     <!--文件會打印出全部信息，這個log每次運行程序會自動清空，由append屬性決定，這個也挺有用的，適合臨時測試用-->
14     <File name="log" fileName="log/test.log" append="false">
15        <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
16     </File>
17     <!-- 這個會打印出全部的info及如下級別的信息，每次大小超過size，則這size大小的日誌會自動存入按年份-月份創建的文件夾下面並進行壓縮，做爲存檔-->
18         <RollingFile name="RollingFileInfo" fileName="${sys:user.home}/logs/info.log"
19                      filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
20             <!--控制檯只輸出level及以上級別的信息（onMatch），其餘的直接拒絕（onMismatch）-->        
21             <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
22             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
23             <Policies>
24                 <TimeBasedTriggeringPolicy/>
25                 <SizeBasedTriggeringPolicy size="100 MB"/>
26             </Policies>
27         </RollingFile>
28         <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log"
29                      filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
30             <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
31             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
32             <Policies>
33                 <TimeBasedTriggeringPolicy/>
34                 <SizeBasedTriggeringPolicy size="100 MB"/>
35             </Policies>
36         <!-- DefaultRolloverStrategy屬性如不設置，則默認爲最多同一文件夾下7個文件，這裏設置了20 -->
37             <DefaultRolloverStrategy max="20"/>
38         </RollingFile>
39         <RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log"
40                      filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
41             <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
42             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
43             <Policies>
44                 <TimeBasedTriggeringPolicy/>
45                 <SizeBasedTriggeringPolicy size="100 MB"/>
46             </Policies>
47         </RollingFile>
48     </appenders>
49     <!--而後定義logger，只有定義了logger並引入的appender，appender纔會生效-->
50     <loggers>
51         <!--過濾掉spring和mybatis的一些無用的DEBUG信息-->
52         <logger name="org.springframework" level="INFO"></logger>
53         <logger name="org.mybatis" level="INFO"></logger>
54         <root level="all">
55             <appender-ref ref="Console"/>
56             <appender-ref ref="RollingFileInfo"/>
57             <appender-ref ref="RollingFileWarn"/>
58             <appender-ref ref="RollingFileError"/>
59         </root>
60     </loggers>
61 </configuration>