Spring Boot乾貨系列：（七）預設日誌logback配置解析

阿新 • • 發佈：2019-01-30

前言

今天來介紹下Spring Boot如何配置日誌logback,我剛學習的時候，是帶著下面幾個問題來查資料的，你呢
- 如何引入日誌？
- 日誌輸出格式以及輸出方式如何配置？
- 程式碼中如何使用？

正文

Spring Boot在所有內部日誌中使用Commons Logging，但是預設配置也提供了對常用日誌的支援，如：Java Util Logging，Log4J, Log4J2和Logback。每種Logger都可以通過配置使用控制檯或者檔案輸出日誌內容。

預設日誌Logback

SLF4J——Simple Logging Facade For Java

，它是一個針對於各類Java日誌框架的統一Facade抽象。Java日誌框架眾多——常用的有java.util.logging, log4j, logback，commons-logging, Spring框架使用的是Jakarta Commons Logging API (JCL)。而SLF4J定義了統一的日誌抽象介面，而真正的日誌實現則是在執行時決定的——它提供了各類日誌框架的binding。

Logback是log4j框架的作者開發的新一代日誌框架，它效率更高、能夠適應諸多的執行環境，同時天然支援SLF4J。

預設情況下，Spring Boot會用Logback來記錄日誌，並用INFO級別輸出到控制檯。在執行應用程式和其他例子時，你應該已經看到很多INFO級別的日誌了。

從上圖可以看到，日誌輸出內容元素具體如下：
- 時間日期：精確到毫秒
- 日誌級別：ERROR, WARN, INFO, DEBUG or TRACE
- 程序ID
- 分隔符：--- 標識實際日誌的開始
- 執行緒名：方括號括起來（可能會截斷控制檯輸出）
- Logger名：通常使用原始碼的類名
- 日誌內容

新增日誌依賴

假如maven依賴中添加了spring-boot-starter-logging：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId 
>spring-boot-starter-logging</artifactId>
</dependency>

那麼，我們的Spring Boot應用將自動使用logback作為應用日誌框架，Spring Boot啟動的時候，由org.springframework.boot.logging.Logging-Application-Listener根據情況初始化並使用。

但是呢，實際開發中我們不需要直接新增該依賴，你會發現spring-boot-starter其中包含了 spring-boot-starter-logging，該依賴內容就是 Spring Boot 預設的日誌框架 logback。而博主這次專案的例子是基於上一篇的，工程中有用到了Thymeleaf，而Thymeleaf依賴包含了spring-boot-starter，最終我只要引入Thymeleaf即可。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

具體可以看該圖

預設配置屬性支援

Spring Boot為我們提供了很多預設的日誌配置，所以，只要將spring-boot-starter-logging作為依賴加入到當前應用的classpath，則“開箱即用”。
下面介紹幾種在application.properties就可以配置的日誌相關屬性。

控制檯輸出

日誌級別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果設定為WARN，則低於WARN的資訊都不會輸出。
Spring Boot中預設配置ERROR、WARN和INFO級別的日誌輸出到控制檯。您還可以通過啟動您的應用程式–debug標誌來啟用“除錯”模式（開發的時候推薦開啟）,以下兩種方式皆可：
- 在執行命令後加入--debug標誌，如：$ java -jar springTest.jar --debug
- 在application.properties中配置debug=true，該屬性置為true的時候，核心Logger（包含嵌入式容器、hibernate、spring）會輸出更多內容，但是你自己應用的日誌並不會輸出為DEBUG級別。

檔案輸出

預設情況下，Spring Boot將日誌輸出到控制檯，不會寫到日誌檔案。如果要編寫除控制檯輸出之外的日誌檔案，則需在application.properties中設定logging.file或logging.path屬性。
- logging.file，設定檔案，可以是絕對路徑，也可以是相對路徑。如：logging.file=my.log
- logging.path，設定目錄，會在該目錄下建立spring.log檔案，並寫入日誌內容，如：logging.path=/var/log

如果只配置 logging.file，會在專案的當前路徑下生成一個 xxx.log 日誌檔案。
如果只配置 logging.path，在 /var/log資料夾生成一個日誌檔案為 spring.log

注：二者不能同時使用，如若同時使用，則只有logging.file生效

預設情況下，日誌檔案的大小達到10MB時會切分一次，產生新的日誌檔案，預設級別為：ERROR、WARN、INFO

級別控制

所有支援的日誌記錄系統都可以在Spring環境中設定記錄級別（例如在application.properties中）
格式為：’logging.level.* = LEVEL’
- logging.level：日誌級別控制字首，*為包名或Logger名
- LEVEL：選項TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

舉例：
- logging.level.com.dudu=DEBUG：com.dudu包下所有class以DEBUG級別輸出
- logging.level.root=WARN：root日誌以WARN級別輸出

自定義日誌配置

由於日誌服務一般都在ApplicationContext建立前就初始化了，它並不是必須通過Spring的配置檔案控制。因此通過系統屬性和傳統的Spring Boot外部配置檔案依然可以很好的支援日誌控制和管理。

根據不同的日誌系統，你可以按如下規則組織配置檔名，就能被正確載入：

Logback：logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
Log4j：log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
Log4j2：log4j2-spring.xml, log4j2.xml
JDK (Java Util Logging)：logging.properties

Spring Boot官方推薦優先使用帶有-spring的檔名作為你的日誌配置（如使用logback-spring.xml，而不是logback.xml），命名為logback-spring.xml的日誌配置檔案，spring boot可以為它新增一些spring boot特有的配置項（下面會提到）。

上面是預設的命名規則，並且放在src/main/resources下面即可。

如果你即想完全掌控日誌配置，但又不想用logback.xml作為Logback配置的名字，可以通過logging.config屬性指定自定義的名字：

logging.config=classpath:logging-config.xml

雖然一般並不需要改變配置檔案的名字，但是如果你想針對不同執行時Profile使用不同的日
志配置，這個功能會很有用。

下面我們來看看一個普通的logback-spring.xml例子

<?xml version="1.0" encoding="UTF-8"?>
<configuration  scan="true" scanPeriod="60 seconds" debug="false">
    <contextName>logback</contextName>
    <property name="log.path" value="E:\\test\\logback.log" />
    <!--輸出到控制檯-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
       <!-- <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>-->
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!--輸出到檔案-->
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern>
        </rollingPolicy>
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="console" />
        <appender-ref ref="file" />
    </root>

    <!-- logback為java中的包 -->
    <logger name="com.dudu.controller"/>
    <!--logback.LogbackDemo：類的全路徑 -->
    <logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">
        <appender-ref ref="console"/>
    </logger>
</configuration>

根節點`<configuration>`包含的屬性

scan:當此屬性設定為true時，配置檔案如果發生改變，將會被重新載入，預設值為true。
scanPeriod:設定監測配置檔案是否有修改的時間間隔，如果沒有給出時間單位，預設單位是毫秒。當scan為true時，此屬性生效。預設的時間間隔為1分鐘。
debug:當此屬性設定為true時，將打印出logback內部日誌資訊，實時檢視logback執行狀態。預設值為false。

根節點<configuration>的子節點：
<configuration>下面一共有2個屬性，3個子節點，分別是：

屬性一：設定上下文名稱`<contextName>`

每個logger都關聯到logger上下文，預設上下文名稱為“default”。但可以使用設定成其他名字，用於區分不同應用程式的記錄。一旦設定，不能修改,可以通過%contextName來列印日誌上下文名稱。

<contextName>logback</contextName>

屬性二：設定變數`<property>`

用來定義變數值的標籤，有兩個屬性，name和value；其中name的值是變數的名稱，value的值時變數定義的值。通過定義的值會被插入到logger上下文中。定義變數後，可以使“${}”來使用變數。

<property name="log.path" value="E:\\logback.log" />

子節點一`<appender>`

appender用來格式化日誌輸出節點，有倆個屬性name和class，class用來指定哪種輸出策略，常用就是控制檯輸出策略和檔案輸出策略。

控制檯輸出ConsoleAppender：

 <!--輸出到控制檯-->
 <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
     <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
         <level>ERROR</level>
     </filter>
     <encoder>
         <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
     </encoder>
 </appender>

<encoder>表示對日誌進行編碼：

%d{HH: mm:ss.SSS}——日誌輸出時間
%thread——輸出日誌的程序名字，這在Web應用以及非同步任務處理中很有用
%-5level——日誌級別，並且使用5個字元靠左對齊
%logger{36}——日誌輸出者的名字
%msg——日誌訊息
%n——平臺的換行符

ThresholdFilter為系統定義的攔截器，例如我們用ThresholdFilter來過濾掉ERROR級別以下的日誌不輸出到檔案中。如果不用記得註釋掉，不然你控制檯會發現沒日誌~

輸出到檔案RollingFileAppender

另一種常見的日誌輸出到檔案，隨著應用的執行時間越來越長，日誌也會增長的越來越多，將他們輸出到同一個檔案並非一個好辦法。RollingFileAppender用於切分檔案日誌：

<!--輸出到檔案-->
<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${log.path}</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern>
        <maxHistory>30</maxHistory>
        <totalSizeCap>1GB</totalSizeCap>
    </rollingPolicy>
    <encoder>
        <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
</appender>

其中重要的是rollingPolicy的定義，上例中<fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern>定義了日誌的切分方式——把每一天的日誌歸檔到一個檔案中，<maxHistory>30</maxHistory>表示只保留最近30天的日誌，以防止日誌填滿整個磁碟空間。同理，可以使用%d{yyyy-MM-dd_HH-mm}來定義精確到分的日誌切分方式。<totalSizeCap>1GB</totalSizeCap>用來指定日誌檔案的上限大小，例如設定為1GB的話，那麼到了這個值，就會刪除舊的日誌。

子節點二`<root>`

root節點是必選節點，用來指定最基礎的日誌輸出級別，只有一個level屬性。
- level:用來設定列印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能設定為INHERITED或者同義詞NULL。
預設是DEBUG。
可以包含零個或多個元素，標識這個appender將會新增到這個loger。

<root level="debug">
    <appender-ref ref="console" />
    <appender-ref ref="file" />
</root>

子節點三`<loger>`

<loger>用來設定某一個包或者具體的某一個類的日誌列印級別、以及指定<appender>。<loger>僅有一個name屬性，一個可選的level和一個可選的addtivity屬性。
- name:用來指定受此loger約束的某一個包或者具體的某一個類。
- level:用來設定列印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，還有一個特俗值INHERITED或者同義詞NULL，代表強制執行上級的級別。如果未設定此屬性，那麼當前loger將會繼承上級的級別。
- addtivity:是否向上級loger傳遞列印資訊。預設是true。

loger在實際使用的時候有兩種情況
先來看一看程式碼中如何使用

package com.dudu.controller;
@Controller
public class LearnController {
    private Logger logger = LoggerFactory.getLogger(this.getClass());

    @RequestMapping(value = "/login",method = RequestMethod.POST)
    @ResponseBody
    public Map<String,Object> login(HttpServletRequest request, HttpServletResponse response){
        //日誌級別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果設定為WARN，則低於WARN的資訊都不會輸出。
        logger.trace("日誌輸出 trace");
        logger.debug("日誌輸出 debug");
        logger.info("日誌輸出 info");
        logger.warn("日誌輸出 warn");
        logger.error("日誌輸出 error");
        Map<String,Object> map =new HashMap<String,Object>();
        String userName=request.getParameter("userName");
        String password=request.getParameter("password");
        if(!userName.equals("") && password!=""){
            User user =new User(userName,password);
            request.getSession().setAttribute("user",user);
            map.put("result","1");
        }else{
            map.put("result","0");
        }
        return map;
    }
}

這是一個登入的判斷的方法，我們引入日誌，並且列印不同級別的日誌，然後根據logback-spring.xml中的配置來看看列印了哪幾種級別日誌。

第一種：帶有loger的配置，不指定級別，不指定appender

<logger name="com.dudu.controller"/>

<logger name="com.dudu.controller" />將控制controller包下的所有類的日誌的列印，但是並沒用設定列印級別，所以繼承他的上級的日誌級別“info”；
沒有設定addtivity，預設為true，將此loger的列印資訊向上級傳遞；
沒有設定appender，此loger本身不列印任何資訊。
<root level="info">將root的列印級別設定為“info”，指定了名字為“console”的appender。

當執行com.dudu.controller.LearnController類的login方法時，LearnController 在包com.dudu.controller中，所以首先執行<logger name="com.dudu.controller"/>，將級別為“info”及大於“info”的日誌資訊傳遞給root，本身並不列印；
root接到下級傳遞的資訊，交給已經配置好的名為“console”的appender處理，“console”appender將資訊列印到控制檯；

列印結果如下：

16:00:17.407 logback [http-nio-8080-exec-8] INFO  com.dudu.controller.LearnController - 日誌輸出 info
16:00:17.408 logback [http-nio-8080-exec-8] WARN  com.dudu.controller.LearnController - 日誌輸出 warn
16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.dudu.controller.LearnController - 日誌輸出 error

第二種：帶有多個loger的配置，指定級別，指定appender

<!--logback.LogbackDemo：類的全路徑 -->
<logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">
    <appender-ref ref="console"/>
</logger>

控制com.dudu.controller.LearnController類的日誌列印，列印級別為“WARN”;
additivity屬性為false，表示此loger的列印資訊不再向上級傳遞;
指定了名字為“console”的appender;

這時候執行com.dudu.controller.LearnController類的login方法時，先執行<logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">,
將級別為“WARN”及大於“WARN”的日誌資訊交給此loger指定的名為“console”的appender處理，在控制檯中打出日誌，不再向上級root傳遞列印資訊。
列印結果如下：

16:00:17.408 logback [http-nio-8080-exec-8] WARN  com.dudu.controller.LearnController - 日誌輸出 warn
16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.dudu.controller.LearnController - 日誌輸出 error

當然如果你把additivity=”false”改成additivity=”true”的話，就會列印兩次，因為列印資訊向上級傳遞，logger本身列印一次，root接到後又列印一次。

多環境日誌輸出

據不同環境（prod:生產環境，test:測試環境，dev:開發環境）來定義不同的日誌輸出，在 logback-spring.xml中使用 springProfile 節點來定義，方法如下：

檔名稱不是logback.xml，想使用spring擴充套件profile支援，要以logback-spring.xml命名

<!-- 測試環境+開發環境. 多個使用逗號隔開. -->
<springProfile name="test,dev">
    <logger name="com.dudu.controller" level="info" />
</springProfile>
<!-- 生產環境. -->
<springProfile name="prod">
    <logger name="com.dudu.controller" level="ERROR" />
</springProfile>

可以啟動服務的時候指定 profile （如不指定使用預設），如指定prod 的方式為：
java -jar xxx.jar –spring.profiles.active=prod
關於多環境配置可以參考
Spring Boot乾貨系列：（二）配置檔案解析

總結

到此為止終於介紹完日誌框架了，平時使用的時候推薦用自定義logback-spring.xml來配置，程式碼中使用日誌也很簡單，類裡面新增private Logger logger = LoggerFactory.getLogger(this.getClass());即可。

想要檢視更多Spring Boot乾貨教程,可前往：Spring Boot乾貨系列總綱

原始碼下載

一直覺得自己寫的不是技術，而是情懷，一篇篇文章是自己這一路走來的痕跡。靠專業技能的成功是最具可複製性的，希望我的這條路能讓你少走彎路，希望我能幫你抹去知識的蒙塵，希望我能幫你理清知識的脈絡，希望未來技術之巔上有你也有我。