logback的简单使用
一、logback的介紹
Logback是由log4j創(chuàng)始人設(shè)計的又一個開源日志組件,官方網(wǎng)站: http://logback.qos.ch。
logback當(dāng)前分成三個模塊:logback-core,logback- classic和logback-access。
二、logback取代log4j的理由
Logback和log4j是非常相似的,如果你對log4j很熟悉,那對logback很快就會得心應(yīng)手。下面列了logback相對于log4j的一些優(yōu)點:
三、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守護進程等。
Layout 負(fù)責(zé)把事件轉(zhuǎn)換成字符串,格式化的日志信息的輸出。
logger context
各個logger 都被關(guān)聯(lián)到一個 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)都是同一個logger對象的引用。
有效級別及級別的繼承
Logger 可以被分配級別。級別包括:TRACE、DEBUG、INFO、WARN 和 ERROR,定義于ch.qos.logback.classic.Level類。如果 logger沒有被分配級別,那么它將從有被分配級別的最近的祖先那里繼承級別。root logger 默認(rèn)級別是 DEBUG。
打印方法與基本的選擇規(guī)則
打印方法決定記錄請求的級別。例如,如果 L 是一個 logger 實例,那么,語句 L.info("..")是一條級別為 INFO的記錄語句。記錄請求的級別在高于或等于其 logger 的有效級別時被稱為被啟用,否則,稱為被禁用。記錄請求級別為 p,其 logger的有效級別為 q,只有則當(dāng) p>=q時,該請求才會被執(zhí)行。
該規(guī)則是 logback 的核心。級別排序為: TRACE < DEBUG < INFO < WARN < ERROR
四、logback的默認(rèn)配置
如果配置文件 logback-test.xml 和 logback.xml 都不存在,那么 logback 默認(rèn)地會調(diào)用BasicConfigurator ,創(chuàng)建一個最小化配置。最小化配置由一個關(guān)聯(lián)到根 logger 的ConsoleAppender 組成。輸出用模式為%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 進行格式化。root logger 默認(rèn)級別是 DEBUG。
Logback的配置文件
Logback 配置文件的語法非常靈活。正因為靈活,所以無法用 DTD 或 XML schema 進行定義。盡管如此,可以這樣描述配置文件的基本結(jié)構(gòu):以<configuration>開頭,后面有零個或多個<appender>元素,有零個或多個<logger>元素,有最多一個<root>元素。
Logback默認(rèn)配置的步驟
五、logback.xml常用配置詳解
1.根節(jié)點<configuration>,包含下面三個屬性:
scan: 當(dāng)此屬性設(shè)置為true時,配置文件如果發(fā)生改變,將會被重新加載,默認(rèn)值為true。scanPeriod: 設(shè)置監(jiān)測配置文件是否有修改的時間間隔,如果沒有給出時間單位,默認(rèn)單位是毫秒。當(dāng)scan為true時,此屬性生效。默認(rèn)的時間間隔為1分鐘。debug: 當(dāng)此屬性設(shè)置為true時,將打印出logback內(nèi)部日志信息,實時查看logback運行狀態(tài)。默認(rèn)值為false。2.子節(jié)點<contextName>:用來設(shè)置上下文名稱,每個logger都關(guān)聯(lián)到logger上下文,默認(rèn)上下文名稱為default。但可以使用<contextName>設(shè)置成其他名字,用于區(qū)分不同應(yīng)用程序的記錄。一旦設(shè)置,不能修改。
3.子節(jié)點<property> :用來定義變量值,它有兩個屬性name和value,通過<property>定義的值會被插入到logger上下文中,可以使“${}”來使用變量。
name: 變量的名稱value: 的值時變量定義的值4.子節(jié)點<timestamp>:獲取時間戳字符串,他有兩個屬性key和datePattern
key: 標(biāo)識此<timestamp> 的名字;datePattern: 設(shè)置將當(dāng)前時間(解析配置文件的時間)轉(zhuǎn)換為字符串的模式,遵循java.txt.SimpleDateFormat的格式。5.子節(jié)點<appender>:負(fù)責(zé)寫日志的組件,它有兩個必要屬性name和class。name指定appender名稱,class指定appender的全限定名。
5.1ConsoleAppender 把日志輸出到控制臺,有以下子節(jié)點:
5.2 FileAppender:把日志添加到文件,有以下子節(jié)點:
<file>:被寫入的文件名,可以是相對目錄,也可以是絕對目錄,如果上級目錄不存在會自動創(chuàng)建,沒有默認(rèn)值。<append>:如果是 true,日志被追加到文件結(jié)尾,如果是 false,清空現(xiàn)存文件,默認(rèn)是true。<encoder>:對記錄事件進行格式化。(具體參數(shù)稍后講解 )<prudent>:如果是 true,日志會被安全的寫入文件,即使其他的FileAppender也在向此文件做寫入操作,效率低,默認(rèn)是 false。5.3. RollingFileAppender:滾動記錄文件,先將日志記錄到指定文件,當(dāng)符合某個條件時,將日志記錄到其他文件。有以下子節(jié)點:
<file>:被寫入的文件名,可以是相對目錄,也可以是絕對目錄,如果上級目錄不存在會自動創(chuàng)建,沒有默認(rèn)值。<append>:如果是 true,日志被追加到文件結(jié)尾,如果是 false,清空現(xiàn)存文件,默認(rèn)是true。 <rollingPolicy>:當(dāng)發(fā)生滾動時,決定RollingFileAppender的行為,涉及文件移動和重命名。屬性class定義具體的滾動策略類class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy": 最常用的滾動策略,它根據(jù)時間來制定滾動策略,既負(fù)責(zé)滾動也負(fù)責(zé)出發(fā)滾動。有以下子節(jié)點:<fileNamePattern>:必要節(jié)點,包含文件名及“%d”轉(zhuǎn)換符,“%d”可以包含一個java.text.SimpleDateFormat指定的時間格式,如:%d{yyyy-MM}。如果直接使用 %d,默認(rèn)格式是 yyyy-MM-dd。RollingFileAppender的file字節(jié)點可有可無,通過設(shè)置file,可以為活動文件和歸檔文件指定不同位置,當(dāng)前日志總是記錄到file指定的文件(活動文件),活動文件的名字不會改變;如果沒設(shè)置file,活動文件的名字會根據(jù)fileNamePattern 的值,每隔一段時間改變一次。“/”或者“\”會被當(dāng)做目錄分隔符。 <maxHistory>:可選節(jié)點,控制保留的歸檔文件的最大數(shù)量,超出數(shù)量就刪除舊文件。假設(shè)設(shè)置每個月滾動,且<maxHistory>是6,則只保存最近6個月的文件,刪除之前的舊文件。注意,刪除舊文件是,那些為了歸檔而創(chuàng)建的目錄也會被刪除。class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy": 查看當(dāng)前活動文件的大小,如果超過指定大小會告知RollingFileAppender 觸發(fā)當(dāng)前活動文件滾動。只有一個節(jié)點: <maxFileSize>:這是活動文件的大小,默認(rèn)值是10MB。<prudent>:當(dāng)為true時,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有兩個限制,1不支持也不允許文件壓縮,2不能設(shè)置file屬性,必須留空。 <triggeringPolicy >: 告知 RollingFileAppender 合適激活滾動。class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根據(jù)固定窗口算法重命名文件的滾動策略。有以下子節(jié)點: <minIndex>:窗口索引最小值 <maxIndex>:窗口索引最大值,當(dāng)用戶指定的窗口過大時,會自動將窗口設(shè)置為12。 <fileNamePattern>:必須包含“%i”例如,假設(shè)最小值和最大值分別為1和2,命名模式為 mylog%i.log,會產(chǎn)生歸檔文件mylog1.log和mylog2.log。還可以指定文件壓縮選項,例如,mylog%i.log.gz 或者 沒有l(wèi)og%i.log.zip6.子節(jié)點<loger>:用來設(shè)置某一個包或具體的某一個類的日志打印級別、以及指定<appender>。<loger>僅有一個name屬性,一個可選的level和一個可選的addtivity屬性。
可以包含零個或多個<appender-ref>元素,標(biāo)識這個appender將會添加到這個loger
7.子節(jié)點<root>:它也是<loger>元素,但是它是根loger,是所有<loger>的上級。只有一個level屬性,因為name已經(jīng)被命名為"root",且已經(jīng)是最上級了。
level: 用來設(shè)置打印級別,大小寫無關(guān):TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,不能設(shè)置為INHERITED或者同義詞NULL。 默認(rèn)是DEBUG。六、Demo
<?xml version="1.0" encoding="UTF-8"?> <!-- scan: 當(dāng)此屬性設(shè)置為true時,配置文件如果發(fā)生改變,將會被重新加載,默認(rèn)值為true。 scanPeriod: 設(shè)置監(jiān)測配置文件是否有修改的時間間隔,如果沒有給出時間單位,默認(rèn)單位是毫秒。當(dāng)scan為true時,此屬性生效。默認(rèn)的時間間隔為1分鐘。 debug: 當(dāng)此屬性設(shè)置為true時,將打印出logback內(nèi)部日志信息,實時查看logback運行狀態(tài)。默認(rèn)值為false。 --> <configuration scan="true" scanPeriod="60 seconds" debug="false"><!-- 定義參數(shù)常量 --><!-- TRACE<DEBUG<INFO<WARN<ERROR --><property name="log.level" value="debug" /><property name="log.maxHistory" value="30" /><property name="log.filePath" value="${catalina.base}/logs/webapps" /><property name="log.pattern"value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}-%msg%n" /><!-- 控制臺設(shè)置 --><appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender"><encoder><pattern>${log.pattern}</pattern></encoder></appender><!-- DEBUG --><appender name="debugAppender" class="ch.qos.logback.core.rolling.RollingFileAppender"><!-- 文件路徑:先向這個文件里面寫入日志,當(dāng)達(dá)到一定數(shù)量或一定時間之后分裂成下面的滾動日志來存放 --><file>${log.filePath}/debug.log</file><!-- 滾動策略 --><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><!-- 文件名稱 --><fileNamePattern>${log.filePath}/debug/debug.%d{yyyy-MM-dd}.log.gz</fileNamePattern><!-- 文件最大保存歷史數(shù)量 --><maxHistory>${log.maxHistory}</maxHistory></rollingPolicy><encoder><pattern>${log.pattern}</pattern></encoder><filter class="ch.qos.logback.classic.filter.LevelFilter"><level>DEBUG</level><onMatch>ACCEPT</onMatch><onMismatch>DENY</onMismatch></filter></appender><!-- INFO --><appender name="infoAppender" class="ch.qos.logback.core.rolling.RollingFileAppender"><!-- 文件路徑 --><file>${log.filePath}/info.log</file><!-- 滾動策略 --><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><!-- 文件名稱 --><fileNamePattern>${log.filePath}/info/info.%d{yyyy-MM-dd}.log.gz</fileNamePattern><!-- 文件最大保存歷史數(shù)量 --><maxHistory>${log.maxHistory}</maxHistory></rollingPolicy><encoder><pattern>${log.pattern}</pattern></encoder><filter class="ch.qos.logback.classic.filter.LevelFilter"><level>INFO</level><onMatch>ACCEPT</onMatch><onMismatch>DENY</onMismatch></filter></appender><!-- ERROR --><appender name="errorAppender" class="ch.qos.logback.core.rolling.RollingFileAppender"><!-- 文件路徑 --><file>${log.filePath}/error.log</file><!-- 滾動策略 --><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><!-- 文件名稱 --><fileNamePattern>${log.filePath}/error/error.%d{yyyy-MM-dd}.log.gz</fileNamePattern><!-- 文件最大保存歷史數(shù)量 --><maxHistory>${log.maxHistory}</maxHistory></rollingPolicy><encoder><pattern>${log.pattern}</pattern></encoder><filter class="ch.qos.logback.classic.filter.LevelFilter"><level>ERROR</level><onMatch>ACCEPT</onMatch><onMismatch>DENY</onMismatch></filter></appender><!-- 記錄“com.panjingg.o2o”下“${log.level}”以上級別的日志 --><!-- additivity="true":繼承父類屬性,子類有的屬性不會被重寫 --><logger name="com.panjingg.o2o" level="${log.level}" additivity="true"><appender-ref ref="debugAppender"/><appender-ref ref="infoAppender"/><appender-ref ref="errorAppender"/></logger><!-- 如果上面沒有指定level,將繼承父類的level屬性 --><root level="info"><appender-ref ref="consoleAppender"/></root> </configuration>總結(jié)
以上是生活随笔為你收集整理的logback的简单使用的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 才云开源 Nirvana:Golang
- 下一篇: vue - 响应式原理梳理(一)