slf4j log4j logback關(guān)系詳解和相關(guān)用法

昵稱10087950 2017-12-25

展開全文

寫java也有一段時(shí)間了，一直都有用slf4j log4j輸出日志的習(xí)慣。但是始終都是抱著“拿來主義”的態(tài)度，復(fù)制粘貼下配置文件就開始編碼了，于是這段時(shí)間詳細(xì)的看了下日志庫。

slf4j log4j logback的關(guān)系

The Simple Logging Facade for Java是什么？

籠統(tǒng)的講就是slf4j是一系列的日志接口，而log4j logback是具體實(shí)現(xiàn)了的日志框架。接下來我們跟著官方文檔詳細(xì)的來看一下他們的關(guān)系。

The Simple Logging Facade for Java (SLF4J) serves as a simple facade or abstraction for various logging frameworks, such as java.util.logging, logback and log4j. SLF4J allows the end-user to plug in the desired logging framework at deployment time. Note that SLF4J-enabling your library/application implies the addition of only a single mandatory dependency, namely slf4j-api-1.7.21.jar.

官方文檔的這一段話已經(jīng)明確描述了三者的關(guān)系。slf4j譯為簡單日志門面，是日志框架的抽象。而log4j和logback是眾多日志框架中的幾種。

這里寫了幾行簡單的代碼來驗(yàn)證一下。

public class Program {
    public static void main(String[] args) {
        Logger logger = LoggerFactory.getLogger(Program.class);
        logger.info("hello world");
    }
}

從運(yùn)行結(jié)果可以看到，由于沒有給出具體的logger實(shí)現(xiàn)，無法在控制臺輸出日志。也就是說我們在具體開發(fā)中，需要綁定一個(gè)日志框架，才能正常的使用slf4j。

log4j和logback呢？

而log4j和logback就是兩個(gè)受歡迎的日志框架。但兩者又有不同。

log4j是apache實(shí)現(xiàn)的一個(gè)開源日志組件。（Wrapped implementations）
logback同樣是由log4j的作者設(shè)計(jì)完成的，擁有更好的特性，用來取代log4j的一個(gè)日志框架。是slf4j的原生實(shí)現(xiàn)。（Native implementations）

enter image description here
上圖可以看到應(yīng)用程序?qū)θ罩究蚣艿恼{(diào)用關(guān)系。應(yīng)用程序調(diào)用slf4j api，而日志的輸出最終是由底層的日志框架來實(shí)現(xiàn)的。這張圖也提現(xiàn)了log4j和logback的不同。

官方文檔對logback的描述

NATIVE IMPLEMENTATION There are also SLF4J bindings external to the SLF4J project, e.g. logback which implements SLF4J natively. Logback's ch.qos.logback.classic.Logger class is a direct implementation of SLF4J's org.slf4j.Logger interface. Thus, using SLF4J in conjunction with logback involves strictly zero memory and computational overhead.

可以看到logback是直接實(shí)現(xiàn)了slf4j的接口，是不消耗內(nèi)存和計(jì)算開銷的。而log4j不是對slf4j的原生實(shí)現(xiàn)，所以slf4j api在調(diào)用log4j時(shí)需要一個(gè)適配層。

總結(jié)：

slf4j是java的一個(gè)日志門面，實(shí)現(xiàn)了日志框架一些通用的api，log4j和logback是具體的日志框架。
他們可以單獨(dú)的使用，也可以綁定slf4j一起使用。

單獨(dú)使用。分別調(diào)用框架自己的方法來輸出日志信息。
綁定slf4j一起使用。調(diào)用slf4j的api來輸入日志信息，具體使用與底層日志框架無關(guān)（需要底層框架的配置文件）

顯然這里我們不推薦單獨(dú)使用日志框架。假設(shè)項(xiàng)目中已經(jīng)使用了log4j，而我們此時(shí)加載了一個(gè)類庫，而這個(gè)類庫依賴另一個(gè)日志框架。這個(gè)時(shí)候我們就需要維護(hù)兩個(gè)日志框架，這是一個(gè)非常麻煩的事情。而使用了slf4j就不同了，由于應(yīng)用調(diào)用的抽象層的api，與底層日志框架是無關(guān)的，因此可以任意更換日志框架。

使用slf4j綁定日志系統(tǒng)的優(yōu)勢

軟件工程的角度。抽象，解耦，便于維護(hù)。可以參考一下上面的例子。
語法設(shè)計(jì)角度。slf4j有{}占位符，而log4j需要用“+”來連接字符串，既不利于閱讀，同時(shí)消耗了內(nèi)存（heap memory）。
詳細(xì)的描述可以參考：http://www./7450.html

log4j與logback

作為log4j的開發(fā)者，對log4j一定不陌生，他是apache的一個(gè)開源日志框架。而logback相對于log4j來說，更新一點(diǎn)，是由log4j的作者設(shè)計(jì)實(shí)現(xiàn)的，第一個(gè)版本是2011推出的。無論從設(shè)計(jì)上還是實(shí)現(xiàn)上，Logback相對log4j而言有了相對多的改進(jìn)。但是兩者的用法幾乎差別不大。下面是logback的優(yōu)勢：

更快的執(zhí)行速度
充分的測試
logback-classic 非常自然的實(shí)現(xiàn)了SLF4J
豐富的擴(kuò)展文檔
可以使用使用XML配置文件或者Groovy
自動(dòng)重新載入配置文件
優(yōu)雅地從I/O錯(cuò)誤中恢復(fù)
自動(dòng)清除舊的日志歸檔文件
自動(dòng)壓縮歸檔日志文件
更多優(yōu)點(diǎn)可以參考官方文檔。中文版英文版

以上，從性能的角度，可以盡快從log4j遷移到logback上來。

slf4j綁定log4j的用法

由于現(xiàn)在log4j使用的還比較多，所以介紹下他的基本用法。

ide相關(guān)設(shè)置

這里我們使用的IntelliJ IDEA2016.1和maven。

在pom.xml添加相關(guān)依賴。

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.21</version>
</dependency>

此時(shí)會自動(dòng)添加三個(gè)jar包。

配置文件

log4j的正常運(yùn)行需要配置文件，配置文件類型：log4j配置文件可以是log4j.xml也可以是log4j.properties。需要為其配置root、appender、layout等信息。

雖然網(wǎng)上大多數(shù)教程都是用log4j.properties來配置的（鍵值對），但是我個(gè)人覺得用xml配置，節(jié)點(diǎn)更清晰，而且在idea下有代碼提示，可以降低配置錯(cuò)誤的概率。下面我就就不具體講配置文件了，只提幾個(gè)關(guān)鍵的地方。

必須配置root logger和一個(gè)appender。

日志輸出級別，由高到低為

    FATAL        
    ERROR      
    WARN        
    INFO        
    DEBUG

下面給出配置文件。

<?xml version="1.0"  encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration>

    <!--若干個(gè)appender的定義-->
    <!--org.apache.log4j.ConsoleAppender 輸出到控制臺-->
    <appender name="myConsole" class="org.apache.log4j.ConsoleAppender">
        <!--輸出格式-->
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                   value="%-d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n"/>
        </layout>
    </appender>

    <!--org.apache.log4j.DailyRollingFileAppender 每天產(chǎn)生一個(gè)日志文件-->
    <appender name="myFile" class="org.apache.log4j.DailyRollingFileAppender">
        <param name="File" value="output.log"/><!--文件位置-->
        <param name="Append" value="true"/><!--是否選擇追加-->
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                   value="%-d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n"/>
        </layout>
    </appender>

    <!--org.apache.log4j.RollingFileAppender 滾動(dòng)日志文件輸出 文件大小到達(dá)一定尺寸時(shí)重新產(chǎn)生新的文件-->
    <!--<appender name="myFile" class="org.apache.log4j.RollingFileAppender">
        <param name="File" value="D:/output.log" />
        <param name="Append" value="true" />
        <param name="MaxFileSize" value="500KB"/>
        <param name="MaxBackupIndex" value="10" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%p (%c:%L)- %m%n" />
        </layout>
    </appender>-->

    <!--將各個(gè)包中的類日志輸出到不同的日志文件中
        這樣可以便于日志的分類。
        可以通過這個(gè)設(shè)置，把業(yè)務(wù)邏輯的日志添加到數(shù)據(jù)庫。起到過濾的作用
    -->
    <!--這段配置的就是說把包名為“com.zjut.a1”且優(yōu)先級為debug的日志通過myFile這個(gè)appender來處理。
    -->
    <category name="com.zjut.a1">
        <priority value="debug"/>
        <appender-ref ref="myFile"/>
    </category>


    <!-- 根logger的設(shè)置-->
    <root>
        <!--優(yōu)先級設(shè)置，假設(shè)設(shè)置為“info”，則無法輸出debug級別的日志-->
        <priority value="debug"/>
        <!--<priority value="info"/>-->
        <!--<priority value="warn"/>-->
        <!--<priority value="error"/>-->
        <!--<priority value="fatal"/>-->

        <!--添加剛才設(shè)置的appender-->
        <appender-ref ref="myConsole"/>
        <appender-ref ref="myFile"/>
    </root>
</log4j:configuration>

控制臺輸出日志的配置文件（復(fù)制可以直接用）

<?xml version="1.0"  encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration>
    <appender name="myConsole" class="org.apache.log4j.ConsoleAppender">
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                   value="%-d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n"/>
        </layout>
    </appender>
    <root>
        <priority value="debug"/>
        <appender-ref ref="myConsole"/>
    </root>
</log4j:configuration>

配置文件詳解，可以參考：http://zengxiantao./blog/1881700

應(yīng)用調(diào)用

 // 類名.class
Logger logger = LoggerFactory.getLogger(Program.class);
// 輸出字符串
logger.debug("this is a debug msg");
// 占位符
logger.debug("hi，welcome {}，today is {}","admin","Sunday");

slf4j綁定logback的用法

pom.xml添加依賴

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

網(wǎng)上教程添加了很多，其實(shí)只要添加這一個(gè)，其他的依賴jar都會被下載下來。

配置文件

配置文件幾乎和log4j差不多，如下。選擇需要的appender就可以了。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>


    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoders are assigned the type
             ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
        <encoder>
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
        </encoder>
    </appender>

    <!-- Insert the current time formatted as "yyyyMMdd'T'HHmmss" under
         the key "bySecond" into the logger context. This value will be
         available to all subsequent configuration elements. -->
    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>

    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>testFile-${bySecond}.log</file>
        <append>true</append>
        <!-- encoders are assigned the type
             ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
        <encoder>
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="DAYFILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logFile.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- daily rollover -->
            <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>

            <!-- keep 30 days' worth of history capped at 3GB total size -->
            <maxHistory>30</maxHistory>
            <totalSizeCap>3GB</totalSizeCap>

        </rollingPolicy>

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

    <root level="debug">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="DAYFILE"/>
        <appender-ref ref="FILE"/>
    </root>
</configuration>

詳細(xì)配置文件，可以參考http://logback./manual/index.html
雖然是英文的，但是寫的已經(jīng)是非常清楚了。

程序調(diào)用

同為slf4j的api，代碼相同。

 // 類名.class
Logger logger = LoggerFactory.getLogger(Program.class);
// 輸出字符串
logger.debug("this is a debug msg");
// 占位符
logger.debug("hi，welcome {}，today is {}","admin","Sunday");

參考文獻(xiàn)

本站是提供個(gè)人知識管理的網(wǎng)絡(luò)存儲空間，所有內(nèi)容均由用戶發(fā)布，不代表本站觀點(diǎn)。請注意甄別內(nèi)容中的聯(lián)系方式、誘導(dǎo)購買等信息，謹(jǐn)防詐騙。如發(fā)現(xiàn)有害或侵權(quán)內(nèi)容，請點(diǎn)擊一鍵舉報(bào)。

轉(zhuǎn)藏 分享

QQ空間 QQ好友新浪微博微信

獻(xiàn)花（0） +1

來自：昵稱10087950 > 《JAVA》

舉報(bào)/認(rèn)領(lǐng)