日誌的簡單使用
1.1 默認配置
SpringBoot默認幫我們配置好了日誌(使用slf4j作爲日誌門面,logback爲日誌框架);
打開pom.xml,找到spring-boot-starter-web一欄,鼠標右擊,Diagrams - Show Dependcies即可查看依賴關係
我們會發現,其實在引入web的時候,日誌已經被引入進來了
默認配置可以從External Library欄找到:
@RunWith(SpringRunner.class)
@SpringBootTest
public class Demo3ApplicationTests {
//此處的getClass()其實可有可無,但是爲了方便定位日誌是從哪個類輸出的,還是最好帶上
Logger logger = LoggerFactory.getLogger(getClass());
@Test
public void contextLoads() {
logger.trace("===== trace... =====");
logger.debug("===== debug... =====");
logger.info("===== info... =====");
logger.warn("===== warn... =====");
logger.error("===== error... =====");
}
}
-
日誌的級別爲:
trace < debug < info < warn < error
-
SpringBoot的日誌級別默認爲 info,也就是說只有info及比info級別高的日誌纔會輸出。
在默認配置下,運行以上代碼輸出日誌如下:
2020-01-18 22:36:27.191 INFO 10660 --- [ main] com.example.demo3.Demo3ApplicationTests : ===== info... =====
2020-01-18 22:36:27.192 WARN 10660 --- [ main] com.example.demo3.Demo3ApplicationTests : ===== warn... =====
2020-01-18 22:36:27.192 ERROR 10660 --- [ main] com.example.demo3.Demo3ApplicationTests : ===== error... =====
可以看出日誌輸出了時間、日誌級別、線程、類名、日誌信息五項內容
1.2 指定配置
日誌輸出的格式、輸出方式(控制檯、文件)等都可以通過指定配置文件的形式配置
1.2.1 日誌輸出格式
使用logging.pattern.console
或logging.pattern.file
指定,其格式如下:
日誌輸出格式:
%d表示日期時間,
%thread表示線程名,
%-5level:級別從左顯示5個字符寬度
%logger{50} 表示logger名字最長50個字符,否則按照句點分割。
%msg:日誌消息,
%n是換行符
-->
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
# 在控制檯輸出的日誌的格式
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
1.2.2 日誌存儲位置
在logging.path
和logging.file
兩者都沒有指定的情況下,日誌將會輸出在控制檯,其他情況下輸出至文件,如下表:
logging.file | logging.path | Example | Description |
---|---|---|---|
(none) | (none) | 只在控制檯輸出 | |
指定文件名 | (none) | my.log | 輸出日誌到my.log文件 |
(none) | 指定目錄 | /var/log | 輸出到指定目錄的 spring.log 文件中 |
-
logging.path該屬性用來配置日誌文件的路徑
-
logging.file 該屬性用來配置日誌文件名,如果該屬性不配置,默認文件名爲spring.log
1.2.3 日誌顯示級別
全局:
logging.level.root=warn
指定包下:
logging.level.包名=warn
SpringBoot修改日誌的默認配置
logging.level.com.atguigu=trace
#logging.path=
# 不指定路徑在當前項目下生成springboot.log日誌
# 可以指定完整的路徑;
#logging.file=G:/springboot.log
# 在當前磁盤的根路徑下創建spring文件夾和裏面的log文件夾;使用 spring.log 作爲默認文件
logging.path=/spring/log
# 在控制檯輸出的日誌的格式
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
1.2.4 使用配置文件
給類路徑下(src/main/resources)放上每個日誌框架自己的配置文件即可;在使用配置文件後,SpringBoot就不使用他默認配置的了。
Logging System | Customization |
---|---|
Logback | logback-spring.xml , logback-spring.groovy , logback.xml or logback.groovy |
Log4j2 | log4j2-spring.xml or log4j2.xml |
JDK (Java Util Logging) | logging.properties |
官方推薦使用帶有spring後綴名的格式,帶spring後綴後可以使用Profile功能,根據不同的環境使用不同的配置。
-
logback.xml:直接就被日誌框架識別了;
-
logback-spring.xml:日誌框架就不直接加載日誌的配置項,由SpringBoot解析日誌配置,可以使用SpringBoot的高級Profile功能
<springProfile name="staging">
<!-- configuration to be enabled when the "staging" profile is active -->
可以指定某段配置只在某個環境下生效
</springProfile>
如:
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<!--
日誌輸出格式:
%d表示日期時間,
%thread表示線程名,
%-5level:級別從左顯示5個字符寬度
%logger{50} 表示logger名字最長50個字符,否則按照句點分割。
%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>
如果使用logback.xml作爲日誌配置文件,還要使用profile功能,會有以下錯誤
no applicable action for [springProfile]