Spring Boot 默认日志使用

前言

日志框架有很多种，但常用的日志框架是这三种： Log4j，Log4j2，Logback，简单介绍下它们的关系：

Log4j 是作者 Ceki 最早在 1999 年发布的，在2015 年宣布终止。
Log4j 被 Apache 收入门下后，它的作者后来又开发了 sl4j(sl4j 是日志的抽象层，提供了简单统一的接口) 和 Logback（在 log4j 基础上进行了改进）
Apache 后在又在 logback 基础上进行改进，在 2014 年推出了 log4j2

Log4j，Log4j2，Logback 这 3 种日志框架都对 sl4j 提供了实现支持，关于它们之间的性能对比，可以参考这篇文章：https://bbs.huaweicloud.com/blogs/103530，这里就不展开赘述了。

Spring Boot 默认日志

Spring Boot 的日志支持依赖是 spring-boot-starter-logging，默认使用slf4j+logback的方式来记录日志。

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

启动项目, 在控制台中可看到 spring boot 默认打印出的启动日志，不过默认的打印级别为 INFO

1.png

默认日志级别

Logback 支持 TRACE, DEBUG, INFO, WARN, ERROR 日志级别，优先级关系为 TRACE < DEBUG < INFO < WARN < ERROR , 我们可以在 application 配置文件中更改打印日志级别

# Log level config
logging.level.root=DEBUG

在测试方法中打印一下级别：

package top.yekongle.logging;

import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class SpringbootLoggingSampleApplicationTests {
    private static final Logger logger = LoggerFactory.getLogger(SpringbootLoggingSampleApplicationTests.class);

    @Test
    void contextLoads() {
        logger.debug("debug日志");

        logger.info("info日志");

        logger.warn("warn日志");

        logger.error("error日志");
    }

}

2.png

还可以指定包的日志级别

logging.level.org.springframework=INFO

日志格式

使用属性 logging.pattern.console 和 logging.pattern.file 可以分别自定义控制台日志和文件日志的格式

#控制台显示日志的格式
logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{5}- %msg%n

#文件显示日志的格式
logging.pattern.file=%d{yyyy-MM-dd HH:mm} [%thread] %-5level %logger- %msg%n

再次运行测试方法，可见日志打印格式已经变为自定义的格式

3.png

上面用的一些标签含义如下：

%d：日期实践
%thread：线程名
%-5level：级别从左显示5个字符宽度
%logger{5}：表示logger名字最长5个字符，否则按照句点分割。
%msg：日志消息
%n：换行

保存日志

logging.path 可以指定日志保存目录，但不能指定输出的文件名，且默认名为spring.log

logging.path=F:/logs/
logging.pattern.file=%d{yyyy-MM-dd HH:mm} [%thread] %-5level %logger- %msg%n

4.png

logging.file.name 可以指定目录和输出文件名

logging.file.name=F:/logs/info.log
logging.pattern.file=%d{yyyy-MM-dd HH:mm} [%thread] %-5level %logger- %msg%n

5.png

其他一些相关属性：

# 当文件超过 10Mb 时，归档压缩
logging.file.max-size=10Mb
# 日志文件最多保存3天
logging.file.max-history=3
# 用于滚动的日志文件名的模式
logging.pattern.rolling-file-name=${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz

项目已上传至 Github: https://github.com/yekongle/springboot-code-samples/tree/master/springboot-logging-sample , 希望对小伙伴们有帮助哦。