java領域存在多種日誌框架,目前經常使用的日誌框架包括Log4j 1,Log4j 2,Commons Logging,Slf4j,Logback,Jul。html
Commons Logging是經過動態查找機制,在程序運行時,使用本身的ClassLoader尋找和載入本地具體的實現。詳細策略能夠查看commons-logging-*.jar包中的org.apache.commons.logging.impl.LogFactoryImpl.java文件。因爲Osgi不一樣的插件使用獨立的ClassLoader,Osgi的這種機制保證了插件互相獨立, 其機制限制了Commons Logging在Osgi中的正常使用。Slf4j在編譯期間,靜態綁定本地的Log庫,所以能夠在Osgi中正常使用。它是經過查找類路徑下org.slf4j.impl.StaticLoggerBinder,而後在StaticLoggerBinder中進行綁定。java
若是是在一個新的項目中建議使用Slf4j與Logback組合,這樣有以下的幾個優勢:web
jar包名 | 說明 |
---|---|
slf4j-log4j12-1.7.13.jar | Log4j1.2版本的橋接器,你須要將Log4j.jar加入Classpath。 |
slf4j-jdk14-1.7.13.jar | java.util.logging的橋接器,Jdk原生日誌框架。 |
slf4j-nop-1.7.13.jar | NOP橋接器,默默丟棄一切日誌。 |
slf4j-simple-1.7.13.jar | 一個簡單實現的橋接器,該實現輸出全部事件到System.err. 只有Info以及高於該級別的消息被打印,在小型應用中它也許是有用的。 |
slf4j-jcl-1.7.13.jar | Jakarta Commons Logging 的橋接器. 這個橋接器將Slf4j全部日誌委派給Jcl。 |
logback-classic-1.0.13.jar(requires logback-core-1.0.13.jar) | Slf4j的原生實現,Logback直接實現了Slf4j的接口,所以使用Slf4j與Logback的結合使用也意味更小的內存與計算開銷。 |
當咱們在同一項目中使用不一樣的組件時應該若是解決不一樣組件依賴的日誌組件不一致的狀況呢?如今咱們須要統一日誌方案,統一使用Slf4j,把他們的日誌輸出重定向到Slf4j,而後Slf4j又會根據綁定器把日誌交給具體的日誌實現工具。Slf4j帶有幾個橋接模塊,能夠重定向Log4j,JCL和java.util.logging中的Api到Slf4j。算法
jar包名 | 做用 |
---|---|
log4j-over-slf4j-version.jar | 將Log4j重定向到Slf4j |
jcl-over-slf4j-version.jar | 將Commons Logging裏的Simple Logger重定向到slf4j |
jul-to-slf4j-version.jar | 將Java Util Logging重定向到Slf4j |
在使用Slf4j橋接時要注意避免造成死循環,在項目依賴的jar包中不要存在如下狀況:spring
多個日誌jar包造成死循環的條件 | 產生緣由 |
---|---|
log4j-over-slf4j.jar和slf4j-log4j12.jar同時存在 | 因爲slf4j-log4j12.jar的存在會將全部日誌調用委託給log4j。但因爲同時因爲log4j-over-slf4j.jar的存在,會將全部對log4j api的調用委託給相應等值的slf4j,因此log4j-over-slf4j.jar和slf4j-log4j12.jar同時存在會造成死循環 |
jul-to-slf4j.jar和slf4j-jdk14.jar同時存在 | 因爲slf4j-jdk14.jar的存在會將全部日誌調用委託給jdk的log。但因爲同時jul-to-slf4j.jar的存在,會將全部對jul api的調用委託給相應等值的slf4j,因此jul-to-slf4j.jar和slf4j-jdk14.jar同時存在會造成死循環 |
logback主要包含三個組成部分:Loggers(日誌記錄器)、Appenders(輸出目的在)、Layouts(日誌輸出格式)
logback 主要分爲三個模塊,分別是:sql
logback-core:提供基礎功能,是其餘兩個模塊的基礎
logback-classic : log4j的升級,實現了self4j api
logback-access:用於與sevlet容器進行集成、提供網絡訪問日誌的功能數據庫
logback初始化時,默認會去classpath下依次加載以下配置文件(logback.groovy、logback-test.xml、logback.xml),當找不到配置文件時logback將爲rootLogger 添加一個 ConsoleAppender ,用於將日誌輸出到控制檯。apache
編程時但是要以下代碼查看logback內部運行狀況:編程
LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory(); StatusPrinter.print(lc);
對於web項目,可配置sevlet,而後經過網頁查看logback內部運行狀態,以下:設計模式
<!-- 經過瀏覽器以html形式查看logback內部狀態 :http://host/yourWebapp/lbClassicStatus --> <servlet> <servlet-name>ViewStatusMessages</servlet-name> <servlet-class>ch.qos.logback.classic.ViewStatusMessagesServlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>ViewStatusMessages</servlet-name> <url-pattern>/lbClassicStatus</url-pattern> </servlet-mapping>
首先,在pom文件引入相關依賴,以下:
<dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.7</version> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-core</artifactId> <version>1.1.7</version> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-access</artifactId> <version>1.1.7</version> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.1.7</version> </dependency>
接着,編寫logback.xml(位於classpath目錄下,此處爲src/main/resources目錄)
<?xml version="1.0" encoding="UTF-8"?> <!--debug="true" : 打印logback內部狀態(默認當logback運行出錯時纔會打印內部狀態 ),配置該屬性後打印條件以下(同時知足): 一、找到配置文件 二、配置文件是一個格式正確的xml文件 也可編程實現打印內部狀態,例如: LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory(); StatusPrinter.print(lc); --> <!-- scan="true" : 自動掃描該配置文件,如有修改則從新加載該配置文件 --> <!-- scanPeriod="30 seconds" : 配置自動掃面時間間隔(單位能夠是:milliseconds, seconds, minutes or hours,默認爲:milliseconds), 默認爲1分鐘,scan="true"時該配置纔會生效 --> <configuration debug="false" scan="true" scanPeriod="30 seconds" packagingData="true"> <!-- 設置 logger context 名稱,一旦設置不可改變,默認爲default --> <contextName>myAppName</contextName> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <!-- encoders are by default assigned the type ch.qos.logback.classic.encoder.PatternLayoutEncoder --> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> </appender> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 當前活動日誌文件名 --> <file>./my_log.log</file> <!-- 文件滾動策略根據%d{patter}中的「patter」而定,此處爲天天產生一個文件 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- 歸檔文件名「.zip或.gz結尾」,表示歸檔文件自動壓縮 --> <FileNamePattern>./my_log%d{yyyyMMdd}.log.zip</FileNamePattern> <maxHistory>30</maxHistory> </rollingPolicy> <!--rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> <fileNamePattern>renhai%i.log</fileNamePattern> <minIndex>1</minIndex> <maxIndex>10</maxIndex> </rollingPolicy> <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <maxFileSize>20MB</maxFileSize> </triggeringPolicy--> <!-- <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> rollover daily <fileNamePattern>mylog-%d{yyyy-MM-dd}.%i.log</fileNamePattern> each file should be at most 30MB, keep 60 days worth of history, but at most 20GB <maxFileSize>30MB</maxFileSize> <maxHistory>60</maxHistory> <totalSizeCap>20GB</totalSizeCap> </rollingPolicy> --> <encoder> <pattern>%d{HH:mm:ss.SSS}[%-5level][%thread]%logger{36} - %msg%n</pattern> <!-- <pattern>%d{HH:mm:ss.SSS}[%-5level][%thread] - %msg%n</pattern> --> </encoder> </appender> <!-- 日誌級別若沒顯示定義,則繼承最近的父logger(該logger需顯示定義level,直到rootLogger)的日誌級別--> <!-- logger的appender默認具備累加性(默認日誌輸出到當前logger的appender和全部祖先logger的appender中),可經過配置 「additivity」屬性修改默認行爲--> <logger name="com.yinz" level="debug" additivity="false" > <appender-ref ref="FILE"/> </logger> <!-- 至多隻能配置一個root --> <root level="debug"> <appender-ref ref="STDOUT" /> <appender-ref ref="FILE" /> </root> </configuration>
最後,就能夠在程序中使用logback了,例如:
package com.yinz.aaa; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class Test { public static void main(String[] args) { Logger logger = LoggerFactory.getLogger(Test.class); logger.debug("test........"); } }
有幾點須要注意:
logger的父子關係,由logger的名稱決定,例若有三個logger,分別爲:java.lang.util 、 java.lang 、java
則,java是java.lang的父logger, 是java.lang.util的祖先logger. 而同時java.lang是java.lang.util的父logger
參考: Logger日誌定義、級別、記錄、繼承
Logger、appender及layout
1. Logger做爲日誌的記錄器,把它關聯到應用的對應的context上後,主要用於存放日誌對象,也能夠定義日誌類型、級別。
2. Appender主要用於指定日誌輸出的目的地,目的地能夠是控制檯、文件、遠程套接字服務器、 MySQL、PostreSQL、 Oracle和其餘數據庫、 JMS和遠程UNIX Syslog守護進程等。
3. Layout 負責把事件轉換成字符串,格式化的日誌信息的輸出。
各個logger 都被關聯到一個 LoggerContext,LoggerContext負責製造logger,也負責以樹結構排列各logger。其餘全部logger也經過org.slf4j.LoggerFactory 類的靜態方法getLogger取得。 getLogger方法以 logger名稱爲參數。用同一名字調用LoggerFactory.getLogger 方法所獲得的永遠都是同一個logger對象的引用。
Logger 能夠被分配級別。級別包括:TRACE、DEBUG、INFO、WARN 和 ERROR,定義於ch.qos.logback.classic.Level類。若是 logger沒有被分配級別,那麼它將從有被分配級別的最近的祖先那裏繼承級別。root logger 默認級別是 DEBUG。
打印方法決定記錄請求的級別。例如,若是 L 是一個 logger 實例,那麼,語句 L.info("..")是一條級別爲 INFO的記錄語句。記錄請求的級別在高於或等於其 logger 的有效級別時被稱爲被啓用,不然,稱爲被禁用。記錄請求級別爲 p,其 logger的有效級別爲 q,只有則當 p>=q時,該請求才會被執行。
該規則是 logback 的核心。級別排序爲: TRACE < DEBUG < INFO < WARN < ERROR
logback的默認配置
若是配置文件 logback-test.xml 和 logback.xml 都不存在,那麼 logback 默認地會調用BasicConfigurator ,建立一個最小化配置。最小化配置由一個關聯到根 logger 的ConsoleAppender 組成。輸出用模式爲%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 進行格式化。root logger 默認級別是 DEBUG。
Logback 配置文件的語法很是靈活。正由於靈活,因此沒法用 DTD 或 XML schema 進行定義。儘管如此,能夠這樣描述配置文件的基本結構:以<configuration>開頭,後面有零個或多個<appender>元素,有零個或多個<logger>元素,有最多一個<root>元素。
logback.xml經常使用配置詳解
(1) 根節點<configuration>,包含下面三個屬性:
scan: 當此屬性設置爲true時,配置文件若是發生改變,將會被從新加載,默認值爲true。
scanPeriod: 設置監測配置文件是否有修改的時間間隔,若是沒有給出時間單位,默認單位是毫秒。當scan爲true時,此屬性生效。默認的時間間隔爲1分鐘。
debug: 當此屬性設置爲true時,將打印出logback內部日誌信息,實時查看logback運行狀態。默認值爲false。
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false"> <!--其餘配置省略--> </configuration>
(2) 子節點<contextName>:用來設置上下文名稱,每一個logger都關聯到logger上下文,默認上下文名稱爲default。但可使用<contextName>設置成其餘名字,用於區分不一樣應用程序的記錄。一旦設置,不能修改。
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false"> <contextName>myAppName</contextName> <!--其餘配置省略--> </configuration>
(3) 子節點<property> :用來定義變量值,它有兩個屬性name和value,經過<property>定義的值會被插入到logger上下文中,可使「${}」來使用變量。
name: 變量的名稱
value: 的值時變量定義的值
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false"> <property name="APP_Name" value="myAppName" /> <contextName>${APP_Name}</contextName> <!--其餘配置省略--> </configuration>
(4) 子節點<timestamp>:獲取時間戳字符串,他有兩個屬性key和datePattern
key: 標識此<timestamp> 的名字;
datePattern: 設置將當前時間(解析配置文件的時間)轉換爲字符串的模式,遵循java.txt.SimpleDateFormat的格式。
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false"> <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/> <contextName>${bySecond}</contextName> <!-- 其餘配置省略--> </configuration>
(5) 子節點<appender>:負責寫日誌的組件,它有兩個必要屬性name和class。name指定appender名稱,class指定appender的全限定名
5.一、ConsoleAppender 把日誌輸出到控制檯,有如下子節點:
<encoder>:對日誌進行格式化。(具體參數稍後講解 )
<target>:字符串System.out(默認)或者System.err(區別很少說了)
例如:
<configuration> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern> </encoder> </appender> <root level="DEBUG"> <appender-ref ref="STDOUT" /> </root> </configuration>
上述配置表示把>=DEBUG級別的日誌都輸出到控制檯
5.二、FileAppender:把日誌添加到文件,有如下子節點:
<file>:被寫入的文件名,能夠是相對目錄,也能夠是絕對目錄,若是上級目錄不存在會自動建立,沒有默認值。
<append>:若是是 true,日誌被追加到文件結尾,若是是 false,清空現存文件,默認是true。
<encoder>:對記錄事件進行格式化。(具體參數稍後講解 )
<prudent>:若是是 true,日誌會被安全的寫入文件,即便其餘的FileAppender也在向此文件作寫入操做,效率低,默認是 false。
例如:
<configuration> <appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>testFile.log</file> <append>true</append> <encoder> <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> </encoder> </appender> <root level="DEBUG"> <appender-ref ref="FILE" /> </root> </configuration>
上述配置表示把>=DEBUG級別的日誌都輸出到testFile.log
5.三、RollingFileAppender:滾動記錄文件,先將日誌記錄到指定文件,當符合某個條件時,將日誌記錄到其餘文件。有如下子節點:
<file>:被寫入的文件名,能夠是相對目錄,也能夠是絕對目錄,若是上級目錄不存在會自動建立,沒有默認值。
<append>:若是是 true,日誌被追加到文件結尾,若是是 false,清空現存文件,默認是true。
<rollingPolicy>:當發生滾動時,決定RollingFileAppender的行爲,涉及文件移動和重命名。屬性class定義具體的滾動策略類
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy": 最經常使用的滾動策略,它根據時間來制定滾動策略,既負責滾動也負責出發滾動。有如下子節點:
<fileNamePattern>:必要節點,包含文件名及「%d」轉換符,「%d」能夠包含一個java.text.SimpleDateFormat指定的時間格式,如:%d{yyyy-MM}。若是直接使用 %d,默認格式是 yyyy-MM-dd。RollingFileAppender的file字節點無關緊要,經過設置file,能夠爲活動文件和歸檔文件指定不一樣位置,當前日誌老是記錄到file指定的文件(活動文件),活動文件的名字不會改變;
若是沒設置file,活動文件的名字會根據fileNamePattern 的值,每隔一段時間改變一次。「/」或者「」會被當作目錄分隔符。
<maxHistory>:可選節點,控制保留的歸檔文件的最大數量,超出數量就刪除舊文件。假設設置每月滾動,且<maxHistory>是6,則只保存最近6個月的文件,刪除以前的舊文件。注意,刪除舊文件是,那些爲了歸檔而建立的目錄也會被刪除。
class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy": 查看當前活動文件的大小,若是超過指定大小會告知RollingFileAppender 觸發當前活動文件滾動。只有一個節點:
<maxFileSize>:這是活動文件的大小,默認值是10MB。
<prudent>:當爲true時,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,可是有兩個限制,1不支持也不容許文件壓縮,2不能設置file屬性,必須留空。
<triggeringPolicy>: 告知 RollingFileAppender 合適激活滾動。
class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根據固定窗口算法重命名文件的滾動策略。有如下子節點:
<minIndex>:窗口索引最小值
<maxIndex>:窗口索引最大值,當用戶指定的窗口過大時,會自動將窗口設置爲12。
<fileNamePattern>:必須包含「%i」例如,假設最小值和最大值分別爲1和2,命名模式爲 mylog%i.log,會產生歸檔文件mylog1.log和mylog2.log。還能夠指定文件壓縮選項,例如,mylog%i.log.gz 或者 沒有log%i.log.zip
例如:
<configuration> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern> <maxHistory>30</maxHistory> </rollingPolicy> <encoder> <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> </encoder> </appender> <root level="DEBUG"> <appender-ref ref="FILE" /> </root> </configuration>
備註:上述配置表示天天生成一個日誌文件,保存30天的日誌文件。
<configuration> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>test.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> <fileNamePattern>tests.%i.log.zip</fileNamePattern> <minIndex>1</minIndex> <maxIndex>3</maxIndex> </rollingPolicy> <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <maxFileSize>5MB</maxFileSize> </triggeringPolicy> <encoder> <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> </encoder> </appender> <root level="DEBUG"> <appender-ref ref="FILE" /> </root> </configuration>
備註:上述配置表示按照固定窗口模式生成日誌文件,當文件大於20MB時,生成新的日誌文件。窗口大小是1到3,當保存了3個歸檔文件後,將覆蓋最先的日誌。(分別爲tests.1.log.zip、tests.2.log.zip、tests.3.log.zip)
<encoder>:對記錄事件進行格式化。負責兩件事,一是把日誌信息轉換成字節數組,二是把字節數組寫入到輸出流。
PatternLayoutEncoder 是惟一有用的且默認的encoder ,有一個<pattern>節點,用來設置日誌的輸入格式。使用「%」加「轉換符」方式,若是要輸出「%」,則必須用「」對「%」進行轉義。
<encoder>:
負責兩件事,一是把日誌信息轉換成字節數組,二是把字節數組寫入到輸出流。
目前PatternLayoutEncoder 是惟一有用的且默認的encoder ,有一個<pattern>節點,用來設置日誌的輸入格式。使用「%」加「轉換符」方式,>若是要輸出「%」,則必須用「」對「%」進行轉義。
例如:<encoder> <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> </encoder><pattern>裏面的轉換符說明:
5.四、還有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender,並不經常使用,這裏就不詳解了。
你們能夠參考官方文檔(http://logback.qos.ch/documen...),還能夠編寫本身的Appender。
(6)子節點<loger>:用來設置某一個包或具體的某一個類的日誌打印級別、以及指定<appender>。<loger>僅有一個name屬性,一個可選的level和一個可選的addtivity屬性。
能夠包含零個或多個<appender-ref>元素,標識這個appender將會添加到這個loger
name: 用來指定受此loger約束的某一個包或者具體的某一個類。
level: 用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,還有一個特俗值INHERITED或者同義詞NULL,表明強制執行上級的級別。 若是未設置此屬性,那麼當前loger將會繼承上級的級別。
addtivity: 是否向上級loger傳遞打印信息。默認是true。同<loger>同樣,能夠包含零個或多個<appender-ref>元素,標識這個appender將會添加到這個loger。
additivity的做用在於 children-logger是否使用 rootLogger配置的appender進行輸出。
false:表示只用當前logger的appender-ref。
true:表示當前logger的appender-ref和rootLogger的appender-ref都有效。
(7)子節點<root>:它也是<loger>元素,可是它是根loger,是全部<loger>的上級。只有一個level屬性,由於name已經被命名爲"root",且已是最上級了。
level: 用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,不能設置爲INHERITED或者同義詞NULL。 默認是DEBUG。
6、經常使用loger配置
<!-- show parameters for hibernate sql 專爲 Hibernate 定製 --> <logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" /> <logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="DEBUG" /> <logger name="org.hibernate.SQL" level="DEBUG" /> <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" /> <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" /> <!--myibatis log configure--> <logger name="com.apache.ibatis" level="TRACE"/> <logger name="java.sql.Connection" level="DEBUG"/> <logger name="java.sql.Statement" level="DEBUG"/> <logger name="java.sql.PreparedStatement" level="DEBUG"/>
https://www.cnblogs.com/chenh...
https://www.cnblogs.com/warki...
http://www.cnblogs.com/yinz/p...
https://www.cnblogs.com/bigbe... Spring Boot 日誌配置方法(超詳細)