什么是 Logback?
Logback 是日志框架 SLF4J 的一个实现,它被设计用来替代 log4j
。Logback 提供了更高的性能,更丰富的日志功能和更好的配置选项。
为什么要用它?
在 Spring Boot 中,Logback 是默认的日志实现,至于官方为何用它作为默认日志组件,有以下几个原因:
-
- 性能:Logback 在性能上超越了许多其他的日志实现,尤其是在高并发环境下。
-
- 灵活性:Logback 提供了高度灵活的日志配置方式,支持从 XML、Groovy 以及编程式的方式进行配置。
-
- 功能丰富:除了基本的日志功能,Logback 还提供了如日志归档、日志级别动态修改、事件监听等高级功能。
-
- 与 SLF4J 集成:SLF4J 是一个日志门面(facade),使得应用程序可以在运行时更换日志实现。Logback 作为 SLF4J 的一个原生实现,可以无缝地与其集成。
-
- 与 Spring Boot 的自动配置集成:Spring Boot 提供了对 Logback 的自动配置,这意味着开发者无需手动配置 Logback,只需提供一个简单的配置文件即可。
引入依赖
由于 Spring Boot 默认使用 Logback,所以当你在 pom.xml
中加入 spring-boot-starter-web
依赖时,它会自动包含 Logback 相关依赖,无需额外添加:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
配置文件我们统一放置在 xx-web
模块中,方便统一管理。然后在 src/main/resources
目录下,创建一个名为 logback-weblog.xml
的文件。
内容如下:
<?xml version="1.0" encoding="UTF-8"?>
<configuration >
<jmxConfigurator/>
<include resource="org/springframework/boot/logging/logback/defaults.xml" />
<!-- 应用名称 -->
<property scope="context" name="appName" value="weblog" />
<!-- 自定义日志输出路径,以及日志名称前缀 -->
<property name="LOG_FILE" value="/app/weblog/logs/${appName}.%d{yyyy-MM-dd}"/>
<property name="FILE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n"/>
<!--<property name="CONSOLE_LOG_PATTERN" value="${FILE_LOG_PATTERN}"/>-->
<!-- 按照每天生成日志文件 -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 日志文件输出的文件名 -->
<FileNamePattern>${LOG_FILE}-%i.log</FileNamePattern>
<!-- 日志文件保留天数 -->
<MaxHistory>30</MaxHistory>
<!-- 日志文件最大的大小 -->
<TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>10MB</maxFileSize>
</TimeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!-- 格式化输出:%d 表示日期,%thread 表示线程名,%-5level:级别从左显示 5 个字符宽度 %errorMessage:日志消息,%n 是换行符-->
<pattern>${FILE_LOG_PATTERN}</pattern>
</encoder>
</appender>
<!-- dev 环境(仅输出到控制台) -->
<springProfile name="dev">
<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
<root level="info">
<appender-ref ref="CONSOLE" />
</root>
</springProfile>
<!-- prod 环境(仅输出到文件中) -->
<springProfile name="prod">
<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
<root level="INFO">
<appender-ref ref="FILE" />
</root>
</springProfile>
</configuration>
因为打印日志到文件只需要在生产环境开启就行了,所以,使日志生效的配置放到 application-prod.yml
文件中就行了:
#=================================================================
# log 日志
#=================================================================
logging:
config: classpath:logback-weblog.xml
打印日志
为了测试一下日志是否能够正常打印,我们在单元测试包下的 xxWebApplicationTests
类中:
新建一个 testLog()
测试方法,同时添加 Lombok 的 @Slf4j
日志注解,它可以帮助我们自动的生成日志实例,示例代码如下:
package com.example.xx.web;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
@Slf4j
class xxWebApplicationTests {
@Test
void contextLoads() {
}
@Test
void testLog() {
log.info("这是一行 Info 级别日志");
log.warn("这是一行 Warn 级别日志");
log.error("这是一行 Error 级别日志");
// 占位符
String author = "闫小生";
log.info("这是一行带有占位符日志,作者:{}", author);
}
}
控制台日志
运行该测试方法,若控制台日志输出如下,表示日志组件运行正常运行,在后续的功能开发中,我们会频繁地使用到它:
日志输出到文件中
接下来,我们再验证一下生产环境是否能够使文件输出到文件中。先将 application.yml
的环境改为 prod
,一旦激活 prod
, 则日志将被输出到文件中:
spring:
profiles:
# 默认激活 dev 环境
active: prod
因为小生用的 Windows 系统做的演示,还需要修改 logback-weblog.xml
, 将日志输出路径自定义为 Windows 路径:
测试完成后,记得将 profile
重新改回 dev
环境,以及路径改回 Linux 格式路径。