java日誌logback入門

我們的項目中日誌是必不可少的，好的日誌可以爲我們無論在開發，測試還是實際應用中都能幫助我們快速方便的解決問題，查找問題，我們今天介紹下logback的簡單入門:

logback 繼承自 log4j，它建立在有十年工業經驗的日誌系統之上。它比其它所有的日誌系統更快並且更小，包含了許多獨特並且有用的特性。

首先新建一個java的maven項目，

在pom.xml中添加：

<!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-classic -->
		<dependency>
		  <groupId>ch.qos.logback</groupId>
		  <artifactId>logback-classic</artifactId>
		  <version>1.1.7</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-core -->
		<dependency>
		  <groupId>ch.qos.logback</groupId>
		  <artifactId>logback-core</artifactId>
		  <version>1.1.7</version>
		</dependency>
		
		<!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-access -->
		<dependency>
		  <groupId>ch.qos.logback</groupId>
		  <artifactId>logback-access</artifactId>
		  <version>1.1.7</version>
		</dependency>
		
		<dependency>
		  <groupId>org.slf4j</groupId>
		  <artifactId>slf4j-api</artifactId>
		  <version>1.6.4</version>
		</dependency>

然後在classpath目錄下，添加logback.xml，並添加如下內容：

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan:當此屬性設置爲true時，配置文件如果發生改變，將會被重新加載，默認值爲true。
scanPeriod:設置監測配置文件是否有修改的時間間隔，(通俗講：就是設置多長時間查看一下logback.xml文件有沒有被修改）如果沒有給出時間單位，
            默認單位是毫秒。當scan爲true時，此屬性生效。默認的時間間隔爲1分鐘。
debug:當此屬性設置爲true時，將打印出logback內部日誌信息，實時查看logback運行狀態。默認值爲false。
-->
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <!-- 整個logback.xml文件中只有四個主要的標籤：其一是根標籤configuration，其餘是三個子標籤：appende，logger，root
    　　但是有人會疑問：那property和timestamp是做什麼的？答案是：這兩個標籤是用來爲以上提到的是三個子標籤定義屬性和賦值的。例如：
    　　第一個property標籤中定義了一個USER_HOME屬性，其值是/logs，scope是這個屬性的作用範圍，scope="context"是指該屬性只能在本配置文件中使用。
    　　而timestamp定義了一個時間戳，也就是定義了一個時間格式，以供三個子標籤使用。
    -->
    <property name="USER_HOME" value="D:/logs" />
    <property scope="context" name="FILE_NAME" value="mylog-logback" />
    <timestamp key="byDay" datePattern="yyyy-MM-dd" />

    <!-- 第一個子標籤appender：
　　name:標籤名，爲了讓其他標籤調用的唯一標示，相當於html標籤中的id
　　class:引用的類，從此類中可以看出該appender標籤定義的是日誌輸出的位置，也就是往哪裏輸出
　　ch.qos.logback.core.ConsoleAppender可以看出是往控制檯上輸出。
　　encoder：該標籤中定義了日誌的輸出格式
-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度   %msg：日誌消息，%n是換行符
                  級別分別是：TRACE < DEBUG < INFO <WARN < ERROR
            -->
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n </pattern>
        </encoder>
    </appender>

    <!--
　　class:從此類中可以看出該appender標籤定義的日誌輸出位置是回滾文件，也就是說：把日誌輸出到一個文件中，並且該文件可以回滾，至於怎麼回滾請看下面的註釋
    -->
    <appender name="log_file"  class="ch.qos.logback.core.rolling.RollingFileAppender">

        <!--   定義了日誌文件的目錄結構和文件名：磁盤根目錄：/logs/mylog-logback.log
        　　注意了：該文件名是在日誌文件沒有觸發回滾要求時的文件名，也就是說現在的日誌文件還沒有滿足xxMB，
        一旦滿足了就會按照rollingPolicy裏設置的屬性進行重新命名
        -->
        <file>${USER_HOME}/${FILE_NAME}-${byDay}.log</file>
        <!--  rollingPolicy：回滾策略
        　　fileNamePattern：標籤中定義的是日誌文件一旦滿足5MB就重新命名成新文件的命名格式，
        其中minIndex和maxIndex分別對應的是滿足5MB的日誌文件的命名序號（1~10）對應%i.log中的i值。
        如：mylog-logback-2016-07-12-1.log，mylog-logback-2016-07-12-2.log，mylog-logback-2016-07-12-3.log
        -->
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>${USER_HOME}/${byDay}/${FILE_NAME}-${byDay}-%i.log</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>10</maxIndex>
        </rollingPolicy>
        <!-- 觸發策略：當日志文件滿足5MB就會出發回滾策略-->
        <triggeringPolicy   class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>5MB</maxFileSize>
        </triggeringPolicy>
        <!--%-4relative 表示，將輸出從程序啓動到創建日誌記錄的時間 進行左對齊 且最小寬度爲4。-->
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} %-4relative [%thread] %-5level %logger{35} - %msg%n
            </pattern>
        </encoder>

    </appender>

    <!-- 設置哪個目錄或者包，類使用哪個日誌
    將com.xdf包下的所有類的日誌的打印，level是打印級別：debug，如果不設置level，它將繼承它的上級<root>的日誌級別“DEBUG”
    如果沒有設置addtivity，默認爲true，將此loger的打印信息向上級傳遞；
    如果沒有設置appender-ref，此loger本身不打印任何信息。
    -->
    <!--    <logger name="com.fsdm" level="debug" additivity="true">
            <appender-ref ref="console" />
        </logger>-->

    <root level="debug">
        <appender-ref ref="log_file" />
        <appender-ref ref="console" />
    </root>
</configuration>

接下來我們寫測試類：

package com.log;

import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import junit.framework.TestCase;

public class LogTest extends TestCase {

	@Test
	public void test() {
		Logger logger = LoggerFactory.getLogger(this.getClass());
 		logger.error("error");
 		logger.warn("warn");
 		logger.info("info");
 		logger.debug("debug");
 		logger.trace("trace");
	}
}

然後我們看到D:\logs目錄下生成了相應的日誌文件:

我們可以在文件和控制檯都能看到相應的日誌內容：

以上就是簡單的logback入門，後面我們會繼續深入logback.