Slf4j是The Simple Logging Facade for Java的簡稱,是一個簡單日志門面抽象架構,它本身隻提供了日志Facade API和一個簡單的日志類實作,一般常配合Log4j,LogBack,java.util.logging使用。Slf4j作為應用層的Log接入時,程式可以根據實際應用場景動态調整底層的日志實作架構(Log4j/LogBack/JdkLog…)。
LogBack官方建議配合Slf4j使用,這樣可以靈活地替換底層日志架構。
TIPS:為了優化log4j,以及更大性能的提升,Apache基金會已經着手開發了log4j 2.0, 其中也借鑒和吸收了logback的一些先進特性,目前log4j2還處于beta階段。
LogBack被分為3個元件,logback-core, logback-classic 和 logback-access。
其中logback-core提供了LogBack的核心功能,是另外兩個元件的基礎。
logback-classic則實作了Slf4j的API,是以當想配合Slf4j使用時,需要将logback-classic加入classpath。
logback-access是為了內建Servlet環境而準備的,可提供HTTP-access的日志接口。
scan:當此屬性設定為true時,配置檔案如果發生改變,将會被重新加載,預設值為true.
scanPeriod:設定監測配置檔案是否有修改的時間間隔,如果沒有給出時間機關,預設機關是毫秒。當scan為true時,此屬性生效。預設的時間間隔為1分鐘.
debug:當此屬性設定為true時,将列印出logback内部日志資訊,實時檢視logback運作狀态。預設值為false。
XML代碼:
LogBack的配置大概包括3部分:appender, logger和root。

每個logger都關聯到logger上下文,預設上下文名稱為“default”。但可以使用<contextName>設定成其他名字,用于區分不同應用程式的記錄。一旦設定,不能修改。
用來定義變量值的标簽,<property> 有兩個屬性,name和value;其中name的值是變量的名稱,value的值時變量定義的值。通過<property>定義的值會被插入到logger上下文中。定義變量後,可以使“${}”來使用變量。
例如使用<property>定義上下文名稱,然後在<contentName>設定logger上下文時使用。
兩個屬性 key:辨別此<timestamp> 的名字;datePattern:設定将目前時間(解析配置檔案的時間)轉換為字元串的模式,遵循Java.txt.SimpleDateFormat的格式。
例如将解析配置檔案的時間作為上下文名稱:
<logger>
用來設定某一個包或者具體的某一個類的日志列印級别、以及指定<appender>。<logger>僅有一個name屬性,一個可選的level和一個可選的addtivity屬性。
name:用來指定受此logger限制的某一個包或者具體的某一個類。
level:用來設定列印級别,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,還有一個特殊值INHERITED或者同義詞NULL,代表強制執行上級的級别。
如果未設定此屬性,那麼目前logger将會繼承上級的級别。
addtivity:是否向上級logger傳遞列印資訊。預設是true。
<logger>可以包含零個或多個<appender-ref>元素,辨別這個appender将會添加到這個logger。
<root>
也是<logger>元素,但是它是根logger。隻有一個level屬性,應為已經被命名為”root”.
level:用來設定列印級别,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能設定為INHERITED或者同義詞NULL。預設是DEBUG。
<root>可以包含零個或多個<appender-ref>元素,辨別這個appender将會添加到這個logger。
首先,Java類如下:
logback.xml配置檔案
其中appender的配置表示列印到控制台(稍後詳細講解appender )。<root level=”INFO”>将root的列印級别設定為“INFO”,指定了名字為“STDOUT”的appender。
當執行logback.LogbackDemo類的main方法時,root将級别為“INFO”及大于“INFO”的日志資訊交給已經配置好的名為“STDOUT”的appender處理,“STDOUT”appender将資訊列印到控制台;
輸出結果:
其中appender的配置表示列印到控制台。
<logger name=”logback” />将控制logback包下的所有類的日志的列印,但是并沒有設定列印級别,是以繼承他的上級<root>的日志級别“DEBUG”。
沒有設定addtivity,預設為true,将此logger的列印資訊向上級傳遞。
沒有設定appender,此logger本身不列印任何資訊。
<root level=”DEBUG”>将root的列印級别設定為“DEBUG”,指定了名字為“STDOUT”的appender。
當執行logback.LogbackDemo類的main方法時,因為LogbackDemo 在包logback中,是以首先執行<logger name=”logback” />,将級别為“DEBUG”及大于“DEBUG”的日志資訊傳遞給root,本身并不列印。
root接到下級傳遞的資訊,交給已經配置好的名為“STDOUT”的appender處理,“STDOUT”appender将資訊列印到控制台。
<logger name=”logback” />将控制logback包下的所有類的日志的列印,但是并沒用設定列印級别,是以繼承他的上級<root>的日志級别“DEBUG”。
<logger name=”logback.LogbackDemo” level=”INFO” additivity=”false”>控制logback.LogbackDemo類的日志列印,列印級别為“INFO”。
additivity屬性為false,表示此logger的列印資訊不再向上級傳遞,指定了名字為“STDOUT”的appender。
<root level=”DEBUG”>将root的列印級别設定為“ERROR”,指定了名字為“STDOUT”的appender。
當執行logback.LogbackDemo類的main方法時,先執行<logger name=”logback.LogbackDemo” level=”INFO” additivity=”false”>,将級别為“INFO”及大于“INFO”的日志資訊交給此logger指定的名為“STDOUT”的appender處理,在控制台中打出日志,不再向次logger的上級 <logger name=”logback”/> 傳遞列印資訊。
<logger name=”logback”/>未接到任何列印資訊,當然也不會給它的上級root傳遞任何列印資訊。
如果将<logger name=”logback.LogbackDemo” level=”INFO” additivity=”false”>修改為 <logger name=”logback.LogbackDemo” level=”INFO” additivity=”true”>那列印結果将是什麼呢?
沒錯,日志列印了兩次,想必大家都知道原因了,因為列印資訊向上級傳遞,logger本身列印一次,root接到後又列印一次:
<appender>是<configuration>的子節點,是負責寫日志的元件。<appender>有兩個必要屬性name和class。name指定appender名稱,class指定appender的全限定名。
把日志添加到控制台,有以下子節點:
<encoder>:對日志進行格式化。(具體參數稍後講解 )
<target>:字元串 System.out 或者 System.err ,預設 System.out .
把日志添加到檔案,有以下子節點:
<file>:被寫入的檔案名,可以是相對目錄,也可以是絕對目錄,如果上級目錄不存在會自動建立,沒有預設值。
<append>:如果是 true,日志被追加到檔案結尾,如果是 false,清空現存檔案,預設是true。
<encoder>:對記錄事件進行格式化。(具體參數稍後講解 )
<prudent>:如果是 true,日志會被安全的寫入檔案,即使其他的FileAppender也在向此檔案做寫入操作,效率低,預設是 false。
滾動記錄檔案,先将日志記錄到指定檔案,當符合某個條件時,将日志記錄到其他檔案。有以下子節點:
<rollingPolicy>:當發生滾動時,決定 RollingFileAppender 的行為,涉及檔案移動和重命名。
<triggeringPolicy >: 告知 RollingFileAppender 何時激活滾動。
<prudent>:當為true時,不支援FixedWindowRollingPolicy。支援TimeBasedRollingPolicy,但是有兩個限制,1不支援也不允許檔案壓縮,2不能設定file屬性,必須留白。
TimeBasedRollingPolicy: 最常用的滾動政策,它根據時間來制定滾動政策,既負責滾動也負責觸發滾動。有以下子節點:
<fileNamePattern>: 必要節點,包含檔案名及“%d”轉換符,%d”可以包含一個Java.text.SimpleDateFormat指定的時間格式,如:%d{yyyy-MM}。如果直接使用 %d,預設格式是 yyyy-MM-dd。RollingFileAppender 的file位元組點可有可無,通過設定file,可以為活動檔案和歸檔檔案指定不同位置,目前日志總是記錄到file指定的檔案(活動檔案),活動檔案的名字不會改變;如果沒設定file,活動檔案的名字會根據fileNamePattern 的值,每隔一段時間改變一次。“/”或者“\”會被當做目錄分隔符。
<maxHistory>: 可選節點,控制保留的歸檔檔案的最大數量,超出數量就删除舊檔案。假設設定每個月滾動,且<maxHistory>是6,則隻儲存最近6個月的檔案,删除之前的舊檔案。注意,删除舊檔案是,那些為了歸檔而建立的目錄也會被删除。
FixedWindowRollingPolicy: 根據固定視窗算法重命名檔案的滾動政策。有以下子節點:
<minIndex>:視窗索引最小值。
<maxIndex>:視窗索引最大值,當使用者指定的視窗過大時,會自動将視窗設定為12。
<fileNamePattern >: 必須包含“%i”例如,假設最小值和最大值分别為1和2,命名模式為 mylog%i.log,會産生歸檔檔案mylog1.log和mylog2.log。還可以指定檔案壓縮選項,例如,mylog%i.log.gz 或者 沒有log%i.log.zip
SizeBasedTriggeringPolicy: 檢視目前活動檔案的大小,如果超過指定大小會告知RollingFileAppender 觸發目前活動檔案滾動。隻有一個節點:
<maxFileSize>:這是活動檔案的大小,預設值是10MB。
例如:每天生産一個日志檔案,儲存30天的日志檔案
又例如:按照固定視窗模式生成日志檔案,當檔案大于20MB時,生成新的日志檔案。視窗大小是1到3,當儲存了3個歸檔檔案後,将覆寫最早的日志。
另外還有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender,并不常用,這些就不在這裡講解了,大家可以參考官方文檔。當然大家可以編寫自己的Appender。
負責兩件事,一是把日志資訊轉換成位元組數組,二是把位元組數組寫入到輸出流。
目前PatternLayoutEncoder 是唯一有用的且預設的encoder ,有一個<pattern>節點,用來設定日志的輸入格式。使用“%”加“轉換符”方式,如果要輸出“%”,則必須用“\”對“\%”進行轉義。
例如:
格式修飾符,與轉換符共同使用:
可選的格式修飾符位于“%”和轉換符之間。第一個可選修飾符是左對齊 标志,符号是減号“-”;接着是可選的最小寬度 修飾符,用十進制數表示。如果字元小于最小寬度,則左填充或右填充,預設是左填充(即右對齊),填充符為空格。如果字元大于最小寬度,字元永遠不會被截斷。最大寬度 修飾符,符号是點号”.”後面加十進制數。如果字元大于最大寬度,則從前面截斷。點符号“.”後面加減号“-”在加數字,表示從尾部截斷。
例如:%-4relative 表示,将輸出從程式啟動到建立日志記錄的時間 進行左對齊 且最小寬度為4。
最後附上相對比較完整的,涵蓋大部配置設定置的案例,案例中有解析。
<a href="http://logback.qos.ch/">http://logback.qos.ch/</a>
<a href="http://blog.csdn.net/haidage/article/details/6794509/">logback 配置詳解(一)</a>
<a href="http://blog.csdn.net/haidage/article/details/6794529">logback 常用配置詳解(二) <appender></a>
<a href="http://blog.csdn.net/u011270461/article/details/50241815">Logback配置解析</a>
<a href="http://www.cnblogs.com/mailingfeng/p/3499436.html">LogBack簡易教程</a>