摘自:使用@Slf4j和logback-spring.xml搭建日志框架
前言
對于一名Java后端開發工程師,查詢日志是經常做的事情。因此,如果能構建一個合適的日志[框架],就能讓我們在查看日志排查錯誤的時候,能夠很快地找出問題所在。
配置logback.xml,可以讓idea的控制臺輸出我們想要的信息,比如時間、線程、端口、pid等等,還能配置不同信息不同顏色輸出在控制臺上,方便我們查看日志。
1、在yml配置文件中輸入文件輸出路徑
此配置是logback.xml讀取yml配置文件中的路徑,使得文件能夠輸出到我們想要的地方。在配置文件中配置是因為如果你使用Apollo這種可以熱發布的配置中心,可以動態修改。如果你輸出的地址不變,可以直接寫在logback.xml中。
log:
path: ./logs/test-module/test-module-${server.port}
./表示當前模塊的路徑
${server.port}表示yml配置的模塊端口
2、引入依賴
我一般使用的是@SLf4j作為日志輸出。
使用logback.xml,需要引入下面兩個依賴。如果你使用的是springboot,那么springboot的starter會自帶這兩個依賴,不用再重復導入。
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.11</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>1.2.11</version>
</dependency>
3、在模塊的resource目錄下創建logback.xml
此份logback.xml,配置了控制臺的輸出日志,寫入文件的日志以及寫入錯誤日志的配置。
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
<!-- 彩色日志 -->
<!-- 彩色日志依賴的渲染類 -->
<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
<conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>
<!-- 彩色日志格式 {blue}表示前面的輸出日志的顏色是藍色 -->
<property name="CONSOLE_LOG_PATTERN"
value=" ${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){blue} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
<!-- 獲取yml中的log地址 -->
<springProperty scope="context" name="logPath" source="log.path"/>
<!-- 控制臺彩色日志輸出 -->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>${CONSOLE_LOG_PATTERN}</pattern>
<charset>utf8</charset>
</encoder>
</appender>
<!--由文件大小與時間控制滾動-->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!--日志文件輸出的文件名-->
<FileNamePattern>${logPath}/%d{yyyy-MM-dd}/logs-%d{yyyy-MM-dd}-%i.log</FileNamePattern>
<!--活動文件大小-->
<maxFileSize>20MB</maxFileSize>
<!--回滾的總文件大小 eg:totalSizeCap/MaxFileSize 即只保存2個文件-->
<totalSizeCap>2GB</totalSizeCap>
<cleanHistoryOnStart>true</cleanHistoryOnStart>
<!--最大的日志保存數量-->
<!--<param name="MaxBackupIndex" value="10"/>-->
<!--日志文件保留天數-->
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化輸出:%d表示日期。%-5level:日志級別,從左顯示5個字符寬度。%thread表示線程名,%c:表示日志所在類。%L:表示日志所在行數。 %msg:日志消息,%n是換行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%level] [%thread] [%c] %L - %msg%n</pattern>
<charset>utf8</charset>
</encoder>
</appender>
<!--異常日志-->
<appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<!--由文件大小與時間控制滾動-->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<FileNamePattern>${logPath}/%d{yyyy-MM-dd}/errors-%d{yyyy-MM-dd}-%i.log</FileNamePattern>
<maxFileSize>5MB</maxFileSize>
<!--回滾的總文件大小 eg:totalSizeCap/MaxFileSize 即只保存2個文件-->
<totalSizeCap>1GB</totalSizeCap>
<cleanHistoryOnStart>true</cleanHistoryOnStart>
<!--最大的日志保存數量-->
<!--<param name="MaxBackupIndex" value="10"/>-->
<!--日志文件保留天數-->
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%level] [%thread] [%c] %L - %msg%n</pattern>
<charset>utf8</charset>
</encoder>
</appender>
<!--
logger 有兩種級別,一種是 root,一種是普通的 logger,logger 是用來設置某一個包或者具體的某一個類的日志打印機級別,以及制定的 appender。
logger 有三個屬性
- name:用來指定此 logger 約束的某一個包或者具體的某一個類
- level:用來設置打印機別,
- addtivity:是否向上級 logger 傳遞打印信息。默認是 true
每個 logger 都有對應的父級關系,它通過包名來決定父級關系,root 是最高級的父元素。
-->
<logger name="com.czf" level="INFO"/>
<!-- 日志輸出級別 -->
<root level="INFO">
<appender-ref ref="CONSOLE"/>
<appender-ref ref="FILE"/>
<appender-ref ref="ERROR"/>
</root>
</configuration>
注意:
1、文件名需要為logback-spring.xml,如果是logback.xml的話,springboot會因為識別問題,會自動創建一個logPath_IS_UNDEFINED的文件夾。
2、如果想在啟動類中加上日志,注意需要加在run方法的后面,否則雖然會在控制臺輸出,但不會寫入到日志文件中。
public class PersonalCreditApplication {
public static void main(String[] args) {
SpringApplication.run(PersonalCreditApplication.class, args);
log.info("項目啟動");
}
至此,一個項目或模塊的日志框架就搭建成功。