Logback在SpringBoot中的詳細配置教程

更新時間：2025年05月26日 15:45:39 作者：悟能不能悟

Spring Boot 默認會加載 classpath 下的 logback-spring.xml（推薦）或 logback.xml 作為 Logback 的配置文件,下面我們來看看具體的配置教程吧

1. Logback 配置文件

Spring Boot 默認會加載 classpath 下的 logback-spring.xml（推薦）或 logback.xml 作為 Logback 的配置文件。

?推薦使用 logback-spring.xml，因為 Spring Boot 提供了擴展支持（例如基于 Profile 的配置）。

配置文件位置

放在 src/main/resources/ 目錄下。

2. 基礎(chǔ)配置示例

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="30 seconds">
    <!-- 定義變量 -->
    <property name="LOG_PATH" value="./logs" />
    <property name="LOG_FILE" value="myapp" />
 
    <!-- 控制臺輸出 -->
    <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>${LOG_PATH}/${LOG_FILE}.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${LOG_PATH}/${LOG_FILE}-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <maxFileSize>50MB</maxFileSize>
            <maxHistory>30</maxHistory>
            <totalSizeCap>1GB</totalSizeCap>
        </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>
 
    <!-- 指定包或類的日志級別 -->
    <logger name="com.example.demo" level="DEBUG" />
</configuration>

3. 關(guān)鍵配置項說明

Appender（日志輸出器）

?ConsoleAppender: 輸出日志到控制臺。

?RollingFileAppender: 輸出到文件并支持滾動（按時間、大小分割）。

SizeAndTimeBasedRollingPolicy: 根據(jù)時間和文件大小滾動。
maxFileSize: 單個文件最大大小。
maxHistory: 保留的歷史日志文件數(shù)量。
totalSizeCap: 日志文件總大小限制。

Encoder（日志格式化）

<pattern> 定義日志格式，常用占位符：

%d: 日期時間
%thread: 線程名
%-5level: 日志級別（左對齊，寬度5）
%logger{36}: 日志輸出者的名稱（最長36字符）
%msg: 日志消息
%n: 換行符

Logger 和 Root Logger

<root>: 根日志配置，所有日志默認繼承此配置。
<logger>: 針對特定包或類配置日志級別。

4. Spring Boot 特有功能

通過 application.properties 覆蓋配置

在 application.properties 中可以覆蓋部分日志配置：

# 設(shè)置根日志級別
logging.level.root=INFO
# 設(shè)置特定包日志級別
logging.level.com.example.demo=DEBUG
# 日志文件路徑
logging.file.path=./logs
logging.file.name=./logs/app.log

按 Profile 配置日志

在 logback-spring.xml 中使用 <springProfile> 實現(xiàn)多環(huán)境配置：

<springProfile name="dev">
    <root level="DEBUG">
        <appender-ref ref="CONSOLE" />
    </root>
</springProfile>
 
<springProfile name="prod">
    <root level="INFO">
        <appender-ref ref="FILE" />
    </root>
</springProfile>

5. 高級配置

異步日志

使用 AsyncAppender 提升性能：

<appender name="ASYNC_FILE" class="ch.qos.logback.classic.AsyncAppender">
    <appender-ref ref="FILE" />
    <!-- 隊列大小，超出此值會丟棄 TRACE/DEBUG 日志 -->
    <queueSize>256</queueSize>
</appender>

彩色日志輸出

在 ConsoleAppender 中啟用顏色：

<encoder>
    <pattern>%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%-5level) %clr(${PID}){magenta} --- [%thread] %clr(%logger{36}){cyan} : %msg%n</pattern>
</encoder>