快捷導(dǎo)航

如何設(shè)置springboot禁止日志輸出到控制臺

更新時間：2025年01月14日 14:26:19 作者：左直拳

文章總結(jié)：本文主要介紹了SpringBoot項(xiàng)目中使用SLF4J記錄日志時,日志默認(rèn)輸出到控制臺的原因及解決方法,日志框架如Logback默認(rèn)會將日志輸出到控制臺,可以通過`logback-spring.xml`配置文件或配置類來禁止日志輸出到控制臺,并設(shè)置日志輸出級別

為啥日志還會自動輸出到控制臺呢？我一向孤陋寡聞，好奇去問AI。AI告訴我，系統(tǒng)使用org.slf4j.Logger.info記錄日志，而SLF4J 只是一個日志門面（Facade），具體的日志記錄行為是由綁定的具體日志實(shí)現(xiàn)框架（如 Logback、Log4j、java.util.logging 等）決定的。就相當(dāng)于，org.slf4j.Logger.info只定義了日志的接口，具體實(shí)現(xiàn)要看用了什么日志工具包。如果沒有指定，Spring Boot會默認(rèn)采用Logback。

我看了看pom.xml，沒有發(fā)現(xiàn)有引用什么日志包，因此可以確定，我們系統(tǒng)用的應(yīng)該是Logback。

我記得Spring Boot的核心是控制反轉(zhuǎn)（IoC），AOP和容器，然后AI說，除此之外，還有約定大于配置，自動配置，起步依賴等等。

起步依賴就是為程序啟動自動提供了許多準(zhǔn)備，自動配置應(yīng)該就包含了上面說的，默認(rèn)采用Logback作為日志框架的做法。

一、禁止日志輸出到控制臺

回到日志內(nèi)容默認(rèn)輸出到控制臺，這是Logback的做派。如果要禁止，需要在配置文件或代碼中指定。

這個配置文件，不是指application.yml這種Spring Boot項(xiàng)目級的配置文件，它們只能簡單地設(shè)置日志的輸出級別和輸出路徑，而禁止輸出到控制臺，只能在專有的logback-spring.xml進(jìn)行配置。

1、application.yml只能簡單地設(shè)置日志的輸出級別和輸出路徑

application.yml

logging:
  level:
    root: info      # 設(shè)置全局日志級別
    com.yourpackage: debug  # 針對特定包的日志級別
  file:
    path: ./log/seller.log  # 日志輸出路徑
  pattern:
    file: '%d{yyyy-MM-dd HH:mm:ss} - %msg%n'  # 日志文件的格式
    console: '%d{yyyy-MM-dd HH:mm:ss} - %msg%n'  # 控制臺輸出的日志格式

2、日志配置文件logback-spring.xml設(shè)置

logback-spring.xml需要手動創(chuàng)建，位置也是在resources根目錄下，SpringBoot會自動識別。

文件內(nèi)容如下：

resources/logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 定義文件日志輸出 -->
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>./log/seller.log</file>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 配置 root 只使用文件輸出 -->
    <root level="info">
        <appender-ref ref="FILE" />
    </root>
</configuration>

3、也可以通過配置類進(jìn)行設(shè)置

當(dāng)然也可以通過創(chuàng)建配置類來設(shè)置：

import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.core.Appender;
import ch.qos.logback.core.ConsoleAppender;
import ch.qos.logback.core.FileAppender;
import ch.qos.logback.classic.encoder.PatternLayoutEncoder;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import ch.qos.logback.classic.spi.ILoggingEvent;
import java.util.Iterator;

@Configuration
public class LoggingConfig {

    @Bean
    public void configureLogging() {
        LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
        Logger rootLogger = loggerContext.getLogger("ROOT");

        // 移除 ConsoleAppender
        removeConsoleAppender(rootLogger);

        // 添加 FileAppender
        addFileAppender(loggerContext, rootLogger);
    }

    private void removeConsoleAppender(Logger rootLogger) {
        Iterator<Appender<ILoggingEvent>> iterator = rootLogger.iteratorForAppenders();
        while (iterator.hasNext()) {
            Appender<ILoggingEvent> appender = iterator.next();
            if (appender instanceof ConsoleAppender) {
                rootLogger.detachAppender(appender);
                appender.stop();
            }
        }
    }

    private void addFileAppender(LoggerContext context, Logger rootLogger) {
        // 創(chuàng)建 FileAppender
        FileAppender<ILoggingEvent> fileAppender = new FileAppender<>();
        fileAppender.setContext(context);
        fileAppender.setFile("./log/seller.log");

        // 設(shè)置日志輸出格式
        PatternLayoutEncoder encoder = new PatternLayoutEncoder();
        encoder.setContext(context);
        encoder.setPattern("%d{yyyy-MM-dd HH:mm:ss} - %msg%n");
        encoder.start();

        fileAppender.setEncoder(encoder);
        fileAppender.start();

        // 添加到 rootLogger
        rootLogger.addAppender(fileAppender);
    }
}

二、設(shè)置日志輸出級別

Logback的日志輸出有所謂級別：Level: FATAL 0 ERROR 3 WARN 4 INFO 6 DEBUG 7

其中FATAL最高，DEBUG最低。級別越高，記錄到日志的機(jī)會就越小。如果設(shè)為DEBUG，可能日志內(nèi)容會很多。

這是我另外一個項(xiàng)目中，resources/logback-spring.xml的部分內(nèi)容

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false" scan="false">
	。。。
    <!-- Level: FATAL 0  ERROR 3  WARN 4  INFO 6  DEBUG 7 -->
    <root level="warn">
        <appender-ref ref="console"/>
        <appender-ref ref="debug"/>
        <appender-ref ref="error"/>
    </root>
</configuration>