本文旨在解决logback配置中日志文件不写入的常见问题。核心原因通常在于Appender与Logger的关联不当，特别是根Logger与特定Logger的配置冲突。教程将深入解析Logback的日志层级、Appender引用机制及additivity属性，并提供正确的配置示例，同时提醒gradle依赖管理中的潜在陷阱，确保日志能按预期输出到文件。
理解 Logback 的核心组件：Appender 与 Logger
logback 作为流行的Java日志框架，其核心在于logger（日志记录器）和appender（输出目的地）的协同工作。logger负责捕获和过滤日志事件，而appender则定义了这些事件的输出方式和位置，例如控制台、文件或数据库。一个logger可以引用一个或多个appender，将日志事件发送到不同的目的地。
在Logback配置中，通常会定义至少一个ConsoleAppender用于控制台输出，以及一个或多个FileAppender（如RollingFileAppender）用于文件输出。
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</pattern> </encoder> </appender> <appender name="LOGFILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>/mnt/test/testLog.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> <fileNamePattern>/mnt/test/testLog_%i.log</fileNamePattern> <minIndex>1</minIndex> <maxIndex>10</maxIndex> </rollingPolicy> <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <maxFileSize>10MB</maxFileSize> </triggeringPolicy> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</pattern> </encoder> </appender>
上述配置定义了一个名为STDOUT的控制台Appender和一个名为LOGFILE的文件Appender，后者配置了基于大小和文件数量的滚动策略。
日志不写入文件的常见原因：Appender 引用与日志层级
日志文件不写入的常见问题往往出在Logger对Appender的引用方式上，尤其是涉及到root Logger和特定命名Logger的配置。
Logback中的Logger具有层级结构，例如org.test.abc是org.test的子Logger。日志事件会从特定的Logger向上冒泡（如果additivity属性为true）到其父Logger，直到根Logger（root）。
考虑以下Logger配置：
<logger name="weblogic" level="INFO" additivity="false"> <appender-ref ref="LOGFILE"/> </logger> <root level="INFO"> <appender-ref ref="STDOUT" /> </root>
在这种配置下，LOGFILE Appender仅被名为weblogic的Logger引用。这意味着只有通过org.slf4j.LoggerFactory.getLogger(“weblogic”)或其子Logger记录的日志事件，才会被发送到/mnt/test/testLog.log文件。
同时，weblogic Logger的additivity属性被设置为false，这表示其日志事件不会向上冒泡到父Logger。因此，即使有weblogic相关的日志，它们也只会流向LOGFILE，而不会到达root Logger。
另一方面，root Logger只引用了STDOUT Appender。由于大多数应用程序日志通常通过未明确配置的Logger（或其父Logger）最终流向root Logger，因此所有这些日志事件都只会输出到控制台，而不会写入文件。如果应用程序中没有或极少有weblogic相关的日志输出，那么文件testLog.log自然会保持为空。
解决方案：正确关联 Appender 到 Logger
要确保日志能够写入文件，最直接的方法是将文件Appender关联到能够接收到大部分日志事件的Logger。通常，这意味着将其添加到root Logger中，以便所有满足根Logger级别的日志都能同时输出到控制台和文件。
方案一：将文件 Appender 添加到 root Logger
<?xml version="1.0" encoding="UTF-8"?> <configuration debug="false" scan="true"> <!-- ... Appender 定义部分保持不变 ... --> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</pattern> </encoder> </appender> <appender name="LOGFILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>/mnt/test/testLog.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> <fileNamePattern>/mnt/test/testLog_%i.log</fileNamePattern> <minIndex>1</minIndex> <maxIndex>10</maxIndex> </rollingPolicy> <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <maxFileSize>10MB</maxFileSize> </triggeringPolicy> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</pattern> </encoder> </appender> <!-- 修正后的 Logger 配置 --> <logger name="weblogic" level="INFO" additivity="false"> <appender-ref ref="LOGFILE"/> </logger> <logger name="org.apache" level="ERROR" /> <logger name="httpclient" level="ERROR" /> <logger name="org.test.abc" level="INFO" /> <root level="INFO"> <appender-ref ref="STDOUT" /> <appender-ref ref="LOGFILE" /> <!-- 将 LOGFILE 也添加到 root Logger --> </root> </configuration>
通过将LOGFILE Appender引用添加到root Logger，所有级别为INFO及以上的日志事件（除了那些被特定Logger的additivity=”false”阻止的）都将同时输出到控制台和文件。
方案二：为特定模块配置独立的日志文件
如果只想将特定模块的日志写入文件，而不影响root Logger，可以为该模块创建独立的Logger并引用文件Appender。例如，只记录org.test.abc包下的日志到文件：
<logger name="org.test.abc" level="INFO" additivity="false"> <appender-ref ref="LOGFILE"/> </logger> <root level="INFO"> <appender-ref ref="STDOUT" /> </root>
这种情况下，org.test.abc的日志将只写入testLog.log，而其他所有日志（未被特定Logger捕获的）将通过root Logger输出到控制台。注意additivity=”false”的重要性，它确保org.test.abc的日志不会再次冒泡到root Logger并被重复输出到控制台。
Gradle 依赖管理注意事项
虽然本例中的主要问题是Logback配置，但正确的依赖管理同样至关重要。原始Gradle配置中logback-classic被声明为testImplementation：
testImplementation 'ch.qos.logback:logback-classic:0.9.26'
testImplementation表示该依赖仅在测试编译和运行时可用。如果应用程序需要在生产或运行时进行日志记录，logback-classic必须作为implementation依赖引入：
implementation 'ch.qos.logback:logback-classic:0.0.0' // 使用合适的版本
否则，在运行时可能找不到Logback的类，导致日志功能完全失效或行为异常。尽管示例中日志已在控制台输出，这可能意味着其他implementation依赖间接引入了logback-classic（例如spring Boot应用通常会这样做），但明确声明为implementation是最佳实践，以避免潜在的运行时问题。
总结与故障排除
-
检查 Appender 引用： 确保你希望写入文件的Appender被正确的Logger（通常是root Logger或你关注的特定业务Logger）引用。
-
理解 additivity： additivity=”false”会阻止日志事件向上冒泡到父Logger。谨慎使用，确保不会意外地阻止日志输出到预期目的地。
-
Logback 内部状态： 在
标签中设置debug=”true”可以输出Logback的内部状态信息，这对于调试配置问题非常有帮助。 <configuration debug="true" scan="true"> <!-- ... --> </configuration>
-
文件权限与路径： 确保Logback有权限在指定路径（如/mnt/test/）创建和写入文件，并且该目录确实存在。权限不足或路径错误是常见的外部因素。
-
日志级别： 确保Logger的级别（如INFO）低于或等于实际记录的日志事件级别。如果Logger级别设置为WARN，那么INFO级别的日志将不会被处理。
通过以上步骤和注意事项，可以有效诊断并解决Logback日志不写入文件的问题，确保应用程序的日志功能正常运行。
