使用實例：SpringBoot+Logback日誌框架配置詳解

一、Logback日誌框架簡介

Logback是一個高效的、靈活的、可配置的日誌框架，是Log4j框架的繼承者，其基於一系列過濾器來實現對日誌記錄的控制和過濾，並且日誌輸出的目的地可以是控制台、文件、甚至是網絡。因此Logback日誌框架在Java世界中被廣泛使用，特別是在SpringBoot項目中，其支持許多不同類型的應用實例的日誌記錄需求。

二、Logback的依賴配置

在SpringBoot項目中，我們可以通過Maven進行Logback的依賴配置，具體的依賴配置信息如下所示：

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
</dependency>
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
</dependency>

這兩個依賴是對應Logback框架的核心依賴，通過這些依賴我們可以在SpringBoot項目中使用Logback框架進行日誌的記錄和管理。

三、Logback的配置文件

Logback框架最重要的組件就是配置文件。在SpringBoot項目中，你需要在classpath路徑下定義一個名為logback.xml或者logback-spring.xml的文件。這個配置文件包含了日誌輸出的各種參數和設定，比如日誌文件的輸出目錄、日誌文件的命名、日誌文件的分割周期等等。

下面是一個簡單的logback.xml配置文件示例：

<configuration>
  <!-- 配置日誌輸出源為控制台 -->
  <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>

  <!-- 配置日誌輸出文件 -->
  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>./logs/mylog.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>./logs/mylog.%d{yyyy-MM-dd}.log</fileNamePattern>
    </rollingPolicy>
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>

  <!-- 配置日誌輸出級別 -->
  <root level="INFO">
    <appender-ref ref="CONSOLE" />
    <appender-ref ref="FILE" />
  </root>
</configuration>

這個配置文件定義了兩個日誌輸出源，一個輸出目標為控制台，另一個輸出目標為文件。其中，控制台輸出源名稱為CONSOLE，使用的是ConsoleAppender，文件輸出源名稱為FILE，使用的是RollingFileAppender。在配置中，我們可以使用Root作為根輸出日誌，定義輸出級別，並將輸出源引入進去。

四、在SpringBoot項目中使用Logback

使用Logback非常簡單，只需要將Logback配置文件添加到classpath路徑中即可。SpringBoot會自動為我們檢測到配置文件並使用它來配置應用程序的日誌輸出。

下面是使用Logback進行日誌記錄的示例代碼：

@Slf4j
@RestController
@RequestMapping("/api/v1")
public class UserController {

    @GetMapping("/users")
    public ResponseEntity<List<User>> getUsers() {
        List<User> users = new ArrayList<>();
        users.add(new User("Alice", 20));
        users.add(new User("Bob", 25));
        log.info("Get all users");
        return ResponseEntity.ok(users);
    }

    @PostMapping("/users")
    public ResponseEntity<User> addUser(@RequestBody User user) {
        log.info("Add user {}", user);
        return ResponseEntity.ok(user);
    }
}

上述代碼中，我們首先通過@Slf4j註解來引入Lombok中的@Slf4j日誌，然後在控制器類中定義了兩個HTTP請求處理方法，一個獲取用戶列表，另一個添加用戶。在這兩個方法中，我們使用了Logback框架定義的log.info方法來輸出日誌信息，其中log會自動獲取當前類的日誌記錄器。

五、Logback的過濾器管理

Logback框架除了支持不同的輸出源和輸出級別之外，還支持不同的過濾器管理。通過合理地配置不同的過濾器，我們可以對日誌進行更加細緻的控制。

下面是一個使用Logback過濾器進行日誌管理的示例配置文件：

<configuration>
  <!-- 配置日誌輸出源為控制台 -->
  <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
      <level>TRACE</level>
      <onMatch>ACCEPT</onMatch>
      <onMismatch>DENY</onMismatch>
    </filter>
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>

  <!-- 配置日誌輸出文件 -->
  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>./logs/mylog.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>./logs/mylog.%d{yyyy-MM-dd}.log</fileNamePattern>
    </rollingPolicy>
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
      <level>WARN</level>
      <onMatch>ACCEPT</onMatch>
      <onMismatch>DENY</onMismatch>
    </filter>
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>

  <!-- 配置日誌輸出級別 -->
  <root level="INFO">
    <appender-ref ref="CONSOLE" />
    <appender-ref ref="FILE" />
  </root>
</configuration>

在這個配置文件中，我們首先定義了一個針對控制台輸出源的LevelFilter過濾器，該過濾器只接受TRACE及以上級別的日誌輸出。對於文件輸出源，我們定義了另外一個LevelFilter過濾器，該過濾器只接受WARN及以上級別的日誌輸出。通過這樣的過濾器配置，我們可以對不同的日誌輸出源進行不同的日誌級別篩選和管理。

六、Logback的調試與優化

Logback框架提供了多種機制來幫助我們調試和優化日誌輸出性能，比如線程安全檢查、動態調整日誌級別等等。在實際使用中，我們可以通過增加調試信息和性能統計來幫助我們更好地理解和優化應用程序日誌。

下面是一個Logback的性能統計模塊配置示例：

<appender name="STAT" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>./logs/mylog-perf.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>./logs/mylog-perf.%d{yyyy-MM-dd}.log</fileNamePattern>
        <maxHistory>30</maxHistory>
    </rollingPolicy>
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <level>INFO</level>
    </filter>
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>WARN</level>
    </filter>
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>ERROR</level>
        <onMatch>DENY</onMatch>
        <onMismatch>ACCEPT</onMismatch>
    </filter>
    <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
        <expression>return %logger{20}.contains("repository");</expression>
        <onMatch>DENY</onMatch>
        <onMismatch>ACCEPT</onMismatch>
    </filter>
    <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
        <expression>return %logger{20}.contains("service");</expression>
        <onMatch>DENY</onMatch>
        <onMismatch>ACCEPT</onMismatch>
    </filter>
    <filter class="ch.qos.logback.classic.filter.DuplicateMessageFilter">
        <interval>60000</interval>
        <hash>5</hash>
        <value>1</value>
    </filter>
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>DEBUG</level>
        <onMatch>ACCEPT</onMatch>
        <onMismatch>DENY</onMismatch>
    </filter>
    <filter class="ch.qos.logback.classic.filter.DenyAllFilter"/>
</appender>

這個配置文件中，我們定義了一個名為STAT的輸出源，並對其進行了多項過濾和統計操作。其中，HashDuplicateChecker統計了1分鐘內相同的日誌信息數量，通過設置篩選hash值和過濾數量的方式去重，對於不同的日誌類別，我們還定義了獨立的EvaluatorFilter過濾器，來限制不同級別日誌的輸出。

結語：

這篇文章詳細介紹了使用實例：SpringBoot+Logback日誌框架配置詳解，從Logback日誌框架的簡介、依賴配置、配置文件、使用示例、過濾器管理、調試優化等多個方面對其進行了詳細說明，希望各位讀者可以在實際應用中成功使用Logback框架，優化應用程序日誌輸出質量，提升應用程序的穩定性和性能。

原創文章，作者：小藍，如若轉載，請註明出處：https://www.506064.com/zh-hant/n/199514.html