日誌對於應用程式來說是非常重要的，Spring框架本身集成了不少其他工具，我們自身的應用也會使用到第三方庫，所以我們推薦在Spring應用中使用SLF4J/Logback來記錄日誌。

SLF4J與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 Logging

Spring Boot實現了一套日誌系統——它能夠根據類路徑上的內容來決定使用哪一種日誌框架，logback是最優先的選擇。配置了logback.xml可以利用Spring Boot提供的預設日誌配置：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/base.xml"
 
/>
    <logger name="org.springframework.web" level="DEBUG"/>
</configuration>

這樣就定義了一個<logger>捕獲org.springframework.web的日誌，日誌級別是DEBUG，base.xml內容如下：

<included>
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />
    <property name="LOG_FILE"
 
 value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}/}spring.log}"/>
    <include resource="org/springframework/boot/logging/logback/console-appender.xml" />
    <include resource="org/springframework/boot/logging/logback/file-appender.xml" />
    <root level="INFO">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="FILE" />
    </root>
</included>

Spring Boot的日誌系統預先定義了一些系統變數：

• ${PID}，當前程序ID
• ${LOG_FILE}，Spring Boot配置檔案中logging.file的值
• ${LOG_PATH}, Spring Boot配置檔案中logging.path的值

同時預設情況下包含另個appender——一個是控制檯，一個是檔案，分別定義在console-appender.xml和file-appender.xml中。同時對於應用的日誌級別也可以通過application.properties進行定義：

logging.level.org.springframework.web=DEBUG
logging.level.org.hibernate=ERROR

這等價於在logback.xml配置appender的日誌級別。

ConsoleAppender

Logback使用appender來定義日誌輸出，在開發過程中最常用的是將日誌輸出到控制檯：

<appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">
  <encoder>
    <Pattern>.%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg %n</Pattern>
  </encoder>
  <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
    <level>TRACE</level>
  </filter>
</appender>

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

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

在這種格式下一條日誌的輸出結果如下：

0:12:51.012 [qtp231719230-45] DEBUG o.c.d.r.util.LoggingResponseFilter

RollingFileAppender

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

<appender name="dailyRollingFileAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
  <File>/data/log/app.log</File>
  <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    <!-- daily rollover -->
    <FileNamePattern>rest-demo.%d{yyyy-MM-dd}.log</FileNamePattern>
    <!-- keep 30 days' worth of history -->
    <maxHistory>30</maxHistory>         
  </rollingPolicy>
  <encoder>
    <Pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{35} - %msg %n</Pattern>
  </encoder>        
</appender>

其中重要的是rollingPolicy的定義，上例中<FileNamePattern>rest-demo.%d{yyyy-MM-dd}.log</FileNamePattern>定義了日誌的切分方式——把每一天的日誌歸檔到一個檔案中，<maxHistory>30</maxHistory>表示只保留最近30天的日誌，以防止日誌填滿整個磁碟空間。同理，可以使用%d{yyyy-MM-dd_HH-mm}來定義精確到分的日誌切分方式。

Sentry

Sentry是一個統一的日誌跟蹤平臺，在傳統的日誌管理中，都是在伺服器上通過tail, vim等工具檢視日誌，並且不同的日誌位置也個不相同，而Sentry則是將這些日誌（主要是錯誤日誌）通過統一的介面收集起來，並且提供跟蹤、管理的功能，使得應用程式的錯誤、Bug能夠即時被解決。

Sentry提供了Java庫——Raven Java，Java應用程式能夠在捕獲異常後將其傳送到Sentry伺服器中，另一方面它包含了各類日誌框架的支援，以Logbakc為例：

<dependency>
    <groupId>net.kencochrane.raven</groupId>
    <artifactId>raven-logback</artifactId>
    <version>6.0.0</version>
</dependency>

在logback.xml中定義appender：

<configuration>
    <appender name="Sentry" class="net.kencochrane.raven.logback.SentryAppender">
        <dsn>https://publicKey:[email protected]:port/1?options</dsn>
        <tags>tag1:value1,tag2:value2</tags>
        <!-- Optional, allows to select the ravenFactory -->
        <!--<ravenFactory>net.kencochrane.raven.DefaultRavenFactory</ravenFactory>-->
    </appender>
    <root level="warn">
        <appender-ref ref="Sentry"/>
    </root>
</configuration>

我們推薦在這個<appender>中加入<filter>用於過濾ERROR級別的日誌。