Logback默認配置的步驟:
(1). 嘗試在 classpath下查找文件logback-test.xml;
(2). 如果文件不存在,則查找文件logback.xml;
(3). 如果兩個文件都不存在,logback用BasicConfigurator自動對自己進行配置,這會導致記錄輸出到控制檯。
1.根節點<configuration>包含三個屬性:
scan:默認爲true。作用:當設置爲true時,如果配置文件發生改變,將會被重新加載。
scanPeriod:默認時間間隔爲1分鐘,默認單位是毫秒,當scan爲true時,此屬性生效。作用:檢測配置文件是否有修改時間間隔。
debug:默認爲false。作用:當此屬性爲true時,將打印出logback內部日誌信息,實時查看logback運行狀態。
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!--其他配置省略-->
</configuration>
2.子節點<contextName>:用來設置上下文名稱。
每個logger都關聯到logger上下文,默認上下文名稱爲default。
可以使用<contextName>設置成其他名字,用於區分不同的應用程序的記錄。一旦設置,不能修改。
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<contextName>myAppName</contextName>
<!--其他配置省略-->
</configuration>
3.子節點<property>:用來定義變量值,有兩個屬性name和value。
通過<property>定義的值被插入到logger上下文中,可以使"${}"來使用變量。
name:變量的名字
value:變量名字對應的數值
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<property name="APP_Name" value="myAppName"></property>
<contextName>${APP_Name}</contextName>
<!--其他配置省略-->
</configuration>
4.子節點<timestamp>:獲取時間戳字符串,有兩個屬性key和datePattern。
key:標識此<timestamp>的名字
datePattern:設置將當前時間(即解析配置文件的時間)轉換爲字符串,遵循java.txt.SimpleDateFormat的格式。
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"></timestamp>
<contextName>${bySecond}</contextName>
</configuration>
5.子節點<appender>:負責寫日誌的組件,有兩個必要屬性name和class。
name:指定appender名稱
class:指定appender的全限定名
5.1 class="ch.qos.logback.core.ConsoleAppender":把日誌輸出到控制檯,有以下子節點。
<encoder>:對日誌進行格式化。(具體參數稍後講~~~~~~~~~~~~~)
<target>:字符串System.out(默認)或者System.err
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<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"></appender-ref>
</root>
</configuration>
上述配置表示把>=DEBUG級別的日誌都輸出到控制檯
5.2 class="ch.qos.logback.core.FileAppender":把日誌添加到文件,有以下子節點:
<file>:被寫入的文件名,可以是相對目錄,也可以是絕對目錄,如果上級目錄不存在會自動創建,沒有默認值。
<append>:默認爲true。如果是true,日誌被追加到文件結尾,如果是false,清空現存文件。
<encoder>:對記錄事件進行格式化。(具體參數稍後講~~~~~~~~~~~)
<prudent>:默認爲false。如果是true,日誌會被安全的寫入文件,即其他的FileAppender也在向此文件做寫入操作,效率低。
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<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 class="ch.qos.logback.core.rolling.RollingFileAppender":滾動記錄文件,先將日誌文件指定到文件,當符合某個條件時,將日誌記錄到其他文件。有以下子節點:
<file>:被寫入的文件名,可以是相對目錄,也可以是絕對目錄,如果上級目錄不存在會自動創建,沒有默認值。
<append>:默認爲true。如果是 true,日誌被追加到文件結尾,如果是 false,清空現存文件。
<rollingPolicy>:當發生滾動時,決定RollingFileAppender的行爲,涉及文件移動和重命名。屬性class定義具體的滾動策略類。
<triggeringPolicy >: 告知 RollingFileAppender 合適激活滾動。
<encoder>:對記錄事件進行格式化。負責兩件事:1)是把日誌信息轉換成字節數組,2)是把字節數組寫入到輸出流。
PatternLayoutEncoder 是唯一有用的且默認的encoder。有一個節點:
<pattern>節點,用來設置日誌的輸入格式。使用“%”加“轉換符”方式,如果要輸出“%”,則必須用“\”對“\%”進行轉義。
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy": 最常用的滾動策略,它根據時間來制定滾動策略,既負責滾動也負責出發滾動。有以下子節點:
<fileNamePattern>:必要節點,包含文件名及"%d"轉換符,"%d"可以包含一個java.text.SimpleDateFormat指定的時間格式,默認格式是 yyyy-MM-dd。也可以設置其他格 式,如:%d{yyyy-MM}。
<maxHistory>:可選節點,控制保留的歸檔文件的最大數量,超出數量就刪除舊文件。假設設置每個月滾動,且<maxHistory>是6,則只保存最近6個月的文件,刪除之前的舊文件。
注:刪除舊文件時,那些爲了歸檔而創建的目錄也會被刪除。
注:(RollingFileAppender的<file>子節點可有可無,通過設置<file>,可以爲活動文件和歸檔文件指定不同位置,當前日誌總是記錄到file指定的文件(活動文件),活動文件的名字不會改變; 如果沒設置file,活動文件的名字會根據fileNamePattern 的值,每隔一段時間改變一次。“/”或者“\”會被當做目錄分隔符。)
class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy": 查看當前活動文件的大小,如果超過指定大小會告知RollingFileAppender 觸發當前活動文件滾動。只有一個節點:
<maxFileSize>:活動文件的大小,默認值是10MB。
<prudent>:當爲true時,不支持FixedWindowRollingPolicy,支持TimeBasedRollingPolicy。但是有兩個限制:1)不支持也不允許文件壓縮,2)不能設置file屬性,必須留空。
class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" :根據固定窗口算法重命名文件的滾動策略。有以下子節點:
<minIndex>:窗口索引最小值
<maxIndex>:窗口索引最大值,當用戶指定的窗口過大時,會自動將窗口設置爲12。
<fileNamePattern>:必須包含“%i”例如,假設最小值和最大值分別爲1和2,命名模式爲 mylog%i.log,會產生歸檔文件mylog1.log和mylog2.log。還可以指定文件壓縮選項,例如,mylog%i.log.gz 或者 沒有log%i.log.zip
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<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 scan="true" scanPeriod="60 seconds" debug="false">
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>test.log</file>
<roollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
<fileNamePattern>tests.%i.log.zip</fileNamePattern>
<minIndex>1</minIndex>
<maxIndex>3</maxIndex>
</roollingPolicy>
<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個歸檔文件後,將覆蓋最早的日誌。
5.4 還有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender,並不常用,這裏就不詳解了。
大家可以參考官方文檔(http://logback.qos.ch/documentation.html),還可以編寫自己的Appender。
6. 子節點<logger>:用來設置某一個包或具體的某一個類的日誌打印級別、以及指定<appender>。
<logger>僅有一個name屬性,一個可選的level和一個可選的addtivity屬性。可以包含零個或多個<appender-ref>元素,標識這個appender將會添加到這個logger。
name: 用來指定受此logger約束的某一個包或者具體的某一個類。
level: 用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,還有一個特俗值INHERITED或者同義詞NULL,代表強制執行上級的級別。 如果未設置此屬性,那麼當前logger將會繼承上級的級別。
addtivity: 是否向上級logger傳遞打印信息。默認是true。同<logger>一樣,可以包含零個或多個<appender-ref>元素,標識這個appender將會添加到這個logger。
7. 子節點<root>:它也是<logger>元素,但是它是根logger,是所有<logger>的上級。只有一個level屬性,因爲name已經被命名爲"root",且已經是最上級了。有一個屬性:
level: 用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,不能設置爲INHERITED或者同義詞NULL。 默認是DEBUG。
<!--配置文件logback.xml-->
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!-- 定義日誌文件的存儲地址 -->
<!--
關於catalina.base解釋如下:
catalina.home指向公用信息的位置,就是bin和lib的父目錄。
catalina.base指向每個Tomcat目錄私有信息的位置,就是conf、logs、temp、webapps和work的父目錄。
-->
<property name="LOG_DIR" value="${catalina.base}/logs"/>
<!--
%p:輸出優先級,即DEBUG,INFO,WARN,ERROR,FATAL
%r:輸出自應用啓動到輸出該日誌訊息所耗費的毫秒數
%t:輸出產生該日誌事件的線程名
%f:輸出日誌訊息所屬的類別的類別名
%c:輸出日誌訊息所屬的類的全名
%d:輸出日誌時間點的日期或時間,指定格式的方式: %d{yyyy-MM-dd HH:mm:ss}
%l:輸出日誌事件的發生位置,即輸出日誌訊息的語句在他所在類別的第幾行。
%m:輸出代碼中指定的訊息,如log(message)中的message
%n:輸出一個換行符號
-->
<!--格式化輸出:%d表示日期,%thread表示線程名,%-5level:級別從左顯示5個字符寬度 %msg:日誌消息,%n是換行符-->
<property name="pattern" value="%d{yyyyMMdd:HH:mm:ss.SSS} [%thread] %-5level %msg%n"/>
<!--
Appender: 設置日誌信息的去向,常用的有以下幾個
ch.qos.logback.core.ConsoleAppender (控制檯)
ch.qos.logback.core.rolling.RollingFileAppender (文件大小到達指定尺寸的時候產生一個新文件)
ch.qos.logback.core.FileAppender (文件)
-->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<!-- 字符串System.out(默認)或者System.err -->
<target>System.out</target>
<!-- 對記錄事件進行格式化 -->
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${pattern}</pattern>
</encoder>
</appender>
<appender name="SQL_INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 被寫入的文件名,可以是相對目錄,也可以是絕對目錄,如果上級目錄不存在會自動創建 -->
<file>${LOG_DIR}/sql_info.log</file>
<!-- 當發生滾動時,決定RollingFileAppender的行爲,涉及文件移動和重命名。屬性class定義具體的滾動策略類 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 必要節點,包含文件名及"%d"轉換符,"%d"可以包含一個java.text.SimpleDateFormat指定的時間格式,默認格式是 yyyy-MM-dd -->
<fileNamePattern>${LOG_DIR}/sql_info_%d{yyyy-MM-dd}.log.%i.gz</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>20MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!-- 可選節點,控制保留的歸檔文件的最大數量,超出數量就刪除舊文件。假設設置每個月滾動,如果是6,則只保存最近6個月的文件,刪除之前的舊文件 -->
<maxHistory>10</maxHistory>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${pattern}</pattern>
</encoder>
<!-- LevelFilter: 級別過濾器,根據日誌級別進行過濾 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<!-- 用於配置符合過濾條件的操作 ACCEPT:日誌會被立即處理,不再經過剩餘過濾器 -->
<onMatch>ACCEPT</onMatch>
<!-- 用於配置不符合過濾條件的操作 DENY:日誌將立即被拋棄不再經過其他過濾器 -->
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<appender name="SQL_ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_DIR}/sql_error.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_DIR}/sql_error_%d{yyyy-MM-dd}.log.%i.gz</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>20MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<maxHistory>10</maxHistory>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${pattern}</pattern>
</encoder>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<appender name="APP_INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_DIR}/info.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<FileNamePattern>${LOG_DIR}/info.%d{yyyy-MM-dd}.log
</FileNamePattern>
</rollingPolicy>
<encoder>
<Pattern>[%date{yyyy-MM-dd HH:mm:ss}] [%-5level] [%thread] [%logger:%line]--%mdc{client} %msg%n</Pattern>
</encoder>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
<encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
<layout class="ch.qos.logback.classic.html.HTMLLayout">
<property name="pattern" value="%d{yyyyMMdd:HH:mm:ss.SSS} [%thread] %-5level %msg%n"/>
<pattern>%d{yyyyMMdd:HH:mm:ss.SSS}%thread%-5level%F{32}%M%L%msg</pattern>
</layout>
</encoder>
<file>${LOG_DIR}/test.html</file>
</appender>
<!--
用來設置某一個包或者具體的某一個類的日誌打印級別、以及指定<appender>。
<loger>僅有一個name屬性,一個可選的level和一個可選的addtivity屬性
name:
用來指定受此logger約束的某一個包或者具體的某一個類。
level:
用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
如果未設置此屬性,那麼當前logger將會繼承上級的級別。
additivity:
是否向上級loger傳遞打印信息。默認是true。
<logger>可以包含零個或多個<appender-ref>元素,標識這個appender將會添加到這個logger
-->
<logger name="java.sql" level="info" additivity="false">
<level value="info" />
<appender-ref ref="STDOUT"></appender-ref>
<appender-ref ref="SQL_INFO"></appender-ref>
<appender-ref ref="SQL_ERROR"></appender-ref>
</logger>
<logger name="com.souche.LogbackTest" additivity="false">
<level value="info" />
<appender-ref ref="STDOUT" />
<appender-ref ref="APP_INFO" />
<appender-ref ref="FILE"/>
</logger>
<!--
也是<logger>元素,但是它是根logger。默認debug
level:用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
<root>可以包含零個或多個<appender-ref>元素,標識這個appender將會添加到這個logger。
-->
<root level="info">
<level>info</level>
<appender-ref ref="STDOUT"/>
<appender-ref ref="SQL_INFO"/>
<appender-ref ref="SQL_ERROR"/>
<appender-ref ref="FILE"/>
</root>
</configuration>
詳細參考:
logback配置詳解和使用
https://www.cnblogs.com/nananana/p/8371805.html
logback最佳實踐
https://www.jianshu.com/p/b3dedb8fb61e
以下是個人練習:
<properties>
<slf4j.version>1.7.7</slf4j.version>
<logback.version>1.1.2</logback.version>
</properties>
<dependencies>
<!--
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
-->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-access</artifactId>
<version>${logback.version}</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>${logback.version}</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>${logback.version}</version>
</dependency>
</dependencies>
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="30 seconds">
<!--Appendar詳解: http://logback.qos.ch/manual/appenders.html#RollingFileAppender -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 當前Log文件名 -->
<file>test.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 非當天的Log文件壓縮備份爲 archive/ldap-pwd.2014-08-10.zip -->
<fileNamePattern>archive/ldap-pwd.%d{yyyy-MM-dd}.zip</fileNamePattern>
<!-- 超過30天的備份文件會被刪除 -->
<maxHistory>30</maxHistory>
</rollingPolicy>
<layout class="ch.qos.logback.classic.PatternLayout">
<!-- 格式說明:http://logback.qos.ch/manual/layouts.html#ClassicPatternLayout -->
<Pattern>%d [%thread] %-5level %40logger{40} - %msg%n</Pattern>
</layout>
</appender>
<!-- ConsoleAppender 控制檯輸出日誌 -->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>
<!-- 設置日誌輸出格式 -->
%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger - %msg%n
</pattern>
</encoder>
</appender>
<logger name="cn.justfly.training.logging" level="info" />
<root level="DEBUG">
<appender-ref ref="FILE" />
<appender-ref ref="console" />
</root>
</configuration>