Spring Boot日志配置详解

我们知道日志对于系统监控、故障定位非常重要，比如当生产系统发生问题时，完整清晰的日志记录有助于快速定位问题。

接下来介绍 Spring Boot 对日志的支持。

Spring Boot日志简介

Spring Boot 自带 spring-boot-starter-logging 库实现系统日志功能，spring-boot-starter-logging 组件默认使用 LogBack 日志记录工具。系统运行日志默认输出到控制台，也能输出到文件中。

下面通过示例来演示 Spring Boot 项目配置日志的功能。

1) 修改 pom.xml 文件，添加 spring-boot-starter-logging 依赖。

<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>

启动项目，查看控制台的日志输出情况，如下图所示：


在默认情况下，Spring Boot 会用 LogBack 来记录日志，并用 INFO 级别输出到控制台。运行应用程序，可以看到很多 INFO 级别的日志。

配置日志格式

在 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 控制台启动日志的格式已经改成配置的格式。

日志输出级别

一般而言，系统的日志级别为：

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("LogDemoerror日志...");
        return "hello log";
    }
}

在上面的示例中，针对每个日志级别输出了一行日志。我们可以调整输出的日志级别，让其只在该级别以后的高级别生效。

然后，配置日志输出级别，在 application.properties 中添加如下配置：

logging.level.root=warn

在上面的示例中，使用 logging.level.root 指定整个项目的日志级别为 WARN。当然，我们也可以对某个包指定单独的日志级别，例如：

logging.level.root=INFO
logging.level.com.weiz.example01.log=WARN

在上面的配置示例，我们将整个项目的日志级别设置为 INFO，同时将指定包 com.weiz.example01 下的日志级别设置为 WARN。

最后，启动项目验证日志的输出情况，如下图所示。


如图 3 所示，Spring Boot 控制台输出的系统启动日志为 INFO 级别，而 com.weiz.example01.log 下 LogDemo 的日志级别设置为 WARN，输出了 WARN、INFO 和 ERROR 的日志。

保存日志文件

一般情况下，在开发环境中习惯通过控制台查看日志，但是生产环境中需要将日志信息保存到磁盘上，以便于日后的日志查询。应该如何配置才能将日志信息保存到日志文件内呢？下面演示保存日志文件的过程。

在 resources 目录下的 application.properties 配置文件中添加如下配置项：

logging.file.name=D:/var/log/spring_log.log

重新启动项目，可以看到在 D:/var/log 目录下生成了 spring_log.log 文件，该文件的内容和控制台打印输出的内容一致，如图 4 所示。


声明：《Java系列教程》为本站“54笨鸟”官方原创，由国家机构和地方版权局所签发的权威证书所保护。