JAVA 项目使用 Logback 日志文件不滚动？RollingPolicy 配置实战 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

好的，现在开始我们的Logback滚动策略实战讲座。今天我们聚焦一个很常见但又容易让人头疼的问题：JAVA项目使用Logback，但日志文件不滚动。我们会深入分析各种原因，并提供切实可行的解决方案和最佳实践。

Logback滚动策略问题诊断

首先，我们需要明确“不滚动”具体指的是什么？它可能表现为以下几种情况：

日志文件一直增长，没有新的文件生成。 这通常意味着滚动策略根本没有生效。
日志文件只生成一个，但大小超过了设定的阈值，却没有进行切割。 这表明滚动触发条件没有满足。
日志文件生成了多个，但是旧的文件没有被删除。 这说明清理策略配置有问题。
滚动发生，但是滚动后的文件名不符合预期。 这说明滚动文件名的配置不正确。

在深入代码之前，我们需要先了解Logback滚动策略的核心组件：

<appender>: 定义日志输出目的地，例如文件、控制台等。
<rollingPolicy>: 定义日志文件滚动的策略，例如何时滚动、如何命名滚动后的文件。
<triggeringPolicy>: 定义何时触发滚动。这通常是基于文件大小或时间。
<encoder>: 定义日志的格式。
<filter>: 过滤需要记录的日志级别。

问题排查与解决思路

接下来，我们将针对上述四种情况，分别提供排查思路和解决方案。

1. 滚动策略根本没有生效

这种情况下，首先要确保<rollingPolicy>被正确配置，并且<appender>中引用了该策略。最常见的错误是忘记在<appender>中添加<rollingPolicy>。

检查配置文件结构: 确保<rollingPolicy>是<appender>的子元素。

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/app.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>logs/app.%d{yyyy-MM-dd}.log</fileNamePattern>
        <maxHistory>30</maxHistory>
    </rollingPolicy>
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
</appender>

检查root或logger是否引用了该appender: 如果没有引用，日志根本不会输出到该appender，滚动自然也不会发生。
```
<root level="INFO">
    <appender-ref ref="FILE"/>
</root>
```
检查Logback配置文件的加载: 确保Logback配置文件被正确加载。如果使用Spring Boot，默认会自动加载logback-spring.xml或logback.xml。如果使用其他框架，需要显式地配置Logback的加载。可以通过添加以下代码来检查Logback是否正确加载：
```
import org.slf4j.LoggerFactory;
import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.core.util.StatusPrinter;

public class LogbackConfigChecker {
    public static void main(String[] args) {
        LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();
        StatusPrinter.print(lc);
    }
}
```
运行这段代码，Logback会打印出配置文件的加载状态信息，可以帮助你诊断是否加载成功。

2. 文件大小超过阈值，但没有切割

这通常是<triggeringPolicy>配置不正确导致的。常用的<triggeringPolicy>有两种：SizeBasedTriggeringPolicy (基于文件大小) 和 TimeBasedRollingPolicy (基于时间)。

使用SizeBasedTriggeringPolicy: 确保maxFileSize属性被正确设置。

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/app.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
        <fileNamePattern>logs/app.%i.log.zip</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.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
</appender>

检查<maxFileSize>的值是否合理。注意大小写，单位可以是 KB, MB, GB. 例如 10MB 表示 10兆字节。

使用TimeBasedRollingPolicy: 确保fileNamePattern属性包含了时间占位符。

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/app.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>logs/app.%d{yyyy-MM-dd}.log</fileNamePattern>
        <maxHistory>30</maxHistory>
    </rollingPolicy>
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
</appender>

%d{yyyy-MM-dd}表示每天滚动一次。常见的日期格式包括：

%d{yyyy-MM-dd}: 每天滚动
%d{yyyy-MM-dd HH}: 每小时滚动
%d{yyyy-MM-dd HH:mm}: 每分钟滚动
%d{yyyy-MM}: 每月滚动

如果缺少时间占位符，Logback将无法正确地创建新的日志文件，导致滚动失败。如果使用了TimeBasedRollingPolicy，并且希望也能够基于文件大小进行滚动，可以使用TimeBasedRollingPolicy结合SizeAndTimeBasedFNATP。

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/app.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>logs/app.%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern>
        <maxHistory>30</maxHistory>
        <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
            <maxFileSize>10MB</maxFileSize>
        </timeBasedFileNamingAndTriggeringPolicy>
    </rollingPolicy>
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
</appender>

这个配置表示每天滚动一次，并且当文件大小超过10MB时也会滚动。 %i 是索引占位符，用于区分同一天内多次滚动产生的文件。

3. 旧的文件没有被删除

这个问题通常与<maxHistory>属性有关。<maxHistory>定义了保留的最大日志文件数量。超过这个数量的旧文件会被自动删除。

检查<maxHistory>是否设置: 如果没有设置，或者设置为0，Logback将不会删除任何旧文件。

<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    <fileNamePattern>logs/app.%d{yyyy-MM-dd}.log</fileNamePattern>
    <maxHistory>30</maxHistory>  <!-- 保留30天的日志 -->
</rollingPolicy>

检查文件目录权限: 确保Logback进程有权限删除旧文件。如果没有权限，删除操作将会失败，导致旧文件一直保留。
检查文件是否被占用: 如果旧的日志文件被其他进程占用，Logback可能无法删除它们。可以使用一些工具来查看哪些进程正在访问这些文件，例如 Windows 的 "资源监视器" 或 Linux 的 "lsof" 命令。

4. 滚动后的文件名不符合预期

<fileNamePattern>属性定义了滚动后的文件名格式。如果文件名不符合预期，需要检查<fileNamePattern>的配置。

检查占位符是否正确: 确保使用了正确的占位符。例如，%d{yyyy-MM-dd} 表示日期，%i 表示索引。
```
<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
    <fileNamePattern>logs/app.%i.log.zip</fileNamePattern>
    <minIndex>1</minIndex>
    <maxIndex>10</maxIndex>
</rollingPolicy>
```
这个配置表示使用固定窗口滚动策略，文件名格式为 app.1.log.zip, app.2.log.zip 等。

检查压缩配置: 如果希望滚动后的文件被压缩，需要确保文件名以 .gz 或 .zip 结尾。

<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    <fileNamePattern>logs/app.%d{yyyy-MM-dd}.log.gz</fileNamePattern>
    <maxHistory>30</maxHistory>
</rollingPolicy>

这个配置表示滚动后的文件会被压缩成 .gz 格式。

常见滚动策略配置示例

为了帮助大家更好地理解，这里提供一些常用的滚动策略配置示例。

1. 基于时间的滚动策略 (每天滚动)

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/app.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>logs/app.%d{yyyy-MM-dd}.log</fileNamePattern>
        <maxHistory>30</maxHistory>
    </rollingPolicy>
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
</appender>

属性	说明
`file`	当前日志文件的名称。
`fileNamePattern`	滚动后日志文件的名称模式，`%d{yyyy-MM-dd}` 表示日期占位符，每天滚动一次。
`maxHistory`	保留的最大日志文件数量，超过这个数量的旧文件会被自动删除。

2. 基于大小的滚动策略 (每个文件10MB，最多保留10个文件)

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/app.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
        <fileNamePattern>logs/app.%i.log.zip</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.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
</appender>

属性	说明
`file`	当前日志文件的名称。
`fileNamePattern`	滚动后日志文件的名称模式，`%i` 表示索引占位符。
`minIndex`	滚动文件索引的最小值。
`maxIndex`	滚动文件索引的最大值，表示最多保留多少个滚动文件。
`maxFileSize`	触发滚动的最大文件大小。

3. 基于时间和大小的滚动策略 (每天滚动，且每个文件最大10MB)

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/app.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>logs/app.%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern>
        <maxHistory>30</maxHistory>
        <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
            <maxFileSize>10MB</maxFileSize>
        </timeBasedFileNamingAndTriggeringPolicy>
    </rollingPolicy>
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
</appender>

属性	说明
`file`	当前日志文件的名称。
`fileNamePattern`	滚动后日志文件的名称模式，`%d{yyyy-MM-dd}` 表示日期占位符，`%i` 表示索引占位符。
`maxHistory`	保留的最大日志文件数量，超过这个数量的旧文件会被自动删除。
`maxFileSize`	触发滚动的最大文件大小。当文件大小超过这个值时，即使未到每天的滚动时间，也会触发滚动。

其他注意事项

同步问题: 在高并发环境下，日志写入可能会出现同步问题，导致日志丢失或文件损坏。可以考虑使用异步Appender来提高性能和可靠性。

<appender name="ASYNC" class="ch.qos.logback.classic.AsyncAppender">
    <queueSize>512</queueSize>
    <discardingThreshold>0</discardingThreshold>
    <appender-ref ref="FILE" />
</appender>

<root level="INFO">
    <appender-ref ref="ASYNC"/>
</root>

性能优化: 滚动策略会影响日志写入的性能。选择合适的滚动策略，并根据实际情况进行调整。
监控和告警: 建议对日志文件进行监控，及时发现滚动策略的问题。可以设置告警，当日志文件大小异常或滚动失败时，及时通知相关人员。

Logback 滚动策略的问题解决思路

Logback滚动策略配置的关键在于理解各个组件的作用，并根据实际需求进行组合。遇到问题时，需要仔细检查配置文件，确认配置是否正确，并结合日志输出进行分析。通过以上步骤，相信你能够有效地解决Logback日志文件不滚动的问题。

配置的细微之处决定了日志滚动是否顺利

通过对Logback滚动策略的深入讲解，我们了解了如何诊断和解决日志文件不滚动的问题。合理配置<rollingPolicy>、<triggeringPolicy>和<maxHistory>等属性，可以实现灵活的日志滚动策略，保证系统的稳定运行。记住，配置的正确性是关键，细节决定成败。

发表回复 取消回复

发表回复取消回复