slf4j

簡介

SLF4J，即簡單日誌門面(Simple Logging Facade for Java)，不是具體的日誌解決方案，它只服務於各種各樣的日誌系統。在使用SLF4J的時候，不需要在程式碼中或配置檔案中指定你打算使用那個具體的日誌系統。

使用步驟

1. 引入slf4j依賴，這裡以maven專案為例

<dependencies>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId
 
>
        <version>1.7.22</version>
    </dependency>
</dependencies>

1. 程式碼編寫記錄日誌語句,示例如下

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

/**
 * 
 * Created by xuyh at 2017年8月24日 下午4:01:57.
 */
public class Main {
    //定義日誌物件
    private static Logger logger = LoggerFactory.getLogger(Main.class);

    public
 
 static void main(String... strings) {
        //級別為debug的日誌
        logger.debug("Hello! debug!");
        //級別為info的日誌
        logger.info("Hello! info!");
        //級別為warn的日誌
        logger.warn("Hello! warn!");
        //級別為error的日誌
        logger.error("Hello! error!");
    }
}

以上兩步即可記錄日誌了，不過在執行程式之後會出現如下問題:

SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

說明光引入slf4j還不夠，必須得挑選一個具體的日誌元件實現來完成日誌的記錄，下面介紹一款不錯的日誌實現:logback

logback

logback簡介

Logback是由log4j創始人設計的一個開源日誌元件。logback當前分成三個模組：logback-core,logback-classic和logback-access。logback-core是其它兩個模組的基礎模組。logback-classic是log4j的一個改良版本。

我們這裡的例項使用到logback-classic

使用步驟

1. 引入slf4j以及logback依賴，這裡以maven專案為例

<dependencies>

    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.22</version>
    </dependency>

    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.1.6</version>
    </dependency>

</dependencies>

1. classpath中編寫logback的配置檔案logback.xml, 以maven專案為例，logback.xml檔案放在/src/main/resources/路徑中

logback.xml配置例項及註釋詳解

<?xml version="1.0" encoding="UTF-8"?>
<!-- scan:當此屬性設定為true時，配置檔案如果發生改變，將會被重新載入，預設值為true。 
     scanPeriod:設定監測配置檔案是否有修改的時間間隔，如果沒有給出時間單位，預設單位是毫秒。當scan為true時，此屬性生效。預設的時間間隔為1分鐘。
     debug:當此屬性設定為true時，將打印出logback內部日誌資訊，實時檢視logback執行狀態。預設值為false。 -->
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <!-- 上下文變數設定,用來定義變數值,其中name的值是變數的名稱，value的值時變數定義的值。
        通過<property>定義的值會被插入到logger上下文中。定義變數後，可以使“${}”來使用變數。 -->
    <property name="CONTEXT_NAME" value="logback-test" />

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

    <!-- <appender>是<configuration>的子節點，是負責寫日誌的元件。
        有兩個必要屬性name和class。
        name指定appender名稱，
        class指定appender的實現類。 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!-- 對日誌進行格式化。 -->
        <encoder>
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss.SSS}|%level|%class|%thread|%method|%line|%msg%n
            </pattern>
        </encoder>
    </appender>

    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 被寫入的檔名，可以是相對目錄，也可以是絕對目錄，如果上級目錄不存在會自動建立，沒有預設值。 -->
        <file>${logs.dir}/logback-test.log</file>

        <!-- 當發生滾動時的行為  -->
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <!-- 必須包含“%i”例如，假設最小值和最大值分別為1和2，命名模式為 mylog%i.log,會產生歸檔檔案mylog1.log和mylog2.log。還可以指定檔案壓縮選項，例如，mylog%i.log.gz 或者 沒有log%i.log.zip -->
            <FileNamePattern>${logs.dir}/logback-test.%i.log</FileNamePattern>
            <!-- 視窗索引最小值 -->
            <minIndex>1</minIndex>
            <!-- 視窗索引最大值 -->
            <maxIndex>1</maxIndex>
        </rollingPolicy>

        <!-- 啟用滾動的條件。 -->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <!-- 活動檔案的大小，預設值是10MB -->
            <maxFileSize>30MB</maxFileSize>
        </triggeringPolicy>

        <!-- 對記錄事件進行格式化。 -->
        <encoder>
            <charset>UTF-8</charset>
            <Pattern>
                %d{yyyy-MM-dd HH:mm:ss.SSS}|%level|%class|%thread|%method|%line|%msg%n
            </Pattern>
        </encoder>
    </appender>

    <!-- 特殊的<logger>元素，是根logger。只有一個level屬性，應為已經被命名為"root".
        level:設定列印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能設定為INHERITED或者同義詞NULL。預設是DEBUG。
        <root>可以包含零個或多個<appender-ref>元素，標識這個appender將會新增到這個loger。 -->
    <root>
        <level value="WARN" />
        <appender-ref ref="stdout" />
        <appender-ref ref="file" />
    </root>

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

</configuration>

1. 通過以上配置，在程式執行之後，slf4j會載入logback的日誌實現，然後logback從類路徑中讀取logback.xml檔案中的日誌配置資訊，實現日誌的記錄等功能。

重新執行以上程式，結果如下：

2017-08-24 17:00:22.354|DEBUG|xuyihao.logback.test.Main|main|main|14|Hello! debug!
2017-08-24 17:00:22.354|INFO|xuyihao.logback.test.Main|main|main|15|Hello! info!
2017-08-24 17:00:22.354|WARN|xuyihao.logback.test.Main|main|main|16|Hello! warn!
2017-08-24 17:00:22.354|ERROR|xuyihao.logback.test.Main|main|main|17|Hello! error!