概述
很早之前就想寫一篇關於項目中日誌框架的使用了,有這想法時大家還在使用Log4j呢。也慶幸沒有寫,要不然今天介紹的日誌框架Logback一樣還得補上。言歸正傳,介紹當下最流行日誌框架Logback的使用及配置。本文需要掌握日誌相關基礎知識(如日誌級別等最基本知識)。
一、介紹
Logback中文網:http://www.logback.cn/
logback與slf4j有什麼區別?
- Slf4j:簡單日誌門面(Simple Logging Facade for Java),不是具體的日誌解決方案,它只服務於各種各樣的日誌系統。在使用SLF4J的時候,不需要在代碼中或配置文件中指定你打算使用那個具體的日誌系統。
- log4j和logback是具體實現了的日誌框架。
logback同樣是由log4j的作者實現的,擁有更好的特性,是slf4j的原生實現,Logback 的架構非常的通用,適用不同的使用場景。
Logback 被分成三個不同的模塊:logback-core,logback-classic,logback-access。
logback中的logger、appender、layout :
- logger:作爲日誌的記錄器,把它關聯到對應的context後,主要用於存放日誌對象,也可以定義日誌類型,級別。
- appender:主要用於指定日誌輸出的目的地。目的地可以是控制檯,文件,遠程套接字服務器,數據庫mysql等。
- layout:負責把時間轉換成字符串,格式化日誌信息的輸出。
二、使用步驟
2.1 添加依賴
如果項目是Sprng-boot項目無需單獨引入slf4j和Logback相關依賴,Spring-boot默認使用Logback日誌框架。
如果是普通Spring項目或者Maven項目則需要引入以下依賴。(目前Sl4j穩定版本1.7.28,logback三個依賴穩定版1.2.3)
<!-- slf4j -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
<!-- logback -->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</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-access</artifactId>
<version>${logback.version}</version>
</dependency>
2.2 獲取日誌對象
常規獲取日誌對象方式:
- 在類中定義私有成員變量 private static finall Logger log= LoggerFactory.getLogger(ClassName.class)
- 在類上添加@Slf4註解,即可在類中使用變量名爲"log"的日誌對象,當然需要lombok的支持
2.3 調用日誌方法
使用實例 log來調用不同的方法來打印日誌。例:debug(),info(),warn(),error()等。通過這些方法將會在配置好的 appender 中輸出日誌。
說明:建議自己在輸出日誌信息時,使用推薦的“{}”佔位單個變量的方式來輸出變量。輸出時logback會按變量順序添加到{}順序中。
如:log.info("小明的年齡是{}歲,性別是{}性",age,sex)。
2.4 測試
使用spring-boot項目測試最簡單的日誌使用,創建好spring-boot項目後(無需引入Logback依賴)。直接在啓動類中編寫:
@SpringBootApplication
public class LogbackApplication {
private final static Logger logger = LoggerFactory.getLogger(LogbackApplication.class);
public static void main(String[] args) {
//SpringApplication.run(LogbackApplication.class, args);
logger.error("test -> error");
logger.warn("test -> warn");
logger.info("test -> info");
logger.debug("test-> debug");
logger.trace("test -> trace");
}
}
運行結果:
由此可見在沒有任何配置Logback的情況下,也會有指定格式的控制檯輸出,並且輸出級別是DEBUG的,所以Logback肯定是有默認配置的,來看看它的默認配置。
三、logback的默認配置
在項目的resources資源目錄下,如果配置文件 logback-test.xml 和 logback.xml 都不存在,那麼 logback 默認地會調用BasicConfigurator ,創建一個最小化配置。最小化配置由一個關聯到根 logger 的ConsoleAppender (控制檯輸出)組成。
輸出用模式爲%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 進行格式化。root logger 默認級別是 DEBUG。這就是上面測試時輸出的緣故了。
默認配置等同於如下配置,看不懂沒關係,全文看完就秒懂了。
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<root level="debug">
<appender-ref ref="STDOUT" />
</root>
</configuration>
- Logback的配置文件
Logback 配置文件的語法非常靈活。正因爲靈活,所以無法用 DTD 或 XML schema 進行定義。儘管如此,可以這樣描述配置文件的基本結構:以<configuration>開頭,後面有零個或多個<appender>元素,有零個或多個<logger>元素,有最多一個<root>元素。基本結構圖如下:
- Logback默認配置的步驟
- 嘗試在 classpath下查找文件logback-test.xml;
- 如果文件不存在,則查找文件logback.xml;
- 如果兩個文件都不存在,logback用BasicConfigurator自動對自己進行配置,這會導致記錄輸出到控制檯。
特別指出:如果是Spring-boot項目,官方推薦使用的xml名字的格式爲:logback-spring.xml而不是logback.xml,至於爲什麼,因爲帶spring後綴的可以使用<springProfile>這個標籤。
四、logback.xml常用配置詳解(*重點)
4.1 根節點<configuration>
<configuration>元素包含下面三個屬性:
- scan: 當此屬性設置爲true時,配置文件如果發生改變,將會被重新加載,默認值爲true。
- scanPeriod: 設置監測配置文件是否有修改的時間間隔,如果沒有給出時間單位,默認單位是毫秒。當scan爲true時,此屬性生效。默認的時間間隔爲1分鐘。
- debug: 當此屬性設置爲true時,將打印出logback內部日誌信息,實時查看logback運行狀態。默認值爲false。
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!--其他配置省略-->
</configuration>
4.2 子節點<contextName>
用來設置上下文名稱,每個logger都關聯到logger上下文,默認上下文名稱爲default。但可以使用<contextName>設置成其他名字,用於區分不同應用程序的記錄。一旦設置,不能修改。
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<contextName>myAppName</contextName>
<!--其他配置省略-->
</configuration>
4.3 子節點<property>
用來定義變量值,它有兩個屬性name和value,通過<property>定義的值會被插入到logger上下文中,可以使“${}”來使用變量。
- name: 變量的名稱
- value: 的值時變量定義的值
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<property name="APP_Name" value="myAppName" />
<contextName>${APP_Name}</contextName>
<!--其他配置省略-->
</configuration>
4.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"/>
<contextName>${bySecond}</contextName>
<!-- 其他配置省略-->
</configuration>
4.5 子節點<appender>(重點 + 重點)
logback 將寫入日誌事件的任務委託給一個名爲 appender 的組件。它有兩個強制屬性name和class。name指定appender名稱,class 屬性需要指定類的全限定名用於實例化。<appender>
元素可以包含 0 或一個 <layout>
元素,0 或多個 <encoder>
元素,0 或多個 <filter>
元素。除了這些公共的元素之外,<appender>
元素可以包含任意與 appender 類的 JavaBean 屬性相一致的元素。常見的結構如下:
4.5.1 ConsoleAppender 把日誌輸出到控制檯,有以下子節點:
- <encoder>:對日誌進行格式化。
- <target>:字符串System.out(默認)或者System.err(區別不多說了)
<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級別的日誌都輸出到控制檯
4.5.2 FileAppender:把日誌添加到文件,有以下子節點:
- <file>:被寫入的文件名,可以是相對目錄,也可以是絕對目錄,如果上級目錄不存在會自動創建,沒有默認值。
- <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
4.5.3 RollingFileAppender(最強大組件):具有輪轉日誌文件功能。例如,RollingFileAppender
將日誌輸出到 log.txt 文件,在滿足了特定的條件之後,將日誌輸出到另外一個文件。
與 RollingFileAppender
進行交互的有兩個重要的子組件。第一個是 RollingPolicy
,它負責日誌輪轉的功能。另一個是 TriggeringPolicy
,它負責日誌輪轉的時機。所以 RollingPolicy
負責發生什麼,TriggeringPolicy
負責什麼時候發生。
- <file>:被寫入的文件名,可以是相對目錄,也可以是絕對目錄,如果上級目錄不存在會自動創建,沒有默認值。
- <append>:如果是 true,日誌被追加到文件結尾,如果是 false,清空現存文件,默認是true。
- <encoder>:對記錄事件進行格式化。負責兩件事,一是把日誌信息轉換成字節數組,二是把字節數組寫入到輸出流。
PatternLayoutEncoder 是唯一有用的且默認的encoder ,有一個<pattern>節點,用來設置日誌的輸入格式。使用“%”加“轉換符”方式,如果要輸出“%”,則必須用“\”對“\%”進行轉義。 - <prudent>:當爲true時,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有兩個限制,1不支持也不允許文件壓縮,2不能設置file屬性,必須留空。
- <rollingPolicy>:當發生滾動時,決定RollingFileAppender的行爲,涉及文件移動和重命名。屬性class定義具體的滾動策略類。
以下爲<rollingPolicy>的使用有三種策略:按時間(常用)重命名、大小和時間重命名、固定窗口算法重命名文件。
第一種:class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy": 最常用的滾動策略,它根據時間來制定滾動策略,既負責滾動也負責觸發滾動。不用指定觸發策略。有以下子節點
<fileNamePattern>:必要節點,包含文件名及“%d”轉換符,“%d”可以包含一個java.text.SimpleDateFormat指定的時間格式,如:%d{yyyy-MM}。如果直接使用 %d,默認格式是 yyyy-MM-dd。
RollingFileAppender的file節點可有可無,通過設置file,可以爲活動文件和歸檔文件指定不同位置,當前日誌總是記錄到file指定的文件(活動文件),活動文件的名字不會改變;如果沒設置file,活動文件的名字會根據fileNamePattern 的值,每隔一段時間改變一次。“/”或者“\”會被當做目錄分隔符。
<maxHistory>:可選節點,控制保留的歸檔文件的最大數量,超出數量就刪除舊文件。假設設置每個月滾動,且<maxHistory>是6,則只保存最近6個月的文件,刪除之前的舊文件。注意,刪除舊文件是,那些爲了歸檔而創建的目錄也會被刪除。<totalSizeCap>:這個可選屬性用來控制所有歸檔文件總的大小。當達到這個大小後,舊的歸檔文件將會被異步的刪除。使用這個屬性時還需要設置 maxHistory 屬性。而且,maxHistory 將會被作爲第一條件,該屬性作爲第二條件。
<cleanHistoryOnStart>:如果設置爲 true,那麼在 appender 啓動的時候,歸檔文件將會被刪除。默認的值爲 false。
歸檔文件的刪除通常在輪轉期間執行。但是,有些應用的存活時間可能等不到輪轉觸發。對於這種短期應用,可以通過設置該屬性爲 true,在 appender 啓動的時候執行刪除操作。<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天的日誌文件。
第二種:class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy":有時你希望按時輪轉,但同時又想限制每個日誌文件的大小。特別是如果後期處理工具需要對日誌進行大小限制。
注意,除了 %d 之外還有 %i。這兩個佔位符都是強制要求的。在當前時間還沒有到達週期輪轉之前,日誌文件達到了 <
maxFileSize>
指定的大小,會進行歸檔,遞增索引從 0 開始。默認值是10M。基於大小與時間的文件歸檔支持刪除舊的歸檔文件。你需要指定 <
maxHistory>
屬性的值來保存幾個週期的日誌。當你的應用停止或者啓動的時候,日誌將會繼續向正確的位置輸出。即當前週期內索引最大的。
第三種:class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy":在輪轉時,
FixedWindowRollingPolicy
根據固定窗口算法重命名文件,具體描述如下:
filaNamePattern
表示歸檔文件的名字。這個屬性是必須的,而且必須包含一個表示整形的佔位符 i%。<minIndex>:表示窗口索引的下界
<maxIndex>:表示窗口索引的上界
<fileNamePattern>:
FixedWindowRollingPolicy
在重命名日誌文件時將會根據這個屬性來命名。它必須包含一個 i% 的佔位符,該佔位符指明瞭窗口索引的值應該插入的位置。
例如,當該屬性的值爲 MyLogFile%i.log,最小與最大的值分別爲 1 和 3。將會產生的歸檔文件爲 MyLogFile1.log,MyLogFile2.log,MyLogFile3.log。
文件壓縮的方式也是通過該屬性來指定。例如,設置該屬性的值爲 MyLogFile%i.log.zip,那麼歸檔文件將會被壓縮成 zip 格式。也可以選擇壓縮成 gz 格式。使用示例參考下面的。
- <triggeringPolicy >:用於通知
RollingFileAppender
何時輪轉、何時激活滾動。
以下爲<triggeringPolicy>的使用:
class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy": 觀察當前活動文件的大小,如果已經大於了指定的值,它會給
RollingFileAppender
發一個信號觸發對當前活動文件的輪轉。
SizeBasedTriggeringPolicy
只接收maxFileSize
這一個參數,它的默認值是 10 MB。
maxFileSize
可以爲字節,千字節,兆字節,千兆字節,通過在數值後面指定一個後綴 KB,MB 或者 GB。例如,5000000,5000KB,5MB 以及 2GB 都是有效的,前三個是一樣的。<configuration> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>test.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> <fileNamePattern>test.%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>
備註:上述配置表示按照固定窗口模式生成日誌文件,當文件大於5MB時,生成新的日誌文件。窗口大小是1到3,當保存了3個歸檔文件後,將覆蓋最早的日誌。
4.5.4 還有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender,並不常用,這裏就不詳解了。
大家可以參考官方文檔(http://logback.qos.ch/documentation.html),還可以編寫自己的Appender。
日誌過濾器:Filter
<filter>將日誌信息過濾:常用LevelFilter-等級過濾器來過濾日誌信息。有三個字元素
- <level>INFO</level>:指定特定等級
- <onMatch>ACCEPT</onMatch>:如果匹配則接受輸出
- <onMismatch>DENY</onMismatch>:如果不匹配則過濾掉
示例如下:
<configuration> <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>INFO</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> <encoder> <pattern> %-4relative [%thread] %-5level %logger{30} - %msg%n </pattern> </encoder> </appender> <root level="DEBUG"> <appender-ref ref="CONSOLE" /> </root> </configuration>
備註:儘管root輸出的是DEBUG,可是經過過濾器後,只輸出了INFO級別的信息。
4.6 子節點<loger>
用來設置某一個包或具體的某一個類的日誌打印級別、以及指定<appender>。<loger>僅有一個name屬性,一個可選的level和一個可選的addtivity屬性。
可以包含零個或多個<appender-ref>元素,標識這個appender將會添加到這個loger
- name: 用來指定受此loger約束的某一個包或者具體的某一個類。
- level: 用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,還有一個特俗值INHERITED或者同義詞NULL,代表強制執行上級的級別。 如果未設置此屬性,那麼當前loger將會繼承上級的級別。
- addtivity: 是否向上級loger傳遞打印信息。默認是true。
loger節點可以包含零個或多個<appender-ref>元素,標識這個appender將會添加到這個loger。
4.7 子節點<root>
它的本質也是<loger>元素,但是它是根loger,是所有<loger>的上級。只有一個level屬性,因爲name已經被命名爲"root",且已經是最上級了。
- level: 用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,不能設置爲INHERITED或者同義詞NULL。 默認是DEBUG。
同loger一樣,root節點可以包含零個或多個<appender-ref>元素,標識這個appender將會添加到這個loger。
五、整體配置文件說明:
<?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.xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
<!--定義日誌文件的存儲地址 -->
<property name="LOG_HOME" value="../logs" />
<property name="COLOR_PATTERN" value="%black(%contextName-) %red(%d{yyyy-MM-dd HH:mm:ss}) %green([%thread]) %highlight(%-5level) %boldMagenta( %replace(%caller{1}){'\t|Caller.{1}0|\r\n', ''})- %gray(%msg%xEx%n)" />
<!-- 控制檯輸出 -->
<appender name="STDOUT"
class="ch.qos.logback.core.ConsoleAppender">
<encoder
class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化輸出:%d表示日期,%thread表示線程名,%-5level:級別從左顯示5個字符寬度%msg:日誌消息,%n是換行符 -->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}:%L - %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}/jeecgboot.%d{yyyy-MM-dd}.log
</FileNamePattern>
<!--日誌文件保留天數 -->
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder
class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化輸出:%d表示日期,%thread表示線程名,%-5level:級別從左顯示5個字符寬度%msg:日誌消息,%n是換行符 -->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}:%L - %msg%n</pattern>
</encoder>
<!--日誌文件最大的大小 -->
<triggeringPolicy
class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>
<!-- 生成html格式日誌開始 -->
<appender name="HTML" class="ch.qos.logback.core.FileAppender">
<!-- 過濾器,只記錄WARN級別的日誌 -->
<!-- <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>info</level>
<onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> -->
<encoder
class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
<layout class="ch.qos.logback.classic.html.HTMLLayout">
<pattern>%p%d%msg%M%F{32}%L</pattern>
</layout>
</encoder>
<file>${LOG_HOME}/error-log.html</file>
</appender>
<!-- 生成html格式日誌結束 -->
<!-- 每天生成一個html格式的日誌開始 -->
<appender name="FILE_HTML"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日誌文件輸出的文件名 -->
<FileNamePattern>${LOG_HOME}/jeecgboot.%d{yyyy-MM-dd}.html
</FileNamePattern>
<!--日誌文件保留天數 -->
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder
class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
<layout class="ch.qos.logback.classic.html.HTMLLayout">
<pattern>%p%d%msg%M%F{32}%L</pattern>
</layout>
</encoder>
<!--日誌文件最大的大小 -->
<triggeringPolicy
class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>
<!-- 每天生成一個html格式的日誌結束 -->
<!--myibatis log configure -->
<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" />
<!-- 日誌輸出級別 -->
<root level="INFO">
<appender-ref ref="STDOUT" />
<appender-ref ref="FILE" />
<appender-ref ref="HTML" />
<appender-ref ref="FILE_HTML" />
</root>
</configuration>
(完)