Log4j扩展—保留最近指定个数的日志文件（自动清理）

Log4j扩展—保留最近指定个数的日志文件（自动清理）1.概述：DailyRollingFileAppender和RollingFileAppender是日志记录软件包Log4J中的Appender，提供滚动日志记录文件的能力，通俗的说就是根据配置信息将指定级别的日志信息记录到文件中，并且可以配置一些个性化参数，比如：日志文件按天、周、月来记录生成或者限制日志文件的生成个数（项目部署到生产环境一般来说需要定期自动清理日志文件，防止日志文件占用空间过大，以至于影响项目的正常运行）。
①DailyRollingFileAppender：能够按一定的频度滚动日志记录文件。可以指定monthly(每月)、 weekly(每周)、daily(每天)、half-daily(每半天)、hourly(每小时)和minutely(每分钟)六个频度，这是通过为 DatePattern选项赋予不同的值来完成的。DatePattern选项的有效值为：

'.'yyyy-MM,对应monthly(每月)
'.'yyyy-ww,对应weekly(每周)
'.'yyyy-MM-dd,对应daily(每天)
'.'yyyy-MM-dd-a,对应half-daily(每半天)
'.'yyyy-MM-dd-HH,对应hourly(每小时)
'.'yyyy-MM-dd-HH-mm,对应minutely(每分钟)
DatePattern中不用处理的文字要放到单引号(')中，如上面的(.)
DatePattern格式化之后的文本将作为文件名字的后缀。DailyRollingFileAppender不支持格式化之后的文本作为文件名字的前缀。

DailyRollingFileAppender在每一个日志事件(LoggingEvent)附加(append)之前检查是否需要附加。也就是说如果在一个滚动区间中没有任何日志记录，那么这个区间的日志记录文件就不会形成。

②RollingFileAppender：使用MaxFileSize设置一个日志文件的最大大小，当产生多个日志时，会在日志名称后面加上".1"、".2"、……这样的后缀。RollingFileAppender有个属性MaxBackupIndex，这个属性通过限制日志文件名后缀".n"中的n大小来限制日志数量，比如上面MaxBackupIndex=10，其实最大日志数量为11。但是不支持DatePattern！！！

2.需求：很多情况下：我们需要日志文件名以日期为文件名后缀，这样查询起来非常方便，并且我们希望日志可以保留最近一段时间的日志。其余的日志自动删除。所有我们将DailyRollingFileAppender和RollingFileAppender的功能综合一下就可以达到相应效果。
思路：我们需要通过继承自FileAppender编写我们自己需要的Appender，阅读DailyRollingFileAppender和RollingFileAppender的源码后发现在rollOver方法中是滚动日志文件的方法，在方法中会判断当前是否需要重新生成一个日志文件，并且将之前的文件重命名。之所以叫滚动，即是说每次我们不断的将日志信息输出到文件，当达到我们设置的条件（比如限制了日志文件的大小或者DailyRollingFileAppender频度：monthly(每月)、 weekly(每周)、daily(每天)、half-daily(每半天)、hourly(每小时)和minutely(每分钟)）时，将这个日志文件重新命名（DailyRollingFileAppender则加上DatePattern，RollingFileAppender加上".1"、".2"、……这样的后缀），然后生成一个新的日志文件，以后的日志全部输出到这个新的日志文件中，当再一次达到条件时，循环上面的操作，就像是车轮滚动一圈回到原点再重新开始一样，所以叫做滚动。
综上所述，要达到我们的功能只需要在这个方法里面修改如下：①在对上一个日志文件进行重新命名时，根据DatePattern加上后缀②在需要重新生成一个日志文件时，我们遍历目录下所有的符合当前日志文件名前缀（就是配置的日志文件名，可用FileFilter实现过滤）的日志文件，然后按照时间升序排列，如果这个文件集合大于我们设置的要保留的文件个数，则将多余的文件从创建时间最早的文件开始删除（前面已经排序好了），保留最近的文件。
3.源代码：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 java.util.Arrays;
import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.Locale;
import java.util.TimeZone;

import org.apache.log4j.FileAppender;
import org.apache.log4j.Layout;
import org.apache.log4j.helpers.LogLog;
import org.apache.log4j.spi.LoggingEvent;

/**
* Log4j的扩展-保留最近指定个数的日志文件
* @author zhous
*
*/
public class MyDailyRollingFileAppender extends FileAppender{
static final int TOP_OF_TROUBLE =-1;
static final int TOP_OF_MINUTE = 0;
static final int TOP_OF_HOUR = 1;
static final int HALF_DAY = 2;
static final int TOP_OF_DAY = 3;
static final int TOP_OF_WEEK = 4;
static final int TOP_OF_MONTH = 5;

/**
* 默认设置："'.'yyyy-MM-dd"
* 设置说明：按天循环打印日志
*/
private String datePattern = "'.'yyyy-MM-dd";
private int maxBackupIndex = 1;
private String scheduledFilename;
/**下一次Rolling日志文件的时间*/
private long nextCheck = System.currentTimeMillis () - 1;
Date now = new Date();
SimpleDateFormat sdf;
RollingCalendar rc = new RollingCalendar();
int checkPeriod = TOP_OF_TROUBLE;
/**
* 获取当前环境所处的时区
* 仅供computeCheckPeriod方法使用
*/
static final TimeZone gmtTimeZone = TimeZone.getTimeZone("GMT");

public MyDailyRollingFileAppender() {}
public MyDailyRollingFileAppender (Layout layout, String filename, String datePattern) throws IOException {
super(layout, filename, true);
this.datePattern = datePattern;
activateOptions();
}
public String getDatePattern() {
return datePattern;
}
public void setDatePattern(String pattern) {
this.datePattern = pattern;
}
public int getMaxBackupIndex() {
return maxBackupIndex;
}
public void setMaxBackupIndex(int maxBackupIndex) {
this.maxBackupIndex = maxBackupIndex;
}

/**
* activateOptions译名为激活操作
* 意思是按照配置的参数进行初始化
* scheduledFilename为log的最后一次修改时间
*/
@Override
public void activateOptions() {
super.activateOptions();

if(datePattern != null && fileName != null) {
now.setTime(System.currentTimeMillis());
sdf = new SimpleDateFormat(datePattern);
int type = computeCheckPeriod();
printPeriodicity(type);
rc.setType(type);
File file = new File(fileName);
scheduledFilename = fileName+sdf.format(new Date(file.lastModified()));
} else {
LogLog.error("Either File or DatePattern options are not set for appender ["+name+"].");
}
}

// This method computes the roll over period by looping over the
// periods, starting with the shortest, and stopping when the r0 is
// different from from r1, where r0 is the epoch formatted according
// the datePattern (supplied by the user) and r1 is the
// epoch+nextMillis(i) formatted according to datePattern. All date
// formatting is done in GMT and not local format because the test
// logic is based on comparisons relative to 1970-01-01 00:00:00
// GMT (the epoch).
int computeCheckPeriod() {
RollingCalendar rollingCalendar = new RollingCalendar(gmtTimeZone, Locale.getDefault());
//设置初始时间为格林尼治时间：1970-01-01 00:00:00 GMT
Date epoch = new Date(0);
if(datePattern != null) {
for(int i = TOP_OF_MINUTE; i <= TOP_OF_MONTH; i++) {
//将所示的时间格式化为当前时区
SimpleDateFormat simpleDateFormat = new SimpleDateFormat(datePattern);
simpleDateFormat.setTimeZone(gmtTimeZone);

String r0 = simpleDateFormat.format(epoch);
rollingCalendar.setType(i);
Date next = new Date(rollingCalendar.getNextCheckMillis(epoch));
String r1 =simpleDateFormat.format(next);
//System.out.println("Type = "+i+", r0 = "+r0+", r1 = "+r1);
if(r0 != null && r1 != null && !r0.equals(r1)) {
return i;
}
}
}
return TOP_OF_TROUBLE; // Deliberately head for trouble...
}

/**
* 按照周期将当前日志文件转存为日期文件
*
* @throws IOException
*/
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;
}

/**
* 写入日志之前判断是否需要新起一个日志来记录
*/
@Override
protected void subAppend(LoggingEvent event) {
long n = System.currentTimeMillis();
if (n >= nextCheck) {
now.setTime(n);
nextCheck = rc.getNextCheckMillis(now);
try {
rollOver();
} catch(IOException ioe) {
if (ioe instanceof InterruptedIOException) {
Thread.currentThread().interrupt();
}
LogLog.error("rollOver() failed.", ioe);
}
}
super.subAppend(event);
}

/**
* 文件过滤器
*/
class LogFileFilter implements FileFilter {
private String logName;

public LogFileFilter(String logName) {
this.logName = logName;
}

@Override
public boolean accept(File file) {
if (logName == null || file.isDirectory()) {
return false;
} else {
LogLog.debug(file.getName());
return file.getName().startsWith(logName);
}
}
}

/**
* 根据type打印做出日志打印
* @param type
*/
void printPeriodicity(int type) {
switch(type) {
case TOP_OF_MINUTE:
LogLog.debug("Appender ["+name+"] to be rolled every minute.");
break;
case TOP_OF_HOUR:
LogLog.debug("Appender ["+name+"] to be rolled on top of every hour.");
break;
case HALF_DAY:
LogLog.debug("Appender ["+name+"] to be rolled at midday and midnight.");
break;
case TOP_OF_DAY:
LogLog.debug("Appender ["+name+"] to be rolled at midnight.");
break;
case TOP_OF_WEEK:
LogLog.debug("Appender ["+name+"] to be rolled at start of week.");
break;
case TOP_OF_MONTH:
LogLog.debug("Appender ["+name+"] to be rolled at start of every month.");
break;
default:
LogLog.warn("Unknown periodicity for appender ["+name+"].");
}
}

/**
* 内部类
* @author 日志Rolling日历,获取下一次日志Rolling时间
*
*/
class RollingCalendar extends GregorianCalendar {
private static final long serialVersionUID = -3560331770601814177L;

int type = MyDailyRollingFileAppender.TOP_OF_TROUBLE;

/**
* RollingCalendar默认构造器
*/
RollingCalendar() {
super();
}

/**
* RollingCalendar构造器
* 根据地点时区 ，获取对应的日历Calendar
* @param tz
* @param locale
*/
RollingCalendar(TimeZone tz, Locale locale) {
super(tz, locale
9163
);
}

void setType(int type) {
this.type = type;
}

public long getNextCheckMillis(Date now) {
return getNextCheckDate(now).getTime();
}

/**
* 根据所传入的时间以及时间类型获取下一个时间
* @param now
* @return
*/
public Date getNextCheckDate(Date now) {
this.setTime(now);

switch(type) {
case MyDailyRollingFileAppender.TOP_OF_MINUTE:
this.set(Calendar.SECOND, 0);
this.set(Calendar.MILLISECOND, 0);
this.add(Calendar.MINUTE, 1);
break;
case MyDailyRollingFileAppender.TOP_OF_HOUR:
this.set(Calendar.MINUTE, 0);
this.set(Calendar.SECOND, 0);
this.set(Calendar.MILLISECOND, 0);
this.add(Calendar.HOUR_OF_DAY, 1);
break;
case MyDailyRollingFileAppender.HALF_DAY:
this.set(Calendar.MINUTE, 0);
this.set(Calendar.SECOND, 0);
this.set(Calendar.MILLISECOND, 0);
int hour = get(Calendar.HOUR_OF_DAY);
if(hour < 12) {
this.set(Calendar.HOUR_OF_DAY, 12);
} else {
this.set(Calendar.HOUR_OF_DAY, 0);
this.add(Calendar.DAY_OF_MONTH, 1);
}
break;
case MyDailyRollingFileAppender.TOP_OF_DAY:
this.set(Calendar.HOUR_OF_DAY, 0);
this.set(Calendar.MINUTE, 0);
this.set(Calendar.SECOND, 0);
this.set(Calendar.MILLISECOND, 0);
this.add(Calendar.DATE, 1);
break;
case MyDailyRollingFileAppender.TOP_OF_WEEK:
this.set(Calendar.DAY_OF_WEEK, getFirstDayOfWeek());
this.set(Calendar.HOUR_OF_DAY, 0);
this.set(Calendar.MINUTE, 0);
this.set(Calendar.SECOND, 0);
this.set(Calendar.MILLISECOND, 0);
this.add(Calendar.WEEK_OF_YEAR, 1);
break;
case MyDailyRollingFileAppender.TOP_OF_MONTH:
this.set(Calendar.DATE, 1);
this.set(Calendar.HOUR_OF_DAY, 0);
this.set(Calendar.MINUTE, 0);
this.set(Calendar.SECOND, 0);
this.set(Calendar.MILLISECOND, 0);
this.add(Calendar.MONTH, 1);
break;
default:
throw new IllegalStateException("Unknown periodicity type.");
}
return getTime();
}
}
}