日志配置
日志对于系统监控、故障定位非常重要,比如当生产系统发生问题时,完整清晰的日志记录有助于快速定位问题。接下来介绍Spring Boot对日志的支持。
1.Spring Boot日志简介
Spring Boot自带spring-boot-starter-logging库实现系统日志功能,spring-boot-starter-logging组件默认使用LogBack日志记录工具。系统运行日志默认输出到控制台,也能输出到文件中。下面通过示例来演示Spring Boot项目配置日志的功能。
修改pom.xml文件,添加spring-boot-starter-logging依赖。
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
启动项目,查看控制台的日志输出情况,如图所示。
在默认情况下,Spring Boot会用LogBack来记录日志,并用INFO级别输出到控制台。运行应用程序,可以看到很多INFO级别的日志。
2.配置日志格式
在Spring Boot项目中配置日志功能之后,如何定制自己的日志格式、自定义记录的信息呢?Spring Boot提供了logging.pattern.console和logging.pattern.file配置项来定制日志输出格式,只需在application.properties文件中添加logging.pattern.console的配置项即可:
logging.pattern.console=%d{yyyy-MM-dd-HH:mm:ss} [%thread] %-5level %logger- %msg%n
logging.pattern.file=%d{yyyy-MM-dd-HH:mm} [%thread] %-5level %logger- %msg%n
上述配置的示例中,对应符号的含义如下:
- %d{HH:mm:ss.SSS}:日志输出时间。
- %thread:输出日志的进程名,这在Web应用以及异步任务处理中很有用。
- %-5level:日志级别,使用5个字符靠左对齐。
- %logger-:日志输出者的名称。
- %msg:日志消息。
- %n:平台的换行符。
修改完配置项再重启项目,查看控制台的日志输出情况,如图所示。
Spring Boot控制台启动日志的格式已经改成配置的格式。
3.日志输出级别
一般而言,系统的日志级别为TRACE < DEBUG < INFO < WARN < ERROR <FATAL,级别逐渐提高。如果日志级别设置为INFO,则意味着TRACE和DEBUG级别的日志都不会输出。
Spring Boot通过logging.level配置项来设置日志输出级别,下面通过示例演示Spring Boot日志输出级别。
首先,添加Log级别测试类LogDemo,示例代码如下:
@Configuration
public class LogDemo {
Logger logger = LoggerFactory.getLogger(getClass());
@Bean
public String logMethod() {
// 从trace到error日志级别由低到高
// 可以调整输出的日志级别,日志就只会在这个级别后的高级别生效
logger.trace("LogDemo trace日志...");
logger.debug("LogDemo debug日志...");
// Spring Boot默认使用的是info级别,没有指定级别就用Spring Boot默认规定的级别,即root级别
logger.info("LogDemo info日志...");
logger.warn("LogDemo warn日志...");
logger.error("LogDemo error日志...");
return "hello log";
}
}
在上面的示例中,针对每个日志级别输出了一行日志。我们可以调整输出的日志级别,让其只在该级别以后的高级别生效。
然后,配置日志输出级别,在application.properties中添加如下配置:
logging.level.root=warn
在上面的示例中,使用logging.level.root指定整个项目的日志级别为WARN。当然,我们也可以对某个包指定单独的日志级别,例如:
logging.level.root=INFO
logging.level.com.lxml.demo.log=WAEN
在上面的配置示例,我们将整个项目的日志级别设置为INFO,同时将指定包com.lxml.demo下的日志级别设置为WARN。
Spring Boot控制台输出的系统启动日志为INFO级别,而com.lxml.demo.log下LogDemo的日志级别设置为WARN,输出了WARN、INFO和ERROR的日志。
4.保存日志文件
一般情况下,在开发环境中习惯通过控制台查看日志,但是生产环境中需要将日志信息保存到磁盘上,以便于日后的日志查询。应该如何配置才能将日志信息保存到日志文件内呢?下面演示保存日志文件的过程。
在resources目录下的application.properties配置文件中添加如下配置项:
logging.file.name=D:/02Project-list/log/spring_log.log
重新启动项目,可以看到在D:/02Project-list/log/目录下生成了spring_log.log文件,该文件的内容和控制台打印输出的内容一致,如图所示。