摘要：引言用過的同學們大多都知道日志框架可以自動按照某個時間點切割日志的功能。而跟日志切割相關(guān)的邏輯就在這里面。第一步判斷是否需要切割日志，需要就執(zhí)行滾動操作。中實現(xiàn)了按照時間切割日志的策略。如果到了應(yīng)該切割日志的時間則會調(diào)用方法。

用過Logback的同學們大多都知道Logback日志框架可以自動按照某個時間點切割日志的功能。但了解其中工作原理的同學可能并不是很多。樓主今天就帶領(lǐng)各位了解一下其中的核心源碼。本文的示例引用了Logback 1.1.7版的源碼。

舉個實際的例子，如果希望某一個Appender按天切割日志，那么我們需要類似如下的配置：

    
        logs/service-log.log
        
            %d{yyyy-MM-dd HH:mm:ss} %level [%class:%line] - %m%n
        
        
            
            logs/service-log.%d{yyyy-MM-dd}.log.zip
        
    

如果需要日志切割功能，首先要選用RollingFileAppender這種Appender，之后要配置TimeBasedRollingPolicy作為該Appender的滾動策略。

業(yè)務(wù)代碼在調(diào)用Logback的記錄日志的方法時，Logger類會調(diào)用ch.qos.logback.core.Appender#doAppend方法。Appender的doAppend就是Appender記錄日志功能的入口。
我們先來看一下RollingFileAppender的繼承關(guān)系

看起來貌似有些暈。沒關(guān)系，doAppend方法經(jīng)過幾層之后會調(diào)到ch.qos.logback.core.rolling.RollingFileAppender#subAppend 這個方法。而跟日志切割相關(guān)的邏輯就在這里面。因此從doAppend到subAppend之間的調(diào)用鏈路我們在此略過不提，而是從subAppend這個方法切入。

    /**
    * This method differentiates RollingFileAppender from its super class.
    */
    @Override
    protected void subAppend(E event) {
        // The roll-over check must precede actual writing. This is the
        // only correct behavior for time driven triggers.

        // We need to synchronize on triggeringPolicy so that only one rollover
        // occurs at a time
        synchronized (triggeringPolicy) {
            if (triggeringPolicy.isTriggeringEvent(currentlyActiveFile, event)) {
                rollover();
            }
        }

        super.subAppend(event);
    }

第一步判斷是否需要切割日志，需要就執(zhí)行滾動操作。第二步執(zhí)行父類中的寫日志操作。
TimeBasedRollingPolicy中實現(xiàn)了按照時間切割日志的策略。

ch.qos.logback.core.rolling.TimeBasedRollingPolicy#isTriggeringEvent方法

    public boolean isTriggeringEvent(File activeFile, final E event) {
        return timeBasedFileNamingAndTriggeringPolicy.isTriggeringEvent(activeFile, event);
    }

這個timeBasedFileNamingAndTriggeringPolicy是DefaultTimeBasedFileNamingAndTriggeringPolicy類的實例。
ch.qos.logback.core.rolling.DefaultTimeBasedFileNamingAndTriggeringPolicy#isTriggeringEvent方法

    public boolean isTriggeringEvent(File activeFile, final E event) {
        long time = getCurrentTime();//獲得當前時間
        if (time >= nextCheck) {//如果當前時間大于下一次滾動時間點，則執(zhí)行如下邏輯
            Date dateOfElapsedPeriod = dateInCurrentPeriod;//之前時間段的開始時間
            addInfo("Elapsed period: " + dateOfElapsedPeriod);
            elapsedPeriodsFileName = tbrp.fileNamePatternWithoutCompSuffix.convert(dateOfElapsedPeriod);//算出之前一個時間段的文件名字（用于將當前文件重命名）
            setDateInCurrentPeriod(time);//將當前時間保存起來，作為下次滾動時的上一次滾動的時間點
            computeNextCheck();//計算下次滾動時間
            return true;
        } else {
            return false;
        }
    }

ch.qos.logback.core.rolling.helper.FileNamePattern類的convert方法根據(jù)上次滾動執(zhí)行的開始時間計算出了本次操作的文件名。

計算下次滾動執(zhí)行的時間。

    protected void computeNextCheck() {
        nextCheck = rc.getNextTriggeringDate(dateInCurrentPeriod).getTime();
    }

上述方法調(diào)用了ch.qos.logback.core.rolling.helper.RollingCalendar#getNextTriggeringDate
RollingCalendar這個工具類是用來計算每一次觸發(fā)滾動操作的時間的。RollingCalendar的periodicityType成員變量就是滾動時間類型枚舉，可以是天、小時、分鐘等等時間單位。這個值并不是在logback.xml文件中配置的，而是拿到日期格式“%d{yyyy-MM-dd}”之后自動計算出來的。計算原理就是用日期格式創(chuàng)建一個SimpleDateFormat然后按照時間單位從小到大（必須是從小到大）的順序依次試驗。每次試驗的方法就是用SimpleDateFormat生成兩個時間，這兩個時間相差1倍的該時間單位的時間，然后將兩個時間轉(zhuǎn)換成字符串進行對比，如果這兩個字符串不相等就說明該日期格式對應(yīng)的時間單位是當前試驗的時間單位。

看完判斷是否觸發(fā)滾動的邏輯之后我們把視線轉(zhuǎn)回ch.qos.logback.core.rolling.RollingFileAppender#subAppend方法。如果到了應(yīng)該切割日志的時間則會調(diào)用rollover方法。

    /**
     * Implemented by delegating most of the rollover work to a rolling policy.
     */
    public void rollover() {
        lock.lock();
        try {
            // Note: This method needs to be synchronized because it needs exclusive
            // access while it closes and then re-opens the target file.
            //
            // make sure to close the hereto active log file! Renaming under windows
            // does not work for open files.
            this.closeOutputStream();
            attemptRollover();
            attemptOpenFile();
        } finally {
            lock.unlock();
        }
    }

滾動方法里面自己控制了線程同步邏輯，保證多個線程只有一個會執(zhí)行滾動操作。attemptRollover方法調(diào)用了ch.qos.logback.core.rolling.TimeBasedRollingPolicy#rollover方法

    public void rollover() throws RolloverFailure {

        // when rollover is called the elapsed period"s file has
        // been already closed. This is a working assumption of this method.

        String elapsedPeriodsFileName = timeBasedFileNamingAndTriggeringPolicy.getElapsedPeriodsFileName();//獲得上個周期的文件名字

        String elapsedPeriodStem = FileFilterUtil.afterLastSlash(elapsedPeriodsFileName);

        if (compressionMode == CompressionMode.NONE) {
            if (getParentsRawFileProperty() != null) {
                renameUtil.rename(getParentsRawFileProperty(), elapsedPeriodsFileName);//將當前文件重命名
            } // else { nothing to do if CompressionMode == NONE and parentsRawFileProperty == null }
        } else {
            if (getParentsRawFileProperty() == null) {
                compressionFuture = compressor.asyncCompress(elapsedPeriodsFileName, elapsedPeriodsFileName, elapsedPeriodStem);//執(zhí)行異步壓縮，里面用到了java語言的Future
            } else {
                compressionFuture = renameRawAndAsyncCompress(elapsedPeriodsFileName, elapsedPeriodStem);
            }
        }

        if (archiveRemover != null) {
            Date now = new Date(timeBasedFileNamingAndTriggeringPolicy.getCurrentTime());
            cleanUpFuture = archiveRemover.cleanAsynchronously(now);//執(zhí)行清理，清楚過期日志
        }
    }

其中有一些工具類可以供我們在業(yè)務(wù)開發(fā)過程中使用，比如ch.qos.logback.core.rolling.helper.RenameUtil#rename可以將文件重命名，拿來用就可以不用重復(fù)造輪子了。

    private void attemptOpenFile() {
        try {
            // update the currentlyActiveFile LOGBACK-64
            currentlyActiveFile = new File(rollingPolicy.getActiveFileName());//創(chuàng)建一個當前的文件，新的日志輸出到這個文件。因此日志的滾動操作就完成了

            // This will also close the file. This is OK since multiple close operations are safe.
            this.openFile(rollingPolicy.getActiveFileName());
        } catch (IOException e) {
            addError("setFile(" + fileName + ", false) call failed.", e);
        }
    }

由于篇幅關(guān)系，一些細節(jié)沒有展開。歡迎大家拍磚。