開(kāi)發(fā) | Spring Boot是如何實(shí)現(xiàn)日志的?
休息日閑著無(wú)聊看了下 Spring Boot 中的日志實(shí)現(xiàn),把我的理解跟大家說(shuō)下。
門面模式
說(shuō)到日志框架不得不說(shuō)門面模式。門面模式,其核心為外部與一個(gè)子系統(tǒng)的通信必須通過(guò)一個(gè)統(tǒng)一的外觀對(duì)象進(jìn)行,使得子系統(tǒng)更易于使用。
用一張圖來(lái)表示門面模式的結(jié)構(gòu)為:
門面模式
簡(jiǎn)單來(lái)說(shuō),該模式就是把一些復(fù)雜的流程封裝成一個(gè)接口供給外部用戶更簡(jiǎn)單的使用。
這個(gè)模式中,涉及到三個(gè)角色:
- 門面角色:外觀模式的核心。它被客戶角色調(diào)用,熟悉子系統(tǒng)的功能。內(nèi)部根據(jù)客戶角色的需求預(yù)定了幾種功能的組合(模塊)。
- 子系統(tǒng)(模塊)角色:實(shí)現(xiàn)了子系統(tǒng)的功能。它對(duì)客戶角色和 Facade 是未知的。它內(nèi)部可以有系統(tǒng)內(nèi)的相互交互,也可以有供外界調(diào)用的接口。
- 客戶角色:通過(guò)調(diào)用 Facede 來(lái)完成要實(shí)現(xiàn)的功能。
市面上的日志框架
簡(jiǎn)單說(shuō)下,上表的日志門面對(duì)應(yīng)了門面模式中的 Facede 對(duì)象,它們只是一個(gè)接口層,并不提供日志實(shí)現(xiàn)。
而日志實(shí)現(xiàn)則對(duì)應(yīng)著各個(gè)子系統(tǒng)或者模塊,日志記錄的具體邏輯實(shí)現(xiàn),就寫在這些右邊的框架里面;那我們的應(yīng)用程序就相當(dāng)于客戶端。
為什么要使用門面模式?
試想下我們開(kāi)發(fā)系統(tǒng)的場(chǎng)景,需要用到很多包,而這些包又有自己的日志框架,于是就會(huì)出現(xiàn)這樣的情況:我們自己的系統(tǒng)中使用了 Logback 這個(gè)日志系統(tǒng),我們的系統(tǒng)使用了 Hibernate。
Hibernate 中使用的日志系統(tǒng)為 jboss-logging,我們的系統(tǒng)又使用了 Spring,Spring 中使用的日志系統(tǒng)為 commons-logging。
這樣,我們的系統(tǒng)就不得不同時(shí)支持并維護(hù) Logback、jboss-logging、commons-logging 三種日志框架,非常不便。
解決這個(gè)問(wèn)題的方式就是引入一個(gè)接口層,由接口層決定使用哪一種日志系統(tǒng),而調(diào)用端只需要做的事情就是打印日志而不需要關(guān)心如何打印日志,而上表的日志門面就是這種接口層。
鑒于此,我們選擇日志時(shí),就必須從上表左邊的日志門面和右邊的日志實(shí)現(xiàn)各選擇一個(gè)框架。
而 Spring Boot 底層默認(rèn)選用的就是 SLF4j 和 Logback 來(lái)實(shí)現(xiàn)日志輸出。
SLF4j 使用
官方文檔給出這樣一個(gè)例子:
- import org.slf4j.Logger;
- import org.slf4j.LoggerFactory;
- public class HelloWorld {
- public static void main(String[] args) {
- // HelloWorld.class 就是你要打印的指定類的日志,
- // 如果你想在其它類中打印,那就把 HelloWorld.class 替換成目標(biāo)類名.class 即可。
- Logger logger = LoggerFactory.getLogger(HelloWorld.class);
- logger.info("Hello World");
- }
- }
為了理解 SLF4j 的工作原理,我翻了下它的官方文檔,看到這么一張圖:
SLF4J
簡(jiǎn)單解釋一下,上圖 SLF4J 有六種用法,一共五種角色,Application 不用說(shuō),就是我們的系統(tǒng)。
SLF4J API 就是日志接口層(門面);藍(lán)色和最下面灰色的就是具體日志實(shí)現(xiàn)(子系統(tǒng));而 Adaptation 就是適配層。
解釋下,上圖第二,第三種用法。其中第二種就是 Spring Boot 的默認(rèn)用法;而為什么會(huì)出現(xiàn)第三種?
因?yàn)?Log4J 出現(xiàn)得比較早,它根本不知道后面會(huì)有 SLF4J 這東西。Log4J 不能直接作為 SLF4J 的日志實(shí)現(xiàn),所以中間就出現(xiàn)了適配層。第四種同理。
這里提醒下,每一個(gè)日志的實(shí)現(xiàn)框架都有自己的配置文件。使用 SLF4J 以后,**配置文件還是做成日志實(shí)現(xiàn)框架自己本身的配置文件。比如,Logback 就使用 logback.xml、Log4J 就使用 Log4j.xml 文件。
如何讓系統(tǒng)中所有的日志都統(tǒng)一到 SLF4J?
我繼續(xù)瀏覽了下官網(wǎng),看見(jiàn)這么一張圖:
Legacy
由上圖可以看出,讓系統(tǒng)中所有的日志都統(tǒng)一到 SLF4J 的做法是:
- 將系統(tǒng)中其他日志框架先排除出去。
- 用中間包來(lái)替換原有的日志框架。
- 我們導(dǎo)入 SLF4J 其他的實(shí)現(xiàn)。
Spring Boot 中的日志關(guān)系
Spring Boot 使用以下依賴實(shí)現(xiàn)日志功能:
- <dependency>
- <groupId>org.springframework.boot</groupId>
- <artifactId>spring-boot-starter-logging</artifactId>
- <version>2.1.3.RELEASE</version>
- <scope>compile</scope>
- </dependency>
spring-boot-starter-logging 有這么一張關(guān)系圖:
日志底層依賴
由上圖可見(jiàn):
- Spring Boot2.x 底層也是使用 slf4j+logback 或 Log4J 的方式進(jìn)行日志記錄。
- Spring Boot 引入中間替換包把其他的日志都替換成了 SLF4J。
- 如果我們要引入其他框架、可以把這個(gè)框架的默認(rèn)日志依賴移除掉。
比如 Spring 使用的是 commons-logging 框架,我們可以這樣移除:
- <dependency>
- <groupId>org.springframework</groupId>
- <artifactId>spring-core</artifactId>
- <exclusions>
- <exclusion>
- <groupId>commons-logging</groupId>
- <artifactId>commons-logging</artifactId>
- </exclusion>
- </exclusions>
- </dependency>
Spring Boot 能自動(dòng)適配所有的日志,而且底層使用 slf4j+logback 的方式記錄日志,引入其他框架的時(shí)候,只需要把這個(gè)框架依賴的日志框架排除掉即可。
日志使用
①默認(rèn)配置(以 Log4J 框架為例),Spring Boot 默認(rèn)幫我們配置好了日志:
- //記錄器
- Logger logger = LoggerFactory.getLogger(getClass());
- @Test
- public void contextLoads() {
- //日志的級(jí)別;
- //由低到高 trace<debug<info<warn<error
- //可以調(diào)整輸出的日志級(jí)別;日志就只會(huì)在這個(gè)級(jí)別以以后的高級(jí)別生效
- logger.trace("這是trace日志...");
- logger.debug("這是debug日志...");
- // SpringBoot 默認(rèn)給我們使用的是 info 級(jí)別的,沒(méi)有指定級(jí)別的就用SpringBoot 默認(rèn)規(guī)定的級(jí)別;root 級(jí)別
- logger.info("這是info日志...");
- logger.warn("這是warn日志...");
- logger.error("這是error日志...");
- }
②log4j.properties 修改日志默認(rèn)配置:
- logging.level.com.nasus=debug
- #logging.path=
- # 不指定路徑在當(dāng)前項(xiàng)目下生成 springboot.log 日志
- # 可以指定完整的路徑;
- #logging.file=Z:/springboot.log
- # 在當(dāng)前磁盤的根路徑下創(chuàng)建 spring 文件夾和里面的 log 文件夾;使用 spring.log 作為默認(rèn)文件
- logging.path=/spring/log
- # 在控制臺(tái)輸出的日志的格式
- logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
- # 指定文件中日志輸出的格式
- logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n
配置解釋
③指定配置。Spring Boot 會(huì)自動(dòng)加載類路徑下對(duì)應(yīng)框架的配置文件,所以我們只需給類路徑下放上每個(gè)日志框架自己的配置文件即可,Spring Boot 就不會(huì)使用默認(rèn)配置了。
logback.xml:直接就被日志框架識(shí)別了。
logback-spring.xml:日志框架就不直接加載日志的配置項(xiàng),由 Spring Boot 解析日志配置,可以使用 Spring Boot 的高級(jí) Profile 功能。
- <springProfile name="staging">
- <!-- configuration to be enabled when the "staging" profile is active -->
- 可以指定某段配置只在某個(gè)環(huán)境下生效
- </springProfile>
例子 (以 Logback 框架為例):
- <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
- <!--
- 日志輸出格式:
- %d表示日期時(shí)間,
- %thread表示線程名,
- %-5level:級(jí)別從左顯示5個(gè)字符寬度
- %logger{50} 表示logger名字最長(zhǎng)50個(gè)字符,否則按照句點(diǎn)分割。
- %msg:日志消息,
- %n是換行符
- -->
- <layout class="ch.qos.logback.classic.PatternLayout">
- <!--指定在 dev 環(huán)境下,控制臺(tái)使用該格式輸出日志-->
- <springProfile name="dev">
- <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
- </springProfile>
- <!--指定在非 dev 環(huán)境下,控制臺(tái)使用該格式輸出日志-->
- <springProfile name="!dev">
- <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
- </springProfile>
- </layout>
- </appender>
如果使用 logback.xml 作為日志配置文件,而不是 logback-spring.xml,還要使用 Profile 功能,會(huì)有以下錯(cuò)誤:
- no applicable action for [springProfile]
切換日志框架
了解了 Spring Boot 的底層日志依賴關(guān)系,我們就可以按照 SLF4J 的日志適配圖,進(jìn)行相關(guān)的切換。
例如,切換成 SLF4J+Log4J ,可以這樣做:
- <dependency>
- <groupId>org.springframework.boot</groupId>
- <artifactId>spring-boot-starter-web</artifactId>
- <exclusions>
- <exclusion>
- <artifactId>logback-classic</artifactId>
- <groupId>ch.qos.logback</groupId>
- </exclusion>
- </exclusions>
- </dependency>
- <dependency>
- <groupId>org.slf4j</groupId>
- <artifactId>slf4j-log4j12</artifactId>
- </dependency>
切換成 log4j2 ,就可以這樣做:
- <dependency>
- <groupId>org.springframework.boot</groupId>
- <artifactId>spring-boot-starter-web</artifactId>
- <exclusions>
- <exclusion>
- <artifactId>spring-boot-starter-logging</artifactId>
- <groupId>org.springframework.boot</groupId>
- </exclusion>
- </exclusions>
- </dependency>
- <dependency>
- <groupId>org.springframework.boot</groupId>
- <artifactId>spring-boot-starter-log4j2</artifactId>
- </dependency>
***放上 logback-spring.xml 的詳細(xì)配置,大家在自己項(xiàng)目可以參考配置:
- <?xml version="1.0" encoding="UTF-8"?>
- <!--
- scan:當(dāng)此屬性設(shè)置為true時(shí),配置文件如果發(fā)生改變,將會(huì)被重新加載,默認(rèn)值為true。
- scanPeriod:設(shè)置監(jiān)測(cè)配置文件是否有修改的時(shí)間間隔,如果沒(méi)有給出時(shí)間單位,默認(rèn)單位是毫秒當(dāng)scan為true時(shí),此屬性生效。默認(rèn)的時(shí)間間隔為1分鐘。
- debug:當(dāng)此屬性設(shè)置為true時(shí),將打印出logback內(nèi)部日志信息,實(shí)時(shí)查看logback運(yùn)行狀態(tài)。默認(rèn)值為false。
- -->
- <configuration scan="false" scanPeriod="60 seconds" debug="false">
- <!-- 定義日志的根目錄 -->
- <property name="LOG_HOME" value="/app/log" />
- <!-- 定義日志文件名稱 -->
- <property name="appName" value="nasus-springboot"></property>
- <!-- ch.qos.logback.core.ConsoleAppender 表示控制臺(tái)輸出 -->
- <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
- <!--
- 日志輸出格式:
- %d表示日期時(shí)間,
- %thread表示線程名,
- %-5level:級(jí)別從左顯示5個(gè)字符寬度
- %logger{50} 表示logger名字最長(zhǎng)50個(gè)字符,否則按照句點(diǎn)分割。
- %msg:日志消息,
- %n是換行符
- -->
- <layout class="ch.qos.logback.classic.PatternLayout">
- <springProfile name="dev">
- <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
- </springProfile>
- <springProfile name="!dev">
- <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
- </springProfile>
- </layout>
- </appender>
- <!-- 滾動(dòng)記錄文件,先將日志記錄到指定文件,當(dāng)符合某個(gè)條件時(shí),將日志記錄到其他文件 -->
- <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
- <!-- 指定日志文件的名稱 -->
- <file>${LOG_HOME}/${appName}.log</file>
- <!--
- 當(dāng)發(fā)生滾動(dòng)時(shí),決定 RollingFileAppender 的行為,涉及文件移動(dòng)和重命名
- TimeBasedRollingPolicy: 最常用的滾動(dòng)策略,它根據(jù)時(shí)間來(lái)制定滾動(dòng)策略,既負(fù)責(zé)滾動(dòng)也負(fù)責(zé)出發(fā)滾動(dòng)。
- -->
- <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
- <!--
- 滾動(dòng)時(shí)產(chǎn)生的文件的存放位置及文件名稱 %d{yyyy-MM-dd}:按天進(jìn)行日志滾動(dòng)
- %i:當(dāng)文件大小超過(guò)maxFileSize時(shí),按照i進(jìn)行文件滾動(dòng)
- -->
- <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
- <!--
- 可選節(jié)點(diǎn),控制保留的歸檔文件的***數(shù)量,超出數(shù)量就刪除舊文件。假設(shè)設(shè)置每天滾動(dòng),
- 且maxHistory是365,則只保存最近365天的文件,刪除之前的舊文件。注意,刪除舊文件是,
- 那些為了歸檔而創(chuàng)建的目錄也會(huì)被刪除。
- -->
- <MaxHistory>365</MaxHistory>
- <!--
- 當(dāng)日志文件超過(guò)maxFileSize指定的大小是,根據(jù)上面提到的%i進(jìn)行日志文件滾動(dòng) 注意此處配置SizeBasedTriggeringPolicy是無(wú)法實(shí)現(xiàn)按文件大小進(jìn)行滾動(dòng)的,必須配置timeBasedFileNamingAndTriggeringPolicy
- -->
- <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
- <maxFileSize>100MB</maxFileSize>
- </timeBasedFileNamingAndTriggeringPolicy>
- </rollingPolicy>
- <!-- 日志輸出格式: -->
- <layout class="ch.qos.logback.classic.PatternLayout">
- <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
- </layout>
- </appender>
- <!--
- logger主要用于存放日志對(duì)象,也可以定義日志類型、級(jí)別
- name:表示匹配的logger類型前綴,也就是包的前半部分
- level:要記錄的日志級(jí)別,包括 TRACE < DEBUG < INFO < WARN < ERROR
- additivity:作用在于children-logger是否使用 rootLogger配置的appender進(jìn)行輸出,
- false:表示只用當(dāng)前l(fā)ogger的appender-ref,true:
- 表示當(dāng)前l(fā)ogger的appender-ref和rootLogger的appender-ref都有效
- -->
- <!-- hibernate logger -->
- <logger name="com.nasus" level="debug" />
- <!-- Spring framework logger -->
- <logger name="org.springframework" level="debug" additivity="false"></logger>
- <!--
- root 與 logger 是父子關(guān)系,沒(méi)有特別定義則默認(rèn)為root,任何一個(gè)類只會(huì)和一個(gè)logger對(duì)應(yīng),
- 要么是定義的logger,要么是root,判斷的關(guān)鍵在于找到這個(gè)logger,然后判斷這個(gè)logger的appender和level。
- -->
- <root level="info">
- <appender-ref ref="stdout" />
- <appender-ref ref="appLogAppender" />
- </root>
- </configuration>
參考文獻(xiàn):
http://www.importnew.com/28494.html
https://www.cnblogs.com/lthIU/p/5860607.html