新聞中心
一、logback的介紹
Logback是由log4j創(chuàng)始人設(shè)計(jì)的另一個(gè)開源日志組件,它當(dāng)前分為下面下個(gè)模塊:

- logback-core:其它兩個(gè)模塊的基礎(chǔ)模塊
- logback-classic:它是log4j的一個(gè)改良版本,同時(shí)它完整實(shí)現(xiàn)了slf4j API使你可以很方便地更換成其它日志系統(tǒng)如log4j或JDK14 Logging
- logback-access:訪問模塊與Servlet容器集成提供通過Http來訪問日志的功能
二、logback取代log4j的理由:
1.更快的實(shí)現(xiàn):Logback的內(nèi)核重寫了,在一些關(guān)鍵執(zhí)行路徑上性能提升10倍以上。而且logback不僅性能提升了,初始化內(nèi)存加載也更小了。
2.非常充分的測試:Logback經(jīng)過了幾年,數(shù)不清小時(shí)的測試。Logback的測試完全不同級別的。
3.Logback-classic非常自然實(shí)現(xiàn)了SLF4j:Logback-classic實(shí)現(xiàn)了SLF4j。在使用SLF4j中,你都感覺不到logback-classic。而且因?yàn)閘ogback-classic非常自然地實(shí)現(xiàn)了slf4j , 所 以切換到log4j或者其他,非常容易,只需要提供成另一個(gè)jar包就OK,根本不需要去動那些通過SLF4JAPI實(shí)現(xiàn)的代碼。
4.非常充分的文檔:官方網(wǎng)站有兩百多頁的文檔。
5.自動重新加載配置文件,當(dāng)配置文件修改了,Logback-classic能自動重新加載配置文件。掃描過程快且安全,它并不需要另外創(chuàng)建一個(gè)掃描線程。這個(gè)技術(shù)充分保證了應(yīng)用程序能跑得很歡在JEE環(huán)境里面。
6.Lilith是log事件的觀察者,和log4j的chainsaw類似。而lilith還能處理大數(shù)量的log數(shù)據(jù)。
7.謹(jǐn)慎的模式和非常友好的恢復(fù),在謹(jǐn)慎模式下,多個(gè)FileAppender實(shí)例跑在多個(gè)JVM下,能 夠安全地寫道同一個(gè)日志文件。RollingFileAppender會有些限制。Logback的FileAppender和它的子類包括 RollingFileAppender能夠非常友好地從I/O異常中恢復(fù)。
8.配置文件可以處理不同的情況,開發(fā)人員經(jīng)常需要判斷不同的Logback配置文件在不同的環(huán)境下(開發(fā),測試,生產(chǎn))。而這些配置文件僅僅只有一些很小的不同,可以通過,來實(shí)現(xiàn),這樣一個(gè)配置文件就可以適應(yīng)多個(gè)環(huán)境。
9.打印更加靈活:Filters(過濾器)有些時(shí)候,需要診斷一個(gè)問題,需要打出日志。在log4j,只有降低日志級別,不過這樣會打出大量的日志,會影響應(yīng)用性能。在Logback,你可以繼續(xù)保持那個(gè)日志級別而除掉某種特殊情況,如alice這個(gè)用戶登錄,她的日志將打在DEBUG級別而其他用戶可以繼續(xù)打在WARN級別。要實(shí)現(xiàn)這個(gè)功能只需加4行XML配置??梢詤⒖糓DCFIlter 。
10.SiftingAppender(一個(gè)非常多功能的Appender):它可以用來分割日志文件根據(jù)任何一個(gè)給定的運(yùn)行參數(shù)。如,SiftingAppender能夠區(qū)別日志事件跟進(jìn)用戶的Session,然后每個(gè)用戶會有一個(gè)日志文件。
11.自動壓縮已經(jīng)打出來的log:RollingFileAppender在產(chǎn)生新文件的時(shí)候,會自動壓縮已經(jīng)打出來的日志文件。壓縮是個(gè)異步過程,所以甚至對于大的日志文件,在壓縮過程中應(yīng)用不會受任何影響。
12.堆棧樹帶有包版本:Logback在打出堆棧樹日志時(shí),會帶上包的數(shù)據(jù)。
13.自動去除舊的日志文件:通過設(shè)置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory屬性,你可以控制已經(jīng)產(chǎn)生日志文件的最大數(shù)量。如果設(shè)置maxHistory 12,那那些log文件超過12個(gè)月的都會被自動移除。
三、logback的配置介紹
Logger、appender及l(fā)ayout
Logger作為日志的記錄器,把它關(guān)聯(lián)到應(yīng)用的對應(yīng)的context上后,主要用于存放日志對象,也可以定義日志類型、級別。
Appender主要用于指定日志輸出的目的地,目的地可以是控制臺、文件、遠(yuǎn)程套接字服務(wù)器、 MySQL、PostreSQL、 Oracle和其他數(shù)據(jù)庫、 JMS和遠(yuǎn)程UNIX Syslog守護(hù)進(jìn)程等。
Layout 負(fù)責(zé)把事件轉(zhuǎn)換成字符串,格式化的日志信息的輸出。
logger context
各個(gè)logger 都被關(guān)聯(lián)到一個(gè) LoggerContext,LoggerContext負(fù)責(zé)制造logger,也負(fù)責(zé)以樹結(jié)構(gòu)排列各logger。其他所有l(wèi)ogger也通過org.slf4j.LoggerFactory 類的靜態(tài)方法getLogger取得。
getLogger方法以 logger名稱為參數(shù)。用同一名字調(diào)用LoggerFactory.getLogger 方法所得到的永遠(yuǎn)都是同一個(gè)logger對象的引用。
有效級別及級別的繼承
Logger 可以被分配級別。級別包括:TRACE、DEBUG、INFO、WARN 和 ERROR,定義于ch.qos.logback.classic.Level類。如果 logger沒有被分配級別,那么它將從有被分配級別的最近的祖先那里繼承級別。root logger 默認(rèn)級別是 DEBUG。
打印方法與基本的選擇規(guī)則
打印方法決定記錄請求的級別。例如,如果 L 是一個(gè) logger 實(shí)例,那么,語句 L.info("..")是一條級別為 INFO的記錄語句。記錄請求的級別在高于或等于其 logger 的有效級別時(shí)被稱為被啟用,否則,稱為被禁用。記錄請求級別為 p,其 logger的有效級別為 q,只有則當(dāng) p>=q時(shí),該請求才會被執(zhí)行。
該規(guī)則是 logback 的核心。級別排序?yàn)椋篢RACE < DEBUG < INFO < WARN < ERROR
四、logback的默認(rèn)配置
如果配置文件 logback-test.xml 和 logback.xml 都不存在,那么 logback 默認(rèn)地會調(diào)用BasicConfigurator ,創(chuàng)建一個(gè)最小化配置。最小化配置由一個(gè)關(guān)聯(lián)到根 logger 的ConsoleAppender 組成。
輸出用模式為%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 進(jìn)行格式化。root logger 默認(rèn)級別是 DEBUG。
Logback的配置文件
Logback 配置文件的語法非常靈活。正因?yàn)殪`活,所以無法用 DTD 或 XML schema 進(jìn)行定義。盡管如此,可以這樣描述配置文件的基本結(jié)構(gòu):以
Logback默認(rèn)配置的步驟
- 嘗試在 classpath下查找文件logback-test.xml;
- 如果文件不存在,則查找文件logback.xml;
- 如果兩個(gè)文件都不存在,logback用BasicConfigurator自動對自己進(jìn)行配置,這會導(dǎo)致記錄輸出到控制臺。
五、logback.xml常用配置詳解
(1) 根節(jié)點(diǎn)
包含下面三個(gè)屬性:
- scan: 當(dāng)此屬性設(shè)置為true時(shí),配置文件如果發(fā)生改變,將會被重新加載,默認(rèn)值為true。
- scanPeriod: 設(shè)置監(jiān)測配置文件是否有修改的時(shí)間間隔,如果沒有給出時(shí)間單位,默認(rèn)單位是毫秒。當(dāng)scan為true時(shí),此屬性生效。默認(rèn)的時(shí)間間隔為1分鐘。
- debug: 當(dāng)此屬性設(shè)置為true時(shí),將打印出logback內(nèi)部日志信息,實(shí)時(shí)查看logback運(yùn)行狀態(tài)。默認(rèn)值為false。
例如:
(2) 子節(jié)點(diǎn)
用來設(shè)置上下文名稱,每個(gè)logger都關(guān)聯(lián)到logger上下文,默認(rèn)上下文名稱為default。但可以使用
例如:
myAppName
(3) 子節(jié)點(diǎn)
用來定義變量值,它有兩個(gè)屬性name和value,通過
- name: 變量的名稱
- value: 的值時(shí)變量定義的值
例如:
${APP_Name}
(4) 子節(jié)點(diǎn)
獲取時(shí)間戳字符串,他有兩個(gè)屬性key和datePattern
- key: 標(biāo)識此
的名字; - datePattern: 設(shè)置將當(dāng)前時(shí)間(解析配置文件的時(shí)間)轉(zhuǎn)換為字符串的模式,遵循java.txt.SimpleDateFormat的格式。
例如:
${bySecond}
(5) 子節(jié)點(diǎn)
負(fù)責(zé)寫日志的組件,它有兩個(gè)必要屬性name和class。name指定appender名稱,class指定appender的全限定名
5.1、ConsoleAppender 把日志輸出到控制臺,有以下子節(jié)點(diǎn):
-
:對日志進(jìn)行格式化。(具體參數(shù)稍后講解 ) -
:字符串System.out(默認(rèn))或者System.err(區(qū)別不多說了)
例如:
%-4relative [%thread] %-5level %logger{35} - %msg %n
上述配置表示把>=DEBUG級別的日志都輸出到控制臺
5.2、FileAppender:把日志添加到文件,有以下子節(jié)點(diǎn):
-
:被寫入的文件名,可以是相對目錄,也可以是絕對目錄,如果上級目錄不存在會自動創(chuàng)建,沒有默認(rèn)值。 -
:如果是 true,日志被追加到文件結(jié)尾,如果是 false,清空現(xiàn)存文件,默認(rèn)是true。 -
:對記錄事件進(jìn)行格式化。(具體參數(shù)稍后講解 ) -
:如果是 true,日志會被安全的寫入文件,即使其他的FileAppender也在向此文件做寫入操作,效率低,默認(rèn)是 false。
例如:
testFile.log true %-4relative [%thread] %-5level %logger{35} - %msg%n
上述配置表示把>=DEBUG級別的日志都輸出到testFile.log
5.3、RollingFileAppender:滾動記錄文件,先將日志記錄到指定文件,當(dāng)符合某個(gè)條件時(shí),將日志記錄到其他文件。有以下子節(jié)點(diǎn):
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy":最常用的滾動策略,它根據(jù)時(shí)間來制定滾動策略,既負(fù)責(zé)滾動也負(fù)責(zé)出發(fā)滾動。有以下子節(jié)點(diǎn):
-
:
必要節(jié)點(diǎn),包含文件名及%d轉(zhuǎn)換符,%d可以包含一個(gè)java.text.SimpleDateFormat指定的時(shí)間格式,如:%d{yyyy-MM}。
如果直接使用 %d,默認(rèn)格式是 yyyy-MM-dd。RollingFileAppender的file字節(jié)點(diǎn)可有可無,通過設(shè)置file,可以為活動文件和歸檔文件指定不同位置,當(dāng)前日志總是記錄到file指定的文件(活動文件),活動文件的名字不會改變;
如果沒設(shè)置file,活動文件的名字會根據(jù)fileNamePattern 的值,每隔一段時(shí)間改變一次。/或者\(yùn)會被當(dāng)做目錄分隔符。
-
:
可選節(jié)點(diǎn),控制保留的歸檔文件的最大數(shù)量,超出數(shù)量就刪除舊文件。假設(shè)設(shè)置每個(gè)月滾動,且
class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy":查看當(dāng)前活動文件的大小,如果超過指定大小會告知RollingFileAppender 觸發(fā)當(dāng)前活動文件滾動。只有一個(gè)節(jié)點(diǎn):
-
:這是活動文件的大小,默認(rèn)值是10MB。 -
:當(dāng)為true時(shí),不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有兩個(gè)限制,1不支持也不允許文件壓縮,2不能設(shè)置file屬性,必須留空。 -
: 告知 RollingFileAppender 合適激活滾動?! lass="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根據(jù)固定窗口算法重命名文件的滾動策略。有以下子節(jié)點(diǎn): -
:窗口索引最小值 -
:窗口索引最大值,當(dāng)用戶指定的窗口過大時(shí),會自動將窗口設(shè)置為12。 -
:必須包含%i例如,假設(shè)最小值和最大值分別為1和2,命名模式為 mylog%i.log,會產(chǎn)生歸檔文件mylog1.log和mylog2.log。還可以指定文件壓縮選項(xiàng),例如,mylog%i.log.gz 或者 沒有l(wèi)og%i.log.zip
例如:
logFile.%d{yyyy-MM-dd}.log 30 %-4relative [%thread] %-5level %logger{35} - %msg%n
備注:上述配置表示每天生成一個(gè)日志文件,保存30天的日志文件。
test.log tests.%i.log.zip 1 3 5MB %-4relative [%thread] %-5level %logger{35} - %msg%n
備注:上述配置表示按照固定窗口模式生成日志文件,當(dāng)文件大于5MB時(shí),生成新的日志文件。窗口大小是1到3,當(dāng)保存了3個(gè)歸檔文件后,將覆蓋最早的日志。
PatternLayoutEncoder 是唯一有用的且默認(rèn)的encoder ,有一個(gè)
5.4、還有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender,并不常用,這里就不詳解了。
大家可以參考官方文檔,還可以編寫自己的Appender。
(6)子節(jié)點(diǎn)
用來設(shè)置某一個(gè)包或具體的某一個(gè)類的日志打印級別、以及指定
可以包含零個(gè)或多個(gè)
- name: 用來指定受此loger約束的某一個(gè)包或者具體的某一個(gè)類。
- level: 用來設(shè)置打印級別,大小寫無關(guān):TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,還有一個(gè)特俗值INHERITED或者同義詞NULL,代表強(qiáng)制執(zhí)行上級的級別。如果未設(shè)置此屬性,那么當(dāng)前l(fā)oger將會繼承上級的級別。
- addtivity: 是否向上級loger傳遞打印信息。默認(rèn)是true。同
一樣,可以包含零個(gè)或多個(gè) 元素,標(biāo)識這個(gè)appender將會添加到這個(gè)loger。
(7)子節(jié)點(diǎn)
它也是
level: 用來設(shè)置打印級別,大小寫無關(guān):TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,不能設(shè)置為INHERITED或者同義詞NULL。默認(rèn)是DEBUG。
六、常用logger配置
七、Demo
(1)添加依賴包logback使用需要和slf4j一起使用,所以總共需要添加依賴的包有slf4j-api
logback使用需要和slf4j一起使用,所以總共需要添加依賴的包有slf4j-api.jar,logback-core.jar,logback-classic.jar,logback-access.jar這個(gè)暫時(shí)用不到所以不添加依賴了,maven配置
UTF-8 1.1.7 1.7.21 org.slf4j slf4j-api ${slf4j.version} compile ch.qos.logback logback-core ${logback.version} ch.qos.logback logback-classic ${logback.version}
(2)logback.xml配置
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n ${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log 30 %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n 10MB
(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)輸出
八、總結(jié)
logback的配置,需要配置輸出源appender,打日志的loger(子節(jié)點(diǎn))和root(根節(jié)點(diǎn)),實(shí)際上,它輸出日志是從子節(jié)點(diǎn)開始,子節(jié)點(diǎn)如果有輸出源直接輸入,如果無,判斷配置的addtivity,是否像上級傳遞,即是否向root傳遞,傳遞則采用root的輸出源,否則不輸出日志。最后,關(guān)注Java知音公眾號,回復(fù)“后端面試”,送你一份面試題寶典!
網(wǎng)頁名稱:為什么推薦你使用logback取代log4j
鏈接URL:http://m.fisionsoft.com.cn/article/djoeecj.html


咨詢
建站咨詢
