SpringBoot的默認日志配置
SpringBoot
開箱即用,默認幫你配置了日志框架,使用 Commons Logging
,但是默認配置也提供了對常用日志的支持,如: Java Util Logging , Log4J , Log4J2 和 Logback。每種Logger都可以通過配置使用控制臺或者文件輸出日志內容。
控制臺輸出
關于log日志,首先說說的5個日志級別 LEVEL: 從高到低分別是 ERROR
、 WARN
、 INFO
、 DEBUG
、 TRACE
低級別的會輸出高級別信息,高級別不會輸出低級別信息。例如:等級設為 ERROR
的話, WARN
、 INFO
、 DEBUG
的信息是不會輸出的。 在 SpringBoot 中默認配置了 ERROR
、 WARN
和 INFO
級別的日志輸出到控制臺。 Logback中沒有 FATAL
級別,它會被當作 ERROR
級別來處理。
我們可以通過兩種方式切換至 DEBUG 級別:
- 在運行命令后加入 --debug 標志,如: $ java -jar myapp.jar --debug
-
在
application.properties
中配置 debug=true ,該屬性置為true的時候,核心Logger(包含嵌入式容器、hibernate、spring)會輸出更多內容,但是你自己應用的日志并不會輸出為DEBUG級別。
多彩輸出
SpringBoot 從1.4.0版本開始支持彩色日志輸出了。 如果你的終端支持ANSI,設置彩色輸出會讓日志更具可讀性。通過在 application.properties
中設置 spring.output.ansi.enabled
參數來支持。
-
NEVER
:禁用ANSI-colored輸出(默認項) -
DETECT
:會檢查終端是否支持ANSI,是的話就采用彩色輸出(推薦項) -
ALWAYS
:總是使用ANSI-colored格式輸出,若終端不支持的時候,會有很多干擾信息,不推薦使用
文件輸出
SpringBoot 默認配置只會輸出到控制臺,并不會記錄到文件中,但是我們通常生產環境使用時都需要以文件方式記錄。
若要增加文件輸出,需要在 application.properties
中配置 logging.file
或 logging.path
屬性。
-
logging.file
:設置文件,可以是絕對路徑,也可以是相對路徑。如: logging.file=my.log -
logging.path
:設置目錄,會在該目錄下創建spring.log文件,并寫入日志內容,如: logging.path=/var/log
日志文件會在10Mb大小的時候被截斷,產生新的日志文件,默認級別為:ERROR、WARN、INFO
級別控制
在 SpringBoot 中只需要在 application.properties
中進行配置完成日志記錄的級別控制。
配置格式: logging.level.*=LEVEL
-
logging.level
:日志級別控制前綴, * 為包名或Logger名 -
LEVEL
:選項TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF
舉例:
-
logging.level.com.controller=DEBUG : com.controller 包下所有class以
DEBUG
級別輸出 -
logging.level.root=WARN :root日志以
WARN
級別輸出
自定義日志配置
如果不想使用默認配置,只要加入自己的日志配置文件就行了。 由于日志服務一般都在 ApplicationContext
創建前就初始化了,它并不是必須通過 Spring
的配置文件控制。因此通過系統屬性和傳統的 Spring Boot 外部配置文件依然可以很好的支持日志控制和管理。
根據不同的日志系統,你可以按如下規則組織配置文件名,就能被正確加載:
- Logback: logback-spring.xml , logback-spring.groovy , logback.xml , logback.groovy
- Log4j: log4j-spring.properties , log4j-spring.xml , log4j.properties , log4j.xml
- Log4j2: log4j2-spring.xml , log4j2.xml
- JDK (Java Util Logging): logging.properties
SpringBoot 官方推薦優先使用帶有 -spring
的文件名作為你的日志配置(如使用 logback-spring.xml ,而不是 logback.xml )
自定義輸出格式
在 SpringBoot 中可以通過在 application.properties
配置如下參數控制輸出格式:
-
logging.pattern.console
:定義輸出到控制臺的樣式(不支持JDK Logger) -
logging.pattern.file
:定義輸出到文件的樣式(不支持JDK Logger)
也可以直接在日志配置文件中定義這些格式,而不是在應用配置文件中。
常用的Logback配置文件模板
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
<? xml version = "1.0" encoding = "UTF-8" ?> < configuration > <!--定義日志文件的存儲地址 勿在 LogBack 的配置中使用相對路徑--> < property name = "LOG_HOME" value = "d:/logs" /> <!-- 彩色日志依賴的渲染類 --> < conversionRule conversionWord = "clr" converterClass = "org.springframework.boot.logging.logback.ColorConverter" /> < conversionRule conversionWord = "wex" converterClass = "org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" /> < conversionRule conversionWord = "wEx" converterClass = "org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" /> <!-- 彩色日志格式 --> < property name = "CONSOLE_LOG_PATTERN" value = "${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(--){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}" /> <!-- Console 輸出設置 --> < appender name = "console" class = "ch.qos.logback.core.ConsoleAppender" > < encoder > <!--格式化輸出:%d表示日期,%thread表示線程名,%-5level:級別從左顯示5個字符寬度%msg:日志消息,%n是換行符--> <!--<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>--> < pattern >${CONSOLE_LOG_PATTERN}</ pattern > < charset >utf8</ charset > </ encoder > </ appender > <!-- 按照每天生成日志文件 --> < appender name = "file" class = "ch.qos.logback.core.rolling.RollingFileAppender" > < rollingPolicy class = "ch.qos.logback.core.rolling.TimeBasedRollingPolicy" > <!--日志文件輸出的文件名--> < fileNamePattern >${LOG_HOME}/mixedSys.%d{yyyy-MM-dd}.log</ fileNamePattern > </ rollingPolicy > < encoder > < pattern >%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</ pattern > </ encoder > </ appender > <!-- 日志logger(包.類)的輸出級別 --> < logger name = "org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver" level = "DEBUG" > < appender-ref ref = "console" /> < appender-ref ref = "file" /> </ logger > < logger name = "org.springframework.boot" level = "DEBUG" /> <!-- 為 Hibernate sql 定制 --> <!-- <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" /> --> <!-- 日志輸出級別 --> < root level = "INFO" > <!-- 此時debug級別的信息會被過濾 --> < appender-ref ref = "console" /> < appender-ref ref = "file" /> </ root > <!--日志異步到數據庫 --> <!-- <appender name="DB" class="ch.qos.logback.classic.db.DBAppender"> 日志異步到數據庫 <connectionSource class="ch.qos.logback.core.db.DriverManagerConnectionSource"> 連接池 <dataSource class="com.mchange.v2.c3p0.ComboPooledDataSource"> <driverClass>com.mysql.jdbc.Driver</driverClass> <url>jdbc:mysql://127.0.0.1:3306/databaseName</url> <user>root</user> <password>root</password> </dataSource> </connectionSource> </appender> --> </ configuration > |
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持服務器之家。
原文鏈接:https://juejin.im/post/5afbe1c6f265da0ba469f966