SLF4J+Logback 日誌框架使用

阿新 • • 發佈：2018-11-07

宣告：部分內容摘自網路

注：使用logback和log4j十分相似， log4j的屬性配置檔案可以通過工具http://logback.qos.ch/translator/轉換為logback的配置檔案放到類路徑裡面去，另外再將logback的類庫logback-core，logback-classic加入到類路徑中去就搞定了。

一、下載元件：

slf4j:http：//www.slf4j.org/download.html
logback：http://logback.qos.ch/download.html

Logback 分為三個模組：logback-core，logback-classic，logback-access
logback-core 是核心；
logback-classic 改善了 log4j，且自身實現了 SLF4J API，所以即使用 Logback 你仍然可以使用其他的日誌實現，如原始的 Log4J，java.util.logging 等；
logback-access 讓你方便的訪問日誌資訊，如通過 http 的方式。

二、配置資訊

需要的配置檔案和元件包，下面三個 jar 檔案和一個 xml檔案都是要放在專案的 ClassPath上
slf4j-api-1.6.1.jar
logback-classic-0.9.24.jar
logback-core-0.9.24.jar

一個示例logback.xml

<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
    <!-- 控制檯輸出日誌 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender" 
>
        <encoder>
            <pattern>%d{mm:ss} %-5level %logger{36} >>> %msg%n</pattern>
        </encoder>
    </appender>
    <!--每天生成一個日誌檔案，儲存30天的日誌檔案。-->
    <appender name="DayFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy 
 class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logs/logFile.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
        </encoder>
    </appender>
    <!--指定logger name為包名或類全名 指定級別 additivity設定是否傳遞到root logger -->
    <logger name="slf4j" level="INFO" additivity="false">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="DayFile"/>
    </logger>
    <!--slf4j2包下的類在ERROR級別時候傳遞到root logger中-->
    <logger name="slf4j2" level="ERROR" />
    <!--根logger控制-->
    <root level="WARN">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

三、示例程式碼

同slf4j整合log4j的程式碼完全一樣，由於使用了slf4j日誌門面介面故程式碼無需任何改變，只需要改變類庫和配置檔案即可。

配置檔案詳解：

一：根節點包含的屬性：

scan:
當此屬性設定為true時，配置檔案如果發生改變，將會被重新載入，預設值為true。
scanPeriod:
設定監測配置檔案是否有修改的時間間隔，如果沒有給出時間單位，預設單位是毫秒。當scan為true時，此屬性生效。預設的時間間隔為1分鐘。
debug:
當此屬性設定為true時，將打印出logback內部日誌資訊，實時檢視logback執行狀態。預設值為false。
例如：

Xml程式碼

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

二：根節點的子節點：

2.1設定上下文名稱：

每個logger都關聯到logger上下文，預設上下文名稱為“default”。但可以使用設定成其他名字，用於區分不同應用程式的記錄。一旦設定，不能修改。

Xml程式碼

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

2.2設定變數：

用來定義變數值的標籤，有兩個屬性，name和value；其中name的值是變數的名稱，value的值時變數定義的值。通過定義的值會被插入到logger上下文中。定義變數後，可以使“${}”來使用變數。
例如使用定義上下文名稱，然後在設定logger上下文時使用。
Xml程式碼

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

2.3獲取時間戳字串：

兩個屬性 key:標識此的名字；datePattern：設定將當前時間（解析配置檔案的時間）轉換為字串的模式，遵循java.txt.SimpleDateFormat的格式。
例如將解析配置檔案的時間作為上下文名稱：
Xml程式碼

<configuration scan="true" scanPeriod="60 seconds" debug="false">  
      <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>   
      <contextName>${bySecond}</contextName>  
      <!-- 其他配置省略-->  
</configuration>

2.4設定loger：

用來設定某一個包或者具體的某一個類的日誌列印級別、以及指定。僅有一個name屬性，一個可選的level和一個可選的addtivity屬性。
name:
用來指定受此loger約束的某一個包或者具體的某一個類。
level:
用來設定列印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，還有一個特俗值INHERITED或者同義詞NULL，代表強制執行上級的級別。
如果未設定此屬性，那麼當前loger將會繼承上級的級別。
addtivity:
是否向上級loger傳遞列印資訊。預設是true。
可以包含零個或多個元素，標識這個appender將會新增到這個loger。

也是元素，但是它是根loger。只有一個level屬性，應為已經被命名為”root”.
level:
用來設定列印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能設定為INHERITED或者同義詞NULL。
預設是DEBUG。
可以包含零個或多個元素，標識這個appender將會新增到這個loger。

例如：
LogbackDemo.java類
Java程式碼

package logback;  

import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  

public class LogbackDemo {  
    private static Logger log = LoggerFactory.getLogger(LogbackDemo.class);  
    public static void main(String[] args) {  
        log.trace("======trace");  
        log.debug("======debug");  
        log.info("======info");  
        log.warn("======warn");  
        log.error("======error");  
    }  
}

logback.xml配置檔案
第1種：只配置root
Xml程式碼

<configuration>   
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
    <!-- encoder 預設配置為PatternLayoutEncoder -->   
    <encoder>   
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
    </encoder>   
  </appender>   

  <root level="INFO">             
    <appender-ref ref="STDOUT" />   
  </root>     

 </configuration>

其中appender的配置表示列印到控制檯(稍後詳細講解appender )；
將root的列印級別設定為“INFO”，指定了名字為“STDOUT”的appender。

當執行logback.LogbackDemo類的main方法時，root將級別為“INFO”及大於“INFO”的日誌資訊交給已經配置好的名為“STDOUT”的appender處理，“STDOUT”appender將資訊列印到控制檯；
列印結果如下：

Xml程式碼
13:30:38.484 [main] INFO  logback.LogbackDemo - ======info  
13:30:38.500 [main] WARN  logback.LogbackDemo - ======warn  
13:30:38.500 [main] ERROR logback.LogbackDemo - ======error

第2種：帶有loger的配置，不指定級別，不指定appender，
Xml程式碼:

<configuration>
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
    <!-- encoder 預設配置為PatternLayoutEncoder -->   
    <encoder>   
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
    </encoder>   
  </appender>   

  <logger name="logback"/>   

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

 </configuration>

其中appender的配置表示列印到控制檯(稍後詳細講解appender )；
將控制logback包下的所有類的日誌的列印，但是並沒用設定列印級別，所以繼承他的上級的日誌級別“DEBUG”；
沒有設定addtivity，預設為true，將此loger的列印資訊向上級傳遞；
沒有設定appender，此loger本身不列印任何資訊。
將root的列印級別設定為“DEBUG”，指定了名字為“STDOUT”的appender。

當執行logback.LogbackDemo類的main方法時，因為LogbackDemo 在包logback中，所以首先執行，將級別為“DEBUG”及大於“DEBUG”的日誌資訊傳遞給root，本身並不列印；
root接到下級傳遞的資訊，交給已經配置好的名為“STDOUT”的appender處理，“STDOUT”appender將資訊列印到控制檯；
列印結果如下：

Xml程式碼
13:19:15.406 [main] DEBUG logback.LogbackDemo - ======debug  
13:19:15.406 [main] INFO  logback.LogbackDemo - ======info  
13:19:15.406 [main] WARN  logback.LogbackDemo - ======warn  
13:19:15.406 [main] ERROR logback.LogbackDemo - ======error

第3種：帶有多個loger的配置，指定級別，指定appender
Xml程式碼

<configuration>   
   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
    <!-- encoder 預設配置為PatternLayoutEncoder -->   
    <encoder>   
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
    </encoder>   
  </appender>   
  <!-- logback為java中的包 -->   
  <logger name="logback"/>   
  <!--logback.LogbackDemo：類的全路徑 -->   
  <logger name="logback.LogbackDemo" level="INFO" additivity="false">  
    <appender-ref ref="STDOUT"/>  
  </logger>   

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

控制logback.LogbackDemo類的日誌列印，列印級別為“INFO”；
additivity屬性為false，表示此loger的列印資訊不再向上級傳遞，
指定了名字為“STDOUT”的appender。

將root的列印級別設定為“ERROR”，指定了名字為“STDOUT”的appender。

當執行logback.LogbackDemo類的main方法時，先執行，將級別為“INFO”及大於“INFO”的日誌資訊交給此loger指定的名為“STDOUT”的appender處理，在控制檯中打出日誌，不再向次loger的上級傳遞列印資訊；
未接到任何列印資訊，當然也不會給它的上級root傳遞任何列印資訊；
列印結果如下：

Xml程式碼
14:05:35.937 [main] INFO  logback.LogbackDemo - ======info  
14:05:35.937 [main] WARN  logback.LogbackDemo - ======warn  
14:05:35.937 [main] ERROR logback.LogbackDemo - ======error

如果將修改為那列印結果將是什麼呢？
沒錯，日誌列印了兩次，想必大家都知道原因了，因為列印資訊向上級傳遞，logger本身列印一次，root接到後又列印一次
列印結果如下：

Xml程式碼
14:09:01.531 [main] INFO  logback.LogbackDemo - ======info  
14:09:01.531 [main] INFO  logback.LogbackDemo - ======info  
14:09:01.531 [main] WARN  logback.LogbackDemo - ======warn  
14:09:01.531 [main] WARN  logback.LogbackDemo - ======warn  
14:09:01.531 [main] ERROR logback.LogbackDemo - ======error  
14:09:01.531 [main] ERROR logback.LogbackDemo - ======error

*************************************詳解 >********************************
：
是的子節點，是負責寫日誌的元件。
有兩個必要屬性name和class。name指定appender名稱，class指定appender的全限定名。

1.ConsoleAppender:
把日誌新增到控制檯，有以下子節點：
：對日誌進行格式化。（具體引數稍後講解）
：字串 System.out 或者 System.err ，預設 System.out ；
例如：
Xml程式碼

<configuration>  

  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
    <encoder>  
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>  
    </encoder>  
  </appender>  

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

2.FileAppender:
把日誌新增到檔案，有以下子節點：
：被寫入的檔名，可以是相對目錄，也可以是絕對目錄，如果上級目錄不存在會自動建立，沒有預設值。
：如果是 true，日誌被追加到檔案結尾，如果是 false，清空現存檔案，預設是true。
：對記錄事件進行格式化。（具體引數稍後講解）
：如果是 true，日誌會被安全的寫入檔案，即使其他的FileAppender也在向此檔案做寫入操作，效率低，預設是 false。
例如：
Xml程式碼

<configuration>  

  <appender name="FILE" class="ch.qos.logback.core.FileAppender">  
    <file>testFile.log</file>  
    <append>true</append>  
    <encoder>  
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>  
    </encoder>  
  </appender>  

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

3.RollingFileAppender:
滾動記錄檔案，先將日誌記錄到指定檔案，當符合某個條件時，將日誌記錄到其他檔案。有以下子節點：
：被寫入的檔名，可以是相對目錄，也可以是絕對目錄，如果上級目錄不存在會自動建立，沒有預設值。
：如果是 true，日誌被追加到檔案結尾，如果是 false，清空現存檔案，預設是true。
：對記錄事件進行格式化。（具體引數稍後講解）
:當發生滾動時，決定 RollingFileAppender 的行為，涉及檔案移動和重新命名。
: 告知 RollingFileAppender 合適啟用滾動。
：當為true時，不支援FixedWindowRollingPolicy。支援TimeBasedRollingPolicy，但是有兩個限制，
1、不支援也不允許檔案壓縮，
2、不能設定file屬性，必須留空。

rollingPolicy：

TimeBasedRollingPolicy：最常用的滾動策略，它根據時間來制定滾動策略，既負責滾動也負責出發滾動。有以下子節點：
:
必要節點，包含檔名及“%d”轉換符， “%d”可以包含一個java.text.SimpleDateFormat指定的時間格式，如：%d{yyyy-MM}。如果直接使用 %d，預設格式是 yyyy-MM-dd。RollingFileAppender 的file位元組點可有可無，通過設定file，可以為活動檔案和歸檔檔案指定不同位置，當前日誌總是記錄到file指定的檔案（活動檔案），活動檔案的名字不會改變；如果沒設定file，活動檔案的名字會根據fileNamePattern 的值，每隔一段時間改變一次。“/”或者“\”會被當做目錄分隔符。

:
可選節點，控制保留的歸檔檔案的最大數量，超出數量就刪除舊檔案。假設設定每個月滾動，且是6，則只儲存最近6個月的檔案，刪除之前的舊檔案。注意，刪除舊檔案是，那些為了歸檔而建立的目錄也會被刪除。

FixedWindowRollingPolicy：根據固定視窗演算法重新命名檔案的滾動策略。有以下子節點：
:視窗索引最小值
:視窗索引最大值，當用戶指定的視窗過大時，會自動將視窗設定為12。
:
必須包含“%i”例如，假設最小值和最大值分別為1和2，命名模式為 mylog%i.log,會產生歸檔檔案mylog1.log和mylog2.log。還可以指定檔案壓縮選項，例如，mylog%i.log.gz 或者沒有log%i.log.zip

triggeringPolicy:
SizeBasedTriggeringPolicy：檢視當前活動檔案的大小，如果超過指定大小會告知RollingFileAppender 觸發當前活動檔案滾動。只有一個節點:
:這是活動檔案的大小，預設值是10MB。
例如：每天生成一個日誌檔案，儲存30天的日誌檔案。

Java程式碼

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

    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">   
      <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>   
      <maxHistory>30</maxHistory>    
    </rollingPolicy>   

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

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

例如：按照固定視窗模式生成日誌檔案，當檔案大於20MB時，生成新的日誌檔案。視窗大小是1到3，當儲存了3個歸檔檔案後，將覆蓋最早的日誌。
Xml程式碼

<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>

4.另外還有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，可以參考官方文件。當然大家可以編寫自己的Appender。
：
負責兩件事，一是把日誌資訊轉換成位元組陣列，二是把位元組陣列寫入到輸出流。
目前PatternLayoutEncoder 是唯一有用的且預設的encoder ，有一個節點，用來設定日誌的輸入格式。使用“%”加“轉換符”方式，如果要輸出“%”，則必須用“\”對“\%”進行轉義。
例如：
Xml程式碼

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

<filter>:

過濾器，執行一個過濾器會有返回個列舉值，即DENY，NEUTRAL，ACCEPT其中之一。返回DENY，日誌將立即被拋棄不再經過其他過濾器；返回NEUTRAL，有序列表裡的下個過濾器過接著處理日誌；返回ACCEPT，日誌會被立即處理，不再經過剩餘過濾器。
過濾器被新增到中，為新增一個或多個過濾器後，可以用任意條件對日誌進行過濾。有多個過濾器時，按照配置順序執行。
關於的詳細使用資訊請大家參見官網。

SLF4J+Logback 日誌框架使用

一：根節點包含的屬性：

二：根節點的子節點：

2.1設定上下文名稱：

2.2設定變數：

2.3獲取時間戳字串：

2.4設定loger：

SLF4J+Logback 日誌框架使用

SpringBoot整合Slf4j+logback日誌框架

SpringBoot 整合slf4j+logback日誌框架即ELK架構

Linux Jboss下logback日誌框架的輸出日誌只保留10天的問題

springboot2.x簡單詳細教程--整合Logback日誌框架（第十一章）

logback日誌框架的使用

spring-boot結合logback日誌框架

logback日誌框架（轉發）

11、Logback日誌框架介紹和SpringBoot整合實戰 2節課

java-web環境整合各種主流日誌框架(jcl,jul,slf4j,log4j,logback)總結

日誌框架Slf4j和Logback的使用說明

web開發-日誌框架-------slf4j+logback

JAVA日誌框架log4j和slf4j

【Java】日誌知識總結和經常使用組合配置(commons-logging,log4j,slf4j,logback)

SLF4J - 借助SLF4J, 統一適配所有日誌實現為logback日誌實現的實踐

slf4j日誌框架

slf4j + logback 輸出日誌：mybatis sql語句

IDEA整合日誌框架Log4j2+Slf4j詳細配置過程

log4j+slf4j管理日誌項目遷移logback+slf4j

日誌框架logback相對於log4j的優勢

SLF4J+Logback 日誌框架使用

一：根節點包含的屬性：

二：根節點的子節點：

2.1設定上下文名稱：

2.2設定變數：

2.3獲取時間戳字串：

2.4設定loger：

相關推薦