---
category:
- Java企业级开发
tag:
- Spring Boot
- Redis
title: Spring Boot 整合 Logback 定制日志框架
---
## 关于 Logback
日志系统是一个线上项目必备的素质之一，代表性的日志框架 Log4j、SLF4J、Logback 这哥仨竟然是亲兄弟，他们有一个亲爹，那就是巨佬 Ceki Gulcu。
由于 Spring Boot 的默认日志框架选用的 Logback，再加上 Log4j2 之前爆过严重的漏洞，所以我们这次就只关注 Logback。
1）Logback 非常自然地实现了 SLF4J，不需要像 Log4j 和 JUL 那样加一个适配层。
2）Spring Boot 的默认日志框架使用的是 Logback，启动编程喵项目的时候就可以看到 Logback 记录的日志了。
怎么看出来是 logback 呢？
说实话，看不出来，哈哈哈，不过可以从 Spring Boot 官网找到证据。
还有，通过源码也可以窥见一二。
3）logback 分为三个模块：
- logback-core，核心模块，提供了关键的通用机制；
- logback-classic，可以看作是 log4j 的改进版，实现了简单的日志门面 SLF4J；
- logback-access，主要用来和 Servlet 容器交互，比如说 Tomcat，提供了一些 HTTP 访问的功能。
如果想研究 logback 源码的话，可以按照这三个模块去研究。
## 直接上手
不废话，直接新建一个空的 Spring Boot 项目，在测试类中加上两行代码。
```java
@SpringBootTest
class CodingmoreLogbackApplicationTests {
static Logger logger = LoggerFactory.getLogger(CodingmoreLogbackApplicationTests.class);
@Test
void contextLoads() {
logger.info("logback testing");
}
}
```
Logger 和 LoggerFactory 都来自 SLF4J，所以如果项目是从 Log4j + SLF4J 切换到 Logback 的话，此时的代码是零改动的。
其他什么也不用做，运行后就可以看到 logback 已经正常工作了。
在没有配置文件的情况下，一切都是默认的，Logback 的日志信息会输出到控制台。可以通过 StatusPrinter 来打印 Logback 的内部信息：
```java
LoggerContext lc = (LoggerContext)LoggerFactory.getILoggerFactory();
StatusPrinter.print(lc);
```
再次运行测试类，可以在控制台看到以下信息：
也就是说，Logback 会在 classpath 路径下先寻找 logback-test.xml 文件，没有找到的话，寻找 logback.xml 文件，都找不到的话，就输出到控制台。
并且，Logger 的默认日志级别是 INFO 级别的，这就意味着如果尝试下面的代码：
```java
logger.debug("沉默王二是傻 X");
```
控制台是看不到这行日志输出的。Logback 的日志级别是这样的：
>TRACE < DEBUG < INFO < WARN < ERROR
也就是说小于 INFO 级别的日志都不会记录，只有大于等于 INFO 级别的日志才会被记录。
## 编程喵实战项目的日志案例分析
尽管默认配置很有用，但它很可能不能满足我们的实际开发需求，于是我们需要找到一种更优雅的解决方案。
当 `src/main/resources` 目录下有以下名称之一的配置文件时，Spring Boot 将自动加载它来作为 Logback 的配置项：
- logback-spring.xml
- logback.xml
- logback-spring.groovy
- logback.groovy
Spring Boot 建议我们使用 `-spring` 结尾的配置文件，这样可以使用 Spring Boot 的 Profile 功能（针对不同的环境（开发环境、测试环境、正式环境）提供不同的配置项）。
编程喵用的是 logback-spring.xml（在 codingmore-admin 项目下可以找得到）：
```
${LOG_FILE}
${LOG_FILE}.%d{yyyy-MM-dd}.%i.log
7
50MB
%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n
%green(%d{yyyy-MM-dd HH:mm:ss.SSS}) [%magenta(%thread)] %highlight(%-5level) %yellow(%logger{36}): %msg%n
```
具体含义都写在了注释里，大家可以细致看一下，了解即可。基本上生产环境下的 Logback 配置就是这样的，可微调。
也可以使用下面这份 logback-spring.xml。
```
${LOG_FILE}
${FILE_LOG_PATTERN}
${LOG_FILE}.%d{yyyy-MM-dd}.%i.log
7
50MB
2GB
${CONSOLE_LOG_PATTERN}
utf8
```
只说几个不同的点。
`FILE_LOG_PATTERN` 和 `CONSOLE_LOG_PATTERN` 是在 Spring Boot 中默认定义的。
>[https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/logback/DefaultLogbackConfiguration.java](https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/logback/DefaultLogbackConfiguration.java)
SizeAndTimeBasedRollingPolicy 比 TimeBasedRollingPolicy 多了一个日志文件大小设定的属性：maxFileSize，其他完全一样。
totalSizeCap，所有日志文件的大小（可选项）。超出这个大小时，旧的日志文件将会被异步删除。需要配合 maxHistory 属性一起使用，并且是第二条件。
在Intellij IDEA 中启动项目，我们来查看一下配置后的日志效果（控制台中）。
由于我们加了颜色配置，所以控制台日志看起来对眼睛更友好了一些。
那配置的日志文件在哪里呢？在 `user.home` 下，如果不确定具体值是什么的话，可以通过 `System.getProperty("user.home")` 获取到。
顺着这个路径就可以找到生成的日志文件了，并且日志的生成策略也是符合我们的预期的。
## 使用 lombok 进行日志记录
在上面的例子中，我们必须在类中声明一个静态的 Logger 对象才能在需要记录日志的地方使用它。
```java
static Logger logger = LoggerFactory.getLogger(CodingmoreLogbackApplicationTests.class);
```
这样的样板代码令人生厌！
我们可以通过 lombok 的方式来解决这个问题，在 pom.xml 文件中加入依赖。
```
org.projectlombok
lombok
```
然后在类上加上 `@Slf4j` 注解，之后就可以直接使用 log（添加`@Slf4j` 注解后会自动添加一个 log 字段）来记录日志了。
```
@SpringBootTest
@Slf4j
class CodingmoreLogbackApplicationTests {
@Test
void testSlf4j() {
log.info("沉默王二是个大煞笔");
}
}
```
----
更多内容，只针对《二哥的Java进阶之路》星球用户开放，需要的小伙伴可以[戳链接🔗](https://javabetter.cn/zhishixingqiu/)加入我们的星球，一起学习，一起卷。。**编程喵**🐱是一个 Spring Boot+Vue 的前后端分离项目，融合了市面上绝大多数流行的技术要点。通过学习实战项目，你可以将所学的知识通过实践进行检验、你可以拓宽自己的技术边界，你可以掌握一个真正的实战项目是如何从 0 到 1 的。
----
## 源码路径
> - 编程喵：[https://github.com/itwanger/coding-more](https://github.com/itwanger/coding-more)
> - Logback 详细配置专用：[https://github.com/itwanger/coding-more](https://github.com/itwanger/codingmore-learning/tree/main/codingmore-logback)
