Spring Boot 2.x的默认日志管理与 Logback 配置详解

时间：2022-02-08 00:11:20

Spring Boot 2.x的默认日志管理与 Logback 配置详解

Spring Boot在所有内部日志中使用Commons Logging，但是对底层日志的实现是开放的。在Spring Boot生态中，为Java Util Logging 、Log4J2 和Logback 这些常见的日志框架都提供了自动化配置组件，每种Logger都可以通过配置在控制台或者文件中输出日志内容。默认情况下，当我们使用各种Starter的时候，会使用Logback来实现日志管理。

如何记日志

在介绍写日志的方式有很多，这里就不对各种方式做罗列了，只讲DD用得最多的方式!

首先，在代码层面，我们不纠结到底用默认的Logback还是Log4j，而是直接用：Slf4j。

为什么不用管具体用Logback还是Log4j就可以去写代码呢?这个就是使用Slf4j好处!那么什么是Slf4j?英文全称：Simple Logging Facade for Java，即：简单日志门面，它并不是一个具体的日志解决方案，实际工作的还是Logback或Log4j这样的日志框架。Slf4j是23种设计模式中门面模式的典型应用案例，通过Slf4j这样一个门面的抽象，让我们在写代码的记录日志的时候，只依赖这个抽象的操作，而具体实现会在Slf4j门面调用的时候委托给具体的实现日志记录的框架。

比如：下面的就是一个简单的使用Slf4j记录日志例子：

  1. @Slf4j
  2. @SpringBootApplication
  3. public class Application {
  5. public static void main(String[] args) {
  6. SpringApplication.run(Application.class, args);
  8. log.error("Hello World");
  9. log.warn("Hello World");
  10. log.info("Hello World");
  11. log.debug("Hello World");
  12. log.trace("Hello World");
  13. }
  15. }

注意：这里我们通过在pom.xml中引入了Lombok，然后使用@Slf4j声明引入Slf4j的log日志记录对象，之后就可以轻松的用它来日志了。而这个日志具体是如何写到控制台或者文件的，则有Spring Boot项目中引入了什么具体的日志框架决定，默认情况下就是Logback。

日志元素

启动任意一个Spring Boot项目，我们都可以在控制台看到很多日志信息，比如下面这样的一条日志：

Spring Boot 2.x的默认日志管理与 Logback 配置详解

日志的输出内容中一共有7种元素，具体如下：

  • 时间日期：精确到毫秒
  • 日志级别：ERROR, WARN, INFO, DEBUG or TRACE
  • 进程ID
  • 分隔符：--- 标识实际日志的开始
  • 线程名：方括号括起来(可能会截断控制台输出)
  • Logger名：通常使用源代码的类名
  • 日志内容

日志输出

在Spring Boot应用中，日志会默认会输出到控制台中，默认的输出日志级别包含：ERROR、WARN和INFO，我们可以帮上面写的Hello World例子跑起来，就可以验证这样的默认设定：

  1. 2021-12-28 17:37:25.578 INFO 65136 --- [ main] com.didispace.chapter81.Application : Started Application in 2.695 seconds (JVM running for 3.957)
  2. 2021-12-28 17:37:25.579 ERROR 65136 --- [ main] com.didispace.chapter81.Application : Hello World
  3. 2021-12-28 17:37:25.579 WARN 65136 --- [ main] com.didispace.chapter81.Application : Hello World
  4. 2021-12-28 17:37:25.579 INFO 65136 --- [ main] com.didispace.chapter81.Application : Hello World

开启DEBUG日志

我们可以通过两种方式切换至DEBUG级别：

第一种：在运行命令后加入--debug标志，如：$ java -jar myapp.jar --debug

第二种：在配置文件application.properties中配置debug=true

这里开启的DEBUG日志，仅影响核心Logger，包含嵌入式容器、hibernate、spring等这些框架层面的会输出更多内容，但是你自己应用的日志并不会输出为DEBUG级别，从下面的截图中我们就可以看到，我们自己编写的debug级别的Hello World并没有输出。

Spring Boot 2.x的默认日志管理与 Logback 配置详解

日志配置

下面介绍一些常用的日志配置，以帮助我们更好的管理好日志内容。

多彩输出

如果你的终端支持ANSI，设置彩色输出会让日志更具可读性。通过在application.properties中设置spring.output.ansi.enabled参数来支持，该参数有三个选项：

  • NEVER：禁用ANSI-colored输出
  • DETECT：会检查终端是否支持ANSI，是的话就采用彩色输出(默认项)
  • ALWAYS：总是使用ANSI-colored格式输出，若终端不支持的时候，会有很多干扰信息，不推荐使用

注意：Spring Boot 1.x的时候，默认值为NEVER，2.x之后默认为DETECT，所以看我们上面的截图，默认就已经带有颜色了。所以如果是Spring Boot 2.x版本用户的话，这个基本就不用去修改了。

文件输出

Spring Boot默认配置只会输出到控制台，并不会记录到文件中，但是我们通常生产环境使用时都需要以文件方式记录。

若要增加文件输出，需要在配置文件application.properties配置几个参数，比如这样：

  1. logging.file.name=run.log
  2. logging.file.path=./
  • logging.file.name：设置文件名
  • logging.file.path：设置文件路径

注意：这里跟1.x版本有区别，1.x的时候分别对应的参数为logging.file和logging.path。

文件滚动

一直把日志输出在一个文件里显然是不合适的，任何一个日志框架都会为此准备日志文件的滚动配置。由于本篇将默认配置，所以就是Logback的配置，具体有这几个：

  • logging.logback.rollingpolicy.file-name-pattern：用于创建日志档案的文件名模式。
  • logging.logback.rollingpolicy.clean-history-on-start：应用程序启动时是否对进行日志归档清理，默认为false，不清理
  • logging.logback.rollingpolicy.max-history：要保留的最大归档日志文件数量，默认为7个
  • logging.logback.rollingpolicy.max-file-size：归档前日志文件的最大尺寸，默认为10MB
  • logging.logback.rollingpolicy.total-size-cap：日志档案在被删除前的最大容量，默认为0B

级别控制

如果要对各个Logger做一些简单的输出级别控制，那么只需要在application.properties中进行配置就能完成。

配置格式：logging.level.*=LEVEL

  • logging.level：日志级别控制前缀，*为包名或Logger名
  • LEVEL：选项TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

举例：

  • logging.level.com.didispace=DEBUG：com.didispace包下所有class以DEBUG级别输出
  • logging.level.root=WARN：root日志以WARN级别输出

做了这样的配置之后，可以再执行下上面的程序，原本debug级别的Hello World就可以被成功输出了。

Spring Boot 2.x的默认日志管理与 Logback 配置详解

logging.level.com.didispace=DEBUG

自定义日志配置

由于日志服务一般都在ApplicationContext创建前就初始化了，它并不是必须通过Spring的配置文件控制。因此通过系统属性和传统的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。

根据不同的日志系统，你可以按如下规则组织配置文件名，就能被正确加载：

  • Logback：logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
  • Log4j2：log4j2-spring.xml, log4j2.xml
  • JDK (Java Util Logging)：logging.properties

Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置(如使用logback-spring.xml，而不是logback.xml)

自定义输出格式

在Spring Boot中可以通过在application.properties配置如下参数控制输出格式：

  • logging.pattern.console：定义输出到控制台的样式(不支持JDK Logger)
  • logging.pattern.file：定义输出到文件的样式(不支持JDK Logger)

本文的完整工程可以查看下面仓库中2.x目录下的chapter8-1工程：

Github：https://github.com/dyc87112/SpringBoot-Learning/

Gitee：https://gitee.com/didispace/SpringBoot-Learning/

原文链接：https://mp.weixin.qq.com/s/gLivH-db7rqJefbcB2EkPQ

标签：

相关文章