通常情況下罪治,日志是由一個抽象層 + 實現(xiàn)層的組合來搭建[i]。
spring-boot-starter 其中包含了 spring-boot-starter-logging 堕伪,該依賴內(nèi)容就是 Spring Boot 默認(rèn)的日志框架 logback垢啼,所以實際開發(fā)中我們不需要直接添加該依賴[ii]。
因為我們需要對日志進(jìn)行更多控制蛋逾,所以需要增加 logback配置凝垛。
在項目的 resources 文件夾內(nèi)新建一個名為 logback-spring.xml 文件懊悯。logback-spring.xml 只有在Spring應(yīng)用程序運行的時候才生效蜓谋,即帶有@SpringBootApplication注解的類啟動的時候才會生效[iii]。
logback-spring.xml配置主要包含 <configuration> 節(jié)點炭分,在它之下有四個常用的子節(jié)點:root桃焕、contextName、property捧毛、appender观堂。
我們一般先配置 property節(jié)點,定義好變量呀忧;接著定義控制臺和文件的 appender师痕,最后使用 root 來引用之前配置好的 appender。contextName 節(jié)點很少使用而账。
完整配置文件如下:
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
<!--設(shè)置存儲路徑變量-->
<property name="LOG_HOME" value="./log"/>
<!--控制臺輸出appender-->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<!--設(shè)置輸出格式-->
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化輸出:%d表示日期胰坟,%thread表示線程名,%-5level:級別從左顯示5個字符寬度%msg:日志消息泞辐,%n是換行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<!--設(shè)置編碼-->
<charset>UTF-8</charset>
</encoder>
</appender>
<!--文件輸出,時間窗口滾動-->
<appender name="timeFileOutput" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--日志名,指定最新的文件名笔横,其他文件名使用FileNamePattern -->
<File>${LOG_HOME}/xx/info.log</File>
<!--文件滾動模式-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件輸出的文件名,可設(shè)置文件類型為gz,開啟文件壓縮-->
<FileNamePattern>${LOG_HOME}/xx/info.%d{yyyy-MM-dd}.%i.log.gz</FileNamePattern>
<!--日志文件保留天數(shù)-->
<MaxHistory>3000</MaxHistory>
<!--按大小分割同一天的-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!--輸出格式-->
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化輸出:%d表示日期,%thread表示線程名咐吼,%-5level:級別從左顯示5個字符寬度%msg:日志消息吹缔,%n是換行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<!--設(shè)置編碼-->
<charset>UTF-8</charset>
</encoder>
</appender>
<!--指定基礎(chǔ)的日志輸出級別-->
<root level="INFO">
<appender-ref ref="console"/>
<appender-ref ref="timeFileOutput"/>
</root>
</configuration>
比較重要的地方是以下幾點:
- 設(shè)置日志文件所在的根路徑LOG_HOME;
- 設(shè)置日志輸出格式pattern汽烦,其中 %logger{50} 中的 50 表示可以顯示的最大字符數(shù)涛菠;
日志配置項可以根據(jù)業(yè)務(wù)工程要求進(jìn)行修改莉御,具體說明如下:
當(dāng)日志文件超過單個文件最大容量時撇吞,會進(jìn)行分割,形如: