Logback关闭控制台，保留文件日志配置

偷偷努力，悄无声息地变强，然后惊艳所有人！哈哈，小伙伴们又来学习啦~今天我将给大家介绍《Logback禁用控制台，保留文件日志设置》，这篇文章主要会讲到等等知识点，不知道大家对其都有多少了解，下面我们就一起来看一吧！当然，非常希望大家能多多评论，给出合理的建议，我们一起学习，一起进步！

理解Logback的默认行为与日志累加性

在使用Logback进行日志记录时，开发者可能会遇到一个常见场景：即使没有显式配置ConsoleAppender，日志信息仍然会出现在控制台上。同时，如果程序中配置了文件Appender，日志会同时输出到文件和控制台。这种行为的根源在于Logback的默认配置策略以及其核心概念——日志累加性（Additivity）。

1. 默认配置： 当Logback在classpath中找不到logback.xml或logback-test.xml配置文件时，它会回退到默认配置。这个默认配置通常会包括一个绑定到System.err的ConsoleAppender。这意味着，即使你没有手动配置，Logback也可能已经为你添加了一个控制台输出器。
2. 日志累加性（Additivity）： Logback中的Logger是分层的，形成一个树状结构。每个Logger都有一个名为additivity的布尔属性，其默认值为true。当一个Logger的additivity为true时，它不仅会将其日志事件发送到自己直接附加的Appender，还会将这些事件传递给其父Logger。父Logger收到事件后，也会将其发送到自己附加的Appender，并继续向上级父Logger传递，直到达到根Logger。根Logger是所有Logger的祖先，它没有父Logger，其additivity属性通常不影响事件的进一步传播，但它会处理所有到达它的事件。

因此，即使你为某个特定的Logger添加了RollingFileAppender，如果该Logger或其任何祖先Logger（包括根Logger）的additivity为true，并且其祖先Logger附加了ConsoleAppender（无论是默认的还是显式配置的），那么日志事件最终都会被ConsoleAppender处理，导致日志输出到控制台。

问题场景示例

考虑以下Java代码片段，它尝试通过编程方式配置一个RollingFileAppender来记录日志，但并未涉及ConsoleAppender：

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.util.FileSize;
import org.slf4j.LoggerFactory;

public class LoggingSetup {

    private String logFilePath = "logs/application.log";
    private Level logLevel = Level.INFO;

    public void initializeLogging(final String logName) {
        LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();
        final Logger log = lc.getLogger(logName);
        log.setLevel(this.logLevel);

        // 设置文件日志
        setupFileLogging(log, lc);

        // 记录一些日志
        log.info("This is an INFO message.");
        log.warn("This is a WARN message.");
        log.error("This is an ERROR message.");
    }

    private void setupFileLogging(final Logger log, final LoggerContext loggerContext) {
        // 创建并配置 RollingFileAppender
        RollingFileAppender<ch.qos.logback.classic.spi.ILoggingEvent> rollingFileAppender = new RollingFileAppender<>();
        rollingFileAppender.setContext(loggerContext);
        rollingFileAppender.setFile(this.logFilePath);
        rollingFileAppender.setName("FILE-" + log.getName());

        // 配置滚动策略
        SizeAndTimeBasedRollingPolicy<ch.qos.logback.classic.spi.ILoggingEvent> rollingPolicy = new SizeAndTimeBasedRollingPolicy<>();
        rollingPolicy.setContext(loggerContext);
        rollingPolicy.setParent(rollingFileAppender);
        rollingPolicy.setFileNamePattern("logs/application-%d{yyyy-MM-dd}.%i.log.gz");
        rollingPolicy.setMaxFileSize(FileSize.valueOf("10MB"));
        rollingPolicy.setMaxHistory(7); // 保留7天历史日志
        rollingPolicy.start();

        rollingFileAppender.setRollingPolicy(rollingPolicy);

        // 配置编码器
        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);

        rollingFileAppender.start();

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

    public static void main(String[] args) {
        new LoggingSetup().initializeLogging("com.example.myapp");
    }
}

运行上述代码后，你会发现日志不仅被写入了logs/application.log文件，还同时输出到了控制台。这是因为com.example.myapp这个Logger的additivity属性默认为true，它会将日志事件传递给其父Logger，直到根Logger。如果根Logger（或其祖先）默认附加了ConsoleAppender，那么这些事件就会被控制台处理。

解决方案：控制日志累加性

要解决这个问题，即只将日志输出到文件而不输出到控制台，我们需要显式地禁用特定Logger的日志累加性。这可以通过调用Logger实例的setAdditive(false)方法来实现。

当logger.setAdditive(false)被设置后，该Logger将不再将其日志事件传递给其父Logger。它只会将其日志事件发送到直接附加给它的Appender。

修正后的代码示例

在上述initializeLogging方法中添加一行代码即可解决问题：

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.util.FileSize;
import org.slf4j.LoggerFactory;

public class LoggingSetupCorrected {

    private String logFilePath = "logs/application.log";
    private Level logLevel = Level.INFO;

    public void initializeLogging(final String logName) {
        LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();
        final Logger log = lc.getLogger(logName);
        log.setLevel(this.logLevel);

        // 关键一步：禁用日志累加性，防止日志事件传递给父Logger
        log.setAdditive(false); 

        // 设置文件日志
        setupFileLogging(log, lc);

        // 记录一些日志
        log.info("This is an INFO message.");
        log.warn("This is a WARN message.");
        log.error("This is an ERROR message.");
    }

    private void setupFileLogging(final Logger log, final LoggerContext loggerContext) {
        // 创建并配置 RollingFileAppender
        RollingFileAppender<ch.qos.logback.classic.spi.ILoggingEvent> rollingFileAppender = new RollingFileAppender<>();
        rollingFileAppender.setContext(loggerContext);
        rollingFileAppender.setFile(this.logFilePath);
        rollingFileAppender.setName("FILE-" + log.getName());

        // 配置滚动策略
        SizeAndTimeBasedRollingPolicy<ch.qos.logback.classic.spi.ILoggingEvent> rollingPolicy = new SizeAndTimeBasedRollingPolicy<>();
        rollingPolicy.setContext(loggerContext);
        rollingPolicy.setParent(rollingFileAppender);
        rollingPolicy.setFileNamePattern("logs/application-%d{yyyy-MM-dd}.%i.log.gz");
        rollingPolicy.setMaxFileSize(FileSize.valueOf("10MB"));
        rollingPolicy.setMaxHistory(7); // 保留7天历史日志
        rollingPolicy.start();

        rollingFileAppender.setRollingPolicy(rollingPolicy);

        // 配置编码器
        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);

        rollingFileAppender.start();

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

    public static void main(String[] args) {
        new LoggingSetupCorrected().initializeLogging("com.example.myapp");
    }
}

通过添加log.setAdditive(false);这行代码，再次运行程序，你会发现日志将只被写入到logs/application.log文件，而控制台将不再有任何输出。

注意事项与最佳实践

• 配置文件优先： 对于大多数生产环境应用，强烈建议使用logback.xml或logback-test.xml进行日志配置。配置文件提供了更清晰、更易于维护的方式来管理Appender、Logger级别和累加性等设置。在配置文件中，可以通过来设置累加性。
• 根Logger的累加性： 根Logger（Root Logger）没有父Logger，因此其additivity属性通常不影响事件向上级传递，但它会处理所有到达它的事件。如果你想完全禁用所有Logger的控制台输出，并且不使用配置文件，你可能需要确保根Logger没有附加ConsoleAppender，或者为所有相关Logger设置additivity="false"。
• Logger层次结构： 理解Logger的命名和层次结构对于有效管理日志至关重要。例如，com.example.myapp是com.example的子Logger，com.example又是com的子Logger，最终都继承自根Logger。
• 动态配置： 编程方式配置Logback适用于需要根据运行时条件动态调整日志行为的场景，例如在测试环境中启用详细日志，或根据用户设置改变日志输出目标。

总结

Logback的日志累加性（additivity）是一个强大但有时容易被忽视的特性。它允许日志事件在Logger层次结构中传播，从而实现灵活的日志处理。然而，当开发者希望精确控制日志输出，例如仅将日志写入文件而不输出到控制台时，理解并正确使用logger.setAdditive(false)就变得至关重要。通过禁用特定Logger的累加性，我们可以有效地阻止日志事件向父Logger传播，从而避免不必要的控制台输出，实现更精细的日志管理。

好了，本文到此结束，带大家了解了《Logback关闭控制台，保留文件日志配置》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多文章知识！