Logback关闭控制台日志，仅输出到文件

知识点掌握了，还需要不断练习才能熟练运用。下面golang学习网给大家带来一个文章开发实战，手把手教大家学习《Logback禁用控制台日志，只输出到文件》，在实现功能的过程中也带大家重新温习相关知识点，温故而知新，回头看看说不定又有不一样的感悟！

本文档旨在解决Logback在未配置ConsoleAppender的情况下，仍然将日志输出到控制台的问题。通过设置logger的additivity属性为false，可以有效地阻止日志信息继续向上级logger传递，从而实现仅将日志写入文件的目的，避免在控制台产生冗余信息。本文将详细介绍该解决方案，并提供相应的代码示例。

问题分析：

在使用Logback进行日志管理时，即使没有显式配置ConsoleAppender，日志仍然可能输出到控制台。这通常是由于Logback的logger层级结构和additivity（可加性）特性所导致的。默认情况下，logger的additivity属性为true，这意味着日志事件不仅会传递给当前logger的appender，还会继续向上级logger传递，直到到达root logger。如果root logger配置了ConsoleAppender，那么所有日志事件最终都会被输出到控制台。

解决方案：设置 additivity 为 false

要阻止日志输出到控制台，同时保留文件输出，可以将logger的additivity属性设置为false。 这将阻止日志事件向上级logger传递。

代码示例：

以下代码示例展示了如何在程序中设置logger的additivity属性：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.rolling.RollingFileAppender;
import ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy;

public class LoggingExample {

    private RollingFileAppender<ILoggingEvent> rollingFileAppender;
    private String logFilePath = "my_application.log"; // 示例日志文件路径
    private ch.qos.logback.classic.Level logLevel = ch.qos.logback.classic.Level.DEBUG; // 示例日志级别
    private LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();

    public void initializeLogging(final String logName) {
        ch.qos.logback.classic.Logger log = lc.getLogger(logName);
        log.setLevel(this.logLevel);

        setupFileLogging(log, this.lc);

        // 关键代码：设置 additivity 为 false
        log.setAdditive(false);
    }

    private void setupFileLogging(final ch.qos.logback.classic.Logger log, final LoggerContext loggerContext) {
        rollingFileAppender = new RollingFileAppender<>();
        rollingFileAppender.setContext(loggerContext); //需要设置context
        rollingFileAppender.setFile(this.logFilePath);

        SizeAndTimeBasedRollingPolicy<ILoggingEvent> rollingpolicy = new SizeAndTimeBasedRollingPolicy<>();
        rollingpolicy.setContext(loggerContext); //需要设置context
        rollingpolicy.setFileNamePattern(logFilePath + ".%d{yyyy-MM-dd}.%i.log");
        rollingpolicy.setMaxFileSize("10MB");
        rollingpolicy.setMaxHistory(30);
        rollingpolicy.setTotalSizeCap("1GB");
        rollingpolicy.setParent(rollingFileAppender);
        rollingpolicy.start();

        rollingFileAppender.setRollingPolicy(rollingpolicy);

        ch.qos.logback.classic.encoder.PatternLayoutEncoder encoder = new ch.qos.logback.classic.encoder.PatternLayoutEncoder();
        encoder.setContext(loggerContext);
        encoder.setPattern("%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n");
        encoder.start();

        rollingFileAppender.setEncoder(encoder);
        rollingFileAppender.start();

        log.addAppender(rollingFileAppender);
    }

    public static void main(String[] args) {
        LoggingExample example = new LoggingExample();
        example.initializeLogging("myLogger");

        Logger logger = LoggerFactory.getLogger("myLogger");
        logger.debug("This is a debug message.");
        logger.info("This is an info message.");
        logger.warn("This is a warning message.");
        logger.error("This is an error message.");
    }
}

注意事项：

• Logger名称： 确保你获取的是正确的logger实例。LoggerFactory.getLogger(logName)中的logName应该与你的应用中使用的logger名称一致。
• Root Logger配置： 即使设置了additivity为false，如果root logger配置了ConsoleAppender并且日志级别足够低，root logger仍然会接收到所有日志事件。在这种情况下，你需要修改root logger的配置，或者调整日志级别。
• 配置文件覆盖： 如果你的Logback配置是通过logback.xml或logback-test.xml文件加载的，那么代码中的设置可能会被配置文件中的设置覆盖。确保配置文件中没有覆盖additivity属性。
• Context设置： 在使用RollingFileAppender和SizeAndTimeBasedRollingPolicy时，必须设置context属性，否则会导致异常。

总结：

通过将logger的additivity属性设置为false，可以有效地阻止Logback将日志输出到控制台，从而实现仅将日志写入文件的目的。在实际应用中，请务必结合具体的Logback配置和应用场景，进行适当的调整和优化。 仔细检查logger的配置，确保没有其他因素导致日志输出到控制台。通过以上方法，可以有效控制Logback的日志输出行为，提高日志管理效率。

终于介绍完啦！小伙伴们，这篇关于《Logback关闭控制台日志，仅输出到文件》的介绍应该让你收获多多了吧！欢迎大家收藏或分享给更多需要学习的朋友吧~golang学习网公众号也会发布文章相关知识，快来关注吧！