一 logback簡介

? ? ??Logback是一個開源日志組件。Logback一般和SLF4結(jié)合起來使用。外層使用SLF4J,里面的實現(xiàn)是logback。什么意思，簡單來說我們使用層看到的是SLF4J。我們使用的時候就是和SLF4J提供的一些api打交道。

? ? ??我們可能經(jīng)常聽到SLF4J,logback,log4j,logging這些個名詞。下面我們用一個簡單的圖來解釋下他們之間的關(guān)系之間的關(guān)系。我們用一個圖來表述他們之間的關(guān)系。

log.png

• SLF4J: Simple Logging Facade for Java 簡單日志門面，不是具體的日志解決方案，它只服務(wù)于各種各樣的日志系統(tǒng)。換句話說SLF4J只是一個日志標準(按照我們程序員的思維，我們可以把它認為是接口)。并不是日志系統(tǒng)的具體實現(xiàn)。如果項目只有slf4j的包是沒辦法實現(xiàn)日志功能的，需要配合其他的實現(xiàn)框架比如logback，logback，log4j，logging等。
• Logback：logback框架完全按照slf4j的規(guī)范開發(fā)。是日志的具體實現(xiàn)框架。
• log4j：log4j不是按照slf4j標準來開發(fā)的，所以log4j需要一個中間適配器。
• logging: logging是jdk提供的一個日志框架，也不是按照slf4j標準來的，所以也需要一個總結(jié)適配器。才能兼容slf4j。

因為logback的使用不需要適配器，講道理logback比其他需要中間適配器的日志框架要快。

二 logback配置文件

? ? ??logback使用最關(guān)鍵在配置文件的使用。因為在logbakc(包括其他的日志框架)的使用過程中，有很大一部分工作都是在配置文件上做文章的，比如需要輸出什么級別的日志，日志文件怎么歸檔，打印日志文件的時候需要打印哪些信息等等。這些個東西都是通過logback的配置文件來定義的。

? ? ??logback的配置文件是一個xml格式的文件logback-test.xml或者logback.xml，讀取配置文件的步驟：

• （1）嘗試classpath下查找文件logback-test.xml
• （2）如果文件不存在，嘗試查找logback.xml
• （3）如果兩個文件都不存在，LogBack用BasicConfiguration自動對自己進行最小化配置，這樣既實現(xiàn)了上面我們不需要添加任何配置就可以輸出到控制臺日志信息。

? ? ??logback配置文件是一個xml文件，根節(jié)點是configuration標簽。如下就是一個完成的logback配置文件。

<?xml version="1.0" encoding="UTF-8"?>
<!--
   說明：
   1、日志級別及文件
       日志記錄采用分級記錄，級別與日志文件名相對應(yīng)，不同級別的日志信息記錄到不同的日志文件中
       例如：error級別記錄到xxx-error-xxx.log（該文件為當前記錄的日志文件），而xxx-error-xxx.x.log為歸檔日志，
       日志文件按日期記錄，同一天內(nèi)，若日志文件大小等于或大于2M，則按0、1、2...順序分別命名
       例如xxx-error-2013-12-21.0.log
       其它級別的日志也是如此。
   2、文件路徑
       若本地開發(fā)，以絕對路徑指定，如：/Users/zhangboqing/Downloads/logs。
       若部署到服務(wù)器，則各個服務(wù)器約定一個固定的日志路徑如/data/home/logs/【項目名】/
   3、Appender
       FILE-ALL對應(yīng)所有級別，文件名以xxx-all-xxx.log形式命名
       FILE-ERROR對應(yīng)error級別，文件名以xxx-error-xxx.log形式命名
       FILE-WARN對應(yīng)warn級別，文件名以xxx-warn-xxx.log形式命名
       FILE-INFO對應(yīng)info級別，文件名以xxx-info-xxx.log形式命名
       FILE-DEBUG對應(yīng)debug級別，文件名以xxx-debug-xxx.log形式命名
       STDOUT將日志信息輸出到控制上，為方便開發(fā)測試使用
-->

<!--
    根節(jié)點<configuration>，包含下面三個屬性
    1.scan: 當此屬性設(shè)置為true時，配置文件如果發(fā)生改變，將會被重新加載，默認值為true。
    2.scanPeriod: 設(shè)置監(jiān)測配置文件是否有修改的時間間隔，如果沒有給出時間單位，默認單位是毫秒。當scan為true時，此屬性生效。默認的時間間隔為1分鐘。
    3.debug: 當此屬性設(shè)置為true時，將打印出logback內(nèi)部日志信息，實時查看logback運行狀態(tài)。默認值為false。
-->

<configuration scan="true" scanPeriod="10 seconds">

    <!--
        子節(jié)點<property name="" value=""> ：用來定義變量值，它有兩個屬性name和value，通過<property>定義的值會被插入到logger上下文中，可以使“${}”來使用變量。
    -->
    <!--
        子節(jié)點<property resource=""/> ：用來引入外部屬性文件，可以使“${}”來使用變量。
    -->
    <property name="APP_NAME" value="IoServer4J"/>
    <property name="LOG_DIR" value="./logs/${APP_NAME}"/>

    <property name="LOG_FILE_NAME" value="sys"/>
    <property name="ERROR_LOG_FILE_NAME" value="error"/>
    <property name="DB_LOG_FILE_NAME" value="db"/>

    <property name="logFileNamePattern" value="${LOG_FILE_NAME}_%d{yyyy-MM-dd}_%i"/>
    <property name="errorLogFileNamePattern" value="${ERROR_LOG_FILE_NAME}_%d{yyyy-MM-dd}_%i"/>
    <property name="dbLogFileNamePattern" value="${DB_LOG_FILE_NAME}_%d{yyyy-MM-dd}_%i"/>

    <!-- 注冊轉(zhuǎn)換器，顏色轉(zhuǎn)化器 -->
    <!-- 彩色日志依賴的渲染類 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
    <conversionRule conversionWord="wex"
                    converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
    <conversionRule conversionWord="wEx"
                    converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>

    <!-- 日志輸出格式 -->
    <!--
    日志輸出格式：
        %d:             表示日期時間，
        %5p:            級別從左顯示5個字符寬度，
        ${PID:- }:      pid
        %15.20t:        線程名字(如果寬度不足15，左側(cè)補空白；如果寬度超過20，從左側(cè)截斷)
        %logger{50}:    表示logger名字最長50個字符，否則按照句點分割
        %%-4L:          行號，保留后面四位字符寬度
        %m:             日志消息
        %n:             換行符
        ${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}:
-->
    <property name="consoleLayoutPattern"
              value="%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%5p) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.20t]){faint} %clr(%-40.40logger{60} Line:%-4L){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"/>

    <property name="fileLayoutPattern"
              value="%d{yyyy-MM-dd HH:mm:ss.SSS} %5p ${PID:- } --- [%15.20t] %-40.40logger{60} Line:%-4L : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"/>

    <!--
        子節(jié)點<contextName>：用來設(shè)置上下文名稱，每個logger都關(guān)聯(lián)到logger上下文，默認上下文名稱為default。但可以使用<contextName>設(shè)置成其他名字，用于區(qū)分不同應(yīng)用程序的記錄。一旦設(shè)置，不能修改。
    -->
    <contextName>${APP_NAME}</contextName>

    <!--
        子節(jié)點<appender>：負責(zé)寫日志的組件，它有兩個必要屬性name和class。name指定appender名稱，class指定appender的全限定名
        class為ch.qos.logback.core.ConsoleAppender 把日志輸出到控制臺
        class為ch.qos.logback.core.FileAppender 把日志添加到文件
        class為ch.qos.logback.core.rolling.RollingFileAppender 滾動記錄文件，先將日志記錄到指定文件，當符合某個條件時，將日志記錄到其他文件
    -->

    <!-- 控制臺輸出 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <charset>UTF-8</charset>
            <pattern>${consoleLayoutPattern}</pattern>
        </encoder>
    </appender>

    <appender name="SYS_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_DIR}/${LOG_FILE_NAME}.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_DIR}/${logFileNamePattern}.log.zip
            </fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <charset>UTF-8</charset>
            <pattern>${fileLayoutPattern}</pattern>
        </encoder>
    </appender>

    <appender name="ERROR_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_DIR}/${ERROR_LOG_FILE_NAME}.log</file>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_DIR}/${errorLogFileNamePattern}.log.zip
            </fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>30</maxHistory><!-- days -->
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <charset>UTF-8</charset>
            <pattern>${fileLayoutPattern}</pattern>
        </encoder>
    </appender>

    <appender name="DB_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_DIR}/${DB_LOG_FILE_NAME}.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_DIR}/${dbLogFileNamePattern}.log.zip
            </fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>30</maxHistory><!-- days -->
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <charset>UTF-8</charset>
            <pattern>${fileLayoutPattern}</pattern>
        </encoder>
    </appender>

    <!--
        子節(jié)點<logger>：用來設(shè)置某一個包或者具體的某一個類的日志打印級別，以及指定<appender>,
        logger 僅有一個name屬性，兩個可選屬性 level／additivity
            name：用來指定受此logger約束的某一個包或者具體的某一個類。
            level：用來設(shè)置打印級別，大小寫無關(guān)，TRACE,DEBUG,INFO,WARE,ERROR,ALL和OFF,還有一個特俗值INHERITED
                    或者 同義詞NULL，代表強制執(zhí)行上級的級別。
            additivity:是否向上級logger傳遞打印信息。默認是true。
    -->

    <!-- db/sql logger -->
    <logger name="java.sql.Connection" level="warn" additivity="true">
        <appender-ref ref="DB_LOG"/>
    </logger>
    <logger name="java.sql.PreparedStatement" level="warn" additivity="true">
        <appender-ref ref="DB_LOG"/>
    </logger>
    <logger name="java.sql.Statement" level="warn" additivity="true">
        <appender-ref ref="DB_LOG"/>
    </logger>

    <!-- sql -->
    <logger name="com.pilot.ioserver.basic.biz.pbl.core.db.mapper" level="warn" additivity="true">
        <appender-ref ref="DB_LOG"/>
    </logger>

    <!-- 生產(chǎn)環(huán)境下，將此級別配置為適合的級別，以免日志文件太多或影響程序性能 -->
    <!--
        <root>元素也是<logger>元素,logger。只有一個level屬性。
        root 元素配置根 logger。該元素有一個 level 屬性。沒有 name 屬性，因為已經(jīng)被命名為“root”
        <root>可以包含零個或多個<appender-ref>元素,標識這個appender將會添加到這個logger。
    -->
    <root level="warn">
        <!-- 控制臺輸出 -->
        <appender-ref ref="CONSOLE"/>
        <!-- 文件輸出 -->
        <appender-ref ref="SYS_LOG"/>
        <!-- 錯誤日志 -->
        <appender-ref ref="ERROR_LOG"/>
    </root>
</configuration>

2.1 configuration

? ? ??configuration標簽是logback文件的根目錄。

2.1.1 configuration屬性

<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <!--其他配置省略-->
</configuration>

? ? ??上述配置代碼每隔60毫秒會檢查logback配置文件是否有修改，如果有修改就重寫加載。并且不會輸出logback的內(nèi)部日志。

2.1.2 configuration子節(jié)點

2.2 contextName

? ? ??contextName標簽用于設(shè)置日志上下文名稱，后面輸出格式中可以通過定義%contextName來打印日志上下文名稱。每個logger都關(guān)聯(lián)到logger上下文，默認上下文名稱為default。可以使用<contextName>設(shè)置成其他名字，用于區(qū)分不同的應(yīng)用程序的記錄。一旦設(shè)置，不能修改。

<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <contextName>myAppName</contextName>
    <!--其他配置省略-->
</configuration>

2.3 property

? ? ??property標簽用來設(shè)置相關(guān)變量,通過key-value的方式配置，然后在后面的配置文件中通過 ${key}來訪問。

<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <property name="APP_Name" value="myAppName"></property>
    <contextName>${APP_Name}</contextName>
    <!--其他配置省略-->
</configuration>

2.4 timestamp

? ? ??timestamp標簽用于獲取時間戳字符串，有兩個屬性key和datePattern。

<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <timestamp key="bySecond"datePattern="yyyyMMdd'T'HHmmss"></timestamp>
    <contextName>${bySecond}</contextName>
</configuration>

2.5 appender

? ? ??appender標簽負責(zé)主要負責(zé)日志的輸出以及格式化日志。當一個日志記錄被觸發(fā)的時候，logback會根據(jù)我們的配置信息把這個事件交給appender處理。appender有兩個必要屬性name和class。

appender屬性

? ? ??append屬性class設(shè)置的不同，append子節(jié)點也不同，所以這里我們直接看appender對應(yīng)的class類型有哪些。

appender class 類型

? ? ??ConsoleAppender、FileAppender、RollingFileAppender。這幾個appender是最常用的,我們對他們的使用做一個簡單的介紹。

2.5.1 ConsoleAppender

? ? ??ConsoleAppender用于把日志輸出到控制臺。

? ? ??如下配置會把DEBUG級別的日志輸出到控制臺。

<configuration>

  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <!-- encoders are assigned the type
         ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
    <encoder>
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
    </encoder>
  </appender>

  <root level="DEBUG">
    <appender-ref ref="STDOUT" />
  </root>
</configuration>

? ? ??ConsoleAppender節(jié)點介紹。

2.5.2 FileAppender

? ? ??FileAppender用于把日志添加到文件。

? ? ??比如如下的配置會把DEBUG級別的日志輸出到log-${bySecond}.txt文件。

<configuration>

  <!-- Insert the current time formatted as "yyyyMMdd'T'HHmmss" under
       the key "bySecond" into the logger context. This value will be
       available to all subsequent configuration elements. -->
  <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>

  <appender name="FILE" class="ch.qos.logback.core.FileAppender">
    <!-- use the previously created timestamp to create a uniquely
         named log file -->
    <file>log-${bySecond}.txt</file>
    <encoder>
      <pattern>%logger{35} - %msg%n</pattern>
    </encoder>
  </appender>

  <root level="DEBUG">
    <appender-ref ref="FILE" />
  </root>
</configuration>

? ? ??FileAppender節(jié)點介紹。

2.5.3 RollingFileAppender

? ? ??RollingFileAppender是對FileAppender的一個擴展。相較于它的父類，它的主要作用是滾動記錄日志。先將日志文件指定到文件，當符合某個條件時，將日志記錄到其他文件。所以這里有兩個重要的點，一是什么時候滾動(觸發(fā)triggeringPolicy)、二是發(fā)生滾動的時候怎么去保存文件(動作，策略rollingPolicy)。

? ? ??RollingFileAppender節(jié)點介紹。

RollingFileAppender子節(jié)點

2.5.3.1 rollingPolicy介紹

? ? ??rollingPolicy節(jié)點用于定義當發(fā)生日志切換時(發(fā)生日志滾動是)，RollingFileAppender的切換行為。例如日志文件名的修改。(RollingPolicy實際上就是負責(zé)日志文件的切換以及重命名的)。logback里面已經(jīng)給我們提供個多種切換的實現(xiàn)類。下面我們對這些實現(xiàn)類做一個簡單的介紹。

2.5.3.1.1 TimeBasedRollingPolicy

? ? ??是最受歡迎的日志滾動策略。它的滾動策略是基于時間的。根據(jù)時間觸發(fā)滾動(fileNamePattern屬性會解析到)，同時可以設(shè)置保留的文件的最大大小(超過最大大小就會把之前的覆蓋掉)，以及最大保留的粒度(如果是觸發(fā)保存是按天來的，可以設(shè)置最大保留多少天的日志。如果是月，可以設(shè)置最多保留多少月等等)。

注意，TimeBasedRollingPolicy已經(jīng)包含了triggeringPolicy節(jié)點的功能。所以設(shè)置了rollingPolicy為TimeBasedRollingPolicy就不需要在設(shè)置triggeringPolicy了。

? ? ??比如如下的配置，會每天保存一個日志文件，并且最大保存30天的日志，同時限制所以日志文件的最大大小為3G。

<configuration>
  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logFile.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <!-- daily rollover -->
      <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>

      <!-- keep 30 days' worth of history capped at 3GB total size -->
      <maxHistory>30</maxHistory>
      <totalSizeCap>3GB</totalSizeCap>

    </rollingPolicy>

    <encoder>
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
    </encoder>
  </appender> 

  <root level="DEBUG">
    <appender-ref ref="FILE" />
  </root>
</configuration>

? ? ??TimeBasedRollingPolicy屬性介紹。

舊版本的logback里可以在TimeBasedRollingPolicy這個rollingPolicy下配置一個timeBasedFileNamingAndTriggeringPolicy（實現(xiàn)類為SizeAndTimeBasedFNATP）達到同時配置時間和文件大小的滾動策略；而在新版本里可以使用SizeAndTimeBasedRollingPolicy替代。

2.5.3.1.2 SizeAndTimeBasedRollingPolicy

? ? ??有時候你不僅想通過時間來規(guī)定滾動策略，還希望同時限制每個日志文件的大小。在TimeBasedRoolingPolicy中已經(jīng)提供限制總?cè)罩疚募拇笮〉墓δ埽鳶izeAndTimeBasedRollingPolicy提供了更為強大的針對單個日志文件的大小限制能力。

? ? ??比如如下的配置，按天觸發(fā)日志的保存，同時限制了單個文件的大小。所以每天可能有多個日志文件。關(guān)于fileNamePattern的使用我們會在下文中講到。

<configuration>
  <appender name="ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>mylog.txt</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
      <!-- rollover daily -->
      <fileNamePattern>mylog-%d{yyyy-MM-dd}.%i.txt</fileNamePattern>
       <!-- each file should be at most 100MB, keep 60 days worth of history, but at most 20GB -->
       <maxFileSize>100MB</maxFileSize>    
       <maxHistory>60</maxHistory>
       <totalSizeCap>20GB</totalSizeCap>
    </rollingPolicy>
    <encoder>
      <pattern>%msg%n</pattern>
    </encoder>
  </appender>


  <root level="DEBUG">
    <appender-ref ref="ROLLING" />
  </root>

</configuration>

? ? ??SizeAndTimeBasedRollingPolicy屬性介紹，SizeAndTimeBasedRollingPolicy繼承TimeBasedRollingPolicy就額外的多一個屬性maxFileSize

2.5.3.1.3 FixedWindowRollingPolicy

? ? ??基于窗口大小的滾動策略。這個聽起來可能有點難理解，其實說白了就是將歸檔日志文件到最大了就寫到下一個文件里，而窗口大小就是最多允許多少份日志文件。要特別注意FixedWindowRollingPolicy是沒有告知什么時候觸發(fā)日志的保存的。所以FixedWindowRollingPolicy的使用需要配合triggeringPolicy標簽一起使用，而且一般triggeringPolicy標簽會設(shè)置SizeBasedTriggeringPolicy。

? ? ??比如如下的配置，保存DEBUG級別的日志，并且每5MB保存一個文件，窗口大小是1到3，當保存了3個歸檔文件后，將覆蓋最早的日志。

<configuration>
  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>test.log</file>

    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
      <fileNamePattern>tests.%i.log.zip</fileNamePattern>
      <minIndex>1</minIndex>
      <maxIndex>3</maxIndex>
    </rollingPolicy>

    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
      <maxFileSize>5MB</maxFileSize>
    </triggeringPolicy>
    <encoder>
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
    </encoder>
  </appender>
        
  <root level="DEBUG">
    <appender-ref ref="FILE" />
  </root>
</configuration>

? ? ??FixedWindowRollingPolicy屬性屬性介紹。

特別要注意，如果rollingPolicy標簽設(shè)置為FixedWindowRollingPolicy。一定要設(shè)置triggeringPolicy標簽的內(nèi)容。要不然是沒辦法觸發(fā)保存日志的。

2.5.3.2 triggeringPolicy介紹

? ? ??triggeringPolicy標簽設(shè)置的值用于告知RollingFileAppender什么時候觸發(fā)滾動操作。上面rollingPolicy介紹的各種rollingPolicy類型里面，其實TimeBasedRollingPolicy和SizeAndTimeBasedRollingPolicy已經(jīng)包含了triggeringPolicy的功能(會通過fileNamePattern屬性解析出來)，只有FixedWindowRollingPolicy是沒有triggeringPolicy功能的，所以FixedWindowRollingPolicy要設(shè)置triggeringPolicy。一般都是設(shè)置SizeBasedTriggeringPolicy。

? ? ??SizeBasedTriggeringPolicy只有一個屬性，就是文件大小。當?shù)竭_了設(shè)置的大小的時候RollingFileAppender就觸發(fā)一次滾動操作。

2.6 filter

? ? ??logback的過濾器可以過濾記錄日志的內(nèi)容，執(zhí)行一個過濾器會有返回個枚舉值，即DENY，NEUTRAL，ACCEPT其中之一。從而將不符合條件的日志信息過濾掉。

• DENY: 日志將立即被拋棄不再經(jīng)過其他過濾器。
• NEUTRAL: 有序列表里的下個過濾器過接著處理日志。
• ACCEPT: 日志會被立即處理，不再經(jīng)過剩余過濾器。

? ? ??過濾器被添加到<Appender>中，為<Appender>添加一個或多個過濾器后，可以用任意條件對日志進行過濾。<Appender>有多個過濾器時，按照配置順序執(zhí)行。

? ? ??關(guān)于Filter的實現(xiàn)類有多種,這里我們主要講兩種:LevelFilter以及ThresholdFilter.

2.6.1 LevelFilter

? ? ??級別過濾器，根據(jù)日志級別進行過濾。如果日志級別等于配置級別，過濾器會根據(jù)onMath 和 onMismatch接收或拒絕日志。

? ? ??比如以下的配置，只接受ERROR級別的日志，非ERROR級別的日志都會被過濾掉。

    <appender name="ERROR_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_DIR}/${ERROR_LOG_FILE_NAME}.log</file>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_DIR}/${errorLogFileNamePattern}.log.zip
            </fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>30</maxHistory><!-- days -->
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <charset>UTF-8</charset>
            <pattern>${fileLayoutPattern}</pattern>
        </encoder>
    </appender>

2.6.2 ThresholdFilter

? ? ??臨界值過濾器，過濾掉低于指定臨界值的日志。ThresholdFilter只有一個level子節(jié)點可以設(shè)置。當日志級別等于或高于臨界值時，過濾器返回NEUTRAL；當日志級別低于臨界值時，日志會被拒絕。

? ? ??比如如下的配置，過濾掉TRACE和DEBUG級別的日志。

    <appender name="ERROR_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_DIR}/${ERROR_LOG_FILE_NAME}.log</file>
        <!-- 過濾掉 TRACE 和 DEBUG 級別的日志-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_DIR}/${errorLogFileNamePattern}.log.zip
            </fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>30</maxHistory><!-- days -->
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <charset>UTF-8</charset>
            <pattern>${fileLayoutPattern}</pattern>
        </encoder>
    </appender>

2.6.3 EvaluatorFilter

? ? ??求值過濾器，評估、鑒別日志是否符合指定條件。需要額外的兩個JAR包，commons-compiler.jar和janino.jar。

? ? ??這里注意下evaluator子節(jié)點的使用，。evaluator有個子標簽<expression>，用于配置求值條件。求值表達式作用于當前日志，logback向求值表達式暴露日志的各種字段如下：

? ? ??比如如下的配置，過濾掉所有日志消息中不包含“billing”字符串的日志。

    <appender name="ERROR_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_DIR}/${ERROR_LOG_FILE_NAME}.log</file>
        <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
            <evaluator> <!-- 默認為 ch.qos.logback.classic.boolex.JaninoEventEvaluator -->
                <expression>return message.contains("billing");</expression>
            </evaluator>
            <OnMatch>ACCEPT </OnMatch>
            <OnMismatch>DENY</OnMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_DIR}/${errorLogFileNamePattern}.log.zip
            </fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>30</maxHistory><!-- days -->
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <charset>UTF-8</charset>
            <pattern>${fileLayoutPattern}</pattern>
        </encoder>
    </appender>

2.7 logger，root

2.7.1 logger

? ? ??用來設(shè)置某一個包或者具體某一個類的日志打印級別，以及指定<appender>。什么意思。

? ? ??關(guān)于addtivity。如果addtivity設(shè)置為true，那么當前l(fā)ogger標簽作用完之后，logger標簽對應(yīng)類或者包的父類，繼續(xù)作用一直到root標簽。如果addtivity設(shè)置為false，那么當前l(fā)ogger標簽作用完之后就直接掐斷了，不在繼續(xù)往上走了。

? ? ??<loger>可以包含零個或多個<appender-ref>元素，標識這個appender將會添加到這個loger。<appender-ref>標簽就是去指定日志的相應(yīng)操作，不管是控制臺輸出,還是保存到文件，還是滾動日志輸出啥的。

2.7.2 root

? ? ??<root>也是<loger>元素，但是它是根loger。只有一個level屬性。用來設(shè)置打印級別。

root是不用指定包或者類的,我們可以簡單的認為root指定了所有的包.

? ? ??這里要重點說下logger和root的關(guān)系。怕有些同學(xué)搞混掉.我們通過幾個例子來說明。

2.7.3 root，logger關(guān)系

? ? ??關(guān)于root和logger之間的關(guān)系要重點講下。當root和logger同時存在的時候。要特別注意logger和root標簽兩者最終的level；和logger標簽是否設(shè)置了向上傳遞的屬性。

• logger沒有設(shè)置level,那么logger直接繼承root的level(如果有多個logger并且logger直接有上下級關(guān)系的話，就一層一層往上)。
• logger設(shè)置了level，同時如果logger設(shè)置了向上傳遞的話(additivity="true")。那么root標簽和logger相同的包也使用logger的level。

2.7.3.1 情況一

    <logger name="com.tuacy.logback"/>

    <root level="info">
        <!-- 控制臺輸出 -->
        <appender-ref ref="CONSOLE"/>
    </root>

? ? ??因為logger沒有設(shè)置等級,直接繼承root的等級.addtivity默認就是true向上傳遞.可以認為當com.tuacy.logback包里面某個類打印日志的時候使用的配置為.

    <logger name="com.tuacy.logback" level="info" additivity="true"/>

    <root level="info">
        <!-- 控制臺輸出 -->
        <appender-ref ref="CONSOLE"/>
    </root>

? ? ??logger沒有設(shè)置appender-ref所以logger沒啥用，不打印，這個時候只有root設(shè)置起作用，com.tuacy.logback包下面的類info,warn,error的日志都會打印出來。

2.7.3.2 情況二

    <logger name="com.tuacy.logback" additivity="false"/>

    <root level="info">
        <!-- 控制臺輸出 -->
        <appender-ref ref="CONSOLE"/>
    </root>

? ? ??logger沒有設(shè)置等級，繼承root的等級，additivity為false,不往上傳遞，root不作用。配置相當于

    <logger name="com.tuacy.logback" additivity="false"/>

? ? ??如果這個時候有com.tuacy.logback包或者子包有打印的時候，不會有任何打印信息。

2.7.3.3 情況三

    <logger name="com.tuacy.logback" level="error"/>

    <root level="info">
        <!-- 控制臺輸出 -->
        <appender-ref ref="CONSOLE"/>
    </root>

? ? ??logger和root都有設(shè)置等級取兩者等級較高的。所以上述配置等價于

    <logger name="com.tuacy.logback" level="error" additivity="true"/>

    <root level="error">
        <!-- 控制臺輸出 -->
        <appender-ref ref="CONSOLE"/>
    </root>

? ? ??這個時候只有error級別的信息會打印出來，root也使用logger的level。注意，只是針對com.tuacy.logback包和他的子包root的等級改變了。其他的包root還是保持原來的level。

2.7.3.4 情況四

    <logger name="com.tuacy.logback" level="error" additivity="false"/>

    <root level="info">
        <!-- 控制臺輸出 -->
        <appender-ref ref="CONSOLE"/>
    </root>

? ? ??上述配置等價于

    <logger name="com.tuacy.logback" level="error" additivity="false"/>

? ? ??不會有打印的

2.7.3.5 情況五

    <logger name="com.tuacy.logback" level="error">
        <!-- 控制臺輸出 -->
        <appender-ref ref="CONSOLE"/>
    </logger>

    <root level="info">
        <!-- 控制臺輸出 -->
        <appender-ref ref="CONSOLE"/>
    </root>

? ? ??上述配置等價于

    <logger name="com.tuacy.logback" level="error">
        <!-- 控制臺輸出 -->
        <appender-ref ref="CONSOLE"/>
    </logger>

    <root level="error">
        <!-- 控制臺輸出 -->
        <appender-ref ref="CONSOLE"/>
    </root>

? ? ??會打印error級別的日志，而且會打印兩次。logger的一次，root的一次。

2.7.3.6 情況六

    <logger name="com.tuacy.logback" level="error" additivity="false">
        <!-- 控制臺輸出 -->
        <appender-ref ref="CONSOLE"/>
    </logger>

    <root level="info">
        <!-- 控制臺輸出 -->
        <appender-ref ref="CONSOLE"/>
    </root>

? ? ??上述配置等價于

    <logger name="com.tuacy.logback" level="error" additivity="false">
        <!-- 控制臺輸出 -->
        <appender-ref ref="CONSOLE"/>
    </logger>

? ? ??所以只會打印一次error級別的日志信息。

2.8 日志模板配置

? ? ??日志模板配置，使用%為前綴讓解析器識別特殊輸出模式，然后以{}后綴結(jié)尾，內(nèi)部指定相應(yīng)的參數(shù)設(shè)置。

2.8.1 模板輸入?yún)?shù)

? ? ??d,data可以配置額外的參數(shù)，用來確定日期格式。輸出日志的打印日志，模式語法與java.text.SimpleDateFormat 兼容。

? ? ??c、lo、logger輸出日志的logger名，可有一個整形參數(shù)，功能是縮短logger名，設(shè)置為0表示只輸入logger最右邊點符號之后的字符串

2.8.2 模板長度設(shè)置

? ? ??每個模板配置都是可以限制模長度的，上面介紹了模塊可以設(shè)置那么多的輸入?yún)?shù)，其實每個輸入?yún)?shù)都是可以限制長度的。

三 spring boot項目使用logback

3.1 pom依賴

? ? ??在Spring Boot項目中要使用logback原則上是要添加spring-boot-starter-logging依賴的。

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </dependency>

但是因為我們使用Spring Boot肯定會添加

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

又因為spring-boot-starter里面已經(jīng)包含了對于spring-boot-starter-logging的依賴，所以我們一般在項目中不用顯示的添加spring-boot-starter-logging。

3.1 logback配置文件

? ? ??spring boot項目中使用logback.關(guān)于配置文件官方推薦使用的xml名字的格式為：logback-spring.xml而不是logback.xml(當然了,你也可以使用logback.xml)，因為帶spring后綴的可以使用<springProfile>這個標簽來控制比如生成環(huán)境還是調(diào)試環(huán)境。比如如下的配置分了對生成環(huán)境和開發(fā)環(huán)境做了一個簡單的區(qū)分.

<configuration scan="true" scanPeriod="10 seconds">

...

    <!-- 生產(chǎn)環(huán)境下，將此級別配置為適合的級別，以免日志文件太多或影響程序性能 -->
    <!--
        <root>元素也是<logger>元素,logger。只有一個level屬性。
        root 元素配置根 logger。該元素有一個 level 屬性。沒有 name 屬性，因為已經(jīng)被命名為“root”
        <root>可以包含零個或多個<appender-ref>元素,標識這個appender將會添加到這個logger。
    -->
    <springProfile name="dev">
        <root level="info">
            <!-- 控制臺輸出 -->
            <appender-ref ref="CONSOLE"/>
            <!-- 文件輸出 -->
            <appender-ref ref="SYS_LOG"/>
            <!-- 錯誤日志 -->
            <appender-ref ref="ERROR_LOG"/>
        </root>
    </springProfile>
    <springProfile name="pro">
        <root level="warn">
            <!-- 控制臺輸出 -->
            <appender-ref ref="CONSOLE"/>
            <!-- 文件輸出 -->
            <appender-ref ref="SYS_LOG"/>
            <!-- 錯誤日志 -->
            <appender-ref ref="ERROR_LOG"/>
        </root>
    </springProfile>
</configuration>