這篇文章主要跟大家分享了關於Spring Boot日誌框架實踐,程式碼部分也非常詳細,有需要的小夥伴可以參考一下。
Java應用程式中,日誌一般分為以下5個等級:
#ERROR 錯誤訊息
WARN 警告訊息
INFO 一般訊息
DEBUG 偵錯資訊
TRACE 追蹤資訊
Spring Boot使用Apache的Commons Logging作為內部的日誌框架,其僅僅是日誌介面,在實際應用中需要為該介面來指定對應的日誌實作。
SpringBt預設的日誌實作是Java Util Logging,是JDK自帶的日誌包,此外SpringBt當然也支援Log4J、Logback這類很流行的日誌實作。
統一將上面這些日誌實作統稱為日誌框架
下面我們來實作一下!
首先application.properties檔案中加配置:
logging.level.root=INFO
#控制器部分程式碼如下:
package com.hansonwang99.controller; import com.hansonwang99.K8sresctrlApplication; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController @RequestMapping("/testlogging") public class LoggingTestController { private static Logger logger = LoggerFactory.getLogger(K8sresctrlApplication.class); @GetMapping("/hello") public String hello() { logger.info("test logging..."); return "hello"; } }
執行結果
由於將日誌等級設定為INFO,因此包含INFO及以上等級的日誌資訊都會列印出來
這裡可以看出,許多大部分的INFO日誌都是來自於SpringBt框架本身,如果我們想要封鎖它們,可以將日誌等級統一先全部設定為ERROR,這樣框架本身的INFO資訊就不會被列印。然後再將應用程式中特定的套件設定為DEBUG等級的日誌,這樣就可以只看到所關心的套件中的DEBUG及以上等級的日誌了。
控制特定包的日誌等級
#application.yml中改配置
logging: level: root: error com.hansonwang99.controller: debug
很明顯,將root日誌級別設定為ERROR,然後再將com.hansonwang99.controller
套件的日誌等級設為DEBUG,此即:即先禁止所有再允許個別的設定方法
#控制器程式碼
package com.hansonwang99.controller; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController @RequestMapping("/testlogging") public class LoggingTestController { private Logger logger = LoggerFactory.getLogger(this.getClass()); @GetMapping("/hello") public String hello() { logger.info("test logging..."); return "hello"; } }
#執行結果
logging:
level:
root: error
com.hansonwang99.controller: debug
file: ${user.home}/logs/hello.log
org.slf4j.Logger是無法解決這個問題的
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
在resources目錄下新增log4j2.xml文件,內容如下:
<?xml version="1.0" encoding="UTF-8"?> <configuration> <appenders> <File name="file" fileName="${sys:user.home}/logs/hello2.log"> <PatternLayout pattern="%d{HH:mm:ss,SSS} %p %c (%L) - %m%n"/> </File> </appenders> <loggers> <root level="ERROR"> <appender-ref ref="file"/> </root> <logger name="com.hansonwang99.controller" level="DEBUG" /> </loggers> </configuration>#其他程式碼都保持不變
執行程式發現控制台沒有日誌輸出,而hello2.log檔案中有內容,這符合我們的預期:
##而且日誌格式和
pattern="%d{HH:mm:ss,SSS} %p %c (%L) - %m%n"Log4J更進一步實作
pom.xml設定:#
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-log4j2</artifactId> </dependency>######log4j2.xml設定####################################################################################### ##
<?xml version="1.0" encoding="UTF-8"?> <configuration status="warn"> <properties> <Property name="app_name">springboot-web</Property> <Property name="log_path">logs/${app_name}</Property> </properties> <appenders> <console name="Console" target="SYSTEM_OUT"> <PatternLayout pattern="[%d][%t][%p][%l] %m%n" /> </console> <RollingFile name="RollingFileInfo" fileName="${log_path}/info.log" filePattern="${log_path}/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log.gz"> <Filters> <ThresholdFilter level="INFO" /> <ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL" /> </Filters> <PatternLayout pattern="[%d][%t][%p][%c:%L] %m%n" /> <Policies> <!-- 归档每天的文件 --> <TimeBasedTriggeringPolicy interval="1" modulate="true" /> <!-- 限制单个文件大小 --> <SizeBasedTriggeringPolicy size="2 MB" /> </Policies> <!-- 限制每天文件个数 --> <DefaultRolloverStrategy compressionLevel="0" max="10"/> </RollingFile> <RollingFile name="RollingFileWarn" fileName="${log_path}/warn.log" filePattern="${log_path}/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log.gz"> <Filters> <ThresholdFilter level="WARN" /> <ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL" /> </Filters> <PatternLayout pattern="[%d][%t][%p][%c:%L] %m%n" /> <Policies> <!-- 归档每天的文件 --> <TimeBasedTriggeringPolicy interval="1" modulate="true" /> <!-- 限制单个文件大小 --> <SizeBasedTriggeringPolicy size="2 MB" /> </Policies> <!-- 限制每天文件个数 --> <DefaultRolloverStrategy compressionLevel="0" max="10"/> </RollingFile> <RollingFile name="RollingFileError" fileName="${log_path}/error.log" filePattern="${log_path}/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log.gz"> <ThresholdFilter level="ERROR" /> <PatternLayout pattern="[%d][%t][%p][%c:%L] %m%n" /> <Policies> <!-- 归档每天的文件 --> <TimeBasedTriggeringPolicy interval="1" modulate="true" /> <!-- 限制单个文件大小 --> <SizeBasedTriggeringPolicy size="2 MB" /> </Policies> <!-- 限制每天文件个数 --> <DefaultRolloverStrategy compressionLevel="0" max="10"/> </RollingFile> </appenders> <loggers> <root level="info"> <appender-ref ref="Console" /> <appender-ref ref="RollingFileInfo" /> <appender-ref ref="RollingFileWarn" /> <appender-ref ref="RollingFileError" /> </root> </loggers> </configuration>#########控制器程式碼:#########
package com.hansonwang99.controller; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController @RequestMapping("/testlogging") public class LoggingTestController { private final Logger logger = LogManager.getLogger(this.getClass()); @GetMapping("/hello") public String hello() { for(int i=0;i<10_0000;i++){ logger.info("info execute index method"); logger.warn("warn execute index method"); logger.error("error execute index method"); } return "My First SpringBoot Application"; } }#########執行結果############ ###########################
日誌會根據不同的層級儲存在不同的文件,當日誌檔案大小超過2M以後會分多個文件壓縮存儲,生產環境的日誌文件大小建議調整為20-50MB。
作者更多的原創文章見SF專欄
作者更多的SpringBt實踐文章在此:
ElasticSearch搜尋引擎在SpringBoot中的實踐
初探Kotlin+SpringBoot聯合程式設計
以上是Spring Boot日誌框架實踐 - hansonwang99的技術分享的詳細內容。更多資訊請關注PHP中文網其他相關文章!