Log4j中DailyRollingFileAppender日志文件清理策略

创作背景

log4j作为使用最广的日志框架，他的简单易用高效一直深受同行们的喜爱！但他的清理策略却十分缺乏，只有在RollingFileAppender中可以通过设置maxBackupIndex属性指定要保留的日志文件数的最大值来达到清理效果！

日志清理策略：[百度知道]

因开发需要，日志打印方式常常会采用DailyRollingFileAppender来实现按天打印或者按月打印等方式，而这种方式却是没有对应的清理策略的，这就需要重新实现DailyRollingFileAppender！

创作过程

创作之前必定会有一番疯狂的百度，毕竟只有站在前人的肩膀才能看得更远。然而在前人的创作成果并不能完全的满足需求的前提下 ，只能自己构思一个方案！
流程图如下：

依照流程图，主要修改了rollover()方法：

void rollOver() throws IOException {

    if (datePattern == null) {
        errorHandler.error("Missing DatePattern option in rollOver().");
        return;
    }

    String datedFilename = fileName+sdf.format(now);

    //如果最后一次的修改时间为当前时间 ，则不做任何任何操作
    if (scheduledFilename.equals(datedFilename)) {
        return;
    }

    // 关闭当前文件，重命名为日期文件
    this.closeFile();

    File target= new File(scheduledFilename);
    if (target.exists()) {
        target.delete();
    }

    File file = new File(fileName);
    boolean result = file.renameTo(target);
    if(result) {
        LogLog.debug(fileName +" -> "+ scheduledFilename);
    } else {
        LogLog.error("Failed to rename ["+fileName+"] to ["+scheduledFilename+"].");
    }

    //获取日志文件列表，控制数量，实现清理策略
    if (file.getParentFile().exists()){
        File[] files = file.getParentFile().listFiles(new LogFileFilter(file.getName()));
        Long[] dateArray = new Long[files.length];
        for (int i = 0; i < files.length; i++) {
            File fileItem = files[i];
            String fileDateStr = fileItem.getName().replace(file.getName(), "");
            Date filedate = null;
            try {
                filedate = sdf.parse(fileDateStr);
                long fileDateLong = filedate.getTime();
                dateArray[i] = fileDateLong;
            } catch (ParseException e) {
                LogLog.error("Parse File Date Throw Exception : " + e.getMessage());
            }
        }
        Arrays.sort(dateArray);
        if (dateArray.length > maxBackupIndex) {
            for (int i = 0; i < dateArray.length - maxBackupIndex; i++) {
                String dateFileName = file.getPath() + sdf.format(dateArray[i]);
                File dateFile = new File(dateFileName);
                if (dateFile.exists()) {
                    dateFile.delete();
                }
            }
        }
    }

    try {
        // This will also close the file. This is OK since multiple close operations are safe.
        this.setFile(fileName, true, this.bufferedIO, this.bufferSize);
    }
    catch(IOException e) {
        errorHandler.error("setFile("+fileName+", true) call failed.");
    }
    scheduledFilename = datedFilename;
}

创作要点

1. 新增参数maxBackupIndex，表示保留的文件数，默认值为1
2. 直接使用DatePattern作为SimpleDateFormat的参数，这样可以完美支持DailyRollingFileAppender所支持的所有打印周期
3. 实现FileFilter用于提高日志文件列表读取的效率
4. 将日志文件（如“web.log.2016-01-12”）后缀的日期格式（如“2016-01-12”）转换成long类型进行排序，实现排序的准确性
5. 转换成long类型时进行一场捕获：

try {
    filedate = sdf.parse(fileDateStr);
    long fileDateLong = filedate.getTime();
    dateArray[i] = fileDateLong;
} catch (ParseException e) {
    LogLog.error("Parse File Date Throw Exception : " + e.getMessage());
}

当日志列表中出现如“web.log.2016-01-12.bak”的情况时，可以忽略该文件！
6. 只在新建日志文件时运行清理策略，提高程序运行效率

附上代码

首先是重新实现的DailyRollingFileAppender源码：

package org.apache.log4j;

import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import