本文主要介紹一下slf4j+logback在java工程中的配置,面向的讀者主要是已經對slf4j+logback有一定了解的同學,但是在文章開頭也做了一些知識鋪墊,下面咱們進入正題。
在介紹slf4j+logback配置之前,首先對日誌組件logback進行介紹。
(一)日誌組件logback的介紹及配置使用方法
一、logback的介紹
Logback是由log4j創始人設計的又一個開源日誌組件。 logback當前分成三個模塊:logback-core,logback- classic和logback-access。 logback-core是其它兩個模塊的基礎模塊。 logback-classic是log4j的一個改良版本。此外logback-classic完整實現SLF4J API使你可以很方便地更換成其它日誌系統如log4j或JDK14 Logging。 logback-access訪問模塊與Servlet容器集成提供通過Http來訪問日誌的功能。 Logback是要與SLF4J結合起來用兩個組件的官方網站如下:
logback的官方網站: http://logback.qos.ch
SLF4J的官方網站:http://www.slf4j.org
本文章用到的組件如下:請自行到官方網站下載!
logback-access-1.0.0.jar
logback-classic-1.0.0.jar
logback-core-1.0.0.jar
slf4j-api-1.6.0.jar
二、logback取代log4j的理由:
Logback和log4j是非常相似的,如果你對log4j很熟悉,那對logback很快就會得心應手。下面列了logback相對於log4j的一些優點:
1、更快的實現Logback的內核重寫了,在一些關鍵執行路徑上性能提升10倍以上。而且logback不僅性能提升了,初始化內存加載也更小了。
2、非常充分的測試Logback經過了幾年,數不清小時的測試。 Logback的測試完全不同級別的。在作者的觀點,這是簡單重要的原因選擇logback而不是log4j。
3、Logback-classic非常自然實現了SLF4j Logback-classic實現了SLF4j。在使用SLF4j中,你都感覺不到logback-classic。而且因為logback-classic非常自然地實現了SLF4J, 所以切換到log4j或者其他,非常容易,只需要提供成另一個jar包就OK,根本不需要去動那些通過SLF4JAPI實現的代碼。
4、非常充分的文檔官方網站有兩百多頁的文檔。
5、自動重新加載配置文件當配置文件修改了,Logback-classic能自動重新加載配置文件。掃描過程快且安全,它並不需要另外創建一個掃描線程。這個技術充分保證了應用程序能跑得很歡在JEE環境裡面。
6、Lilith Lilith是log事件的觀察者,和log4j的chainsaw類似。而lilith還能處理大數量的log數據。
7、謹慎的模式和非常友好的恢復在謹慎模式下,多個FileAppender實例跑在多個JVM下,能夠安全地寫道同一個日誌文件。 RollingFileAppender會有些限制。 Logback的FileAppender和它的子類包括RollingFileAppender能夠非常友好地從I/O異常中恢復。
8、配置文件可以處理不同的情況開發人員經常需要判斷不同的Logback配置文件在不同的環境下(開發,測試,生產)。而這些配置文件僅僅只有一些很小的不同,可以通過,和來實現,這樣一個配置文件就可以適應多個環境。
9、Filters(過濾器) 有些時候,需要診斷一個問題,需要打出日誌。在log4j,只有降低日誌級別,不過這樣會打出大量的日誌,會影響應用性能。在Logback,你可以繼續保持那個日誌級別而除掉某種特殊情況,如alice這個用戶登錄,她的日誌將打在DEBUG級別而其他用戶可以繼續打在WARN級別。要實現這個功能只需加4行XML配置。可以參考MDCFIlter 。
10、SiftingAppender(一個非常多功能的Appender) 它可以用來分割日誌文件根據任何一個給定的運行參數。如,SiftingAppender能夠區別日誌事件跟進用戶的Session,然後每個用戶會有一個日誌文件。
11、自動壓縮已經打出來的log RollingFileAppender在產生新文件的時候,會自動壓縮已經打出來的日誌文件。壓縮是個異步過程,所以甚至對於大的日誌文件,在壓縮過程中應用不會受任何影響。
12、堆棧樹帶有包版本Logback在打出堆棧樹日誌時,會帶上包的數據。
13、自動去除舊的日誌文件通過設置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory屬性,你可以控制已經產生日誌文件的最大數量。如果設置maxHistory 12,那那些log文件超過12個月的都會被自動移除。
總之,logback比log4j太優秀了,讓我們的應用全部建立logback上吧!
三、Logback的配置介紹
1、Logger、appender及layout
Logger作為日誌的記錄器,把它關聯到應用的對應的context上後,主要用於存放日誌對象,也可以定義日誌類型、級別。
Appender主要用於指定日誌輸出的目的地,目的地可以是控制台、文件、遠程套接字服務器、 MySQL、PostreSQL、 Oracle和其他數據庫、 JMS和遠程UNIX Syslog守護進程等。
Layout 負責把事件轉換成字符串,格式化的日誌信息的輸出。
2、logger context
各個logger 都被關聯到一個LoggerContext,LoggerContext負責製造logger,也負責以樹結構排列各logger。其他所有logger也通過org.slf4j.LoggerFactory 類的靜態方法getLogger取得。 getLogger方法以logger名稱為參數。用同一名字調用LoggerFactory.getLogger 方法所得到的永遠都是同一個logger對象的引用。
3、有效級別及級別的繼承
Logger 可以被分配級別。級別包括:TRACE、DEBUG、INFO、WARN 和ERROR,定義於ch.qos.logback.classic.Level類。如果logger沒有被分配級別,那麼它將從有被分配級別的最近的祖先那裡繼承級別。 root logger 默認級別是DEBUG。
4、打印方法與基本的選擇規則<br />打印方法決定記錄請求的級別。例如,如果L 是一個logger 實例,那麼,語句L.info("..")是一條級別為INFO的記錄語句。記錄請求的級別在高於或等於其logger 的有效級別時被稱為被啟用,否則,稱為被禁用。記錄請求級別為p,其logger的有效級別為q,只有則當p>=q時,該請求才會被執行。
該規則是logback 的核心。級別排序為: TRACE < DEBUG < INFO < WARN < ERROR
四、Logback的默認配置<br />如果配置文件logback-test.xml 和logback.xml 都不存在,那麼logback 默認地會調用BasicConfigurator ,創建一個最小化配置。最小化配置由一個關聯到根logger 的ConsoleAppender 組成。輸出用模式為%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的PatternLayoutEncoder 進行格式化。 root logger 默認級別是DEBUG。
1、Logback的配置文件
Logback 配置文件的語法非常靈活。正因為靈活,所以無法用DTD 或XML schema 進行定義。儘管如此,可以這樣描述配置文件的基本結構:以<configuration>開頭,後面有零個或多個<appender>元素,有零個或多個<logger>元素,有最多一個<root>元素。
2、Logback默認配置的步驟
(1). 嘗試在classpath 下查找文件logback-test.xml;
(2). 如果文件不存在,則查找文件logback.xml;
(3). 如果兩個文件都不存在,logback 用Bas icConfigurator 自動對自己進行配置,這會導致記錄輸出到控制台。
3、Logback.xml 文件
<?xml version="1.0" encoding="UTF-8"?><configuration> <!--定義日誌文件的存儲地址勿在LogBack 的配置中使用相對路徑--> <property name="LOG_HOME" value ="c:/log" /> <!-- 控制台輸出--> <appender name="STDOUT"> <!-- 日誌輸出編碼--> <Encoding>UTF-8</Encoding> <layout> <!--格式化輸出:%d表示日期,%thread表示線程名,%-5level:級別從左顯示5個字符寬度%msg:日誌消息,%n是換行符--> <pattern>%d {yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n </pattern> </layout> </appender> <!-- 按照每天生成日誌文件--> <appender name="FILE"> <Encoding>UTF-8</Encoding> <rollingPolicy> <!--日誌文件輸出的文件名--> <FileNamePattern>${LOG_HOME}/myApp.log .%d{yyyy-MM-dd}.log</FileNamePattern> <MaxHistory>30</MaxHistory> </rollingPolicy> <layout> <!--格式化輸出:%d表示日期,%thread表示線程名, %-5level:級別從左顯示5個字符寬度%msg:日誌消息,%n是換行符--> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] % -5level %logger{50} - %msg%n </pattern> </layout> <!--日誌文件最大的大小--> <triggeringPolicy> <MaxFileSize>10MB</MaxFileSize> </triggeringPolicy> </appender > <!-- 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" /> <!-- 日誌輸出級別--> <root level="INFO"> <appender-ref ref=" STDOUT" /> <appender-ref ref="FILE" /> </root> <!--日誌異步到數據庫--> <appender name="DB"> <!--日誌異步到數據庫--> < connectionSource> <!--連接池--> <dataSource> <driverClass>com.mysql.jdbc.Driver</driverClass> <url>jdbc:mysql://127.0.0.1:3306/databaseName</url> <user >root</user> <password>root</password> </dataSource> </connectionSource> </appender> --></configuration>五、在程序用引用Logback
package com.stu.system.action; import org.slf4j.Logger;import org.slf4j.LoggerFactory;public class BlogAction{ //定義一個全局的記錄器,通過LoggerFactory獲取private final static Logger logger = LoggerFactory.getLogger(BlogAction .class); /** * @param args */ public static void main(String[] args) { logger.info("logback 成功了"); logger.error("logback 成功了"); }}接下來我們介紹一下slf4j+logback在java工程中的配置。
一、基於maven的slf4j+logback pom.xml配置
<dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.10</version></dependency><dependency> <groupId>ch.qos.logback</ groupId> <artifactId>logback-classic</artifactId> <version>1.1.2</version></dependency><dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-core</artifactId > <version>1.1.2</version></dependency>
二、在classpath目錄下新建logback.xml配置文件
<?xml version="1.0" encoding="UTF-8"?><!--scan:當此屬性設置為true時,配置文件如果發生改變,將會被重新加載,默認值為true。 scanPeriod:設置監測配置文件是否有修改的時間間隔,如果沒有給出時間單位,默認單位是毫秒當scan為true時,此屬性生效。默認的時間間隔為1分鐘。 debug:當此屬性設置為true時,將打印出logback內部日誌信息,實時查看logback運行狀態。默認值為false。 --><configuration scan="false" scanPeriod="60 seconds" debug="false"> <!-- 定義日誌的根目錄--> <property name="LOG_HOME" value="/app/log" / > <!-- 定義日誌文件名稱--> <property name="appName" value="netty"></property> <!-- ch.qos.logback.core.ConsoleAppender 表示控制台輸出--> < appender name="stdout"> <Encoding>UTF-8</Encoding> <!-- 日誌輸出格式:%d表示日期時間,%thread表示線程名,%-5level:級別從左顯示5個字符寬度% logger{50} 表示logger名字最長50個字符,否則按照句點分割。 %msg:日誌消息,%n是換行符--> <layout> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - % msg%n</pattern> </layout> </appender> <!-- 滾動記錄文件,先將日誌記錄到指定文件,當符合某個條件時,將日誌記錄到其他文件--> <appender name ="appLogAppender"> <Encoding>UTF-8</Encoding> <!-- 指定日誌文件的名稱--> <file>${LOG_HOME}/${appName}.log</file> <!-- 當發生滾動時,決定RollingFileAppender 的行為,涉及文件移動和重命名TimeBasedRollingPolicy: 最常用的滾動策略,它根據時間來製定滾動策略,既負責滾動也負責出發滾動。 --> <rollingPolicy> <!-- 滾動時產生的文件的存放位置及文件名稱%d{yyyy-MM-dd}:按天進行日誌滾動%i:當文件大小超過maxFileSize時,按照i進行文件滾動--> <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern> <!-- 可選節點,控制保留的歸檔文件的最大數量,超出數量就刪除舊文件。假設設置每天滾動, 且maxHistory是365,則只保存最近365天的文件,刪除之前的舊文件。注意,刪除舊文件是, 那些為了歸檔而創建的目錄也會被刪除。 --> <MaxHistory>365</MaxHistory> <!-- 當日誌文件超過maxFileSize指定的大小是,根據上面提到的%i進行日誌文件滾動注意此處配置SizeBasedTriggeringPolicy是無法實現按文件大小進行滾動的,必須配置timeBasedFileNamingAndTriggeringPolicy --> <timeBasedFileNamingAndTriggeringPolicy> <maxFileSize>100MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> </rollingPolicy> <!-- 日誌輸出格式:%d表示日期時間,%thread表示線程名,%-5level:級別從左顯示5個字符寬度%logger{50} 表示logger名字最長50個字符,否則按照句點分割。 %msg:日誌消息,%n是換行符--> <layout> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{ 50} : %line ] - %msg%n</pattern> </layout> </appender> <!-- logger主要用於存放日誌對象,也可以定義日誌類型、級別name:表示匹配的logger類型前綴,也就是包的前半部分level:要記錄的日誌級別,包括TRACE < DEBUG < INFO < WARN < ERROR additivity:作用在於children-logger是否使用rootLogger配置的appender進行輸出,false:表示只用當前logger的appender -ref,true:表示當前logger的appender-ref和rootLogger的appender-ref都有效--> <!-- hibernate logger --> <logger name="org.hibernate" level="error" /> <! -- Spring framework logger --> <logger name="org.springframework" level="error" additivity="false"></logger> <logger name="com.creditease" level="info" additivity="true "> <appender-ref ref="appLogAppender" /> </logger> <!-- root與logger是父子關係,沒有特別定義則默認為root,任何一個類只會和一個logger對應, 要么是定義的logger,要么是root,判斷的關鍵在於找到這個logger,然後判斷這個logger的appender和level。 --> <root level="info"> <appender-ref ref="stdout" /> <appender-ref ref="appLogAppender" /> </root></configuration>