故事篇：終于給老婆講明白什么是logback了！
故事會遲到，但他從不會缺席。今天的故事開始了，你準備好了嗎？
前奏
簡單介紹一下我的老婆：集智慧與美貌于一身的女子——阿貍，一句“我們心有靈犀，不是嗎？”讓我瞬間“淪陷”。
正題
LogBack簡介
常見的日志框架呢有以下幾種：
JUL（Java Util Logging） Logback Log4j Log4j2 JCL（Jakarta Commons Logging） Slf4j（Simple Logging Facade For Java）
首先它配置比較簡單，比較容易上手； 其次配置比較靈活，能滿足大部分項目的需求； 最后性能比較好，可以異步存儲日志。
我覺得這也是它在市面上比較流行，項目中使用比較多的原因吧。
「門面與實現(xiàn)的關系了解一下」
接著奉上官網(wǎng)地址，它分為以下三個模塊：
logback-core：其它兩個模塊的基礎模塊； logback-classic：它是 log4j的一個改良版本，同時它完整實現(xiàn)了slf4j API，你可以很方便地更換成其它日志框架（如log4j或者JUL）；logback-access：訪問模塊與 Servlet容器集成提供通過Http來訪問日志的功能，可以輕松地在logback核心之上構建自己的模塊。
logback組件之間的關系 「可以大體了解下，實戰(zhàn)篇更容易理解」：
Logger作為日志的記錄器，把它關聯(lián)到應用的對應的context上后，主要用于存放日志對象，也可以定義日志類型、級別；Appender主要用于指定日志輸出的目的地，可以是控制臺、文件、遠程套接字服務器、MySQL、PostreSQL、Oracle和其他數(shù)據(jù)庫、JMS和遠程UNIX Syslog守護進程等；Layout負責把事件轉換成字符串，格式化的日志信息的輸出。在logback中Layout對象被封裝在encoder中；Logger Context：各個logger都被關聯(lián)到一個LoggerContext，它負責制造logger，也負責以樹結構排列各logger。其他所有logger也通過org.slf4j.LoggerFactory類的靜態(tài)方法getLogger取得。
??
Logger可以被分配的級別包括：TRACE、DEBUG、INFO、WARN和ERROR，定義于ch.qos.logback.classic.Level類。如果logger沒有被分配級別，那么它將從有被分配級別的最近的祖先那里繼承級別。root logger默認級別是DEBUG。
級別排序為：TRACE < DEBUG < INFO < WARN < ERROR
項目實戰(zhàn)
<!-- slf4j日志門面 -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.30</version>
</dependency>
<!-- logback日志實現(xiàn) -->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.3</version>
</dependency>
logback會從 classpath 下依次讀取以下類型的配置文件：
logback.groovy logback-test.xml logback.xml
如果文件都不存在，logback用 BasicConfigurator 自動對自己進行配置，這會導致記錄輸出到控制臺。
基本信息配置
代碼測試樣例奉上：
public class TestLogBack {
private static final Logger logger = LoggerFactory.getLogger(TestLogBack.class);
public static void main(String[] args) {
for (int i = 0; i < 10000; i++) {
logger.error("error");
logger.warn("warn");
logger.info("info");
logger.debug("debug");
logger.trace("trace");
}
}
}
首先我們在resources下創(chuàng)建一個logback.xml,然后進行配置
<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
<!--
配置集中管理屬性
我們可以直接改屬性的 value 值
格式：${name}
-->
<property name="pattern" value="[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} %c %M %L [%thread] %m%n"/>
<!--
日志輸出格式：
%-5level 日志輸出級別，占5位，靠左補全
%d{yyyy-MM-dd HH:mm:ss.SSS} 時間
%c 類的完整名稱
%M method
%L 行號
%thread 線程名稱
%m或者%msg 信息
%n 換行
-->
<!-- 控制臺日志輸出的 appender -->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<!-- 控制輸出流對象 默認 System.out 我們?yōu)榱藴y試可以改為 System.err（項目中使用 System.out ） -->
<target>System.err</target>
<!-- 日志消息格式配置 -->
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${pattern}</pattern>
</encoder>
</appender>
<!-- 定義日志文件保存路徑屬性 -->
<property name="log_dir" value="/logs"/>
<!-- 日志文件輸出的 appender -->
<appender name="file" class="ch.qos.logback.core.FileAppender">
<!-- 日志文件保存路徑 -->
<file>${log_dir}/logback.log</file>
<!-- 日志消息格式配置 -->
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${pattern}</pattern>
</encoder>
</appender>
<!-- html 格式文件輸出的 appender -->
<appender name="htmlFile" class="ch.qos.logback.core.FileAppender">
<!-- 日志文件保存路徑 -->
<file>${log_dir}/logback.html</file>
<!-- html消息格式配置 -->
<encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
<layout class="ch.qos.logback.classic.html.HTMLLayout">
<!-- <pattern>${pattern}</pattern>-->
<pattern>%-5level%d{yyyy-MM-dd HH:mm:ss.SSS}%c%M%L%thread%m</pattern>
</layout>
</encoder>
</appender>
<!-- root logger 配置 -->
<root level="ALL">
<appender-ref ref="console"/>
<appender-ref ref="file"/>
<appender-ref ref="htmlFile"/>
</root>
</configuration>
運行之后發(fā)現(xiàn)在控制臺打印出紅色字體的日志信息，在/log文件下有logback.log和logback.html兩個日志文件，在項目中一般都只會使用.log結尾的日志的。
<!-- 日志拆分和歸檔壓縮的 appender -->
<appender name="rollFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 日志文件保存路徑（拆分的話此處可以省略） -->
<file>${log_dir}/roll_logback.log</file>
<!-- 日志消息格式配置-->
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${pattern}</pattern>
</encoder>
<!-- 指定拆分規(guī)則 -->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!-- 每滿1M或者 每秒 產(chǎn)生一個新文件，%i產(chǎn)生0 或者 1 的文件名 ，gz為壓縮，
我們一般設置為每天產(chǎn)生一個文件%d{yyyy-MM-dd} -->
<!-- 按照文件大小拆分 -->
<maxFileSize>1MB</maxFileSize>
<!-- 按照時間和壓縮格式聲明拆分的文件名 -->
<fileNamePattern>${log_dir}/rolling.%d{yyyy-MM-dd-HH-mm-ss}.log%i.gz</fileNamePattern>
</rollingPolicy>
</appender>
此時我們對測試程序加上for循環(huán)，循環(huán)1w次，發(fā)現(xiàn)每秒或者每超過1M都會產(chǎn)生新的文件。當然也可以在appender下增加過濾器，過濾需要的日志級別。
<!-- 日志級別過濾器 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<!-- 日志過濾規(guī)則 -->
<level>ERROR</level>
<!-- 匹配時的操作：接收（記錄） -->
<onMatch>ACCEPT</onMatch>
<!-- 不匹配時的操作：拒絕（不記錄） -->
<onMismatch>DENY</onMismatch>
</filter>
先打開 RollingFileAppender,可以看到他底下有個RollingPolicy策略
點進去發(fā)現(xiàn)它是一個接口，然后看一下它的實現(xiàn)類，我們找到 SizeAndTimeBasedRollingPolicy策略看一下
3.發(fā)現(xiàn)這個類里邊就有文件大小的屬性maxFileSize，卻沒有找到按照時間分文件的屬性，我們進入它的父類TimeBasedRollingPolicy查看
4.發(fā)現(xiàn)里邊就有該屬性，翻譯一下：必須在使用TimeBasedRollingPolicy之前設置FileNamePattern選項
<!-- 異步日志 -->
<appender name="async" class="ch.qos.logback.classic.AsyncAppender">
<!-- 指定具體的appender -->
<appender-ref ref="rollFile"/>
</appender>
除了上邊用到的root，還支持自定義的logger呢。
<!-- 自定義logger對象
additivity="false" 自定義的logger 對象是否繼承root logger
name 用來指定受此loger約束的某一個包或者具體的某一個類
-->
<logger name="com.aq.logback" level="info" additivity="false">
<appender-ref ref="console"/>
</logger>
SpringBoot中使用
?默認日志是
?info級別
我們還可以直接使用@Slf4j的注解來代替上邊的
private static final Logger logger = LoggerFactory.getLogger(TestLogBack.class);
引用是使用log.info("info");來實現(xiàn)。它的默認加載順序是logback-spring.xml->logback.xml
我們可以在application.properties中簡單配置
#指定自定義 logger 對象的日志級別
logging.level.com.itzyq.sblogback=trace
#指定控制臺輸出消息格式
logging.pattern.console=[%-5level] %d{yyyy-MM-dd HH:mm:ss} %c [%thread] ===== %m %n
#指定存放日志文件的具體路徑(已經(jīng)棄用)
#logging.file=/logs/springboot.log
#指定日志文件存放的目錄，默認的文件名為spring.log
logging.file.path=/logs/springboot/
#指定日志文件的消息格式
logging.pattern.file=[%-5level] %d{yyyy-MM-dd HH:mm:ss} %c [%thread] ===== %m %n
因為在properties中配置功能有限，我們還是使用上文中的logback.xml來配置。
??
logback-spring.xml只有在Spring應用程序運行的時候才生效，即帶有@SpringBootApplication注解的類啟動的時候才會生效。這里我們完全可以使用它。
另外它還有個特殊的功能，可以用來解析日志的配置。
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<property name="pattern" value="[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} %c %M %L [%thread] %m%n"/>
<!-- 定義日志文件保存路徑屬性 -->
<property name="log_dir" value="/logs"/>
<!-- 日志文件輸出的 appender -->
<appender name="file" class="ch.qos.logback.core.FileAppender">
<!-- 日志文件保存路徑 -->
<file>${log_dir}/logback.log</file>
<!-- 日志消息格式配置-->
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<springProfile name="dev">
<pattern>${pattern}</pattern>
</springProfile>
<springProfile name="pro">
<pattern> %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %m%n</pattern>
</springProfile>
</encoder>
</appender>
<root level="info">
<appender-ref ref="file"/>
</root>
</configuration>
此時在application.properties中引入spring.profiles.active=dev或者pro可以切換測試和正式環(huán)境了，是不是很方便呀。
Logback-access
logback-access模塊與Servlet容器（如Tomcat和jetty）集成，已提供HTTP訪問日志功能。我們可以使用logback-access模塊來替換tomcat的訪問日志;
將
logback-access.jar與logback-core.jar復制到$TOMCAT_HOME/lib/（安裝Tomcat的文件夾）目錄下；修改
$TOMCAT_HOME/conf/server.xml中的Host元素中添加：
<Value className="ch.qos.logback.access.tomcat.LogbackValue" />
這一行通常嵌套在一個<Engine> 或 <Host>元素中。
logback默認會在$TOMCAT_HOME/conf下查找文件logback-access.xml，該配置的官方地址：http://logback.qos.ch/access.html#configuration
<configuration>
<!-- always a good activate OnConsoleStatusListener -->
<statusListener class="ch.qos.logback.core.status.OnConsoleStatusListener" />
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>access.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>access.%d{yyyy-MM-dd}.log.zip</fileNamePattern>
</rollingPolicy>
<encoder>
<!-- 日志消息表達格式 -->
<pattern>%h %l %u [%t] "%r" %s %b "%i{Referer}" “%i{User-Agent}”</pattern>
<pattern>combined</pattern>
</encoder>
</appender>
<appender-ref ref="FILE" />
</configuration>
配置信息補充
（1）根節(jié)點configuration，包含下面三個屬性：
scan: 當此屬性設置為 true時，配置文件如果發(fā)生改變，將會被重新加載，默認值為true。scanPeriod: 設置監(jiān)測配置文件是否有修改的時間間隔，如果沒有給出時間單位，默認單位是毫秒。當 scan為true時，此屬性生效。默認的時間間隔為1分鐘。debug: 當此屬性設置為 true時，將打印出logback內(nèi)部日志信息，實時查看logback運行狀態(tài)。默認值為false。
<configuration scan="true" scanPeriod="60 seconds" debug="false">
</configuration>
（2）contextName：用來設置上下文名稱，每個logger都關聯(lián)到logger上下文，默認上下文名稱為default。但可以使用contextName設置成其他名字，用于區(qū)分不同應用程序的記錄。一旦設置，不能修改。
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<contextName>myAppName</contextName>
</configuration>
(3) property ：用來定義變量值，它有兩個屬性name和value，通過property定義的值會被插入到logger上下文中，可以使“${}”來使用變量。
name: 變量的名稱value: 的值是變量定義的值
(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"/>
</configuration>
（5）appender：負責寫日志的組件，它有兩個必要屬性name和class。name指定appender名稱，class指定appender的全限定名
5.1、ConsoleAppender 把日志輸出到控制臺，有以下子節(jié)點：
encoder：對日志進行格式化。target：字符串System.out(默認)或者System.err
5.2、FileAppender：把日志添加到文件，有以下子節(jié)點：
file：被寫入的文件名，可以是相對目錄，也可以是絕對目錄，如果上級目錄不存在會自動創(chuàng)建，沒有默認值。append：如果是true，日志被追加到文件結尾，如果是false，清空現(xiàn)存文件，默認是true。encoder：對記錄事件進行格式化。prudent：如果是true，日志會被安全的寫入文件，即使其他的FileAppender也在向此文件做寫入操作，效率低，默認是false。
5.3、RollingFileAppender：滾動記錄文件，先將日志記錄到指定文件，當符合某個條件時，將日志記錄到其他文件。有以下子節(jié)點：
file：被寫入的文件名，可以是相對目錄，也可以是絕對目錄，如果上級目錄不存在會自動創(chuàng)建，沒有默認值。append：如果是true，日志被追加到文件結尾，如果是false，清空現(xiàn)存文件，默認是true。rollingPolicy:當發(fā)生滾動時，決定RollingFileAppender的行為，涉及文件移動和重命名。屬性class定義具體的滾動策略類。
5.4、策略：「class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"：」 最常用的滾動策略，它根據(jù)時間來制定滾動策略，既負責滾動也負責觸發(fā)滾動。有以下子節(jié)點：
fileNamePattern：必要節(jié)點，包含文件名及“%d”轉換符，“%d”可以包含一個java.text.SimpleDateFormat指定的時間格式，如：%d{yyyy-MM}。如果直接使用%d，默認格式是yyyy-MM-dd。RollingFileAppender的file子節(jié)點可有可無，通過設置file，可以為活動文件和歸檔文件指定不同位置，當前日志總是記錄到file指定的文件（活動文件），活動文件的名字不會改變；如果沒設置file，活動文件的名字會根據(jù)fileNamePattern的值，每隔一段時間改變一次?！?”或者“\”會被當做目錄分隔符。maxHistory:可選節(jié)點，控制保留的歸檔文件的最大數(shù)量，超出數(shù)量就刪除舊文件。假設設置每個月滾動，且是6，則只保存最近6個月的文件，刪除之前的舊文件。注意，刪除舊文件時，那些為了歸檔而創(chuàng)建的目錄也會被刪除。
「class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"：」 查看當前活動文件的大小，如果超過指定大小會告知RollingFileAppender 觸發(fā)當前活動文件滾動。只有一個節(jié)點:
maxFileSize:這是活動文件的大小，默認值是10MB。prudent：當為true時，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有兩個限制，1不支持也不允許文件壓縮，2不能設置file屬性，必須留空。triggeringPolicy: 告知RollingFileAppender合適激活滾動。
「class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"」 根據(jù)固定窗口算法重命名文件的滾動策略。有以下子節(jié)點：
minIndex:窗口索引最小值maxIndex:窗口索引最大值，當用戶指定的窗口過大時，會自動將窗口設置為12。fileNamePattern:必須包含“%i”例如，假設最小值和最大值分別為1和2，命名模式為mylog%i.log,會產(chǎn)生歸檔文件mylog1.log和mylog2.log。還可以指定文件壓縮選項，例如，mylog%i.log.gz或者 沒有log%i.log.zip
<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天的日志文件。
<configuration>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>test.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
<fileNamePattern>tests.%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個歸檔文件后，將覆蓋最早的日志。
encoder：對記錄事件進行格式化。負責兩件事，一是把日志信息轉換成字節(jié)數(shù)組，二是把字節(jié)數(shù)組寫入到輸出流。
PatternLayoutEncoder 是唯一有用的且默認的encoder ，有一個pattern節(jié)點，用來設置日志的輸入格式。使用“%”加“轉換符”方式，如果要輸出“%”，則必須用“\”對“\%”進行轉義。
（6）子節(jié)點logger：用來設置某一個包或具體的某一個類的日志打印級別、以及指定appender。僅有一個name屬性，一個可選的level和一個可選的additivity（「單詞一定要注意寫對，好多地方都寫成了addtivity」）屬性。可以包含零個或多個appender將會添加到這個logger
name：用來指定受此 logger約束的某一個包或者具體的某一個類；level：用來設置打印級別（日志級別），大小寫無關： TRACE,DEBUG,INFO,WARN,ERROR,ALL和OFF，還有一個特殊值INHERITED或者同義詞NULL，代表強制執(zhí)行上級的級別。如果未設置此屬性，那么當前logger將會繼承上級的級別。additivity:是否向上級 loger傳遞打印信息。默認是true。
（7）子節(jié)點root：它也是logger元素，但是它是根 logger ,是所有logger的上級。只有一個level屬性，因為name已經(jīng)被命名為"root"，且已經(jīng)是最上級了。同logger一樣，可以包含零個或多個appender-ref元素，標識這個appender將會添加到這個logger。
level: 用來設置打印級別，大小寫無關：TRACE,DEBUG,INFO,WARN,ERROR,ALL和OFF，不能設置為INHERITED或者同義詞NULL。默認是DEBUG
常用logger配置
<!-- show parameters for hibernate sql 專為 Hibernate 定制 -->
<logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" />
<logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="DEBUG" />
<logger name="org.hibernate.SQL" level="DEBUG" />
<logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />
<logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" />
<!--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"/>
以上就是今天的所有內(nèi)容了
—————END————— 推薦閱讀： 再見！收費的 XShell，我改用這款國產(chǎn)良心工具！
一個低級錯誤，生產(chǎn)數(shù)據(jù)庫崩潰了將近半個小時.....
最近面試BAT，整理一份面試資料《Java面試BAT通關手冊》，覆蓋了Java核心技術、JVM、Java并發(fā)、SSM、微服務、數(shù)據(jù)庫、數(shù)據(jù)結構等等。 獲取方式：關注公眾號并回復 java 領取，更多內(nèi)容陸續(xù)奉上。 明天見(??ω??)??