一、pom配置
普通項目
<!-- log4j2 --> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-api</artifactId> <version>${log4j2.version}</version> </dependency> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-core</artifactId> <version>${log4j2.version}</version> </dependency> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-web</artifactId> <version>${log4j2.version}</version> </dependency>
springboot項目
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-log4j2</artifactId> </dependency>
注意其他項目spring-boot-starter、spring-boot-starter-web等要排除依賴
<exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </exclusion>
對於其他含有log4j的依賴也要清除，否則可能不生效
方式：https://www.cnblogs.com/bjlhx/p/7518082.html中第四項
二、log4j2使用
2.1、在配置文件中配置使用的log4j2文件【默認文件log4j2-spring.xml可以不用配置】
logging.config=classpath:log4j2-spring-dev.xml
2.2、log4j2具體配置【示例配置】
<?xml version="1.0" encoding="UTF-8"?> <!--設置log4j2的自身log級別為warn--> <!--日志級別以及優先級排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL --> <!--Configuration后面的status，這個用於設置log4j2自身內部的信息輸出，可以不設置， 當設置成trace時，你會看到log4j2內部各種詳細輸出--> <!--monitorInterval：Log4j能夠自動檢測修改配置 文件和重新配置本身，設置間隔秒數--> <configuration status="warn" monitorInterval="30"> <!--全局參數--> <Properties> <!--<Property name="logPath">/export/Logs/bt-middle-data-main</Property>--> <Property name="logPath">/Users/lihongxu6/log/bt-middle-data-main</Property> </Properties> <!--先定義所有的appender--> <appenders> <!--這個輸出控制台的配置--> <console name="Console" target="SYSTEM_OUT"> <!--控制台只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch） --> <!--<ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>--> <!--輸出日志的格式--> <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss:SSS}-%t] [%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="${logPath}/info.log" filePattern="${logPath}/info_%d{yyyy-MM-dd}.log"> <!--<Filters>--> <!--<!–控制台只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）–>--> <!--<ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>--> <!--<!–<ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/>–>--> <!--</Filters>--> <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss:SSS}-%t] [%p] - %l - %m%n"/> <Policies> <!--按照filePattern 時間單位 interval 間隔生成文件--> <TimeBasedTriggeringPolicy modulate="true" interval="1"/> <!--定了當日志文件達到了指定的size時，觸發rollover操作。size參數可以用KB、MB、GB等做后綴來指定具體的字節數--> <!--<SizeBasedTriggeringPolicy size="1G"/>--> </Policies> </RollingFile> </appenders> <!--然后定義logger，只有定義了logger並引入的appender，appender才會生效--> <loggers> <!--過濾掉spring和hibernate的一些無用的debug信息--> <logger name="org.springframework" level="INFO"> </logger> <logger name="org.elasticsearch" level="INFO"> </logger> <logger name="com.jd.jsf.gd" level="warn"> </logger> <logger name="org.mybatis" level="INFO"> </logger> <!-- 將業務dao接口填寫進去,並用控制台輸出即可 --> <logger name="com.jd.bt.middle.data.repository" level="debug" additivity="false"> <appender-ref ref="Console"/> <appender-ref ref="RollingFileInfo"/> </logger> <root level="info"> <appender-ref ref="Console"/> <appender-ref ref="RollingFileInfo"/> </root> </loggers> </configuration>
三、詳細說明
3.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即可。
3.2、缺省配置
<?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>
3.3、配置文件節點解析
(1).根節點Configuration
有兩個屬性:status和monitorinterval,有兩個子節點:Appenders和Loggers(表明可以定義多個Appender和Logger).
status：用來指定log4j本身的打印日志的級別.
monitorinterval：用於指定log4j自動重新配置的監測間隔時間，單位是s,最小是5s.【調試時候很實用】
(2).Appenders節點
1、子節點
常見的有三種子節點: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.
<!--按照filePattern 時間單位 interval 間隔生成文件-->
interval：（integer）該屬性是相對 RollingFile.filePattern 中的%d{yyyy-MM-dd}值,例：
filePattern=”xxx%d{yyyy-MM-dd}xx” interval=”2” 表示將2天一個日志文件；
filePattern=”xxx%d{yyyy-MM-dd-HH}xx” interval=”1”表示一個小時一個日志文件
- SizeBasedTriggeringPolicy:Policies子節點，基於指定文件大小的滾動策略，size屬性用來定義每個日志文件的大小.
<!--定了當日志文件達到了指定的size時，觸發rollover操作。size參數可以用KB、MB、GB等做后綴來指定具體的字節數-->
- DefaultRolloverStrategy:用來指定同一個文件夾下最多有幾個日志文件時開始刪除最舊的，創建新的(通過max屬性)。
2、Filters.ThresholdFilter【過濾】
主要用於不同類型日志放置在不同文件中
level 輸出級別，例：level=”info”,日志級別為info或者以上(匹配的界別)
onMatch DENY/ACCEPT 禁止或者接受（是否接受匹配）
onMismatch DENY/NEUTRAL （是否接受其他高於level的級別）
例如：只打印info日志
<Filters> <!--控制台只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）--> <ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/> <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/> </Filters>
(3).Loggers節點，常見的有兩種:Root和Logger.
Root：始祖日志，節點用來指定項目的根日志，如果沒有單獨指定Logger，那么就會默認使用該Root日志輸出
level:[屬性]日志輸出級別，共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
AppenderRef：Root的子節點，ref用來指定該日志輸出到哪個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中進行輸出。
additivity：是否冒泡，既在本層輸出日志后是否需要在父對象上輸出該日志，默認為 true
(4).關於日志level.
共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
All:最低等級的，用於打開所有日志記錄.
Trace:是追蹤，就是程序推進以下，你就可以寫個trace輸出，所以trace應該會特別多，不過沒關系，我們可以設置最低日志級別不讓他輸出.
Debug:指出細粒度信息事件對調試應用程序是非常有幫助的.
Info:消息在粗粒度級別上突出強調應用程序的運行過程.
Warn:輸出警告及warn以下級別的日志.
Error:輸出錯誤信息日志.
Fatal:輸出每個嚴重的錯誤事件將會導致應用程序的退出的日志.
OFF:最高等級的，用於關閉所有日志記錄.
程序會打印高於或等於所設置級別的日志，設置的日志等級越高，打印出來的日志就越少。
3.4、log4j2 logger 加載規則
logger name 相同時，以 level 級別高的為准
logger name = “org” 會被 name=”org.xxx” 繼承
logger 中的 additivity=”true” 表示子日志所獲得的日志也會在父日志中出現，即使 父日志的 level 遠高於子日志的 level
當子日志 level 大於 父日志時，父日志只能接收到子日志過濾后的日志
3.5、類圖
編譯理解的一個示例
<?xml version="1.0" encoding="UTF-8"?> <!-- configure.status 為設置日志輸出級別，級別如下：OFF 、FATAL 、ERROR、WARN、INFO、DEBUG、TRACE 、ALL --> <!-- configure.monitorInterval 監控間隔 指log4j2每隔600秒（10分鍾），自動監控該配置文件是否有變化，如果變化，則自動根據文件內容重新配置 --> <configuration status="off" monitorInterval="600"> <properties> <property name="LOG_HOME">E:/webbase/logs</property> <property name="LOG_BACK_HOME">${LOG_HOME}/backup</property> <property name="ERROR_FILE_NAME">error</property> <property name="WARN_FILE_NAME">warn</property> <property name="INFO_FILE_NAME">info</property> <property name="DEBUG_FILE_NAME">debug</property> </properties> <Appenders> <Console name="Console" target="SYSTEM_OUT"> <PatternLayout pattern="%d{HH:mm:ss.SSS} {%t} %-5level %logger{36} - %msg%n"/> </Console> <!-- 配置日志輸出文件名字 追加讀寫 --> <!-- Error console log --> <RollingFile name="ErrLog" fileName="${LOG_HOME}/${ERROR_FILE_NAME}.log" filePattern="${LOG_BACK_HOME}/$${date:yyyy-MM}/${ERROR_FILE_NAME}.%d{yyyy-MM-dd}.log" append="true"> <!-- 輸出格式 --> <PatternLayout pattern="%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread][%file:%line] - %msg%n"/> <!-- 設置策略 --> <Policies> <!-- 基於時間的觸發策略。該策略主要是完成周期性的log文件封存工作。有兩個參數： interval，integer型，指定兩次封存動作之間的時間間隔。單位:以日志的命名精度來確定單位， 比如yyyy-MM-dd-HH 單位為小時，yyyy-MM-dd-HH-mm 單位為分鍾 modulate，boolean型，說明是否對封存時間進行調制。若modulate=true， 則封存時間將以0點為邊界進行偏移計算。比如，modulate=true，interval=4hours， 那么假設上次封存日志的時間為03:00，則下次封存日志的時間為04:00， 之后的封存時間依次為08:00，12:00，16:00 --> <TimeBasedTriggeringPolicy interval="1" modulate="true" /> </Policies> <Filters> <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/> </Filters> </RollingFile> <!-- Warn console log --> <RollingFile name="WarnLog" fileName="${LOG_HOME}/${WARN_FILE_NAME}.log" filePattern="${LOG_BACK_HOME}/$${date:yyyy-MM}/${WARN_FILE_NAME}.%d{yyyy-MM-dd}.log" append="true"> <!-- 輸出格式 --> <PatternLayout pattern="%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread][%file:%line] - %msg%n"/> <!-- 設置策略 --> <Policies> <TimeBasedTriggeringPolicy interval="1" modulate="true" /> </Policies> <Filters> <ThresholdFilter level="error" onMatch="DENY" onMismatch="NEUTRAL"/> <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/> </Filters> </RollingFile> <!-- Info console log --> <RollingFile name="InfoLog" fileName="${LOG_HOME}/${INFO_FILE_NAME}.log" filePattern="${LOG_BACK_HOME}/$${date:yyyy-MM}/${INFO_FILE_NAME}.%d{yyyy-MM-dd}.log" append="true"> <!-- 輸出格式 --> <PatternLayout pattern="%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread][%file:%line] - %msg%n"/> <!-- 設置策略 --> <Policies> <TimeBasedTriggeringPolicy interval="1" modulate="true" /> </Policies> <Filters> <ThresholdFilter level="warn" onMatch="DENY" onMismatch="NEUTRAL"/> <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/> </Filters> </RollingFile> <!-- Debug console log --> <RollingFile name="DebugLog" fileName="${LOG_HOME}/${DEBUG_FILE_NAME}.log" filePattern="${LOG_BACK_HOME}/$${date:yyyy-MM}/${DEBUG_FILE_NAME}.%d{yyyy-MM-dd}.log" append="true"> <!-- 輸出格式 --> <PatternLayout pattern="%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread][%file:%line] - %msg%n"/> <!-- 設置策略 --> <Policies> <TimeBasedTriggeringPolicy interval="1" modulate="true" /> </Policies> <Filters> <ThresholdFilter level="info" onMatch="DENY" onMismatch="NEUTRAL"/> <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/> </Filters> </RollingFile> </Appenders> <Loggers> <Logger name="org.webbase" level="debug" additivity="true"> <AppenderRef ref="DebugLog" /> <AppenderRef ref="InfoLog" /> </Logger> <Root level="warn"> <AppenderRef ref="WarnLog" /> <AppenderRef ref="ErrLog" /> <AppenderRef ref="Console"/> </Root> </Loggers> </configuration>
github：https://github.com/bjlhx15/spring-cloud-base/tree/master/service2-log
3.6、日志Layout布局方式
SimpleLayout：以簡單的形式顯示
HTMLLayout：以HTML表格顯示
PatternLayout：自定義形式顯示
在Log4J2中基本采用PatternLayout自定義日志布局。含有CSV/JSON/HTML/RFC-5424/pattern/XML
自定義格式PatternLayout：
%t：線程名稱
%p：日志級別
%c：日志消息所在類名
%m：消息內容
%M：輸出執行方法
%d：發生時間，%d{yyyy-MM-dd HH:mm:ss,SSS}，輸出類似：2011-10-18 22:10:28,921
%x: 輸出和當前線程相關聯的NDC(嵌套診斷環境),尤其用到像java servlets這樣的多客戶多線程的應用中。
%L：代碼中的行數
%n：換行
個人常用：<PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss:SSS}-%t] [%p] - %l - %m%n"/>
關於幾個參數特殊說明
%c: Logger的名稱。它可以接受一個整型的參數。規則如下：
| Conversion Pattern | Logger Name | Result |
|---|---|---|
| %c{1} | org.apache.commons.Foo | Foo |
| %c{2} | org.apache.commons.Foo | commons.Foo |
| %c{1.} | org.apache.commons.Foo | o.a.c.Foo |
| %c{1.1.~.~} | org.apache.commons.test.Foo | o.a.~.~.Foo |
| %c{.} | org.apache.commons.test.Foo | ....Foo |
%d：日志事件的時間。參考示例如下：
| Pattern | Example |
|---|---|
| %d{DEFAULT} | 2012-11-02 14:34:02,781 |
| %d{ISO8601} | 2012-11-02T14:34:02,781 |
| %d{ISO8601_BASIC} | 20121102T143402,781 |
| %d{ABSOLUTE} | 14:34:02,781 |
| %d{DATE} | 02 Nov 2012 14:34:02,781 |
| %d{COMPACT} | 20121102143402781 |
| %d{HH:mm:ss,SSS} | 14:34:02,781 |
| %d{dd MMM yyyy HH:mm:ss,SSS} | 02 Nov 2012 14:34:02,781 |
| %d{HH:mm:ss}{GMT+0} | 18:34:02 |
| %d{UNIX} | 1351866842 |
| %d{UNIX_MILLIS} | 1351866842781 |
四、打印sql日志
將dao或mapper等包注冊logger
<!-- 將業務dao接口填寫進去,並用控制台輸出即可 --> <logger name="com.github.bjlhx15.repository" level="trace" additivity="false"> <appender-ref ref="Console"/> <appender-ref ref="RollingFileInfo"/> </logger>