Spring Boot
内部采用的是 Commons Logging
进行日志记录,但在底层为 Java Util Logging
、Log4J2
、Logback
等日志框架提供了默认配置 。
Java 虽然有很多可用的日志框架,但请不要担心,一般来说,使用
SpringBoot
默认的Logback
就可以了。
SpringBoot
的默认输出的日志格式如下:
2014-03-05 10:57:51.112 INFO 45469 --- [ main] org.apache.catalina.core.StandardEngine : Starting Servlet Engine: Apache Tomcat/7.0.52
2014-03-05 10:57:51.253 INFO 45469 --- [ost-startStop-1] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring embedded WebApplicationContext
2014-03-05 10:57:51.253 INFO 45469 --- [ost-startStop-1] o.s.web.context.ContextLoader : Root WebApplicationContext: initialization completed in 1358 ms
2014-03-05 10:57:51.698 INFO 45469 --- [ost-startStop-1] o.s.b.c.e.ServletRegistrationBean : Mapping servlet: 'dispatcherServlet' to [/]
2014-03-05 10:57:51.702 INFO 45469 --- [ost-startStop-1] o.s.b.c.embedded.FilterRegistrationBean : Mapping filter: 'hiddenHttpMethodFilter' to: [/*]
输出如下元素:
---
来标识日志开始部分Logback
是没有 FATAL
级别的日志,它将被映射到 ERROR
SpringBoot
默认为我们输出的日志级别为 INFO
、WARN
、ERROR
,如需要输出更多日志的时候,可以通过以下方式开启
java -jar app.jar --debug=true
, 这种命令会被 SpringBoot
解析,且优先级最高application.properties
配置 debug=true
即可。该配置只对 嵌入式容器、Spring、Hibernate生效,我们自己的项目想要输出 DEBUG
需要额外配置(配置规则:logging.level.=
)日志输出级别配置:
logging.level.root = WARN
logging.level.org.springframework.web = DEBUG
logging.level.org.hibernate = ERROR
#比如 mybatis sql日志
logging.level.org.mybatis = INFO
logging.level.mapper所在的包 = DEBUG
日志输出格式配置:
如果终端支持 ANSI
,默认情况下会给日志上个色,提高可读性,可以在配置文件中设置 spring.output.ansi.enabled
来改变默认值
ANSI
颜色的输出。ANSI
着色功能是否可用。ANSI
颜色的输出。Level | Color |
---|---|
WARN |
Yellow |
FATAL 、ERROR |
Red |
INFO 、DEBUG 、TRACE |
Green |
如果想修改日志默认色值,可以通过使用 %clr
关键字转换。比如想使文本变为黄色 %clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){yellow}
。目前支持的颜色有(blue
、cyan
、faint
、green
、magenta
、red
、yellow
)
默认情况下,SpringBoot
仅将日志输出到控制台,不会写入到日志文件中去。如果除了控制台输出之外还想写日志文件,则需要在application.properties
设置logging.file
或 logging.path
属性。
spring.log
写入到指定的 文件夹 中,如(/var/log
)日志文件在达到 10MB
时进行切割,产生一个新的日志文件(如:spring.1.log、spring.2.log
),新的日志依旧输出到spring.log
中去,默认情况下会记录 ERROR
、WARN
、INFO
级别消息。
由于日志在 ApplicationContext
之前就初始化好了,所以 SpringBoot
为我们提供了 logging.config
属性,方便我们配置自定义日志文件。默认情况它会根据日志的依赖自动加载。
Logging System | Customization |
---|---|
JDK (Java Util Logging) |
logging.properties |
Log4j2 、ERROR |
log4j2-spring.xml 或 log4j2.xml |
Logback |
logback-spring.xml、logback-spring.groovy、logback.xml、logback.groovy |
在configuration根节点配置属性scan和scanPeriod,scan为true时,配置文件被修改会被重新加载,scanPeriod定义了扫描文件变化的周期,默认60000毫秒,即一分钟。这种做法的好处是不用自己写修改日志级别的逻辑;坏处是要手动更改配置文件,排错完成后需改回原来的配置。示例配置如下:
-------------------------------------------------------------------------------------------
该扩展配置仅适用 logback-spring.xml
或者设置 logging.config
属性的文件,因为 logback.xml
加载过早,因此无法获取SpringBoot
的一些扩展属性
使用扩展属性 springProfile
与 springProperty
让你的 logback-spring.xml
配置显得更有逼格,当别人还在苦苦挣扎弄logback-{profile}.xml的时候 你一个文件就搞定了...
标签使我们让配置文件更加灵活,它可以选择性的包含或排除部分配置。
案例
标签可以让我们在 Logback 中使用 Spring Environment 中的属性。如果想在logback-spring.xml
中回读application.properties
配置的值时,这是一个非常好的解决方案
logs/${logName}.log
${LOG_PATH}/log_error.log
${LOG_PATH}/log-error-%d{yyyy-MM-dd}.%i.log
2MB
30
true
%-5p [%d][%mdc{mdc_userId}] %C:%L - %m %n
utf-8
error
ACCEPT
DENY
${LOG_PATH}/log_warn.log
${LOG_PATH}/log-warn-%d{yyyy-MM-dd}.%i.log
2MB
true
%-5p [%d][%mdc{mdc_userId}] %C:%L - %m %n
utf-8
WARN
ACCEPT
DENY
${LOG_PATH}/log_info.log
${LOG_PATH}/log-info-%d{yyyy-MM-dd}.%i.log
2MB
true
%-5p [%d][%mdc{mdc_userId}] %C:%L - %m %n
utf-8
INFO
ACCEPT
DENY
${LOG_PATH}/log_debug.log
${LOG_PATH}/log-debug-%d{yyyy-MM-dd}.%i.log
2MB
true
%-5p [%d][%mdc{mdc_userId}] %C:%L - %m %n
utf-8
DEBUG
INFO
DEBUG
ACCEPT
DENY
-->
System.out
%-5p [%d][%mdc{mdc_userId}] %C:%L - %m %n
utf-8
DEBUG
${LOG_PATH}/log_filter.log
%d{yyyy-MM-dd HH:mm:ss} : %m%n
INFO
${LOG_PATH}/log_filter.%d{yyyy-MM-dd}
${LOG_PATH}/log_interest_bearing.log
%d{yyyy-MM-dd HH:mm:ss} : %m%n
INFO
${LOG_PATH}/log_interest_bearing.%d{yyyy-MM-dd}