日志分组
在日常工作中,我们基本上很少在使用println的方式查看输出的信息,都是以日志的方式展示各种问题。在SpringBoot框架中就提供了非常详细的日志相关功能。而对于日志框架,也有非常多的类型,比如logback
,log4j
,log4j2
等等日志框架,在springboot中默认使用了logback的日志框架。
但是在日常工作中,不排除有各种各样奇怪的需求,比如这个请求只想记录某一种类型的日志,或者某几个类型记录同一种类型的日志,但是如果我们要对每一个日志设置一遍这个级别,就会显得格外繁琐。因此,在springboot3中对日志增加了新的功能,可以为多个需要输出相同的设置为一个组。然后对这个组设置日志的级别。
logging:
level:
controller: debug
group:
controller:
- HelloController
- HiController
- HeyController
除了我们自定义的组之外,springboot默认创建了两个组,分别为sql
和web
组,可以直接为该组设置日志级别
日志输出
当我们在工作当中,很多时候需要把程序运行的情况输出为日志文件。在springboot中,也提供了对我们很方便的输出文件的格式,只需要在配置文件中配置一下输出文件的路径和文件名称即可
logging:
file:
# 当name和path同时存在时,只看name的配置
# 当指定name时带有路径,则按照name的位置进行保存
name: aaa.log
# 在有name的情况下不生效
path: d:\\log\
实现文件归档和分割
所谓的归档和分割,其实就是在生产过程中,会产生大量的日志信息,但当我们把所有的日志信息全部输出到一个文件中时,那么这个文件一定会变得非常的大,响应的打开文件的速度也会慢很多。所以在生产环境中,我们往往需要按照日期或者一定的要求将日志保存为多个单独的文件。SpringBoot同样也提供了类似的操作:
logging:
logback:
rollingpolicy:
# 默认的文件切割规则,通常和其它条件一起使用,当达到某个限制的时候对该文件进行归档
file-name-pattern: ${LOG_FILE}.%d{yyyy-mm-dd}.%i.gz
max-file-size: 1MB # 当文件达到这个大小时将创建新的文件
total-size-cap: 1G # 所有的日志文件最大可保存的大小
max-history: 7 # 日志记录最长保存多少天
自定义日志框架
因为SpringBoot默认使用的日志框架是logback,如果我们想要使用其它的日志框架时需要在resource资源目录下边新建一个对应的xml
(必须是该日志框架为名称的xml文件或者日志框架名后面加-spring
)配置文件,将该日志框架的规则配置到xml文件中,springBoot会自动识别该配置
- 首先我们需要在依赖的pom文件中排除日志框架的默认配置
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifictId>spring-boot-starter</artifictId>
<!-- 排除该日志的默认配置 -->
<exclusion>
<groupId>org.springframework.boot<groupId>
<artifictId>spring-boot-starter-logging</artifictId>
</exclusion>
</denpendency>
<!-- 选择我们想要使用的日志框架依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifictId>spring-boot-starter-log4j2</artifictId>
</dependency>
</dependencies>
- 我们可以继续在
yml
配置文件中使用原来的日志配置,也可以自己写一个该日志框架的配置文件(文件名必须为日志框架名称
或者日志框架名称 + -spring
)的xm
l文件
<?xml version="1.0" encoding="UTF-8"?>
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status,这个用于设置log4j2自身内部的信息输出,可以不设置,当设置成trace时,你会看到log4j2内部各种详细输出-->
<!--monitorInterval:Log4j能够自动检测修改配置 文件和重新配置本身,设置间隔秒数-->
<configuration status="WARN" monitorInterval="30">
<!--先定义所有的appender-->
<appenders>
<!--这个输出控制台的配置-->
<console name="Console" target="SYSTEM_OUT">
<!--输出日志的格式-->
<PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
</console>
<!--文件会打印出所有信息,这个log每次运行程序会自动清空,由append属性决定,这个也挺有用的,适合临时测试用-->
<File name="log" fileName="log/test.log" append="false">
<PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
</File>
<!-- 这个会打印出所有的info及以下级别的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档-->
<RollingFile name="RollingFileInfo" fileName="${sys:user.home}/logs/info.log"
filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
<!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
<Policies>
<TimeBasedTriggeringPolicy/>
<SizeBasedTriggeringPolicy size="100 MB"/>
</Policies>
</RollingFile>
<RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log"
filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
<ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
<Policies>
<TimeBasedTriggeringPolicy/>
<SizeBasedTriggeringPolicy size="100 MB"/>
</Policies>
<!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件,这里设置了20 -->
<DefaultRolloverStrategy max="20"/>
</RollingFile>
<RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log"
filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
<ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
<Policies>
<TimeBasedTriggeringPolicy/>
<SizeBasedTriggeringPolicy size="100 MB"/>
</Policies>
</RollingFile>
</appenders>
<!--然后定义logger,只有定义了logger并引入的appender,appender才会生效-->
<loggers>
<!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
<logger name="org.springframework" level="INFO"></logger>
<logger name="org.mybatis" level="INFO"></logger>
<root level="all">
<appender-ref ref="Console"/>
<appender-ref ref="RollingFileInfo"/>
<appender-ref ref="RollingFileWarn"/>
<appender-ref ref="RollingFileError"/>
</root>
</loggers>
</configuration>