17370845950

本文旨在解决 Logback 在未配置 ConsoleAppender 的情况下仍然将日志输出到控制台的问题。通过设置 Logger 的 additivity 属性为 false，可以阻止日志消息传递到 root logger，从而避免控制台输出，实现只将日志写入文件的目的。本文将详细介绍如何通过代码配置 Logback，并提供示例代码和注意事项。

在使用 Logback 进行日志管理时，有时会遇到即使没有显式配置 ConsoleAppender，日志仍然会输出到控制台的情况。这通常是因为 Logback 的 logger 具有层级结构，默认情况下，子 logger 会将日志事件传递给父 logger，直到根 logger。而根 logger 默认配置了 ConsoleAppender，因此会导致日志同时输出到文件和控制台。

要解决这个问题，关键在于理解 Logback 的 additivity 属性。additivity 属性决定了 logger 是否将日志事件传递给父 logger。默认情况下，additivity 为 true，这意味着日志事件会沿着 logger 树向上冒泡，直到根 logger。

解决方案：设置 additivity 属性为 false

要禁止 Logback 将日志输出到控制台，只需将目标 logger 的 additivity 属性设置为 false 即可。通过代码配置 Logback 时，可以在初始化 logger 后，设置 additivity 属性。

以下是一个示例代码，展示了如何配置 Logback，使其只将日志写入文件，而不在控制台输出：

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

public class LogbackConfiguration {

    private RollingFileAppender rollingFileAppender;
    private String logFilePath;
    private ch.qos.logback.classic.Level logLevel;
    private LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();

    public void initilizeLogging(final String logName) {
        final Logger log = (Logger) lc.getLogger(logName);
        log.setLevel(this.logLevel);

        setupFileLogging(log, this.lc);
        // 关键步骤：设置 additivity 为 false
        log.setAdditive(false);
    }

    private void setupFileLogging(final Logger log, final LoggerContext loggerContext) {
        rollingFileAppender = new RollingFileAppender<>();
        rollingFileAppender.setContext(loggerContext);
        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 rollingpolicy = new SizeAndTimeBasedRollingPolicy<>();
        rollingpolicy.setContext(loggerContext);
        rollingpolicy.setFileNamePattern(this.logFilePath + ".%d{yyyy-MM-dd}.%i.log");
        rollingpolicy.setMaxFileSize("10MB");
        rollingpolicy.setTotalSizeCap("20GB");
        rollingpolicy.setParent(rollingFileAppender);
        rollingpolicy.start();

        rollingFileAppender.setRollingPolicy(rollingpolicy);
        rollingFileAppender.start();

        log.addAppender(rollingFileAppender);
    }

    public void setLogFilePath(String logFilePath) {
        this.logFilePath = logFilePath;
    }

    public void setLogLevel(ch.qos.logback.classic.Level logLevel) {
        this.logLevel = logLevel;
    }

    public static void main(String[] args) {
        LogbackConfiguration config = new LogbackConfiguration();
        config.setLogFilePath("my-app.log");
        config.setLogLevel(ch.qos.logback.classic.Level.INFO);
        config.initilizeLogging("my-app-logger");

        Logger logger = (Logger) LoggerFactory.getLogger("my-app-logger");
        logger.info("This message will only be written to the file.");
    }
}

代码解释：

1. log.setAdditive(false);: 这行代码是关键，它阻止了 my-app-logger 将日志事件传递给父 logger (通常是 root logger)。
2. RollingFileAppender: 配置了一个 RollingFileAppender，用于将日志写入文件，并设置了滚动策略，以避免日志文件过大。
3. PatternLayoutEncoder: 用于设置日志输出的格式。

注意事项：

• 确保你的 Logback 依赖已正确添加到项目中。
• logFilePath 应该设置为一个有效的路径。
• logLevel 应该设置为你需要的日志级别 (例如，INFO, DEBUG, ERROR)。
• 如果使用了 Logback 的 XML 配置文件，可以在配置文件中设置 。

总结：

通过将 Logback logger 的 additivity 属性设置为 false，可以有效地控制日志的输出目标，避免不必要的控制台输出，从而实现只将日志写入文件的目的。这在需要保持控制台清洁，或者在生产环境中避免敏感信息暴露在控制台的情况下非常有用。