log4j按日期和文件大小拆分

---

一、需求

我们需要一个日志切面来进行记录系统操作的日志
这个日志文件的文件名是需要以 yyyyMMdd.log 样的格式来进行Append
在Append的过程中 如果文件大小满足了配置的大小(例如20MB) 
会进行拆分,将文件名改为 yyyyMMdd_1.log 这个1是递增的日志
如果次日进行Append 也会进行拆分 拆分完成后从1开始
而且项目停止后再次启动不影响递增值

二、log4j配置文件

#记录操作日志
log4j.logger.operateLog=INFO,operateLog
log4j.appender.operateLog=xxx.xxx.xxx.Log4JDateAndSizeSplit
log4j.appender.operateLog.Threshold=INFO
log4j.appender.operateLog.ImmediateFlush=true
#我这边没有用指定的文件位置 我重写了构造器 命名为当前日期
#log4j.appender.operateLog.File=/xxx/xxx/xxx.log  
log4j.appender.operateLog.DatePattern=yyyyMMdd'_'
log4j.appender.operateLog.Append=true
log4j.appender.operateLog.MaxFileSize=10MB
log4j.appender.operateLog.MaxBackupIndex=-1  #-1表示全部保留，重写FileAppender类
log4j.appender.operateLog.layout=org.apache.log4j.PatternLayout
log4j.appender.operateLog.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%5p] - %c -%F(%L) - %m%n 

三、重写 FileAppender 和 GregorianCalendar

package com.ctid.dnc.system.fileappender;

/**
 * @ProductName: IntelliJ IDEA
 * @ProjectName: 
 * @Description:
 * @User: Tangerine
 * @Email: yj_tangerine@163.com | yj_tangerine@sina.com
 * @Date: 2021/11/25 16:59 星期四
 * @version: V1.0.0
 */

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

import java.io.File;
import java.io.IOException;
import java.io.Writer;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;
import java.util.TimeZone;

public class Log4JDateAndSizeSplit extends FileAppender {

    // The code assumes that the following constants are in a increasing
    // sequence.
    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;

    /**
     * The default maximum file size is 10MB.
     */
    protected long maxFileSize = 10 * 1024 * 1024;

    /**
     * There is one backup file by default.
     */
    protected int maxBackupIndex = 1;

    /**
     * meaning daily rollover.
     */
    private String datePattern = "'.'yyyy-MM-dd";

    /**
     * "scheduledFilename" at the beginning of the next hour.
     */
    private String scheduledFilename;

    /**
     * The next time we estimate a rollover should occur.
     */
    private long nextCheck = System.currentTimeMillis() - 1;

    Date now = new Date();

    SimpleDateFormat sdf;

    RollingCalendar rc = new RollingCalendar();

    int checkPeriod = TOP_OF_TROUBLE;

    // The gmtTimeZone is used only in computeCheckPeriod() method.
    static final TimeZone gmtTimeZone = TimeZone.getTimeZone("GMT");

    {
        super.fileName = "/xxx/xxxx/xxxx/" + new SimpleDateFormat("yyyyMMdd").format(new Date()) + ".log";
        //System.out.println(super.fileName);
    }
    
    public Log4JDateAndSizeSplit() {
    }

    public Log4JDateAndSizeSplit(Layout layout, String filename, String datePattern) throws IOException {
        super(layout, filename, true);
        this.datePattern = datePattern;
        activateOptions();
    }
        
    public long getMaximumFileSize() {return maxFileSize;}
    public void setMaximumFileSize(long maxFileSize) {this.maxFileSize = maxFileSize;}
    public void setMaxFileSize(String value) {maxFileSize = OptionConverter.toFileSize(value, maxFileSize + 1);}
    public int getMaxBackupIndex() {return maxBackupIndex;}
    public void setMaxBackupIndex(int maxBackups) {this.maxBackupIndex = maxBackups;}
    public void setDatePattern(String pattern) {datePattern = pattern;}
    public String getDatePattern() {return datePattern;}

    @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()));
            scheduledFilename = fileName.substring(0, fileName.lastIndexOf("/")) + "/" + sdf.format(new Date(file.lastModified()));

        } else {
            LogLog.error("Either File or DatePattern options are not set for appender [" + name + "].");
        }
    }

    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 + "].");
        }
    }

    // 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.ENGLISH);
        // set sate to 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); // do all date
                // formatting in GMT
                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...
    }

	/**这边我们是递增文件，所以maxBackupIndex是-1 所以不会删除文件，让windows不高兴*/
    public void sizeRollOver() {
        File target;
        File file;

        LogLog.debug("rolling over count=" + ((CountingQuietWriter) qw).getCount());
        LogLog.debug("maxBackupIndex=" + maxBackupIndex);

        String datedFilename = fileName.substring(0, fileName.lastIndexOf("/")) + "/" + new SimpleDateFormat("yyyyMMdd").format(now) + "_";

        if (maxBackupIndex > 0) {
            // Delete the oldest file, to keep Windows happy.
            file = new File(datedFilename + '.' + maxBackupIndex);
            if (file.exists())
                file.delete();

            for (int i = maxBackupIndex - 1; i >= 1; i--) {
                file = new File(datedFilename + i + ".log");
                if (file.exists()) {
                    target = new File(datedFilename + (i + 1) + ".log");
                    LogLog.debug("Renaming file " + file + " to " + target);
                    file.renameTo(target);
                }
            }

            // Rename fileName to datedFilename.1
            target = new File(datedFilename + "." + 1);
            this.closeFile(); // keep windows happy.
            file = new File(fileName);
            LogLog.debug("Renaming file " + file + " to " + target);
            file.renameTo(target);
        } else if (maxBackupIndex < 0) { // infinite number of files
            // find the max backup index
            for (int i = 1; i < Integer.MAX_VALUE; i++) {
                target = new File(datedFilename + i + ".log");
                if (!target.exists()) { // Rename fileName to datedFilename.i
                    this.closeFile();
                    file = new File(fileName);
                    file.renameTo(target);
                    LogLog.debug("Renaming file " + file + " to " + target);
                    break;
                }
            }
        }

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

    @Override
    public synchronized void setFile(String fileName, boolean append, boolean bufferedIO, int bufferSize) throws IOException {
        super.setFile(fileName, append, this.bufferedIO, this.bufferSize);
        if (append) {
            File f = new File(fileName);
            ((CountingQuietWriter) qw).setCount(f.length());
        }
    }

    @Override
    protected void setQWForFiles(Writer writer) {
        this.qw = new CountingQuietWriter(writer, errorHandler);
    }

    /**
     * Rollover the current file to a new file.
     */
    void timeRollOver() throws IOException {

        /* Compute filename, but only if datePattern is specified */
        if (datePattern == null) {
            errorHandler.error("Missing DatePattern option in rollOver().");
            return;
        }
        String datedFilename = fileName.substring(0, fileName.lastIndexOf("/")) + "/" + new SimpleDateFormat("yyyyMMdd").format(now) + "_";
        ;
        // It is too early to roll over because we are still within the
        // bounds of the current interval. Rollover will occur once the
        // next interval is reached.
        if (scheduledFilename.equals(datedFilename)) {
            return;
        }

        // close current file, and rename it to datedFilename
        this.closeFile();
        File target = null;   //xxxx/20211125_3.log
        for (int i = 1; i < Integer.MAX_VALUE; i++) {
            target = new File(scheduledFilename + i + ".log");
            if (!target.exists())
                break;
        }
        File file = new File(fileName);
        boolean result = file.renameTo(target);
        if (result) {
            LogLog.debug(fileName + " -> " + scheduledFilename);
            fileName = fileName.substring(0, fileName.lastIndexOf("/") + 1) + new SimpleDateFormat("yyyyMMdd").format(new Date()) + ".log";
        } else {
            LogLog.error("Failed to rename [" + fileName + "] to [" + scheduledFilename + "].");
        }

        try {
            // This will also close the file. This is OK since multiple
            // close operations are safe.
            super.setFile(fileName, false, this.bufferedIO, this.bufferSize);
        } catch (IOException e) {
            errorHandler.error("setFile(" + fileName + ", false) 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 {
                timeRollOver();
            } catch (IOException ioe) {
                LogLog.error("rollOver() failed.", ioe);
            }
        } else if ((fileName != null) && ((CountingQuietWriter) qw).getCount() >= maxFileSize) {
            //如果文件大小大于了，进去
            sizeRollOver();
        }
        super.subAppend(event);

    }


}

package com.ctid.dnc.system.fileappender;

/**
 * @ProductName: IntelliJ IDEA
 * @ProjectName: 
 * @Description: 
 * @User: Tangerine
 * @Email: yj_tangerine@163.com | yj_tangerine@sina.com
 * @Date: 2021/11/25 17:01 星期四
 * @version: V1.0.0
 */
import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.Locale;
import java.util.TimeZone;

public class RollingCalendar extends GregorianCalendar
{
    private static final long serialVersionUID = -3560331770601814177L;

    int type = Log4JDateAndSizeSplit.TOP_OF_TROUBLE;

    RollingCalendar()
    {
        super();
    }

    RollingCalendar(TimeZone tz, Locale locale)
    {
        super(tz, locale);
    }

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

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

    public Date getNextCheckDate(Date now)
    {
        this.setTime(now);

        switch (type)
        {
            case Log4JDateAndSizeSplit.TOP_OF_MINUTE:
                this.set(Calendar.SECOND, 0);
                this.set(Calendar.MILLISECOND, 0);
                this.add(Calendar.MINUTE, 1);
                break;
            case Log4JDateAndSizeSplit.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 Log4JDateAndSizeSplit.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 Log4JDateAndSizeSplit.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 Log4JDateAndSizeSplit.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 Log4JDateAndSizeSplit.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();
    }
}

四、使用

    private static final Log OPERATE_LOG = LogFactory.getLog("operateLog");
    OPERATE_LOG.info("*************************************");