Springboot 集成logback配置

1. 引入依賴

Springboot默認是集成logback日志的, 樓主用的是2.6.3版本

只要項目中引入了該坐標, 則該項目就已經集成了logback日志框架了

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
   <version>${springboot.version}</version>
</dependency>

2. yml 配置:

在application.yml配置文件中添加一下配置, 指定logback的xml配置文件

spring:
  application:
    name: sky
  profiles:
    active: dev

logging:
  config: classpath:logback-spring.xml

3. logback-spring.xml 詳細配置:

主要是配置日志的輸出格式及滾動策略

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志級別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果設置為WARN，則低於WARN的信息都不會輸出 -->
<!-- scan:當此屬性設置為true時，配置文檔如果發生改變，將會被重新加載，默認值為true -->
<!-- scanPeriod:設置監測配置文檔是否有修改的時間間隔，如果沒有給出時間單位，默認單位是毫秒。
                 當scan為true時，此屬性生效。默認的時間間隔為1分鍾。 -->
<!-- debug:當此屬性設置為true時，將打印出logback內部日志信息，實時查看logback運行狀態。默認值為false。 -->
<configuration scan="false" debug="false">
    <!--以下配置基本不需修改 -->
    <!--需要使用springProperty,才可使用application.properties（或application.yml）中的值 -->
    <springProperty name="app.name" source="spring.application.name" />
    <!--指定應用日志的路徑 -->
    <property name="log.path" value="./logs/${app.name}" />


    <!--輸出到控制台 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!--日期 日志等級 PID 線程名 類路徑 方法名 java源文件 行號 打印信息 換行-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%5p) %green(${PID:- }) --- %magenta([%15.15t]) %cyan(%C.%M\(%F:%L\)) : %msg%n</pattern>
            <!--同上, 僅輸出類路徑, 不輸出 方法名 java源文件 行號 -->
            <!--<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%5p) %green(${PID:- }) -&#45;&#45; %magenta([%15.15t]) %cyan(%-40.40logger{40}) : %msg%n</pattern>-->
        </encoder>
    </appender>

    <!--輸出到文件 -->
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日志文檔的路徑及文檔名 -->
        <file>${log.path}/${app.name}.log</file>
        <!-- 日志記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/${app.name}.%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern>
            <!--單個文件大小-->
            <maxFileSize>50MB</maxFileSize>
            <!--日志文檔保留天數-->
            <maxHistory>14</maxHistory>
            <!--指定日志文件總的上限大小-->
            <totalSizeCap>10GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %5p ${PID:- } --- [%15.15t] %C.%M\(%F:%L\) [%X{TRACE_ID}] : %msg%n</pattern>
            <!--<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %5p ${PID:- } -&#45;&#45; [%15.15t] %-40.40logger{40} [%X{TRACE_ID}] : %msg%n</pattern>-->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 單獨輸出error日志文件, 可選配置 -->
    <appender name="error" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/${app.name}-error.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/${app.name}-error.%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern>
            <maxFileSize>50MB</maxFileSize>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %5p ${PID:- } --- [%15.15t] %C.%M\(%F:%L\) [%X{TRACE_ID}] : %msg%n</pattern>
            <!--<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %5p ${PID:- } -&#45;&#45; [%15.15t] %-40.40logger{40} [%X{TRACE_ID}] : %msg%n</pattern>-->
            <charset>UTF-8</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
    </appender>


    <!-- <logger>用來設置某一個包或者具體的某一個類的日志打印級別、以及指定<appender>。<logger>僅有一個name屬性，一個可選的level和一個可選的addtivity屬性。
         name:用來指定受此logger約束的某一個包或者具體的某一個類。
         level:用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，還有一個特俗值INHERITED或者同義詞NULL，代表強制執行上級的級別。
               如果未設置此屬性，那么當前logger將會繼承上級的級別。
         addtivity:是否向上級logger傳遞打印信息。默認是true -->
    <logger name="com.sky.boot.mapper" level="DEBUG" />

    <!--
        使用mybatis的時候，sql語句是debug下才會打印，而這里我們只配置了info，所以想要查看sql語句的話，有以下兩種操作：
        第一種把<root level="info">改成<root level="DEBUG">這樣就會打印sql，不過這樣日志那邊會出現很多其他消息
        第二種就是單獨給dao下目錄配置debug模式，代碼如下，這樣配置sql語句會打印，其他還是正常info級別：
     -->

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

    <!-- 開發環境 -->
    <springProfile name="dev">
        <root level="INFO">
            <appender-ref ref="console" />
        </root>
    </springProfile>
    <!-- 測試環境 -->
    <springProfile name="test">
        <root level="INFO">
            <appender-ref ref="file" />
        </root>
    </springProfile>
    <!-- 生產環境. -->
    <springProfile name="prod">
        <root level="INFO">
            <appender-ref ref="file" />
            <appender-ref ref="error" />
        </root>
    </springProfile>

</configuration>

4. 以上配置完成后, 就可以直接項目中使用了

這里可以用lombok的@Slf4j注解標識相關實體類, 然后類方法中直接log.xxx使用即可, 支持 debug | info | warn | error