最全LogBack 詳解、含java案例和配置說明

（一）logback  java使用 一、 logback介紹

Logback是由log4j創始人設計的又一個開源日誌組件。logback當前分成三個模組：logback-core,logback- classic和logback-access。logback-core是其它兩個模組的基礎模組。logback-classic是log4j的一個 改良版本。此外logback-classic完整實現SLF4J API使你可以很方便地更換成其它日誌系統如log4j或JDK14 Logging。logback-access訪問模組與Servlet容器整合提供通過Http來訪問日誌的功能（來源於百度百科）。

二、maven依賴

<!-- logback+slf4j -->  <dependency>      <groupId>org.slf4j</groupId>      <artifactId>slf4j-api</artifactId>      <version>1.6.0</version>      <type>jar</type>      <scope>compile</scope>  </dependency>  <dependency>      <groupId>ch.qos.logback</groupId>      <artifactId>logback-core</artifactId>      <version>0.9.28</version>      <type>jar</type>  </dependency>  <dependency>      <groupId>ch.qos.logback</groupId>      <artifactId>logback-classic</artifactId>      <version>0.9.28</version>      <type>jar</type>  </dependency>  

如果你沒有使用maven，那麼你自己去下載jar包吧...

三.日誌 使用
我們使用org.slf4j.LoggerFactory，就可以直接使用日誌了。

public class TestController extends BaseController {      protected final Logger    logger = LoggerFactory.getLogger(TestController.class);        public void hello(){          logger.debug("DEBUG TEST 這個地方輸出DEBUG層級的日誌");          logger.info("INFO test 這個地方輸出INFO層級的日誌");          logger.error("ERROR test 這個地方輸出ERROR層級的日誌");      }    }

（二）logback  配置詳解
一：根節點<configuration>包含的屬性： scan: 當此屬性設定為true時，設定檔如果發生改變，將會被重新載入，預設值為true。 scanPeriod: 設定監測設定檔是否有修改的時間間隔，如果沒有給出時間單位，預設單位是毫秒。當scan為true時，此屬性生效。預設的時間間隔為1分鐘。 debug: 當此屬性設定為true時，將列印出logback內部日誌資訊，即時查看logback運行狀態。預設值為false。

例如：

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

二：根節點<configuration>的子節點：

設定上下文名稱：<contextName>

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

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

設定變數： <property>

用來定義變數值的標籤，<property> 有兩個屬性name和value； name: 變數的名稱 value: 的值時變數定義的值。

通過<property>定義的值會被插入到logger上下文中。定義變數後，可以使“${}”來使用變數。

例如使用<property>定義上下文名稱，然後在<contentName>設定logger上下文時使用。

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

擷取時間戳記字串：<timestamp>

兩個屬性: key: 標識此<timestamp> 的名字； datePattern: 設定將目前時間（解析設定檔的時間）轉換為字串的模式，遵循java.txt.SimpleDateFormat的格式。

例如將解析設定檔的時間作為上下文名稱：

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

設定loger： <loger>

用來設定某一個包或者具體的某一個類的日誌列印層級、以及指定<appender>。<loger>僅有一個name屬性，一個可選的level和一個可選的addtivity屬性。

name: 用來指定受此loger約束的某一個包或者具體的某一個類。

level: 用來設定列印層級，大小寫無關：TRACE, DEBUG, INFO,WARN,ERROR,ALL和OFF，還有一個特俗值INHERITED或者同義字NULL`，代表強制執行上級的層級。 如果未設定此屬性，那麼當前loger將會繼承上級的層級。

addtivity: 是否向上級loger傳遞列印資訊。預設是true。 <root>

也是<loger>元素，但是它是根loger。只有一個level屬性，應為已經被命名為"root". level: 用來設定列印層級，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能設定為INHERITED或者同義字NULL。 預設是DEBUG。

<loger>和<root>可以包含零個或多個<appender-ref>元素，標識這個appender將會添加到這個loger。

例如： LogbackDemo.java類

<!-- lang: 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");      }  }

<span style="font-family: Arial, Helvetica, sans-serif; background-color: rgb(255, 255, 255);"></span>

<span style="font-family: Arial, Helvetica, sans-serif; background-color: rgb(255, 255, 255);"></span>

三、logback.xml設定檔 第1種：只配置root

<!-- lang: 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 level="INFO">將root的列印層級設定為“INFO”，指定了名字為“STDOUT”的appender。

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

列印結果如下：

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：

<!-- lang: 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"/>     <root level="DEBUG">                 <appender-ref ref="STDOUT" />     </root>     </configuration>

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

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

列印結果如下：

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:

<!-- lang: 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>

輸出結果：

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

沒有設定addtivity，預設為true，將此logger的列印資訊向上級傳遞。

沒有設定appender，此logger本身不列印任何資訊。

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

<root level=”DEBUG”>將root的列印層級設定為“ERROR”，指定了名字為“STDOUT”的appender。

當執行logback.LogbackDemo類的main方法時，先執行<logger name=”logback.LogbackDemo” level=”INFO” additivity=”false”>，將層級為“INFO”及大於“INFO”的日誌資訊交給此logger指定的名為“STDOUT”的appender處理，在控制台中打出日誌，不再向次logger的上級 <logger name=”logback”/> 傳遞列印資訊。

<logger name=”logback”/>未接到任何列印資訊，當然也不會給它的上級root傳遞任何列印資訊。

如果將<logger name=”logback.LogbackDemo” level=”INFO” additivity=”false”>修改為 <logger name=”logback.LogbackDemo” level=”INFO” additivity=”true”>那列印結果將是什麼呢。
沒錯，日誌列印了兩次，想必大家都知道原因了，因為列印資訊向上級傳遞，logger本身列印一次，root接到後又列印一次：

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