在Spring Boot
中,日志系统是一个非常重要的组件,它能够记录应用程序的运行状态、错误信息等,帮助开发人员和运维人员快速定位和解决问题。Spring Boot默认使用的是SLF4J(Simple Logging Facade for Java)作为抽象层,而具体的日志实现则由底层的日志框架提供,常见的有Logback、Log4j2等。
在Spring Boot
中使用日志:
<dependency> <artifactId>spring-boot-starter-logging</artifactId> <groupId>org.springframework.boot</groupId> </dependency>
Spring Boot
日志依赖关系图:
Spring Boot
底层默认使用Logback
作为日志实现,使用SLF4J
作为日志门面。将JUL
也转换成SEL4J
,也可以使用Log4J2
作为日志门面,但是最终也是通过SLF4J
调用Logback
。
- 在
Spring Boot
中测试日志打印:
@SpringBootTest class SpringbootLogApplicationTests { //记录器 public static final Logger LOGGER = LoggerFactory.getLogger(SpringbootLogApplicationTests.class); @Test public void contextLoads() { // 打印日志信息 LOGGER.error("error"); LOGGER.warn("warn"); LOGGER.info("info"); // 默认日志级别 LOGGER.debug("debug"); LOGGER.trace("trace"); } }
注意:使用的是org.slf4j
包下的Log
。
常见的日志级别如下:
序号 |
日志级别 |
说明 |
1 |
trace |
追踪,指明程序运行轨迹。 |
2 |
debug |
调试,实际应用中一般将其作为最低级别,而 trace 则很少使用。 |
3 |
info |
输出重要的信息,使用较多。 |
4 |
warn |
警告,使用较多。 |
5 |
error |
错误信息,使用较多。 |
使用默认的slf4j
日志类来打印日志,可以看到,默认的级别为info
,trace
和debug
都不会打印出来
- 修改默认的日志配置:
在配置文件application.properties
中添加:
# 日志级别 logging.level.项目包路径=trace # 使用相对路径的方式设置日志输出的位置(项目根目录目录\my-log\mylog\spring.log) # logging.file.path=my-log/myLog # 绝对路径方式将日志文件输出到 【项目所在磁盘根目录\springboot\logging\my\spring.log】 logging.file.path=/spring-boot/logging # 控制台日志输出格式 logging.pattern.console=%d{yyyy-MM-dd hh:mm:ss} [%thread] %-5level %logger{50} - %msg%n # 日志文件输出格式 logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} === - %msg%n
- 自定义日志配置:
在 Spring Boot
的配置文件 application.porperties/yml
中,可以对日志的一些默认配置进行修改,但这种方式只能修改个别的日志配置,想要修改更多的配置或者使用更高级的功能,则需要通过日志实现框架自己的配置文件进行配置。
Spring
官方提供了各个日志实现框架所需的配置文件,用户只要将指定的配置文件放置到项目的类路径下即可。
日志框架 |
配置文件 |
Logback |
logback-spring.xml、logback-spring.groovy、logback.xml、logback.groovy |
Log4j2 |
log4j2-spring.xml、log4j2.xml |
JUL (Java Util Logging) |
logging.properties |
新建logback
文件到resources
文件夹下,配置文件内容如下:
<?xml version="1.0" encoding="UTF-8"?> <!-- scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。 scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒当scan为true时,此属性生效。默认的时间间隔为1分钟。 debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 --> <configuration scan="false" scanPeriod="60 seconds" debug="false"> <!-- 定义日志的根目录 --> <property name="LOG_HOME" value="/logs/potato"/> <!-- 定义日志文件名称 --> <property name="APP_NAME" value="com.potato.webmarket"></property> <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 --> <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>--> <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread]**************** %-5level %logger{50} - %msg%n</pattern> </layout> </appender> <!-- 滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件 --> <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 指定日志文件的名称 --> <file>${LOG_HOME}/${appName}.log</file> <!-- 当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名 TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- 滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}:按天进行日志滚动 %i:当文件大小超过maxFileSize时,按照i进行文件滚动 --> <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern> <!-- 可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每天滚动, 且maxHistory是365,则只保存最近365天的文件,删除之前的旧文件。注意,删除旧文件是, 那些为了归档而创建的目录也会被删除。 --> <MaxHistory>365</MaxHistory> <!-- 当日志文件超过maxFileSize指定的大小是,根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的,必须配置timeBasedFileNamingAndTriggeringPolicy --> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>100MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> </rollingPolicy> <!-- 日志输出格式: --> <layout class="ch.qos.logback.classic.PatternLayout"> <pattern>%d{yyyy-MM-dd HH:mm:ss} [ %thread ] ------------------ [ %-5level ] [ %logger{50} : %line ] - %msg%n </pattern> </layout> </appender> <!-- logger主要用于存放日志对象,也可以定义日志类型、级别 name:表示匹配的logger类型前缀,也就是包的前半部分 level:要记录的日志级别,包括 TRACE < DEBUG < INFO < WARN < ERROR additivity:作用在于children-logger是否使用 rootLogger配置的appender进行输出, false:表示只用当前logger的appender-ref,true: 表示当前logger的appender-ref和rootLogger的appender-ref都有效 --> <!-- hibernate logger --> <logger name="com.potato.marketweb" level="info"/> <!-- Spring framework logger --> <logger name="org.springframework" level="info" additivity="false"></logger> <!-- root与logger是父子关系,没有特别定义则默认为root,任何一个类只会和一个logger对应, 要么是定义的logger,要么是root,判断的关键在于找到这个logger,然后判断这个logger的appender和level。 --> <root level="info"> <appender-ref ref="stdout"/> <!-- <appender-ref ref="appLogAppender"/>--> </root> </configuration>
- 切换底层日志实现框架:
将日志切换为Log4J2
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <exclusions> <!--排除logback--> <exclusion> <artifactId>spring-boot-starter-logging</artifactId> <groupId>org.springframework.boot</groupId> </exclusion> </exclusions> </dependency> <!-- 添加log4j2 依赖 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-log4j2</artifactId> </dependency>