概述
boot通过LoggingSystem日志系统的抽象,为基于boot的应用,在集成第三方日志框架时,提供增强的功能.具体实现由LoggingApplicationListener来完成,它负责感知ApplicationEnvironmentPreparedEvent环境准备完毕的事件,并对日志系统进行初始化.感兴趣的同学可以自行研究源码.
另外,关于boot的日志特性的使用,更详细的说明可以参考:https://docs.spring.io/spring-boot/docs/2.4.2/reference/htmlsingle/#boot-features-logging
在boot框架的支持下,以logback框架集成为例,我们可以选择以下几种集成配置方式:
- 原始logback.xml的配置集成方式肯定是支持的
- 如果应用的日志使用场景简单,那么使用boot的默认配置能力(无需logback.xml),通过application.yml中属性的配置,来集成logback.这种方式boot可以提供一个ConsoleAppender和RollingFileAppender.
- 如果应用的日志使用场景复杂,那么也可以使用boot对logback.xml配置方式的增强来集成,通过定义logback-spring.xml来实现.boot额外提供了profile的能力(
<springProfile>)和从属性源提取属性并装配到日志上下文的能力(<springProperty>)
默认配置
如果要集成第三方日志框架,我们只需要引入第三方jar的依赖即可,不需要做任何配置.boot默认会帮我在rootLogger中追加ConsoleAppender,如果通过application.yml配置了logging.file.name或logging.file.path,boot还会额外追加一个RollingFileAppender,这样可以将日志同时打印到控制台和写入文件.
此外,boot还定义了一系列定制属性,让我们可以对日志格式,滚动策略等方面进行进一步的定制.
下面分别介绍
日志格式的定制
默认情况下,日志格式分为控制台格式和文件格式两种
控制台格式如下:
%clr(%d{${LOG_DATEFORMAT_PATTERN:-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}
文件格式如下
%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}
可进行定制的属性如下:
| 属性名 | 对应的logback属性名 | 描述 |
|---|---|---|
| logging.pattern.dateformat | LOG_DATEFORMAT_PATTERN | 默认格式中,可以定义时间戳的格式,默认值为yyyy-MM-dd HH:mm:ss.SSS |
| logging.pattern.level | LOG_LEVEL_PATTERN | 默认日志格式中,可以定义日志级别选项的模式,默认值是%5p |
| logging.exception-conversion-word | LOG_EXCEPTION_CONVERSION_WORD | 默认格式中,Throwable转String的格式,默认值为%wEx |
当然,除了修改局部格式之外,也可以对整体格式进行重新配置
| 属性名 | 对应的logback属性名 | 描述 |
|---|---|---|
| logging.pattern.console | CONSOLE_LOG_PATTERN | 定义ConsoleAppender日志的整体格式 |
| logging.pattern.file | FILE_LOG_PATTERN | 定义RollingFileAppender日志的整体格式 |
关于RollingFileAppender,我们还可以进行如下定制:
| 属性名 | 对应的logback属性名 | 描述 |
|---|---|---|
| logging.file.name | LOG_FILE | RollingFileAppender写入文件的完整路径 |
| logging.file.path | LOG_PATH | RollingFileAppender写入文件的目录,当没有配置LOG_FILE时该配置才生效,日志会写入${LOG_PATH}/spring.log文件 |
还可以为RollingFileAppender中的滚动策略(SizeAndTimeBasedRollingPolicy)进行如下定制:
| 属性名 | 对应的logback属性名 | 描述 |
|---|---|---|
| logging.file.clean-history-on-start | LOG_FILE_CLEAN_HISTORY_ON_START | 滚动策略的配置,启动时是否清理历史日志文件,默认为false |
| logging.file.max-history | LOG_FILE_MAX_HISTORY | 保留历史文件的最大个数,默认为7 |
| logging.file.max-size | LOG_FILE_MAX_SIZE | 日志文件的最大值,默认10mb |
| logging.file.total-size-cap | LOG_FILE_TOTAL_SIZE_CAP | 日志文件总占用空间限制,默认无限制 |
| logging.pattern.rolling-file-name | ROLLING_FILE_NAME_PATTERN | 历史文件的命名模式,默认值为${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz} |
增强配置文件logback-spring.xml
如果默认配置无法满足使用的话,可以使用增强配置文件的集成方式.
通过logging.config属性指定配置文件的读取位置,默认为classpath:/logback-spring.xml.
tips:如果boot成功读取到了配置文件,则默认配置方式就不再启用了.
| 属性名称 | 描述 |
|---|---|
| logging.config | 用于指定配置文件的位置 |
之所以要给配置文件改名,是因为任何LoggerFactory.getLogger()调用都会触发日志logback框架的初始化,框架会自动查找classpath下的logback.xml配置文件,而boot扩展了配置文件的语法,这个扩展是原生配置器不识别的,如果不改名的话,会导致解析异常.
增强的语法特性包括:
- 可以通过配置
<springProperty name="" source="">将属性值从spring环境对象的属性源中提取出来,装配到日志框架的上下文中,用于logback配置时属性变量的替换 - 可以通过
<springProfile name=""></springProfile>包裹特定配置,来让配置在特定profile激活的情况下才生效.典型的场景是只有线下环境才激活ConsoleAppender的使用
另外,刚刚提到的默认配置方式,boot也提供了等价的配置文件,在org/springframework/boot/logging/logback/目录下:
-
defaults.xml:包含基本的Converter配置和特定logger的日志级别配置和默认的日志格式 -
console-appender: ConsoleAppender的等价配置 -
file-appender:RollingFileAppender的等价配置 -
base.xml:include了以上三个文件的配置,并且给rootLogger配置appender
我们也可以按照需要,将任意配置文件include到我们的logback-spring.xml文件中.
<include resource="org/springframework/boot/logging/logback/defaults.xml" />
tips:如果不使用等价配置文件的话,也就不需要再配置默认配置中的定制属性了.
日志组和日志级别
无论是原生配置方式,默认配置方式,还是增强配置方式,都支持使用application.yml来为logger配置日志级别.这样就可以依靠boot的profile特性,不同环境设置不同的日志级别.
| 名称 | 作用 | |
|---|---|---|
| logging.group.{groupNames} | 用于定义日志组,组合多个loggerName,,分隔 |
|
| logging.level.{loggerNames | groupNames} | 用于定义logger的日志级别,,分隔 |
可以给指定的loggerName配置级别,也可以将多个loggerName组合成一个group,针对group进行统一的日志级别配置.
boot默认定义了两个group:web和sql.
web组包含:
- org.springframework.core.codec
- org.springframework.http
- org.springframework.web
- org.springframework.boot.actuate.endpoint.web
- org.springframework.boot.web.servlet.ServletContextInitializerBeans
sql组包含:
- org.springframework.jdbc.core
- org.hibernate.SQL
- org.jooq.tools.LoggerListener
