【SpringBoot】springboot日志配置

4. 日志配置

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

1. 引入日志

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

在pom.xml文件中添加spring-boot-starter-logging依赖，启动项目后查看控制台的日志输出情况。

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

在默认情况下，Spring Boot会用LogBack来记录日志，并用INFO级别输出到控制台。

在Spring Boot项目中配置日志功能之后，我们可以指定自定义格式。

Spring Boot提供了logging.pattern.console和logging.pattern.file配置项来定制日志输出格式，只需要在application.properties文件中添加logging.patten.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:ss} [%thread] %-5level %logger- %msg%n

• %d{HH:mm:ss.SSS}：日志输出时间。
• %thread：输出日志的进程名，这在Web应用以及异步任务处理中很有用。
• %-5level：日志级别，使用5个字符靠左对齐。
• %logger-：日志输出者的名称。
• %msg：日志消息。
• %n：平台的换行符。

我们发现，Spring Boot 控制台启动日志的格式已经改成配置的格式。

2. 日志输出级别

一般而言，系统的日志级别为TRACE < DEBUG < INFO < WARN < ERROR <FATAL，级别逐渐提高。如果日志级别设置为INFO，则意味着TRACE和DEBUG级别的日志都不会输出。

Spring Boot通过logging.level配置项来设置日志输出级别。

首先，添加Log级别测试类LogDemoConfig文件

@Configuration
public class LogDemoConfig {
    Logger logger = LoggerFactory.getLogger(getClass());

    @Bean
    public String logMethod(){
        // 从trace到error日志级别由低到高
        // 可以调整输出的日志级别，日志就只会在这个级别后的高级别生效
        logger.trace("LogDemoConfig trace日志...");
        logger.debug("LogDemoConfig debug日志...");

        logger.info("LogDemoConfig info日志...");
        logger.warn("LogDemoConfig warn日志...");
        logger.error("LogDemoConfig error日志...");
        return "hello log";
    }
}

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

我们在application.properties中添加如下配置。

# 指定整个项目的日志级别为warn
logging.level.root=info
# 对某个包指定单独的日志级别
logging.level.com.jingt.helloworld.config.LogDemoConfig=warn

在上面中，将整个项目的日志级别设置为INFO，LogDemoConfig文件设置为warn，然后运行。

我们发现控制台输出的系统启动日志为INFO级别，LogDemoConfig的日志级别设置为WARN。

3. 保存日志文件

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

我们在resource目录下的application.properties配置文件中添加配置信息。

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

我们重启项目，可以发现在D:/var/log 目录下有spring_log.log文件。