java 日誌框架總結

在項目開發過程當中，咱們能夠經過 debug 查找問題。而在線上環境咱們查找問題只能經過打印日誌的方式查找問題。所以對於一個項目而言，日誌記錄是一個很是重要的問題。所以，如何選擇一個合適的日誌記錄框架也很是重要。

在Java開發中，經常使用的日誌記錄框架有JDKLog、Log4J、LogBack、SLF4J、SLF4J。這些日誌記錄框架各有各的特色，各有各的應用場景。瞭解這些框架的特色及應用場景，有利於咱們作技術選型的時候作出正確的判斷。

JDKLog：日誌小刀

JDKLog是JDK官方提供的一個記錄日誌的方式，直接在JDK中就可使用。

import java.util.logging.Logger; /**** ** JDKLog Demo **/ public class JDKLog { public static void main( String[] args ) { Logger logger = Logger.getLogger("JDKLog"); logger.info("Hello World."); } }

JDKLog 的有點是使用很是簡單，直接在 JDK 中就可使用。但 JDKLog 功能比較太過於簡單，不支持佔位符顯示，拓展性比較差，因此如今用的人也不多。

Log4J：日誌大炮

Log4J 是 Apache 的一個日誌開源框架，有多個分級（DEBUG/INFO/WARN/ERROR）記錄級別，能夠很好地將不一樣日誌級別的日誌分開記錄，極大地方便了日誌的查看。

Log4J 有 1.X 版本和 2.X 版本，如今官方推薦使用 2.X 版本，2.X 版本在架構上進行了一些升級，配置文件也發生了一些變化。但好在官方的配置說明文檔很是清楚，經過查閱文檔能解決大部分的問題。

使用 Log4J 框架首先須要引入依賴的包：

<!-- Log4J --> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-api</artifactId> <version>2.6.2</version> </dependency> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-core</artifactId> <version>2.6.2</version> </dependency>

增長配置文件 log4j2.xml 放在 resource 目錄下：

<?xml version="1.0" encoding="UTF-8"?> <Configuration status="WARN"> <Appenders> <Console name="Console" target="SYSTEM_OUT"> <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/> </Console> </Appenders> <Loggers> <Root level="info"> <AppenderRef ref="Console"/> </Root> </Loggers> </Configuration>

其中節點的 level 屬性表示輸出的最低級別。

最後編寫一個測試類：

import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; /**** ** Log4J Demo **/ public class Log4jLog { public static void main(String args[]) { Logger logger = LogManager.getLogger(Log4jLog.class); logger.debug("Debug Level"); logger.info("Info Level"); logger.warn("Warn Level"); logger.error("Error Level"); } }

運行測試類輸出結果：

10:16:08.279 [main] INFO com.chanshuyi.Log4jLog - Info Level 10:16:08.280 [main] WARN com.chanshuyi.Log4jLog - Warn Level 10:16:08.280 [main] ERROR com.chanshuyi.Log4jLog - Error Level

若是沒有配置 log4j2.xml 配置文件，那麼LOG4J將自動啓用相似於下面的的配置文件：

<?xml version="1.0" encoding="UTF-8"?> <Configuration status="WARN"> <Appenders> <Console name="Console" target="SYSTEM_OUT"> <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/> </Console> </Appenders> <Loggers> <Root level="error"> <AppenderRef ref="Console"/> </Root> </Loggers> </Configuration>

使用默認配置文件的輸出結果：

ERROR StatusLogger No log4j2 configuration file found. Using default configuration: logging only errors to the console. 11:40:07.377 [main] ERROR com.chanshuyi.Log4jLog - Error Level

從上面的使用步驟能夠看出 Log4J 的使用稍微複雜一些，可是條理仍是很清晰的。並且由於 Log4J 有多個分級（DEBUG/INFO/WARN/ERROR）記錄級別，因此能夠很好地記錄不一樣業務問題。由於這些優勢，因此在幾年前幾乎全部人都使用 Log4J 做爲日誌記錄框架，羣衆基礎可謂很是深厚。

但 Log4J 自己也存在一些缺點，好比不支持使用佔位符，不利於代碼閱讀等缺點。可是相比起 JDKLog，Log4J 能夠說是很是好的日誌記錄框架了。

LogBack：日誌火箭

LogBack 其實能夠說是 Log4J 的進化版，由於它們兩個都是同一我的（Ceki Gülcü）設計的開源日誌組件。LogBack 除了具有 Log4j 的全部優勢以外，還解決了 Log4J 不能使用佔位符的問題。

使用 LogBack 須要首先引入依賴：

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

配置 logback.xml 配置文件：

<?xml version="1.0" encoding="UTF-8"?> <configuration> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <layout class="ch.qos.logback.classic.PatternLayout"> <Pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</Pattern> </layout> </appender> <logger name="com.chanshuyi" level="TRACE"/> <root level="debug"> <appender-ref ref="STDOUT" /> </root> </configuration>

LogBack 的日誌級別區分能夠細分到類或者包，這樣就可使日誌記錄變得更加靈活。以後在類文件中引入Logger類，並進行日誌記錄：

import org.slf4j.Logger; import org.slf4j.LoggerFactory; /**** ** LogBack Demo **/ public class LogBack { static final Logger logger = LoggerFactory.getLogger(LogBack.class); public static void main(String[] args) { logger.trace("Trace Level."); logger.debug("Debug Level."); logger.info("Info Level."); logger.warn("Warn Level."); logger.error("Error Level."); } }

輸出結果：

14:34:45.747 [main] TRACE com.chanshuyi.LogBack - Trace Level. 14:34:45.749 [main] DEBUG com.chanshuyi.LogBack - Debug Level. 14:34:45.749 [main] INFO com.chanshuyi.LogBack - Info Level. 14:34:45.749 [main] WARN com.chanshuyi.LogBack - Warn Level. 14:34:45.749 [main] ERROR com.chanshuyi.LogBack - Error Level.

LogBack 解決了 Log4J 不能使用佔位符的問題，這使得閱讀日誌代碼很是方便。除此以外，LogBack 比 Log4J 有更快的運行速度，更好的內部實現。而且 LogBack 內部集成了 SLF4J 能夠更原生地實現一些日誌記錄的實現。

SLF4J：適配器

上面說了 JDKLog、Log4J、LogBack 這幾個經常使用的日誌記錄框架，它們都有各自的優缺點，適合在不一樣的場景下使用。可能簡單的項目直接用 JDKLog 就能夠了，而複雜的項目須要用上 Log4J。

不少時候咱們作項目都是從簡單到複雜，也就是咱們極可能一開始使用的是 JDKLog，以後業務複雜了須要使用 Log4J，這時候咱們如何將原來寫好的日誌用新的日誌框架輸出呢？

一個最死板的方法就是一行行代碼修改，把以前用 JDKLog 的日誌代碼所有修改爲 Log4J 的日誌接口。可是這種方式不只效率低下，並且作的工做都是重複性的工做，這怎麼能忍呢。

正式由於在實際的項目應用中，有時候可能會從一個日誌框架切換到另一個日誌框架的需求，這時候每每須要在代碼上進行很大的改動。爲了不切換日誌組件時要改動代碼，這時候一個叫作 SLF4J（Simple Logging Facade for Java，即Java簡單日誌記錄接口集）的東西出現了。

SLF4J（Simple Logging Facade for Java，即Java簡單日誌記錄接口集）是一個日誌的接口規範，它對用戶提供了統一的日誌接口，屏蔽了不一樣日誌組件的差別。這樣咱們在編寫代碼的時候只須要看 SLF4J 這個接口文檔便可，不須要去理會不一樣日之框架的區別。而當咱們須要更換日誌組件的時候，咱們只須要更換一個具體的日誌組件Jar包就能夠了。

而整合 SLF4J 和日誌框架使用也是一件很簡單的事情。

SLF4J+JDKLog

SLF4J + JDKLog 須要在 Maven 中導入如下依賴包：

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

編寫測試類：

import org.slf4j.Logger; import org.slf4j.LoggerFactory; /**** ** SLF4J + JDKLog **/ public class Slf4jJDKLog { final static Logger logger = LoggerFactory.getLogger(Slf4jJDKLog.class); public static void main(String[] args) { logger.trace("Trace Level."); logger.info("Info Level."); logger.warn("Warn Level."); logger.error("Error Level."); } }

輸出結果：

七月 15, 2016 3:30:02 下午 com.chanshuyi.slf4j.Slf4jJDKLog main 信息: Info Level. 七月 15, 2016 3:30:02 下午 com.chanshuyi.slf4j.Slf4jJDKLog main 警告: Warn Level. 七月 15, 2016 3:30:02 下午 com.chanshuyi.slf4j.Slf4jJDKLog main 嚴重: Error Level.

SLF4J+LOG4J

須要依賴的 Jar 包：slf4j-api.jar、slf4j-412.jar、log4j.jar，導入Maven依賴：

<!-- 2.SLF4J + Log4J --> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.21</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId> <version>1.7.21</version> </dependency> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency>

配置 log4j.xml 文件：

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd"> <log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/' > <appender name="myConsole" class="org.apache.log4j.ConsoleAppender"> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="[%d{dd HH:mm:ss,SSS\} %-5p] [%t] %c{2\} - %m%n" /> </layout> <!--過濾器設置輸出的級別--> <filter class="org.apache.log4j.varia.LevelRangeFilter"> <param name="levelMin" value="debug" /> <param name="levelMax" value="error" /> <param name="AcceptOnMatch" value="true" /> </filter> </appender> <!-- 根logger的設置--> <root> <priority value ="debug"/> <appender-ref ref="myConsole"/> </root> </log4j:configuration>

咱們仍是用上面的代碼，無需作改變，運行結果爲：

[15 16:04:06,371 DEBUG] [main] slf4j.SLF4JLog - Debug Level. [15 16:04:06,371 INFO ] [main] slf4j.SLF4JLog - Info Level. [15 16:04:06,371 WARN ] [main] slf4j.SLF4JLog - Warn Level. [15 16:04:06,371 ERROR] [main] slf4j.SLF4JLog - Error Level.

SLF4J+LogBack

導入依賴：

<dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.21</version> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.1.7</version> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-core</artifactId> <version>1.1.7</version> </dependency>

配置 logback.xml 文件：

<?xml version="1.0" encoding="UTF-8"?> <configuration> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <layout class="ch.qos.logback.classic.PatternLayout"> <Pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</Pattern> </layout> </appender> <logger name="com.chanshuyi" level="TRACE"/> <root level="warn"> <appender-ref ref="STDOUT" /> </root> </configuration>

咱們仍是用上面的代碼，無需作改變，運行結果爲：

16:08:01.040 [main] TRACE com.chanshuyi.slf4j.SLF4JLog - Trace Level. 16:08:01.042 [main] DEBUG com.chanshuyi.slf4j.SLF4JLog - Debug Level. 16:08:01.043 [main] INFO com.chanshuyi.slf4j.SLF4JLog - Info Level. 16:08:01.043 [main] WARN com.chanshuyi.slf4j.SLF4JLog - Warn Level. 16:08:01.043 [main] ERROR com.chanshuyi.slf4j.SLF4JLog - Error Level.