Spring Boot中Logback实现单次运行独立日志并限制文件数与大小

你的需求是每次Spring Boot启动生成一个含启动时分秒的独立日志文件，同时限制日志目录的文件总数或总占用空间，直接用RollingFileAppender会导致单次运行内日志被拆分，不符合需求。以下是可行的实现方案：

核心思路 #

保持原有FileAppender生成单次运行的唯一日志文件，通过应用启动时自动清理旧日志的方式，实现数量或总大小限制。

方案1：限制日志文件最大数量 #

编写一个Spring组件，在应用启动后扫描日志目录，保留最新的N个日志文件，删除更早的文件。

步骤1：实现清理逻辑 #

创建一个Spring Bean，监听应用启动事件执行清理：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.event.ApplicationStartedEvent;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
import java.io.File;
import java.util.Arrays;
import java.util.Comparator;

@Component
public class LogFileCleaner {
    @Value("${log.path.folder}")
    private String logDirectory;
    @Value("${log.max.files:10}") // 默认保留10个日志文件，可自定义
    private int maxLogFiles;

    @EventListener(ApplicationStartedEvent.class)
    public void cleanOldLogs() {
        File dir = new File(logDirectory);
        if (!dir.exists() || !dir.isDirectory()) {
            return;
        }

        // 筛选所有.log后缀的日志文件
        File[] logFiles = dir.listFiles((d, fileName) -> fileName.endsWith(".log"));
        if (logFiles == null || logFiles.length <= maxLogFiles) {
            return;
        }

        // 按文件最后修改时间从旧到新排序，删除超出数量的旧文件
        Arrays.sort(logFiles, Comparator.comparingLong(File::lastModified));
        for (int i = 0; i < logFiles.length - maxLogFiles; i++) {
            logFiles[i].delete();
        }
    }
}

步骤2：添加配置参数 #

在application.properties中配置日志目录和最大保留数量：

log.path.folder=/your/actual/log/path
log.max.files=10 # 可根据需求调整保留的文件数量

方案2：限制日志文件夹总大小 #

同样通过自定义组件，扫描日志目录计算总占用空间，循环删除旧文件直到总大小符合限制。

步骤1：实现按大小清理逻辑 #

修改上述LogFileCleaner类，替换为按大小清理的逻辑：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.event.ApplicationStartedEvent;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
import java.io.File;
import java.util.Arrays;
import java.util.Comparator;

@Component
public class LogFileCleaner {
    @Value("${log.path.folder}")
    private String logDirectory;
    @Value("${log.max.total.size:1073741824}") // 默认1GB（字节），可自定义
    private long maxTotalSize;

    @EventListener(ApplicationStartedEvent.class)
    public void cleanOldLogsBySize() {
        File dir = new File(logDirectory);
        if (!dir.exists() || !dir.isDirectory()) {
            return;
        }

        File[] logFiles = dir.listFiles((d, fileName) -> fileName.endsWith(".log"));
        if (logFiles == null || logFiles.length == 0) {
            return;
        }

        // 按最后修改时间从旧到新排序
        Arrays.sort(logFiles, Comparator.comparingLong(File::lastModified));
        long currentTotalSize = calculateTotalLogSize(logFiles);

        // 循环删除旧文件，直到总大小低于限制值
        int fileIndex = 0;
        while (currentTotalSize > maxTotalSize && fileIndex < logFiles.length) {
            long fileSize = logFiles[fileIndex].length();
            logFiles[fileIndex].delete();
            currentTotalSize -= fileSize;
            fileIndex++;
        }
    }

    private long calculateTotalLogSize(File[] logFiles) {
        long total = 0;
        for (File file : logFiles) {
            total += file.length();
        }
        return total;
    }
}

步骤2：添加大小配置参数 #

在application.properties中配置总大小限制：

log.path.folder=/your/actual/log/path
log.max.total.size=1073741824 # 1GB，可改为536870912（512MB）等自定义值

注意事项 #

1. 原有Logback配置无需修改，依然保持FileAppender生成带启动时分秒的单日志文件
2. 清理逻辑在应用启动完成后执行，不会干扰当前运行的日志写入
3. 可同时结合数量和大小限制，在清理方法中先判断文件数量，再校验总大小

内容的提问来源于stack exchange，提问作者Lako12