Logbackadditivity原理及控制台关闭技巧

学习文章要努力，但是不要急！今天的这篇文章《Logback additivity原理与控制台输出关闭方法》将会介绍到等等知识点，如果你想深入学习文章，可以关注我！我会持续更新相关文章的，希望对大家都能有所帮助！

本文深入探讨Logback在未显式配置ConsoleAppender时，日志仍输出到控制台的常见问题。核心在于Logback的additivity（累加性）特性。通过编程设置logger.setAdditive(false)，可以有效阻止日志事件向上层Logger传递并触发其关联的Appender（包括Logback的默认控制台输出），从而实现精确控制日志的输出目标。

Logback的默认行为与Appender累加性

在使用Logback作为日志框架时，开发者有时会遇到一个看似矛盾的现象：即使没有在配置中显式声明ConsoleAppender，日志消息仍然会输出到控制台。与此同时，如果程序中通过代码动态添加了其他Appender（例如RollingFileAppender），日志也会同时写入文件。这种双重输出的根源在于Logback的两个核心机制：默认配置和Appender的累加性（additivity）。

1. 默认配置： 当Logback在classpath中找不到任何名为logback.xml或logback-test.xml的配置文件时，它会退回到其默认配置。这个默认配置非常简单，它会自动创建一个关联到根Logger的ConsoleAppender。这意味着，即使你没有编写任何Logback配置，你的日志消息也会默认打印到标准输出。
2. Appender累加性（Additivity）： 这是理解此问题的关键。Logback（以及Log4j等日志框架）中的Logger是分层的，形成一个树状结构。当一个日志事件（例如log.info("message")）被某个Logger处理时，该事件不仅会由当前Logger自身关联的所有Appender进行处理，还会根据additivity属性的设置，向上层Logger（即父Logger）传递。这个过程会一直持续到根Logger。每个被传递到的Logger，都会再次由其关联的所有Appender处理该日志事件。additivity属性的默认值是true。

因此，当你的代码动态创建了一个Logger并为其添加了一个RollingFileAppender时，由于additivity默认为true，该Logger处理的日志事件会向上冒泡，最终到达根Logger。而根Logger在默认情况下（或通过其他配置）通常关联着一个ConsoleAppender，从而导致日志消息在控制台和文件中同时出现。

解决方案：禁用Logger的Additivity特性

要解决这个问题，即只将日志输出到自定义的Appender（如文件），而阻止其传递到父Logger（包括默认的根Logger及其ConsoleAppender），我们需要显式地禁用Logger的additivity特性。这可以通过调用Logger实例的setAdditive(false)方法来实现。

当logger.setAdditive(false)被设置后，该Logger处理的任何日志事件将不会再向上层Logger传递。这意味着日志事件将只由当前Logger所关联的Appender进行处理，从而有效地切断了与默认ConsoleAppender的联系。

编程实践示例

以下是一个完整的Java代码示例，演示了如何通过编程方式配置Logback，并禁用additivity以确保日志只输出到文件而不输出到控制台：

import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.encoder.PatternLayoutEncoder;
import ch.qos.logback.core.rolling.RollingFileAppender;
import ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy;
import ch.qos.logback.core.spi.ContextAwareBase;
import ch.qos.logback.core.util.FileSize;
import org.slf4j.LoggerFactory;

public class LogbackFileOnlyConfigurator {

    private String logFilePath = "logs/application.log";
    private Level logLevel = Level.INFO;
    private LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();

    /**
     * 初始化并配置指定名称的Logger。
     *
     * @param logName 要配置的Logger名称。
     */
    public void initializeLogging(final String logName) {
        // 获取Logger实例
        final Logger logger = loggerContext.getLogger(logName);
        logger.setLevel(this.logLevel);

        // 核心步骤：禁用Logger的additivity特性
        // 这将阻止日志事件传递给父Logger，从而避免默认的控制台输出
        logger.setAdditive(false);

        // 设置文件日志Appender
        setupFileLogging(logger);

        // 示例日志输出
        logger.info("This is an INFO message, should only go to file.");
        logger.debug("This is a DEBUG message (if level permits), should only go to file.");
        logger.warn("A warning message, also to file only.");
    }

    /**
     * 配置一个滚动文件Appender。
     *
     * @param logger 目标Logger。
     */
    private void setupFileLogging(final Logger logger) {
        // 创建RollingFileAppender
        RollingFileAppender<ch.qos.logback.classic.spi.ILoggingEvent> rollingFileAppender = new RollingFileAppender<>();
        rollingFileAppender.setContext(loggerContext); // 必须设置context
        rollingFileAppender.setName("FILE-" + logger.getName()); // 为Appender命名
        rollingFileAppender.setFile(this.logFilePath);

        // 设置日志编码器
        PatternLayoutEncoder encoder = new 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);

        // 设置滚动策略
        SizeAndTimeBasedRollingPolicy<ch.qos.logback.classic.spi.ILoggingEvent> rollingPolicy = new SizeAndTimeBasedRollingPolicy<>();
        rollingPolicy.setContext(loggerContext);
        rollingPolicy.setParent(rollingFileAppender); // 关联到Appender
        rollingPolicy.setFileNamePattern("logs/archive/application-%d{yyyy-MM-dd}.%i.log.gz"); // 归档文件名模式
        rollingPolicy.setMaxFileSize(FileSize.valueOf("10MB")); // 单个文件最大10MB
        rollingPolicy.setMaxHistory(30); // 保留30天历史文件
        rollingPolicy.setTotalSizeCap(FileSize.valueOf("1GB")); // 所有归档文件总大小限制
        rollingPolicy.start(); // 启动滚动策略

        rollingFileAppender.setRollingPolicy(rollingPolicy);
        rollingFileAppender.start(); // 启动Appender

        // 将Appender添加到Logger
        logger.addAppender(rollingFileAppender);
    }

    public static void main(String[] args) {
        LogbackFileOnlyConfigurator configurator = new LogbackFileOnlyConfigurator();
        // 初始化一个名为"com.example.MyApp"的Logger
        configurator.initializeLogging("com.example.MyApp");

        // 如果需要，也可以配置其他Logger，它们同样不会输出到控制台
        Logger anotherLogger = configurator.loggerContext.getLogger("com.example.AnotherModule");
        anotherLogger.setLevel(Level.DEBUG);
        anotherLogger.setAdditive(false); // 同样禁用additivity
        // 为anotherLogger添加一个单独的Appender，或者复用上面的文件Appender
        // anotherLogger.addAppender(configurator.getFileAppenderForLogger(anotherLogger)); // 假设有一个方法可以获取或创建Appender

        anotherLogger.info("This is a message from another module, also file only.");
        anotherLogger.debug("This is a debug message from another module.");

        // 关闭LoggerContext以确保所有Appender正确关闭
        ((LoggerContext) LoggerFactory.getILoggerFactory()).stop();
    }
}

代码说明：

• loggerContext.getLogger(logName)：获取或创建指定名称的Logger。
• logger.setLevel(this.logLevel)：设置Logger的日志级别。
• logger.setAdditive(false)：这是解决问题的关键。它指示Logback，该Logger的日志事件不应传递给其父Logger。
• RollingFileAppender的配置：展示了如何设置文件路径、编码器和滚动策略，以实现日志的按文件大小和时间滚动归档。
• appender.setContext(loggerContext)和encoder.setContext(loggerContext)：在编程配置Appender和Encoder时，务必设置它们的Context，通常是LoggerContext实例。
• appender.start()和encoder.start()：在Appender和Encoder配置完成后，需要调用start()方法来初始化和激活它们。

注意事项

• 配置优先级： 如果你的项目中同时存在logback.xml或logback-test.xml配置文件，那么这些文件的配置将优先于编程方式的默认配置。在这种情况下，你需要确保配置文件中没有为你的Logger或其父Logger设置additivity="true"（或不设置，因为默认就是true），或者显式地设置为additivity="false"。
• 根Logger： 即使你为某个特定的Logger设置了additivity=false，这只影响该Logger及其子Logger的事件传递行为。根Logger（root logger）通常是Logger层次结构的顶端，它默认拥有ConsoleAppender。如果你希望完全禁用所有日志的控制台输出，并且不使用配置文件，你可能需要更精细地控制根Logger。但在多数情况下，为应用程序特定的Logger设置additivity=false已足够。
• 层次结构理解： 深入理解Logback的Logger层次结构和Appender的工作原理，是解决这类问题的基础。Logger的名称通常是点分隔的（如com.example.MyApp），这决定了它们的父子关系。

总结

Logback在未显式配置ConsoleAppender时仍输出日志到控制台，是由于其默认配置和Logger的additivity特性共同作用的结果。通过在编程中为特定的Logger调用setAdditive(false)方法，可以有效地阻止日志事件向上传递到父Logger（包括根Logger），从而避免不必要的控制台输出，实现对日志流向的精确控制。理解并恰当利用additivity特性，是Logback高级配置和故障排查的关键。

到这里，我们也就讲完了《Logbackadditivity原理及控制台关闭技巧》的内容了。个人认为，基础知识的学习和巩固，是为了更好的将其运用到项目中，欢迎关注golang学习网公众号，带你了解更多关于的知识点！