在開發(fā)項目過程中，往往需要使用日志來記錄生成的異常信息，這樣更方便維護。而當前l(fā)ogback是比較流行的日志框架之一，下面，就和大家講講在Springboot項目里如何配置logback日志系統(tǒng)。
logback依賴jar包
SpringBoot項目配置logback理論上需要添加logback-classic依賴jar包：
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.3</version>
</dependency>但是因為SpringBoot項目默認就是使用的就是logback日志系統(tǒng)，創(chuàng)建SpringBoot項目時引入的spring-boot-starter或者spring-boot-starter-web依賴jar包中已經(jīng)包含了spring-boot-starter-logging的依賴，里面同時包含多種日志系統(tǒng)依賴，如下圖所示：
包括logback和log4j，所以，無需額外添加依賴，直接配置logback.xml就可以了。
此外，如果需要切換為log4j2，那么需要在spring-boot-starter-web依賴中排除springboot自帶的commons‐logging，然后在引入log4j2的依賴jar包，如下所示：
<!--排除 commons‐logging-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>commons‐logging</groupId>
<artifactId>commons‐logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<!--引入log4j2 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>logback的默認配置
前面說到SpringBoot項目默認使用logback，那么對于logback的配置情況，SpringBoot又是如何定義的呢？
首先，SpringBoot會從resource包下查找logback-test.xml或logback.xml ，如果這兩個都不存在，則會調(diào)用BasicConfigurator，創(chuàng)建一個最小化的基本配置。
最小化配置由一個關聯(lián)到根logger的ConsoleAppender組成，默認輸出模式為%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n，root logger級別為DEBUG，所以并不會生成日志文件，只會輸出到控制臺。
創(chuàng)建logback.xml配置文件
通過自定義logback.xml配置文件來控制日志輸出情況，通常我們會配置三個日志組件：
- 控制臺輸出
- 輸出info級別日志文件
- 輸出error級別日志文件
以下為logback.xml完整配置
<!-- Logback configuration. See http://logback.qos.ch/manual/index.html -->
<configuration scan="true" scanPeriod="2 seconds">
<!--定義日志文件的存儲地址-->
<property name="LOG_PATH" value="./logs" />
<!-- 控制臺輸出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化輸出：%d表示日期，%-5level：級別從左顯示5個字符寬度，%t表示線程名，%msg：日志消息，%n是換行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level ${PID:-} --- [%t] %logger{50} - %msg%n</pattern>
</encoder>
</appender>
<!-- info級別日志文件輸出 -->
<appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 日志文件輸出的文件名 -->
<File>${LOG_PATH}/info.log</File>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!-- 每日生成日志文件或日志文件大小超出限制后輸出的文件名模板 -->
<fileNamePattern>${LOG_PATH}/info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<!-- 日志文件保留天數(shù) -->
<maxHistory>30</maxHistory>
<!-- 日志文件最大大小：100MB -->
<maxFileSize>100MB</maxFileSize>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level ${PID:-} --- [%t] %logger{50} - %msg%n</pattern>
</encoder>
</appender>
<!-- error級別日志文件輸出 -->
<appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 日志輸出級別，優(yōu)先級 > '<root level>' -->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
<File>${LOG_PATH}/error.log</File>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${LOG_PATH}/error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<maxHistory>30</maxHistory>
<maxFileSize>100MB</maxFileSize>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level ${PID:-} --- [%t] %logger{50} - %msg%n</pattern>
</encoder>
</appender>
<!-- 默認日志輸出級別 -->
<root level="INFO">
<appender-ref ref="STDOUT" />
<appender-ref ref="INFO_FILE" />
<appender-ref ref="ERROR_FILE" />
</root>
</configuration>logback配置說明
根節(jié)點configuration
<configuration scan="true" scanPeriod="2 seconds" debug="false">
</configuration>configuration包含以下三個屬性：
- scan：配置文件發(fā)生更改時，進行重載，默認值為true
- scanPeriod：監(jiān)測配置文件是否有修改的時間間隔，默認值為6000，默認單位為毫秒
- debug：打印logback內(nèi)部日志信息，實時查看logback運行狀態(tài)，默認值為false
子節(jié)點property：
<property name="LOG_PATH" value="./logs" />用來定義變量值，包含以下兩個屬性
- name：變量名稱
- value：變量定義的值
通過property定義的值會被插入到logger上下文中，可以使${}來使用變量，這里定義了log的保存位置根目錄。
子節(jié)點appender：
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
</appender>是負責寫日志的組件，通過自定義日志組件控制日志輸出的情況，包含以下兩個屬性：
- name：組件名稱
- class：組件class指定的類名
不同的class，對應不同的功能：
如ch.qos.logback.core.ConsoleAppender會把日志輸出到控制臺
ch.qos.logback.core.rolling.RollingFileAppender把日志內(nèi)容輸出到指定文件
File節(jié)點：日志文件輸出的文件名
<File>${LOG_PATH}/info.log</File>filter節(jié)點：過濾器，用來指定日志組件的日志輸出級別，優(yōu)先級高于root節(jié)點的level。
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>rollingPolicy節(jié)點：
滾動日志文件配置，涉及日志文件的移動和重命名，只有一個class屬性，用來指定滾動策略，這里使用的是ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy
包含以下三個屬性：
- fileNamePattern：發(fā)生滾動時的日志命名方式
- maxHistory：日志文件的最大保留時間，超過設定時間后會自動刪除
- maxFileSize：每份日志文件的最大限制，超出限制后會重新生成，并將舊的日志文件按照fileNamePattern設定的日志命名方式進行命名
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${LOG_PATH}/error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<maxHistory>30</maxHistory>
<maxFileSize>100MB</maxFileSize>
</rollingPolicy>子節(jié)點encoder
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level ${PID:-} --- [%t] %logger{50} - %msg%n</pattern>
</encoder>對記錄事件進行格式化，負責兩件事，一是把日志信息轉(zhuǎn)換成字節(jié)數(shù)組，二是把字節(jié)數(shù)組寫入到輸出流。
PatternLayoutEncoder 是唯一有用的且默認的encoder ，有一個
節(jié)點，用來設置日志的輸入格式。使用“%”加“轉(zhuǎn)換符”方式，如果要輸出“%”，則必須用“”對“%”進行轉(zhuǎn)義。
子節(jié)點root
根loger，是所有loger的最上級，且只有一個level節(jié)點，用類設置打印日志的級別，默認值為debug，通常設置為info，此外還有trace、warn、error、all、off級別。
子節(jié)點appender-ref的ref屬性指定日志組件名稱，即appender的name屬性值。
使用logback
在yml文件中增加logging.config指定配置文件地址，命名為logback時可以不需要配置，SpringBoot`會自動查找。
level設置指定路徑下的日志輸出級別。
logging:
config: classpath:logback.xml
level:
com:
springboot: debug如圖所示，項目啟動后，訪問接口輸出日志內(nèi)容并生成指定日志文件：
到這里，本篇關于在Springboot項目中如何去配置logback日志系統(tǒng)詳細教程的文章就介紹到結束了，想要了解更多相關Springboot日志logback的內(nèi)容，請多多關注W3Cschool！如果覺得本篇文章不錯，還希望大家多多支持！
