SpringBoot日志的使用解讀

更新時(shí)間：2025年02月18日 10:54:55 作者：Exill

本文主要介紹了SpringBoot中日志的使用方法,包括默認(rèn)輸出格式、使用Lombok簡化日志代碼、通過yml和xml配置日志等

一.默認(rèn)輸出格式

1.日期時(shí)間

2.日志級別（從上至下級別越來越高）：

TRACE：追蹤框架流程日志，一般不使用
DEBUG：調(diào)試日志
INFO：關(guān)鍵、感興趣日志
WARN：警告日志
ERROR：錯(cuò)誤日志

3.進(jìn)程ID

4.---：消息分隔符

5.線程名：用[]包裹

6.Logger名：產(chǎn)生這條日志的類名

7.消息：具體日志內(nèi)容

二.使用

@Service
public class UserService{//創(chuàng)建UserService類對應(yīng)的Logger（SLF4J包下）
    private Logger logger= LoggerFactory.getLogger(getClass());
    public void useLogger() {//使用                
        Loggerlogger.trace("TRACE");
        logger.debug("DEBUG");
        logger.info("INFO {} {}", "參1", "參2");
        logger.warn("WARN");
        logger.error("ERROR");
}

導(dǎo)入lombok后使用@Slf4j注解，會(huì)自動(dòng)創(chuàng)建變量名為log的Logger

只會(huì)輸出INFO及以上的日志級別，因?yàn)镾pringBoot默認(rèn)日志級別為INFO

三.配置

通過yml文件配置日志(以logging開頭的日志)

項(xiàng)目中通常不使用該方式

原因：

日志需要較多自定義，放yml里導(dǎo)致其他配置也難以閱讀
yml提供的日志配置只支持logback實(shí)現(xiàn)，切換實(shí)現(xiàn)后不可用
yml提供的logback配置不夠全面

通過xml配置日志

appender：負(fù)責(zé)寫日志的組件（輸出到控制臺、文件、日志服務(wù)器、消息隊(duì)列等等）
appender-ref：引用某個(gè)appender
layout：配置日志輸出格式
springProfile：配置日志在開發(fā)/測試/生產(chǎn)環(huán)境生效
springProperty：在xml配置中引用yml的配置值
property：在xml中定義值

logback-spring.xml模板示例

<?xml version="1.0" encoding="UTF-8"?>
<configuration><!--讀取yml配置中的spring.application.name值賦值給FILE_NAME變量-->
    <springProperty scope="context" name="FILE_NAME" source="spring.application.name"/><!--定義FILE_PATH變量-->
    <property name="FILE_PATH" value="./logs"/>
    <springProfile name="dev"><!--開發(fā)環(huán)境的日志配置-->
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"><!--輸出到控制臺-->
            <layout><!--設(shè)置日志格式-->
                <pattern>%d{yyyy-MM-dd HH:mm:ss}[%thread] %-5level %logger -%msg%n</pattern>
            </layout>
        </appender>
        <root level="info"><!--設(shè)置日志等級 及 生效appender-->
            <appender-ref ref="STDOUT"/>
        </root>
    </springProfile>
    <springProfile name="test"><!--測試環(huán)境的日志配置-->
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <layout>
                <pattern>%d{yyyy-MM-dd HH:mm:ss}[%thread] %-5level %logger -%msg%n</pattern>
            </layout>
        </appender><!--輸出到文件，文件會(huì)根據(jù)日期、大小進(jìn)行歸檔-->
        <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"><!--文件路徑-->
                <fileNamePattern>${FILE_PATH}/${FILE_NAME}%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <maxHistory>30</maxHistory><!--文件保存天數(shù)-->
                <maxFileSize>10MB</maxFileSize><!--一個(gè)文件最大值-->
            </rollingPolicy>
            <layout>
                <pattern>%d{yyyy-MM-dd HH:mm:ss}[%thread] %-5level %logger -%msg%n</pattern>
            </layout>
        </appender>
        <root level="info">
            <appender-ref ref="STDOUT"/>
            <appender-ref ref="FILE"/>
        </root>
    </springProfile>
    <springProfile name="prod"><!--生產(chǎn)環(huán)境的日志配置-->
        <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
                <fileNamePattern>${FILE_PATH}/${FILE_NAME}%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <maxHistory>30</maxHistory>
                <maxFileSize>10MB</maxFileSize>
            </rollingPolicy>
            <layout>
                <pattern>%d{yyyy-MM-dd HH:mm:ss}[%thread] %-5level %logger -%msg%n</pattern>
            </layout>
        </appender>
        <root level="error">
            <appender-ref ref="FILE"/>
        </root>
    </springProfile>
</configuration>