spring-boot 項目整合logback

使用spring-boot項目中添加日誌輸出，java的日誌輸出一共有兩個大的方案log4j/log4j2 ，logback。log4j2算是對log4j的一個升級版本。常規作法是引入slf4j做爲日誌入口，log4j或者logback選擇一個作實現。spring的項目裏面，只有spring-boot-starter-web用的是log4j，其餘的用過的starter所有都是logback。java

依賴 dependency-spring-boot-starter-logging

spring-boot-starter-logging還有兩個很容易混淆的變種的starter
spring-boot-starter-log4j 和 spring-boot-starter-log4j2web

前者在版本更新到了1.3以後就中止了，後者持續更新，須要注意下。算法

dependencies

spring-boot-starter-logging 依賴有spring

groupId	artifactId	version
ch.qos.logback	logback-classic	1.2.3
org.apache.logging.log4j	log4j-to-slf4j	2.10.0
org.slf4j	jul-to-slf4j	1.7.25

上面的列表中可知log的最終打印是使用logback實現的。項目中優先選用 spring-boot-starter-loggingapache

logback配置

先看一個典型的配置文件安全

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="true">
    <property name="name" value="spring-boot-logging"/>
    <contextName>${name}</contextName>
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="rollingFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logs/infisa.${name}.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logs/${name}.%d{yyyy-MM-dd}.log</fileNamePattern>
        </rollingPolicy>
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- project default level -->
    <logger name="cn.lee.jason" level="info"/>

    <!-- 定義根日誌級別 -->
    <root level="info">
        <appender-ref ref="rollingFile"/>
        <appender-ref ref="console"/>
    </root>
   
</configuration>

configuration

configuration是logback.xml的根節點，全部的配置項目都要位於configuration元素下面，可配置的屬性有：app

屬性名稱	默認值	說明
scan	true	當此屬性設置爲true時，配置文件若是發生改變，將會被從新加載
scanPeriod	1min	設置監測配置文件是否有修改的時間間隔，若是沒有給出時間單位，默認單位是毫秒。當scan爲true時，此屬性生效。
debug	true	當此屬性設置爲true時，將打印出logback內部日誌信息，實時查看logback運行狀態。

contextName

每一個logger都關聯到logger上下文，默認上下文名稱爲「default」。但能夠使用<contextName>設置成其餘名字，用於區分不一樣應用程序的記錄。一旦設置，不能修改。spring-boot

property

用來定義變量值的標籤，<property> 有兩個屬性，name和value；其中name的值是變量的名稱，value的值時變量定義的值。經過<property>定義的值會被插入到logger上下文中。定義變量後，能夠使「${}」來使用變量。例如使用<property>定義上下文名稱，而後在<contentName>設置logger上下文時使用。spa

appender

負責寫日誌的組件，它有兩個必要屬性name和class。name指定appender名稱，class指定appender的全限定名. debug

ConsoleAppender

日誌輸出到控制檯，有如下子節點： <encoder>：對日誌進行格式化。 <target>：字符串System.out(默認)或者System.err（區別很少說了）

FileAppender

把日誌添加到文件，有如下子節點：　　　　　　<file>：被寫入的文件名，能夠是相對目錄，也能夠是絕對目錄，若是上級目錄不存在會自動建立，沒有默認值。　　　　　　<append>：若是是 true，日誌被追加到文件結尾，若是是 false，清空現存文件，默認是true。　　　　　　<encoder>：對記錄事件進行格式化。（具體參數稍後講解）　　　　　　<prudent>：若是是 true，日誌會被安全的寫入文件，即便其餘的FileAppender也在向此文件作寫入操做，效率低，默認是 false。

RollingFileAppender

滾動記錄文件，先將日誌記錄到指定文件，當符合某個條件時，將日誌記錄到其餘文件。有如下子節點：　　　　　　<file>：被寫入的文件名，能夠是相對目錄，也能夠是絕對目錄，若是上級目錄不存在會自動建立，沒有默認值。　　　　　　<append>：若是是 true，日誌被追加到文件結尾，若是是 false，清空現存文件，默認是true。　　　　　　<rollingPolicy>:當發生滾動時，決定RollingFileAppender的行爲，涉及文件移動和重命名。屬性class定義具體的滾動策略類　　　　　　class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"：最經常使用的滾動策略，它根據時間來制定滾動策略，既負責滾動也負責出發滾動。有如下子節點：　　　　　　　　<fileNamePattern>：必要節點，包含文件名及「%d」轉換符，「%d」能夠包含一個java.text.SimpleDateFormat指定的時間格式，如：%d{yyyy-MM}。若是直接使用 %d，默認格式是 yyyy-MM-dd。RollingFileAppender的file字節點無關緊要，經過設置file，能夠爲活動文件和歸檔文件指定不一樣位置，當前日誌老是記錄到file指定的文件（活動文件），活動文件的名字不會改變；若是沒設置file，活動文件的名字會根據fileNamePattern 的值，每隔一段時間改變一次。「/」或者「\」會被當作目錄分隔符。　　　　　　　　<maxHistory>: 可選節點，控制保留的歸檔文件的最大數量，超出數量就刪除舊文件。假設設置每月滾動，且<maxHistory>是6，則只保存最近6個月的文件，刪除以前的舊文件。注意，刪除舊文件是，那些爲了歸檔而建立的目錄也會被刪除。

　　　　　　class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"：查看當前活動文件的大小，若是超過指定大小會告知RollingFileAppender 觸發當前活動文件滾動。只有一個節點: 　　　　　　　　<maxFileSize>:這是活動文件的大小，默認值是10MB。　　　　　　　　<prudent>：當爲true時，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，可是有兩個限制，1不支持也不容許文件壓縮，2不能設置file屬性，必須留空。

　　　　　　<triggeringPolicy >: 告知 RollingFileAppender 合適激活滾動。　　　　　　class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根據固定窗口算法重命名文件的滾動策略。有如下子節點：　　　　　　　　<minIndex>:窗口索引最小值　　　　　　　　<maxIndex>:窗口索引最大值，當用戶指定的窗口過大時，會自動將窗口設置爲12。　　　　　　　　<fileNamePattern>:必須包含「%i」例如，假設最小值和最大值分別爲1和2，命名模式爲 mylog%i.log,會產生歸檔文件mylog1.log和mylog2.log。還能夠指定文件壓縮選項，例如，mylog%i.log.gz 或者沒有log%i.log.zip

logger

用來設置某一個包或具體的某一個類的日誌打印級別、以及指定<appender>。<loger>僅有一個name屬性，一個可選的level和一個可選的addtivity屬性。能夠包含零個或多個<appender-ref>元素，標識這個appender將會添加到這個loger 　　　　name: 用來指定受此loger約束的某一個包或者具體的某一個類。　　　　level: 用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，還有一個特俗值INHERITED或者同義詞NULL，表明強制執行上級的級別。若是未設置此屬性，那麼當前loger將會繼承上級的級別。 addtivity: 是否向上級loger傳遞打印信息。默認是true。同<loger>同樣，能夠包含零個或多個<appender-ref>元素，標識這個appender將會添加到這個loger。

root

它也是<loger>元素，可是它是根loger,是全部<loger>的上級。只有一個level屬性，由於name已經被命名爲"root",且已是最上級了。　　　　level: 用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，不能設置爲INHERITED或者同義詞NULL。默認是DEBUG。