詳解Spring Boot實(shí)現(xiàn)日志記錄 SLF4J
在開發(fā)中打印內(nèi)容，使用 System.out.println() 和 Log4j 應(yīng)當(dāng)是人人皆知的方法了。
其實(shí)在開發(fā)中我們不建議使用 System.out 因?yàn)榇罅康氖褂?System.out 會(huì)增加資源的消耗。
而Log4j 更為靈活在性能上也相比 System.out 要高，我們可以配置輸出級(jí)別，可以指定多個(gè)日志文件分別記錄不同的日志。
使用 System.out 是在當(dāng)前線程執(zhí)行的，寫入文件也是寫入完畢后才繼續(xù)執(zhí)行下面的程序。而使用Log工具不但可以控制日志是否輸出，怎么輸出，它的處理機(jī)制也是通知寫日志，繼續(xù)執(zhí)行后面的代碼不必等日志寫完。
如非必要，建議大家不要使用控制臺(tái)輸出，因?yàn)榭刂婆_(tái)輸出沒有優(yōu)先級(jí)會(huì)顯得輸出太亂。
個(gè)人推薦使用 SLF4J（Simple Logging Facade For Java）的logback來輸出日志，其比log4j 要好，因?yàn)樗矢摺?/p>
spring Boot 提供了一套日志系統(tǒng)，logback是最優(yōu)先的選擇。配置了logback.xml可以利用Spring Boot提供的默認(rèn)日志配置：
<?xml version="1.0" encoding="UTF-8"?> <configuration> <include resource="org/springframework/boot/logging/logback/base.xml"/> <logger name="org.springframework.web" level="DEBUG"/> </configuration>
這樣就定義了一個(gè) 捕獲 org.springframework.web 的日志，日志級(jí)別是 DEBUG，上面引用的base.xml 文件內(nèi)容為：
<?xml version="1.0" encoding="UTF-8"?>
<!--
Base logback configuration provided for compatibility with Spring Boot 1.1
-->
<included>
<include resource="org/springframework/boot/logging/logback/defaults.xml" />
<property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}/}spring.log}"/>
<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
<include resource="org/springframework/boot/logging/logback/file-appender.xml" />
<root level="INFO">
<appender-ref ref="CONSOLE" />
<appender-ref ref="FILE" />
</root>
</included>
Spring Boot的日志系統(tǒng)預(yù)先定義了一些系統(tǒng)變量：
PID，當(dāng)前進(jìn)程ID{LOG_FILE}，Spring Boot配置文件（application.properties|.yml）中l(wèi)ogging.file的值
${LOG_PATH}, Spring Boot配置文件中l(wèi)ogging.path的值
同時(shí)默認(rèn)情況下包含另個(gè)appender——一個(gè)是控制臺(tái)，一個(gè)是文件，分別定義在console-appender.xml和file-appender.xml中。同時(shí)對(duì)于應(yīng)用的日志級(jí)別也可以通過application.properties進(jìn)行定義：
logging.level.org.springframework.web=DEBUG logging.level.org.springboot.sample=TRACE
這樣相當(dāng)于我們在logback.xml 中配置的對(duì)應(yīng)的日志級(jí)別。名稱以logging.level開頭，后面跟要輸入日志的包名。
如果在 logback.xml 和 application.properties 中定義了相同的配置（如都配置了 org.springframework.web）但是輸出級(jí)別不同，則實(shí)際上 application.properties 的優(yōu)先級(jí)高于 logback.xml *
我們既然使用了maven來管理項(xiàng)目，我們就可以根據(jù)不同環(huán)境來定義不同的日志輸出，在 logback-spring.xml 中使用 springProfile 節(jié)點(diǎn)來定義，方法如下：
注意文件名稱不是logback.xml，想使用spring擴(kuò)展profile支持，要以logback-spring.xml命名
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<include resource="org/springframework/boot/logging/logback/base.xml" />
<logger name="org.springframework.web" level="INFO"/>
<logger name="org.springboot.sample" level="TRACE" />
<springProfile name="dev">
<logger name="org.springboot.sample" level="DEBUG" />
</springProfile>
<springProfile name="staging">
<logger name="org.springboot.sample" level="INFO" />
</springProfile>
</configuration>
如上我們默認(rèn)為 org.springboot.sample 定義了TRACE級(jí)別的輸出，下面又定義兩個(gè) springProfile ，分別是 dev 和 staging，輸出級(jí)別分別是 DEBUG 和 INFO
我們可以啟動(dòng)服務(wù)的時(shí)候指定 profile （如不指定使用默認(rèn)），如指定staging 的方式為：
java -jar myapp.jar --spring.profiles.active=staging
下面介紹兩種常用的Appender
ConsoleAppender
Logback使用appender來定義日志輸出，在開發(fā)過程中最常用的是將日志輸出到控制臺(tái)：
<appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<Pattern>.%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg %n</Pattern>
</encoder>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>TRACE</level>
</filter>
</appender>
表示對(duì)日志進(jìn)行編碼
- %d{HH:mm:ss.SSS}——日志輸出時(shí)間
- %thread——輸出日志的進(jìn)程名字，這在Web應(yīng)用以及異步任務(wù)處理中很有用
- %-5level——日志級(jí)別，并且使用5個(gè)字符靠左對(duì)齊
- %logger{36}——日志輸出者的名字
- %msg——日志消息
- %n——平臺(tái)的換行符
在這種格式下一條日志的輸出結(jié)果如下：
10:12:51.012 [threadName] DEBUG o.c.d.r.util.LoggingResponseFilter
RollingFileAppender
另一種常見的日志輸出到文件，隨著應(yīng)用的運(yùn)行時(shí)間越來越長，日志也會(huì)增長的越來越多，將他們輸出到同一個(gè)文件并非一個(gè)好辦法。RollingFileAppender用于切分文件日志：
<appender name="dailyRollingFileAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
<File>/data/log/app.log</File>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- daily rollover -->
<FileNamePattern>rest-demo.%d{yyyy-MM-dd}.log</FileNamePattern>
<!-- keep 30 days' worth of history -->
<maxHistory>30</maxHistory>
</rollingPolicy>
<encoder>
<Pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{35} - %msg %n</Pattern>
</encoder>
</appender>
其中重要的是rollingPolicy的定義，上例中rest-demo.%d{yyyy-MM-dd}.log定義了日志的切分方式——把每一天的日志歸檔到一個(gè)文件中，30表示只保留最近30天的日志，以防止日志填滿整個(gè)磁盤空間。同理，可以使用%d{yyyy-MM-dd_HH-mm}來定義精確到分的日志切分方式。
Sentry
Sentry是一個(gè)統(tǒng)一的日志跟蹤平臺(tái)，在傳統(tǒng)的日志管理中，都是在服務(wù)器上通過tail, vim等工具查看日志，并且不同的日志位置也個(gè)不相同，而Sentry則是將這些日志（主要是錯(cuò)誤日志）通過統(tǒng)一的接口收集起來，并且提供跟蹤、管理的功能，使得應(yīng)用程序的錯(cuò)誤、Bug能夠即時(shí)被解決。
Sentry提供了Java庫——Raven Java，Java應(yīng)用程序能夠在捕獲異常后將其發(fā)送到Sentry服務(wù)器中，另一方面它包含了各類日志框架的支持，以Logbakc為例：
<dependency> <groupId>net.kencochrane.raven</groupId> <artifactId>raven-logback</artifactId> <version>6.0.0</version> </dependency>
在logback.xml中定義appender：
<configuration>
<appender name="Sentry" class="net.kencochrane.raven.logback.SentryAppender">
<dsn>https://publicKey:secretKey@host:port/1?options</dsn>
<tags>tag1:value1,tag2:value2</tags>
<!-- Optional, allows to select the ravenFactory -->
<!--<ravenFactory>net.kencochrane.raven.DefaultRavenFactory</ravenFactory>-->
</appender>
<root level="warn">
<appender-ref ref="Sentry"/>
</root>
</configuration>
我們推薦在這個(gè)中加入用于過濾 ERROR 級(jí)別的日志。
總結(jié)
在Spring Boot 中記錄日志只需兩步：
1、在 src/main/resources 下面創(chuàng)建logback.xml 文件，并按上面講述的進(jìn)行配置。
或者使用最簡單的方法在 application 配置文件中配置。
2、在Java代碼中創(chuàng)建實(shí)例，并在需要輸出日志的地方使用。
// 在Java類中創(chuàng)建 logger 實(shí)例
private static final Logger logger = LoggerFactory.getLogger(SpringBootSampleApplication.class);
// 在方法中使用日志輸出，如
public void logTest() {
logger.debug("日志輸出測試 Debug");
logger.trace("日志輸出測試 Trace");
logger.info("日志輸出測試 Info");
}
以上就是本文的全部內(nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
mybatis的foreach標(biāo)簽語法報(bào)錯(cuò)的解決
這篇文章主要介紹了mybatis的foreach標(biāo)簽語法報(bào)錯(cuò)的解決方案，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-02-02
這篇文章主要為大家詳細(xì)介紹了Java實(shí)現(xiàn)單線程聊天室，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-09-09
解決IDEA?2022?Translation?翻譯文檔失敗:?未知錯(cuò)誤的問題
這篇文章主要介紹了IDEA?2022?Translation?翻譯文檔失敗:?未知錯(cuò)誤,本文較詳細(xì)的給大家介紹了IDEA?2022?Translation未知錯(cuò)誤翻譯文檔失敗的解決方法，需要的朋友可以參考下2022-04-04
Java Socket實(shí)現(xiàn)聊天室附1500行源代碼
Socket是應(yīng)用層與TCP/IP協(xié)議族通信的中間軟件抽象層，它是一組接口。本篇文章手把手帶你通過Java Socket來實(shí)現(xiàn)自己的聊天室,大家可以在過程中查缺補(bǔ)漏，溫故而知新2021-10-10
java開發(fā)BeanUtils類解決實(shí)體對(duì)象間賦值
這篇文章主要為大家介紹了java開發(fā)中使用BeanUtils類實(shí)現(xiàn)實(shí)體對(duì)象之間的賦值有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步學(xué)有所得2021-10-10
利用JWT如何實(shí)現(xiàn)對(duì)API的授權(quán)訪問詳解
這篇文章主要給大家介紹了關(guān)于利用JWT如何實(shí)現(xiàn)對(duì)API的授權(quán)訪問的相關(guān)資料,需要的朋友可以參考下2018-09-09
解決Eclipse中java文件的圖標(biāo)變成空心J的問題
這篇文章主要介紹了解決Eclipse中java文件的圖標(biāo)變成空心J的問題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2021-01-01
在某些特殊的場景下我們需要在Java程序中對(duì)List集合進(jìn)行排序操作,下面這篇文章主要給大家介紹了關(guān)于Java中常用集合的排序方法的相關(guān)資料,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下2023-11-11
解決idea 通過build project 手動(dòng)觸發(fā)熱部署失敗的問題
在debug運(yùn)行項(xiàng)目的過程中,并且保證（不添加方法,不修改方法名）一定的規(guī)則的情況下,可以通過build project 來手動(dòng)熱部署項(xiàng)目,本文給大家介紹解決idea 通過build project 手動(dòng)觸發(fā)熱部署失敗的問題,感興趣的朋友一起看看吧2023-12-12
簡析Java中的util.concurrent.Future接口
這篇文章主要介紹了簡析Java中的util.concurrent.Future接口,作者把future歸結(jié)為在未來得到目標(biāo)對(duì)象的占位符,需要的朋友可以參考下2015-07-07