一能颁、logback的介紹
Logback是由log4j創(chuàng)始人設計的另一個開源日志組件,官方網站: http://logback.qos.ch晓折。它當前分為下面下個模塊:
logback-core:其它兩個模塊的基礎模塊
logback-classic:它是log4j的一個改良版本钻弄,同時它完整實現了slf4j API使你可以很方便地更換成其它日志系統如log4j或JDK14 Logging
logback-access:訪問模塊與Servlet容器集成提供通過Http來訪問日志的功能
二俱尼、logback取代log4j的理由:
1、更快的實現:Logback的內核重寫了岔激,在一些關鍵執(zhí)行路徑上性能提升10倍以上勒极。而且logback不僅性能提升了,初始化內存加載也更小了虑鼎。
2辱匿、非常充分的測試:Logback經過了幾年,數不清小時的測試炫彩。Logback的測試完全不同級別的匾七。
3、Logback-classic非常自然實現了SLF4j:Logback-classic實現了SLF4j江兢。在使用SLF4j中昨忆,你都感覺不到logback-classic。而且因為logback-classic非常自然地實現了slf4j 杉允, 所 以切換到log4j或者其他邑贴,非常容易,只需要提供成另一個jar包就OK夺颤,根本不需要去動那些通過SLF4JAPI實現的代碼痢缎。
4、非常充分的文檔 官方網站有兩百多頁的文檔世澜。
5独旷、自動重新加載配置文件,當配置文件修改了寥裂,Logback-classic能自動重新加載配置文件嵌洼。掃描過程快且安全,它并不需要另外創(chuàng)建一個掃描線程封恰。這個技術充分保證了應用程序能跑得很歡在JEE環(huán)境里面麻养。
6、Lilith是log事件的觀察者诺舔,和log4j的chainsaw類似鳖昌。而lilith還能處理大數量的log數據 。
7低飒、謹慎的模式和非常友好的恢復许昨,在謹慎模式下,多個FileAppender實例跑在多個JVM下褥赊,能 夠安全地寫道同一個日志文件糕档。RollingFileAppender會有些限制。Logback的FileAppender和它的子類包括 RollingFileAppender能夠非常友好地從I/O異常中恢復拌喉。
8速那、配置文件可以處理不同的情況俐银,開發(fā)人員經常需要判斷不同的Logback配置文件在不同的環(huán)境下(開發(fā),測試端仰,生產)捶惜。而這些配置文件僅僅只有一些很小的不同,可以通過,和來實現荔烧,這樣一個配置文件就可以適應多個環(huán)境售躁。
9、Filters(過濾器)有些時候茴晋,需要診斷一個問題,需要打出日志回窘。在log4j诺擅,只有降低日志級別,不過這樣會打出大量的日志啡直,會影響應用性能烁涌。在Logback,你可以繼續(xù) 保持那個日志級別而除掉某種特殊情況酒觅,如alice這個用戶登錄撮执,她的日志將打在DEBUG級別而其他用戶可以繼續(xù)打在WARN級別。要實現這個功能只需加4行XML配置舷丹∈闱可以參考MDCFIlter 。
10颜凯、SiftingAppender(一個非常多功能的Appender):它可以用來分割日志文件根據任何一個給定的運行參數谋币。如,SiftingAppender能夠區(qū)別日志事件跟進用戶的Session症概,然后每個用戶會有一個日志文件蕾额。
11、自動壓縮已經打出來的log:RollingFileAppender在產生新文件的時候彼城,會自動壓縮已經打出來的日志文件诅蝶。壓縮是個異步過程,所以甚至對于大的日志文件募壕,在壓縮過程中應用不會受任何影響调炬。
12、堆棧樹帶有包版本:Logback在打出堆棧樹日志時司抱,會帶上包的數據筐眷。
13、自動去除舊的日志文件:通過設置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory屬性习柠,你可以控制已經產生日志文件的最大數量匀谣。如果設置maxHistory 12照棋,那那些log文件超過12個月的都會被自動移除。
三武翎、logback的配置介紹
1烈炭、Logger、appender及l(fā)ayout
Logger作為日志的記錄器宝恶,把它關聯到應用的對應的context上后符隙,主要用于存放日志對象,也可以定義日志類型垫毙、級別霹疫。
Appender主要用于指定日志輸出的目的地,目的地可以是控制臺综芥、文件丽蝎、遠程套接字服務器、 MySQL膀藐、PostreSQL屠阻、 Oracle和其他數據庫、 JMS和遠程UNIX Syslog守護進程等额各。
Layout 負責把事件轉換成字符串国觉,格式化的日志信息的輸出。
2虾啦、logger context
各個logger 都被關聯到一個 LoggerContext麻诀,LoggerContext負責制造logger,也負責以樹結構排列各logger缸逃。其他所有l(wèi)ogger也通過org.slf4j.LoggerFactory 類的靜態(tài)方法getLogger取得针饥。 getLogger方法以 logger名稱為參數。用同一名字調用LoggerFactory.getLogger 方法所得到的永遠都是同一個logger對象的引用需频。
3丁眼、有效級別及級別的繼承
Logger 可以被分配級別。級別包括:TRACE昭殉、DEBUG苞七、INFO、WARN 和 ERROR挪丢,定義于ch.qos.logback.classic.Level類蹂风。如果 logger沒有被分配級別,那么它將從有被分配級別的最近的祖先那里繼承級別乾蓬。root logger 默認級別是 DEBUG惠啄。
4、打印方法與基本的選擇規(guī)則
打印方法決定記錄請求的級別。例如撵渡,如果 L 是一個 logger 實例融柬,那么,語句 L.info("..")是一條級別為 INFO的記錄語句趋距。記錄請求的級別在高于或等于其 logger 的有效級別時被稱為被啟用粒氧,否則,稱為被禁用节腐。記錄請求級別為 p外盯,其 logger的有效級別為 q,只有則當 p>=q時翼雀,該請求才會被執(zhí)行饱苟。
該規(guī)則是 logback 的核心。級別排序為: TRACE < DEBUG < INFO < WARN < ERROR
四狼渊、logback的默認配置
如果配置文件 logback-test.xml 和 logback.xml 都不存在掷空,那么 logback 默認地會調用BasicConfigurator ,創(chuàng)建一個最小化配置囤锉。最小化配置由一個關聯到根 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用BasicConfigurator自動對自己進行配置宴凉,這會導致記錄輸出到控制臺。
五表悬、logback.xml常用配置詳解
[圖片上傳失敗...(image-787117-1531825114076)]
1弥锄、根節(jié)點<configuration>,包含下面三個屬性:
scan: 當此屬性設置為true時,配置文件如果發(fā)生改變籽暇,將會被重新加載温治,默認值為true。
scanPeriod: 設置監(jiān)測配置文件是否有修改的時間間隔图仓,如果沒有給出時間單位罐盔,默認單位是毫秒。當scan為true時救崔,此屬性生效惶看。默認的時間間隔為1分鐘。
debug: 當此屬性設置為true時六孵,將打印出logback內部日志信息纬黎,實時查看logback運行狀態(tài)。默認值為false劫窒。
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
</configuration>
2本今、子節(jié)點<contextName>:用來設置上下文名稱,每個logger都關聯到logger上下文主巍,默認上下文名稱為default冠息。但可以使用<contextName>設置成其他名字,用于區(qū)分不同應用程序的記錄孕索。一旦設置逛艰,不能修改。
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<contextName>myAppName</contextName>
</configuration>
3搞旭、子節(jié)點<property> :用來定義變量值散怖,它有兩個屬性name和value,通過<property>定義的值會被插入到logger上下文中肄渗,可以使“{}”來使用變量镇眷。 name: 變量的名稱 value: 的值時變量定義的值 例如: {APP_Name}</contextName>
</configuration>
4、子節(jié)點<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翁垂、子節(jié)點<appender>:負責寫日志的組件,它有兩個必要屬性name和class硝桩。name指定appender名稱沿猜,class指定appender的全限定名
5.1、ConsoleAppender 把日志輸出到控制臺碗脊,有以下子節(jié)點:
<encoder>:對日志進行格式化啼肩。(具體參數稍后講解 )
<target>:字符串System.out(默認)或者System.err(區(qū)別不多說了)
例如:
<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.2橄妆、FileAppender:把日志添加到文件,有以下子節(jié)點:
<file>:被寫入的文件名祈坠,可以是相對目錄害碾,也可以是絕對目錄,如果上級目錄不存在會自動創(chuàng)建赦拘,沒有默認值慌随。
<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.3畏邢、RollingFileAppender:滾動記錄文件,先將日志記錄到指定文件检吆,當符合某個條件時棵红,將日志記錄到其他文件。有以下子節(jié)點:
<file>:被寫入的文件名咧栗,可以是相對目錄,也可以是絕對目錄虱肄,如果上級目錄不存在會自動創(chuàng)建致板,沒有默認值。
<append>:如果是 true咏窿,日志被追加到文件結尾斟或,如果是 false,清空現存文件集嵌,默認是true萝挤。
<rollingPolicy>:當發(fā)生滾動時,決定RollingFileAppender的行為根欧,涉及文件移動和重命名怜珍。屬性class定義具體的滾動策略類
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy": 最常用的滾動策略,它根據時間來制定滾動策略凤粗,既負責滾動也負責出發(fā)滾動酥泛。有以下子節(jié)點:
<fileNamePattern>:必要節(jié)點,包含文件名及“%d”轉換符,“%d”可以包含一個java.text.SimpleDateFormat指定的時間格式柔袁,如:%d{yyyy-MM}呆躲。
如果直接使用 %d,默認格式是 yyyy-MM-dd捶索。RollingFileAppender的file字節(jié)點可有可無插掂,通過設置file,可以為活動文件和歸檔文件指定不同位置腥例,當前日志總是記錄到file指定的文件(活動文件)辅甥,活動文件的名字不會改變;
如果沒設置file院崇,活動文件的名字會根據fileNamePattern 的值肆氓,每隔一段時間改變一次〉装辏“/”或者“\”會被當做目錄分隔符谢揪。
<maxHistory>:
可選節(jié)點,控制保留的歸檔文件的最大數量,超出數量就刪除舊文件煌贴。假設設置每個月滾動旧烧,且<maxHistory>是6,則只保存最近6個月的文件患民,刪除之前的舊文件。注意垦梆,刪除舊文件是匹颤,那些為了歸檔而創(chuàng)建的目錄也會被刪除。
class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy": 查看當前活動文件的大小托猩,如果超過指定大小會告知RollingFileAppender 觸發(fā)當前活動文件滾動印蓖。只有一個節(jié)點:
<maxFileSize>:這是活動文件的大小,默認值是10MB京腥。
<prudent>:當為true時赦肃,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy公浪,但是有兩個限制他宛,1不支持也不允許文件壓縮,2不能設置file屬性欠气,必須留空厅各。
<triggeringPolicy >: 告知 RollingFileAppender 合適激活滾動。
class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根據固定窗口算法重命名文件的滾動策略预柒。有以下子節(jié)點:
<minIndex>:窗口索引最小值
<maxIndex>:窗口索引最大值讯检,當用戶指定的窗口過大時琐鲁,會自動將窗口設置為12。
<fileNamePattern>:必須包含“%i”例如人灼,假設最小值和最大值分別為1和2围段,命名模式為 mylog%i.log,會產生歸檔文件mylog1.log和mylog2.log。還可以指定文件壓縮選項投放,例如奈泪,mylog%i.log.gz 或者 沒有l(wèi)og%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個歸檔文件后,將覆蓋最早的日志谒获。
<encoder>:對記錄事件進行格式化蛤肌。負責兩件事,一是把日志信息轉換成字節(jié)數組批狱,二是把字節(jié)數組寫入到輸出流裸准。
PatternLayoutEncoder 是唯一有用的且默認的encoder ,有一個<pattern>節(jié)點赔硫,用來設置日志的輸入格式炒俱。使用“%”加“轉換符”方式,如果要輸出“%”爪膊,則必須用“\”對“%”進行轉義权悟。
5.4、還有SocketAppender推盛、SMTPAppender峦阁、DBAppender、SyslogAppender小槐、SiftingAppender,并不常用荷辕,這里就不詳解了凿跳。
大家可以參考官方文檔(http://logback.qos.ch/documentation.html),還可以編寫自己的Appender疮方。
6控嗜、子節(jié)點<loger>:用來設置某一個包或具體的某一個類的日志打印級別、以及指定<appender>骡显。<loger>僅有一個name屬性疆栏,一個可選的level和一個可選的addtivity屬性曾掂。
可以包含零個或多個<appender-ref>元素,標識這個appender將會添加到這個loger
name: 用來指定受此loger約束的某一個包或者具體的某一個類壁顶。
level: 用來設置打印級別珠洗,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,還有一個特俗值INHERITED或者同義詞NULL若专,代表強制執(zhí)行上級的級別许蓖。 如果未設置此屬性,那么當前l(fā)oger將會繼承上級的級別调衰。
addtivity: 是否向上級loger傳遞打印信息膊爪。默認是true。同<loger>一樣嚎莉,可以包含零個或多個<appender-ref>元素米酬,標識這個appender將會添加到這個loger。
7趋箩、子節(jié)點<root>:它也是<loger>元素赃额,但是它是根loger,是所有<loger>的上級。只有一個level屬性阁簸,因為name已經被命名為"root",且已經是最上級了爬早。
level: 用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF启妹,不能設置為INHERITED或者同義詞NULL筛严。 默認是DEBUG。
六饶米、常用loger配置
<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" />
<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"/>
七桨啃、Demo
1、添加依賴包logback使用需要和slf4j一起使用檬输,所以總共需要添加依賴的包有slf4j-api
logback使用需要和slf4j一起使用照瘾,所以總共需要添加依賴的包有slf4j-api.jar,logback-core.jar丧慈,logback-classic.jar析命,logback-access.jar這個暫時用不到所以不添加依賴了,maven配置
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<logback.version>1.1.7</logback.version>
<slf4j.version>1.7.21</slf4j.version>
</properties>
<dependencies>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>{slf4j.version} compile ch.qos.logback logback-core {logback.version}</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>${logback.version}</version>
</dependency>
</dependencies>
2逃默、logback.xml配置
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
<property name="LOG_HOME" value="/home" />
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
</appender>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<FileNamePattern>${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log</FileNamePattern>
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>
<root level="INFO">
<appender-ref ref="STDOUT" />
</root>
</configuration>
3鹃愤、java代碼
/**
* Hello world!
*/
public class App {
private final static Logger logger = LoggerFactory.getLogger(App.class);
public static void main(String[] args) {
logger.info("logback 成功了");
logger.error("logback 成功了");
logger.debug("logback 成功了");
}
}
4、輸出
八完域、總結
logback的配置软吐,需要配置輸出源appender,打日志的loger(子節(jié)點)和root(根節(jié)點)吟税,實際上凹耙,它輸出日志是從子節(jié)點開始姿现,子節(jié)點如果有輸出源直接輸入,如果無肖抱,判斷配置的addtivity备典,是否像上級傳遞,即是否向root傳遞虐沥,傳遞則采用root的輸出源熊经,否則不輸出日志。