在 Spring Boot 項(xiàng)目中，默認(rèn)使用 Logback 作為日志框架。Logback 是一個(gè)高效、靈活的日志記錄工具，支持多種日志格式和輸出目標(biāo)（如控制臺(tái)、文件等）。通過(guò)配置 logback-spring.xml 文件，可以自定義日志的輸出方式和格式。

以下是 Spring Boot 中 Logback 日志配置的詳細(xì)說(shuō)明：

1. 創(chuàng)建或修改 logback-spring.xml

在 Spring Boot 項(xiàng)目中，默認(rèn)會(huì)使用 logback-spring.xml 文件來(lái)配置日志。如果該文件不存在，可以在 src/main/resources 目錄下創(chuàng)建一個(gè)。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 配置控制臺(tái)輸出 -->
    <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/app.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logs/app-%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>
    </appender>
    <!-- 配置錯(cuò)誤日志輸出 -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logs/error.log</file>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logs/error-%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>
    </appender>
    <!-- 根日志配置 -->
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
    </root>
    <!-- 自定義包的日志級(jí)別 -->
    <logger name="com.example" level="DEBUG" additivity="false">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
    </logger>
    <!-- 配置錯(cuò)誤日志 -->
    <logger name="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter" level="ERROR">
        <appender-ref ref="ERROR_FILE"/>
    </logger>
</configuration>

2. 配置說(shuō)明

2.1 日志格式

通過(guò) <encoder> 標(biāo)簽可以配置日志的輸出格式。常用占位符包括：

• %d{yyyy-MM-dd HH:mm:ss.SSS}：日期和時(shí)間
• [%thread]：線(xiàn)程名
• %-5level：日志級(jí)別（右對(duì)齊，寬度 5）
• %logger{36}：類(lèi)名或包名（最多顯示 36 個(gè)字符）
• %msg：日志消息

2.2 控制臺(tái)輸出

<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
配置控制臺(tái)輸出，日志會(huì)直接打印在終端。

2.3 文件輸出

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
文件輸出支持滾動(dòng)策略，按天生成日志文件：

• logs/app.log：當(dāng)前日志文件
• logs/app-yyyy-MM-dd.log：歷史日志文件

滾動(dòng)策略參數(shù)說(shuō)明：

• <fileNamePattern>：歷史日志文件的命名規(guī)則
• <maxHistory>：保留 30 天的歷史日志

2.4 錯(cuò)誤日志輸出

<appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
專(zhuān)門(mén)記錄錯(cuò)誤級(jí)別的日志，通過(guò) <filter> 標(biāo)簽設(shè)置只記錄 ERROR 級(jí)別的日志。

2.5 根日志配置

<root level="INFO">
設(shè)置根日志的級(jí)別為 INFO，并將輸出目標(biāo)指向控制臺(tái)和文件。

2.6 自定義包的日志級(jí)別

通過(guò) <logger> 標(biāo)簽可以為特定包或類(lèi)配置不同的日志級(jí)別：

• name="com.example"：指定包名
• level="DEBUG"：設(shè)置日志級(jí)別為 DEBUG
• additivity="false"：表示不繼承父 logger 的配置

3. 配置生效條件

確保 logback-spring.xml 文件位于 src/main/resources 目錄下。如果項(xiàng)目中沒(méi)有該文件，Spring Boot 會(huì)使用默認(rèn)日志配置。

4. 常見(jiàn)問(wèn)題

4.1 日志文件不生成

• 檢查 <file> 和 <fileNamePattern> 的路徑是否正確。
• 確保程序有寫(xiě)入權(quán)限。

4.2 自定義包的日志不生效

• 確保 name 屬性與實(shí)際類(lèi)名或包名完全一致。
• 確保 additivity="false"，避免繼承父 logger 的配置。

4.3 日志級(jí)別無(wú)效

• 確保 <logger> 標(biāo)簽中的 level 配置正確（如 DEBUG, INFO, ERROR）。
• 確保沒(méi)有其他配置覆蓋了該日志級(jí)別。

5. 總結(jié)

通過(guò)以上配置，可以靈活地定義 Spring Boot 應(yīng)用的日志輸出方式和格式?？梢愿鶕?jù)實(shí)際需求調(diào)整日志級(jí)別、輸出目標(biāo)和文件路徑，從而更好地監(jiān)控和調(diào)試應(yīng)用。

到此這篇關(guān)于springboot中l(wèi)ogback日志配置的詳細(xì)說(shuō)明的文章就介紹到這了,更多相關(guān)springboot logback日志配置內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論