在同步日志模式下, Logback的性能是最糟糕的,log4j2的性能無論在同步日志模式還是異步日志模式下都是最佳的。本章主要介紹Spring Boot如何集成并配置使用Log4j2
1.準備工作
引入Log4j2依賴包,其它依賴和Logback一樣,使用SLF4J統(tǒng)一輸出
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<!--去掉springboot自帶的logback日志框架,因為項目要用log4j2框架-->
<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>
</dependency>
然后需要在resource下面添加log4j2.xml配置文件,當然了如果你不添加,springboo會提示你沒有對應(yīng)文件,并使用默認的配置文件,這個時候級別可以在application.properties中配置
logging.level.root=error
2. 配置log4j2.xml
和logback配置類似,主要是含有l(wèi)oggers、appenders,其中l(wèi)oggers由logger,root組成。appenders由console(控制臺),F(xiàn)ile、RollingFile(輸出文件)組成,作用和配置和logback差不多
2.1 appenders
(1)Console
用來定義輸出到控制臺的Appender,主要設(shè)置輸出格式和level級別
<console name="Console" target="SYSTEM_OUT">
<!--輸出日志的格式-->
<PatternLayout pattern="${LOG_PATTERN}"/>
<!--控制臺只輸出level及其以上級別的信息(onMatch),其他的直接拒絕(onMismatch)-->
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
</console>
ThresholdFilter: 定義打印級別,onMismatch值設(shè)置是否拒絕其它
(2)File
用來定義輸出到指定位置的文件的Appender
<!--文件會打印出所有信息,這個log每次運行程序會自動清空,由append屬性決定,適合臨時測試用-->
<File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
<PatternLayout pattern="${LOG_PATTERN}"/>
</File>
(3)RollingFile
用來定義超過指定條件自動刪除舊的,創(chuàng)建新的Appender
<!-- 這個會打印出所有的warn及以下級別的信息,每次大小超過size,則這size大小的日志會自動存入按年份-月份建立的文件夾下面并進行壓縮,作為存檔-->
<RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log" filePattern="${FILE_PATH}/${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屬性如不設(shè)置,則默認為最多同一文件夾下7個文件開始覆蓋-->
<DefaultRolloverStrategy max="15"/>
</RollingFile>
參數(shù)說明:
- PatternLayout:輸出格式,不設(shè)置默認為:%m%n.
- filePattern : 指定當發(fā)生Rolling時,文件的轉(zhuǎn)移和重命名規(guī)則,定義的日志文件后綴精確的時間決定了定期生成日志文件. 精確到dd, 即%d{yyyy-MM-dd}, 則會每天生成一個文件, 精確到HH(%d{yyyy-MM-dd-HH}), 則會每時生成一個文件。
- Policies:指定滾動日志的策略,就是什么時候進行新建日志文件輸出日志.
TimeBasedTriggeringPolicy:Policies子節(jié)點,基于時間的滾動策略,interval屬性用來指定多久滾動一次,默認是1 hour。modulate=true用來調(diào)整時間:比如現(xiàn)在是早上3am,interval是4,那么第一次滾動是在4am,接著是8am,12am...而不是7am.
SizeBasedTriggeringPolicy:Policies子節(jié)點,基于指定文件大小的滾動策略,size屬性用來定義每個日志文件的大小. - DefaultRolloverStrategy:用來指定同一個文件夾下最多有幾個日志文件時開始刪除最舊的,創(chuàng)建新的(通過max屬性)。
注意:這個只是控制某時間段內(nèi)(根據(jù)配置不同)文件的數(shù)目,它并不會關(guān)心你的目錄下一共有多少個日志文件了。
2.2 Loggers
Root節(jié)點用來指定項目的根日志,如果沒有單獨指定Logger,那么就會默認使用該Root日志輸出
<!--Logger節(jié)點用來單獨指定日志的形式,比如要為指定包下的class指定不同的日志級別等。-->
<!--然后定義loggers,只有定義了logger并引入的appender,appender才會生效-->
<loggers>
<!--過濾掉spring和mybatis的一些無用的DEBUG信息-->
<logger name="org.mybatis" level="info" additivity="false">
<AppenderRef ref="Console"/>
</logger>
<!--監(jiān)控系統(tǒng)信息-->
<!--若是additivity設(shè)為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="RollingFileInfo"/>
<appender-ref ref="RollingFileWarn"/>
<appender-ref ref="RollingFileError"/>
</root>
</loggers>
參數(shù)說明:
- name:用來指定該Logger所適用的類或者類所在的包全路徑,繼承自Root節(jié)點.
- AppenderRef:Logger的子節(jié)點,用來指定該日志輸出到哪個Appender,如果沒有指定,就會默認繼承自Root.如果指定了,那么會在指定的這個Appender和Root的Appender中都會輸出,此時我們可以設(shè)置Logger的additivity="false"只在自定義的Appender中進行輸出。
2.3 Properties
變量配置,類似常量定義
<!--變量配置-->
<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="FILE_PATH" value="更換為你的日志路徑" />
<property name="FILE_NAME" value="更換為你的項目名" />
</Properties>
3.SpringBoot 配置 log4j2
默認情況下springboot是不將日志輸出到日志文件中,這里對日志框架的支持有兩種配置方式(和logback一樣):
(1)application.properties 或 application.yml (系統(tǒng)層面)
(2)logback-spring.xml (自定義文件方式)
3.1 application.yml
logging:
config: xxxx.xml
level:
cn.jay.repository: trace
默認名log4j2-spring.xml,可以省下在application.yml中配置,如果自定義了文件名,需要在application.yml中配置
3.2 log4j2-spring.xml
此種方式可以處理比較復雜的情況,比如區(qū)分 info 和 error 日志、每天產(chǎn)生一個日志文件。
<!-- OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<configuration status="WARN">
<Properties>
<!-- 日志顯示模板格式 -->
<Property name="LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %F(%L) - %m%n"/>
<!-- 控制臺日志格式 -->
<Property name="LOG_PATTERN_CONSOLE" value="%style{%d{HH:mm:ss.SSS}}{blue} %highlight{%-5level} %style{%logger{36}}{bright,Magenta} - %m%n"/>
<!-- 保存日志文件目錄 -->
<Property name="LOG_PATH" value="/HXG/log/erp-settlement"/>
<!-- 應(yīng)用名稱 -->
<property name="APP_NAME" value="cw"/>
<!-- 日志文件的最大容量 -->
<Property name="FILE_SIZE" value="100MB"/>
<!-- 備份的文件夾 -->
<Property name="BACKUP_FOLDER" value="$${date:yyyy-MM}"/>
<!-- 備份文件的后綴 -->
<Property name="FILE_SUFFIX" value="%d{yyyy-MM-dd}-%i.log"/>
</Properties>
<appenders>
<!-- 控制臺的輸出配置 -->
<console name="CONSOLE" target="SYSTEM_OUT">
<!-- 輸出日志的格式 -->
<PatternLayout charset="UTF-8" pattern="${LOG_PATTERN_CONSOLE}"/>
</console>
<!--
該RollingFile存儲INFO級別的日志,
默認存儲到fileName文件中
超過SizeBasedTriggeringPolicy的設(shè)定值,則存儲到filePattern文件中
-->
<RollingFile name="ROLLING_FILE_INFO" fileName="${LOG_PATH}/${APP_NAME}-info.log"
filePattern="${LOG_PATH}/${APP_NAME}-info-${FILE_SUFFIX}">
<!-- 控制臺只輸出level及以上級別的信息(onMatch),其他的直接拒絕(onMismatch)-->
<ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
<!-- 寫入日志文件的模板 -->
<PatternLayout pattern="${LOG_PATTERN}"/>
<Policies>
<!-- interval屬性用來指定多久滾動一次,默認是1 hour -->
<TimeBasedTriggeringPolicy/>
<SizeBasedTriggeringPolicy size="${FILE_SIZE}"/>
</Policies>
<!-- DefaultRolloverStrategy屬性如不設(shè)置,則默認為最多同一文件夾下7個文件,超過該數(shù)量,會滾動刪除前面的記錄 -->
<DefaultRolloverStrategy max="20"/>
</RollingFile>
<RollingFile name="ROLLING_FILE_ERROR" fileName="${LOG_PATH}/${APP_NAME}-error.log"
filePattern="${LOG_PATH}/${APP_NAME}-error-${FILE_SUFFIX}">
<ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="${LOG_PATTERN}"/>
<Policies>
<TimeBasedTriggeringPolicy/>
<SizeBasedTriggeringPolicy size="${FILE_SIZE}"/>
</Policies>
</RollingFile>
</appenders>
<loggers>
<!--過濾掉spring和mybatis的一些無用的DEBUG信息-->
<!--
<logger name="org.springframework" level="INFO"/>
<logger name="druid.sql" level="INFO"/>
<logger name="org.apache" level="INFO"/>
<logger name="com.alibaba" level="INFO"/>
-->
<logger name="com.hao24.modules.erp.supplier.mapper" level="DEBUG" additivity="false">
<appender-ref ref="CONSOLE" />
<appender-ref ref="ROLLING_FILE_INFO"/>
<appender-ref ref="ROLLING_FILE_ERROR"/>
</logger>
<root level="INFO">
<appender-ref ref="CONSOLE"/>
<appender-ref ref="ROLLING_FILE_INFO"/>
<appender-ref ref="ROLLING_FILE_ERROR"/>
</root>
</loggers>
4.定期生成和刪除過期日志文件的配置
通過在DefaultRolloverStrategy 標簽下添加Delete標簽實現(xiàn),保留7天的日志
<RollingRandomAccessFile name="MyFile"
fileName="${LOG_HOME}/${FILE_NAME}.log"
filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd-HH}-%i.log">
<PatternLayout
pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %class{36}:%M(%L)] - %msg%xEx%n"/>
<Policies>
<TimeBasedTriggeringPolicy interval="1"/> <!--每1小時/分/... 生成一個文件, 時間依據(jù)filePattern的配置-->
<SizeBasedTriggeringPolicy size="5 MB"/>
</Policies>
<DefaultRolloverStrategy max="30">
<Delete basePath="${LOG_HOME}/$${date:yyyy-MM}/" maxDepth="2">
<IfFileName glob="*.log" />
<!--!Note: 這里的age必須和filePattern協(xié)調(diào), 后者是精確到HH, 這里就要寫成xH, xd就不起作用
另外, 數(shù)字最好>2, 否則可能造成刪除的時候, 最近的文件還處于被占用狀態(tài),導致刪除不成功!-->
<!--7天-->
<IfLastModified age="168H" />
</Delete>
</DefaultRolloverStrategy>
</RollingRandomAccessFile>
IfLastModified .age要和filePattern精確的時間一致, 否則貌似無效.