在項目開發中,爲了跟蹤代碼的運行狀況,經常要使用日誌來記錄信息。php
在 Java 世界,有不少的日誌工具庫來實現日誌功能,避免了咱們重複造輪子。html
咱們先來逐一瞭解一下主流日誌工具。java
:notebook: 本文已歸檔到:「blog」git
JDK1.4 開始,經過 java.util.logging
提供日誌功能。github
它能知足基本的日誌須要,可是功能沒有 Log4j 強大,並且使用範圍也沒有 Log4j 普遍。web
Log4j 是 apache 的一個開源項目,創始人 Ceki Gulcu。spring
Log4j 應該說是 Java 領域資格最老,應用最廣的日誌工具。從誕生之日到如今一直廣受業界歡迎。數據庫
Log4j 是高度可配置的,並可經過在運行時的外部文件配置。它根據記錄的優先級別,並提供機制,以指示記錄信息到許多的目的地,諸如:數據庫,文件,控制檯,UNIX 系統日誌等。apache
Log4j 中有三個主要組成部分:api
Logback 是由 log4j 創始人 Ceki Gulcu 設計的又一個開源日記組件,目標是替代 log4j。
logback 當前分紅三個模塊:logback-core
、logback-classic
和 logback-access
。
logback-core
- 是其它兩個模塊的基礎模塊。logback-classic
- 是 log4j 的一個 改良版本。此外 logback-classic
完整實現 SLF4J API 使你能夠很方便地更換成其它日記系統如 log4j 或 JDK14 Logging。logback-access
- 訪問模塊與 Servlet 容器集成提供經過 Http 來訪問日記的功能。按照官方的說法,Log4j2 是 Log4j 和 Logback 的替代。
Log4j2 架構:
按照官方的說法,Log4j2 大大優於 Log4j 和 Logback。
那麼,Log4j2 相比於先問世的 Log4j 和 Logback,它具備哪些優點呢?
何謂日誌門面?
日誌門面是對不一樣日誌框架提供的一個 API 封裝,能夠在部署的時候不修改任何配置便可接入一種日誌實現方案。
common-logging 是 apache 的一個開源項目。也稱Jakarta Commons Logging,縮寫 JCL。
common-logging 的功能是提供日誌功能的 API 接口,自己並不提供日誌的具體實現(固然,common-logging 內部有一個 Simple logger 的簡單實現,可是功能很弱,直接忽略),而是在運行時動態的綁定日誌實現組件來工做(如 log4j、java.util.loggin)。
全稱爲 Simple Logging Facade for Java,即 java 簡單日誌門面。
什麼,做者又是 Ceki Gulcu!這位大神寫了 Log4j、Logback 和 slf4j,專一日誌組件開發五百年,一直只能超越本身。
相似於 Common-Logging,slf4j 是對不一樣日誌框架提供的一個 API 封裝,能夠在部署的時候不修改任何配置便可接入一種日誌實現方案。可是,slf4j 在編譯時靜態綁定真正的 Log 庫。使用 SLF4J 時,若是你須要使用某一種日誌實現,那麼你必須選擇正確的 SLF4J 的 jar 包的集合(各類橋接包)。
slf4j 庫相似於 Apache Common-Logging。可是,他在編譯時靜態綁定真正的日誌庫。這點彷佛很麻煩,其實也不過是導入橋接 jar 包而已。
slf4j 一大亮點是提供了更方便的日誌記錄方式:
不須要使用logger.isDebugEnabled()
來解決日誌由於字符拼接產生的性能問題。slf4j 的方式是使用{}
做爲字符串替換符,形式以下:
logger.debug("id: {}, name: {} ", id, name);
複製代碼
綜上所述,使用 slf4j + Logback 可謂是目前最理想的日誌解決方案了。
接下來,就是如何在項目中實施了。
使用日誌解決方案基本可分爲三步:
常見的各類日誌解決方案的第 2 步和第 3 步基本同樣,實施上的差異主要在第 1 步,也就是使用不一樣的庫。
這裏首選推薦使用 slf4j + logback 的組合。
若是你習慣了 common-logging,能夠選擇 common-logging+log4j。
強烈建議不要直接使用日誌實現組件(logback、log4j、java.util.logging),理由前面也說過,就是沒法靈活替換日誌庫。
還有一種狀況:你的老項目使用了 common-logging,或是直接使用日誌實現組件。若是修改老的代碼,工做量太大,須要兼容處理。在下文,都將看到各類應對方法。
注:據我所知,當前仍沒有方法能夠將 slf4j 橋接到 common-logging。若是我孤陋寡聞了,請不吝賜教。
slf4j + logback
添加依賴到 pom.xml 中便可。
logback-classic-1.0.13.jar 會自動將 slf4j-api-1.7.21.jar 和 logback-core-1.0.13.jar 也添加到你的項目中。
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.0.13</version>
</dependency>
複製代碼
slf4j + log4j
添加依賴到 pom.xml 中便可。
slf4j-log4j12-1.7.21.jar 會自動將 slf4j-api-1.7.21.jar 和 log4j-1.2.17.jar 也添加到你的項目中。
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.7.21</version>
</dependency>
複製代碼
slf4j + java.util.logging
添加依賴到 pom.xml 中便可。
slf4j-jdk14-1.7.21.jar 會自動將 slf4j-api-1.7.21.jar 也添加到你的項目中。
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-jdk14</artifactId>
<version>1.7.21</version>
</dependency>
複製代碼
在介紹解決方案前,先提一個概念——橋接
什麼是橋接呢
假如你正在開發應用程序所調用的組件當中已經使用了 common-logging,這時你須要 jcl-over-slf4j.jar 把日誌信息輸出重定向到 slf4j-api,slf4j-api 再去調用 slf4j 實際依賴的日誌組件。這個過程稱爲橋接。下圖是官方的 slf4j 橋接策略圖:
從圖中應該能夠看出,不管你的老項目中使用的是 common-logging 或是直接使用 log4j、java.util.logging,均可以使用對應的橋接 jar 包來解決兼容問題。
slf4j 兼容 common-logging
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jcl-over-slf4j</artifactId>
<version>1.7.12</version>
</dependency>
複製代碼
slf4j 兼容 log4j
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>log4j-over-slf4j</artifactId>
<version>1.7.12</version>
</dependency>
複製代碼
slf4j 兼容 java.util.logging
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jul-to-slf4j</artifactId>
<version>1.7.12</version>
</dependency>
複製代碼
作 java web 開發,基本離不開 spring 框架。很遺憾,spring 使用的日誌解決方案是 common-logging + log4j。
因此,你須要一個橋接 jar 包:logback-ext-spring。
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.1.3</version>
</dependency>
<dependency>
<groupId>org.logback-extensions</groupId>
<artifactId>logback-ext-spring</artifactId>
<version>0.1.2</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jcl-over-slf4j</artifactId>
<version>1.7.12</version>
</dependency>
複製代碼
common-logging + log4j
添加依賴到 pom.xml 中便可。
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
<version>1.2</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
複製代碼
使用 slf4j 的 API 很簡單。使用LoggerFactory
初始化一個Logger
實例,而後調用 Logger 對應的打印等級函數就好了。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class App {
private static final Logger log = LoggerFactory.getLogger(App.class);
public static void main(String[] args) {
String msg = "print log, current level: {}";
log.trace(msg, "trace");
log.debug(msg, "debug");
log.info(msg, "info");
log.warn(msg, "warn");
log.error(msg, "error");
}
}
複製代碼
common-logging 用法和 slf4j 幾乎同樣,可是支持的打印等級多了一個更高級別的:fatal。
此外,common-logging 不支持{}
替換參數,你只能選擇拼接字符串這種方式了。
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
public class JclTest {
private static final Log log = LogFactory.getLog(JclTest.class);
public static void main(String[] args) {
String msg = "print log, current level: ";
log.trace(msg + "trace");
log.debug(msg + "debug");
log.info(msg + "info");
log.warn(msg + "warn");
log.error(msg + "error");
log.fatal(msg + "fatal");
}
}
複製代碼
log4j2 基本配置形式以下:
<?xml version="1.0" encoding="UTF-8"?>;
<Configuration>
<Properties>
<Property name="name1">value</property>
<Property name="name2" value="value2"/>
</Properties>
<Filter type="type" ... />
<Appenders>
<Appender type="type" name="name">
<Filter type="type" ... />
</Appender>
...
</Appenders>
<Loggers>
<Logger name="name1">
<Filter type="type" ... />
</Logger>
...
<Root level="level">
<AppenderRef ref="name"/>
</Root>
</Loggers>
</Configuration>
複製代碼
配置示例:
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="debug" strict="true" name="XMLConfigTest" packages="org.apache.logging.log4j.test">
<Properties>
<Property name="filename">target/test.log</Property>
</Properties>
<Filter type="ThresholdFilter" level="trace"/>
<Appenders>
<Appender type="Console" name="STDOUT">
<Layout type="PatternLayout" pattern="%m MDC%X%n"/>
<Filters>
<Filter type="MarkerFilter" marker="FLOW" onMatch="DENY" onMismatch="NEUTRAL"/>
<Filter type="MarkerFilter" marker="EXCEPTION" onMatch="DENY" onMismatch="ACCEPT"/>
</Filters>
</Appender>
<Appender type="Console" name="FLOW">
<Layout type="PatternLayout" pattern="%C{1}.%M %m %ex%n"/><!-- class and line number -->
<Filters>
<Filter type="MarkerFilter" marker="FLOW" onMatch="ACCEPT" onMismatch="NEUTRAL"/>
<Filter type="MarkerFilter" marker="EXCEPTION" onMatch="ACCEPT" onMismatch="DENY"/>
</Filters>
</Appender>
<Appender type="File" name="File" fileName="${filename}">
<Layout type="PatternLayout">
<Pattern>%d %p %C{1.} [%t] %m%n</Pattern>
</Layout>
</Appender>
</Appenders>
<Loggers>
<Logger name="org.apache.logging.log4j.test1" level="debug" additivity="false">
<Filter type="ThreadContextMapFilter">
<KeyValuePair key="test" value="123"/>
</Filter>
<AppenderRef ref="STDOUT"/>
</Logger>
<Logger name="org.apache.logging.log4j.test2" level="debug" additivity="false">
<AppenderRef ref="File"/>
</Logger>
<Root level="trace">
<AppenderRef ref="STDOUT"/>
</Root>
</Loggers>
</Configuration>
複製代碼
<configuration>
<configuration>
是 logback 配置文件的根元素。<appender>
、<logger>
、<root>
三個子元素。<appender>
<file>
、<filter>
、<layout>
、<encoder>
四個子元素。<file>
<filter>
<layout>
<encoder>
<logger>
<appender-ref>
<root>
<logger>
中的相同。<appender-ref>
,與 <logger>
中的相同。在下面的配置文件中,我爲本身的項目代碼(根目錄:org.zp.notes.spring)設置了五種等級:
TRACE、DEBUG、INFO、WARN、ERROR,優先級依次從低到高。
由於關注 spring 框架自己的一些信息,我增長了專門打印 spring WARN 及以上等級的日誌。
<?xml version="1.0" encoding="UTF-8" ?>
<!-- logback中一共有5種有效級別,分別是TRACE、DEBUG、INFO、WARN、ERROR,優先級依次從低到高 -->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<property name="DIR_NAME" value="spring-helloworld"/>
<!-- 將記錄日誌打印到控制檯 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] [%-5p] %c{36}.%M - %m%n</pattern>
</encoder>
</appender>
<!-- RollingFileAppender begin -->
<appender name="ALL" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 根據時間來制定滾動策略 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${user.dir}/logs/${DIR_NAME}/all.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>30</maxHistory>
</rollingPolicy>
<!-- 根據文件大小來制定滾動策略 -->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<maxFileSize>30MB</maxFileSize>
</triggeringPolicy>
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] [%-5p] %c{36}.%M - %m%n</pattern>
</encoder>
</appender>
<appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 根據時間來制定滾動策略 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${user.dir}/logs/${DIR_NAME}/error.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>30</maxHistory>
</rollingPolicy>
<!-- 根據文件大小來制定滾動策略 -->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<maxFileSize>10MB</maxFileSize>
</triggeringPolicy>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] [%-5p] %c{36}.%M - %m%n</pattern>
</encoder>
</appender>
<appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 根據時間來制定滾動策略 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${user.dir}/logs/${DIR_NAME}/warn.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>30</maxHistory>
</rollingPolicy>
<!-- 根據文件大小來制定滾動策略 -->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<maxFileSize>10MB</maxFileSize>
</triggeringPolicy>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>WARN</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] [%-5p] %c{36}.%M - %m%n</pattern>
</encoder>
</appender>
<appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 根據時間來制定滾動策略 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${user.dir}/logs/${DIR_NAME}/info.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>30</maxHistory>
</rollingPolicy>
<!-- 根據文件大小來制定滾動策略 -->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<maxFileSize>10MB</maxFileSize>
</triggeringPolicy>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] [%-5p] %c{36}.%M - %m%n</pattern>
</encoder>
</appender>
<appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 根據時間來制定滾動策略 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${user.dir}/logs/${DIR_NAME}/debug.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>30</maxHistory>
</rollingPolicy>
<!-- 根據文件大小來制定滾動策略 -->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<maxFileSize>10MB</maxFileSize>
</triggeringPolicy>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>DEBUG</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] [%-5p] %c{36}.%M - %m%n</pattern>
</encoder>
</appender>
<appender name="TRACE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 根據時間來制定滾動策略 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${user.dir}/logs/${DIR_NAME}/trace.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>30</maxHistory>
</rollingPolicy>
<!-- 根據文件大小來制定滾動策略 -->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<maxFileSize>10MB</maxFileSize>
</triggeringPolicy>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>TRACE</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] [%-5p] %c{36}.%M - %m%n</pattern>
</encoder>
</appender>
<appender name="SPRING" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 根據時間來制定滾動策略 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${user.dir}/logs/${DIR_NAME}/springframework.%d{yyyy-MM-dd}.log
</fileNamePattern>
<maxHistory>30</maxHistory>
</rollingPolicy>
<!-- 根據文件大小來制定滾動策略 -->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<maxFileSize>10MB</maxFileSize>
</triggeringPolicy>
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] [%-5p] %c{36}.%M - %m%n</pattern>
</encoder>
</appender>
<!-- RollingFileAppender end -->
<!-- logger begin -->
<!-- 本項目的日誌記錄,分級打印 -->
<logger name="org.zp.notes.spring" level="TRACE" additivity="false">
<appender-ref ref="STDOUT"/>
<appender-ref ref="ERROR"/>
<appender-ref ref="WARN"/>
<appender-ref ref="INFO"/>
<appender-ref ref="DEBUG"/>
<appender-ref ref="TRACE"/>
</logger>
<!-- SPRING框架日誌 -->
<logger name="org.springframework" level="WARN" additivity="false">
<appender-ref ref="SPRING"/>
</logger>
<root level="TRACE">
<appender-ref ref="ALL"/>
</root>
<!-- logger end -->
</configuration>
複製代碼
log4j 的配置文件通常有 xml 格式或 properties 格式。這裏爲了和 logback.xml 作個對比,就不介紹 properties 了,其實也沒太大差異。
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/'>
<appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss,SSS\} [%-5p] [%t] %c{36\}.%M - %m%n"/>
</layout>
<!--過濾器設置輸出的級別-->
<filter class="org.apache.log4j.varia.LevelRangeFilter">
<param name="levelMin" value="debug"/>
<param name="levelMax" value="fatal"/>
<param name="AcceptOnMatch" value="true"/>
</filter>
</appender>
<appender name="ALL" class="org.apache.log4j.DailyRollingFileAppender">
<param name="File" value="${user.dir}/logs/spring-common/jcl/all"/>
<param name="Append" value="true"/>
<!-- 天天從新生成日誌文件 -->
<param name="DatePattern" value="'-'yyyy-MM-dd'.log'"/>
<!-- 每小時從新生成日誌文件 -->
<!--<param name="DatePattern" value="'-'yyyy-MM-dd-HH'.log'"/>-->
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss,SSS\} [%-5p] [%t] %c{36\}.%M - %m%n"/>
</layout>
</appender>
<!-- 指定logger的設置,additivity指示是否遵循缺省的繼承機制-->
<logger name="org.zp.notes.spring" additivity="false">
<level value="error"/>
<appender-ref ref="STDOUT"/>
<appender-ref ref="ALL"/>
</logger>
<!-- 根logger的設置-->
<root>
<level value="warn"/>
<appender-ref ref="STDOUT"/>
</root>
</log4j:configuration>
複製代碼