日誌系列2——logback配置檔案詳解
阿新 • • 發佈：2020-05-15
[toc]
### 1.logback 配置檔案的組成
#### 1.1root節點
root 節點是必選節點，用來指定最基礎的日誌輸出級別，只有一個 level 屬性，用於設定列印級別，可選如下：`TRACE`,`DEBUG`,`INFO`,`WARN`,`ERROR`,`ALL`,`OFF`。
root 節點可以包含 0 個或多個元素，將`appender`新增進來。如下：
```xml
```
appender 也是子節點之一，將會在後面說明。
#### 1.2.property節點
用於定義變數，方便使用。有兩個屬性：name,value。定義變數後，可以使用`${}`來使用變數。如下：
```xml
%-4relative [%thread] %-5level %logger{35} - %msg %n
```
appender 用來格式化日誌輸出的節點，這個最重要。有兩個屬性：
- name:該本 appender 命名
- class:指定輸出策略，通常有兩種：控制檯輸出，檔案輸出
下面通過例子來說明這個怎麼用：
在logback中，主要有以下三種日誌目的地處理類：
##### 1.3.1 ch.qos.logback.core.ConsoleAppender
將日誌輸出到控制檯
```xml
%-4relative [%thread] %-5level %logger{35} - %msg %n
e:/log.out
true
false
%-4relative [%thread] %-5level %logger{35} - %msg%n
```
子節點append：新增的日誌是否以追加到檔案結尾的方式寫入到log.out檔案中，true為追加，fasle為清空現存檔案寫入；
子節點prudent：日誌是否被安全的寫入磁碟檔案，預設為false。如果為true，則效率低下；
##### 1.3.3 ch.qos.logback.core.rolling.RollingFileAppender
滾動記錄日誌，當符合rollingPolicy節點中設定的條件時，會將現有日誌移到新的檔案中去。rollingPolicy節點中可設定的條件為：檔案的大小、時間等；
```xml
e:/log.out false
testLog-%d{yyyy-MM-dd}.log
30
%-4relative [%thread] %-5level %logger{35} - %msg%n
```
##### 1.3.4 ch.qos.logback.classic.AsyncAppender
非同步記錄日誌，內部通過使用快取的方式來實現非同步列印，將日誌列印事件event放入快取中。具體資料結構為BlockingQueue；
```xml
e:/log.out
true
false
%-4relative [%thread] %-5level %logger{35} - %msg%n
0
512
```
子節點queueSize：指的是BlockingQueue的佇列容量大小，預設為256個；
子節點discardingThreshold：如果BlockingQueue中還剩餘20%的容量，那麼程式會丟棄TRACE、DEBUG和INFO級別的日誌列印事件event，只保留WARN和ERROR級別的。為了保留所有的日誌列印事件，可以將該值設定為0。
##### 1.3.5 rollingPolicy
日誌檔案的滾動策略，與RollingFileAppender搭配使用，當日志文件發生變動時決定RollingFileAppender的行為。在rollingPolicy節點中有一個class屬性，可選的值為TimeBasedRollingPolicy、FixedWindowRollingPolicy、TriggeringPolicy。其中ch.qos.logback.core.rolling.TimeBasedRollingPolicy表示根據時間制定日誌檔案的滾動策略；
```xml
testLog-%d{yyyy-MM-dd}.log
30
```
ch.qos.logback.core.rolling.FixedWindowRollingPolicy表示如果日誌檔案大小超過指定範圍時，會根據檔名拆分成多個檔案；
```xml
tests.%i.log.zip
1
4
```
### 2.配置檔案例子
```xml
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
UTF-8
${LOG_HOME}/timeFile/out.log
${LOG_HOME}/timeFile/info.%d{yyyy-MM-dd}.%i.log.gz
30
10MB
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
UTF-8
0
256
```
### 3 spring boot 使用logback日誌
SpringBoot工程自帶logback和slf4j的依賴，所以只要在maven依賴中添加了spring-boot-starter-logging即可。logback框架會預設載入classpath下命名為logback-spring或logback的配置檔案。
```xml
org.springframework.boot
spring-boot-starter-logging
```
#### 3.1 簡單使用
如果無需複雜的日誌配置，執行簡單設定日誌列印級別，列印方式可直接在 application.yml 中配置。
```ini
logging:
# 配置日誌存放路徑,日誌檔名為：spring.log
path: e:/log
file:
# 設定日誌檔案大小
max-size: 20MB
level:
# root日誌以info級別輸出
root: info
# 此包下所有class以DEBUG級別輸出
com.demo.test: debug
```
#### 3.2 多環境日誌輸出
Spring Boot 官方推薦優先使用帶有 -spring 的檔名作為你的日誌配置（如使用 logback-spring.xml ，而不是 logback.xml ），命名為 logback-spring.xml 的日誌配置檔案， spring boot 可以為它新增一些 spring boot 特有的配置項示例如下：
```xml