此博文轉(zhuǎn)載自阿豪聊干貨的《聊一聊 log4j2 配置文件 log4j2.xml》
一、背景
最近由于項目的需要，我們把log4j 1.x的版本全部遷移成log4j 2.x的版本，那隨之而來的slf4j整合log4j的配置（使用 Slf4j 集成 Log4j2 構(gòu)建項目日志系統(tǒng)的完美解決方案）以及log4j2配置文件的詳解，就需要我們來好好聊一聊了。本文就專門來講解下log4j2.xml配置文件的各項標(biāo)簽的意義。
二、配置全解
2.1、關(guān)于配置文件的名稱以及在項目中的存放位置
log4j 2.x版本不再支持像1.x中的.properties后綴的文件配置方式，2.x版本配置文件后綴名只能為.xml，.json 或者.jsn。系統(tǒng)選擇配置文件的優(yōu)先級(從先到后)如下：
-
classpath下的名為log4j2-test.json或者log4j2-test.jsn的文件. -
classpath下的名為log4j2-test.xml的文件. -
classpath下名為log4j2.json或者log4j2.jsn的文件. -
classpath下名為log4j2.xml的文件.
我們一般默認(rèn)使用log4j2.xml進(jìn)行命名。如果本地要測試，可以把log4j2-test.xml放到classpath，而正式環(huán)境使用log4j2.xml，則在打包部署的時候不要打包log4j2-test.xml即可。
2.2、缺省默認(rèn)配置文件
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
<Appenders>
<Console name="Console" target="SYSTEM_OUT">
<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
</Console>
</Appenders>
<Loggers>
<Root level="error">
<AppenderRef ref="Console"/>
</Root>
</Loggers>
</Configuration>
2.3、配置文件節(jié)點(diǎn)解析
- 根節(jié)點(diǎn)
Configuration有兩個屬性：status和monitorinterval，有兩個子節(jié)點(diǎn)：Appenders和Loggers(表明可以定義多個Appender和Logger)：
-
status用來指定log4j本身的打印日志的級別。 -
monitorinterval用于指定log4j自動重新配置的監(jiān)測間隔時間，單位是s，最小是5s
-
Appenders節(jié)點(diǎn)，常見的有三種子節(jié)點(diǎn)：Console、RollingFile、File：
-
Console節(jié)點(diǎn)用來定義輸出到控制臺的Appender
（1）name：指定 Appender 的名字
（2）target：SYSTEM_OUT或SYSTEM_ERR，一般只設(shè)置默認(rèn)：SYSTEM_OUT
（3）PatternLayout：輸出格式，不設(shè)置默認(rèn)為%m%n -
File節(jié)點(diǎn)用來定義輸出到指定位置的文件的Appender
（1）name：指定Appender的名字
（2）fileName：指定輸出日志的目的文件帶全路徑的文件名
（3）PatternLayout：輸出格式，不設(shè)置默認(rèn)為%m%n -
RollingFile節(jié)點(diǎn)用來定義超過指定大小自動刪除舊的創(chuàng)建新的的Appender
（1）name：指定Appender的名字
（2）fileName：指定輸出日志的目的文件帶全路徑的文件名
（3）PatternLayout：輸出格式，不設(shè)置默認(rèn)為%m%n
（4）filePattern：指定新建日志文件的名稱格式
（5）Policies：指定滾動日志的策略，就是什么時候進(jìn)行新建日志文件輸出日志
（6）TimeBasedTriggeringPolicy：Policies子節(jié)點(diǎn)，基于時間的滾動策略，interval屬性用來指定多久滾動一次，默認(rèn)是1 hour。modulate=true用來調(diào)整時間：比如現(xiàn)在是早上3am，interval是4，那么第一次滾動是在4am，接著是8am，12am...而不是7am
（7）SizeBasedTriggeringPolicy：Policies子節(jié)點(diǎn)，基于指定文件大小的滾動策略，size 屬性用來定義每個日志文件的大小.
（8）DefaultRolloverStrategy：用來指定同一個文件夾下最多有幾個日志文件時開始刪除最舊的，創(chuàng)建新的(通過max屬性)。
Loggers節(jié)點(diǎn)，常見的有兩種Root和Logger：
Root 節(jié)點(diǎn)用來指定項目的根日志，如果沒有單獨(dú)指定Logger，那么就會默認(rèn)使用該Root日志輸出
??level：日志輸出級別，共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF
??AppenderRef：Root的子節(jié)點(diǎn)，用來指定該日志輸出到哪個Appender
Logger 節(jié)點(diǎn)用來單獨(dú)指定日志的形式，比如要為指定包下的class指定不同的日志級別等。
??level：日志輸出級別，共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF
??name：用來指定該Logger所適用的類或者類所在的包全路徑,繼承自Root節(jié)點(diǎn).
??AppenderRef：Logger的子節(jié)點(diǎn)，用來指定該日志輸出到哪個Appender，如果沒有指定，就會默認(rèn)繼承自Root。如果指定了，那么會在指定的這個Appender和Root的Appender中都會輸出，此時我們可以設(shè)置Logger的additivity="false"只在自定義的Appender中進(jìn)行輸出。關(guān)于日志 level
共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF：
-
All：最低等級的，用于打開所有日志記錄. -
Trace：是追蹤，就是程序推進(jìn)以下，你就可以寫個trace輸出，所以trace應(yīng)該會特別多，不過沒關(guān)系，我們可以設(shè)置最低日志級別不讓他輸出. -
Debug：指出細(xì)粒度信息事件對調(diào)試應(yīng)用程序是非常有幫助的. -
Info：消息在粗粒度級別上突出強(qiáng)調(diào)應(yīng)用程序的運(yùn)行過程. -
Warn：輸出警告及warn以下級別的日志. -
Error：輸出錯誤信息日志. -
Fatal：輸出每個嚴(yán)重的錯誤事件將會導(dǎo)致應(yīng)用程序的退出的日志. -
OFF：最高等級的，用于關(guān)閉所有日志記錄.
程序會打印高于或等于所設(shè)置級別的日志，設(shè)置的日志等級越高，打印出來的日志就越少。
2.4、比較完整的 log4j2.xml 配置模板
<?xml version="1.0" encoding="UTF-8"?>
<!--日志級別以及優(yōu)先級排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status，這個用于設(shè)置log4j2自身內(nèi)部的信息輸出，可以不設(shè)置，當(dāng)設(shè)置成trace時，你會看到log4j2內(nèi)部各種詳細(xì)輸出-->
<!--monitorInterval：Log4j能夠自動檢測修改配置 文件和重新配置本身，設(shè)置間隔秒數(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每次運(yùn)行程序會自動清空，由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大小的日志會自動存入按年份-月份建立的文件夾下面并進(jìn)行壓縮，作為存檔-->
<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屬性如不設(shè)置，則默認(rèn)為最多同一文件夾下7個文件，這里設(shè)置了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>
