SpringBoot 2.7.12使用 Logback 日志
SpringBoot 默认使用 Logback 日志
查看 SpringBoot 的文档,默认使用的是日志架构是 Logback。SpringBoot Logging 配置
环境搭建
pom.xml 文件
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.12</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<dependencies>
<!--web 模块-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 热部署-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<!-- lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<!--单元测试-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
Logback 配置方式
在没有配置文件的时候,使用 Logback 默认的配置,日志信息会输出到控制台内。
用户自定义配置的两种方式:
方式一 application.yml
在 application.yml
文件中使用 logging
属性进行配置。可参考 SpringBoot Logging 配置
方式二 xml文件
使用 xml
文件形式进行配置。当 src/main/resources
目录下有以下配置文件的名称之一时,SpringBoot 就会自动加载用作 Logback 的配置项。SpringBoot 建议使用 -spring
结尾的文件
- logback-spring.xml
- logback.xml
- logback-spring.groovy
- logback.groovy
Logback xml 文件方式
配置文件
在 src/main/resources
下新建 logback-spring.xml
文件
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<include resource="org/springframework/boot/logging/logback/defaults.xml" />
<!-- 定义日志文件名称 -->
<property name="APP_NAME" value="spring-boot-logback-test"/>
<!-- 定义日志文件的路径,user.dir 当前项目路径,也可以自定义其他路径,如 D:\\ -->
<property name="LOG_PATH" value="${user.dir}/logs" />
<!-- 定义日志的文件名 -->
<property name="LOG_FILE" value="${LOG_PATH}/${APP_NAME}.log" />
<!-- 滚动记录日志,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件 -->
<appender name="APPLICATION" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 指定日志文件的名称 -->
<file>${LOG_FILE}</file>
<!-- 日志编码 -->
<encoder>
<pattern>
%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger - %msg%n
</pattern>
</encoder>
<!--
当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名
TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责触发滚动。
-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--
滚动时产生的文件的存放位置及文件名称
%d{yyyy-MM-dd}:按天进行日志滚动
%i:当文件大小超过maxFileSize时,按照i进行文件滚动
-->
<fileNamePattern>${LOG_FILE}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<!--
可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每天滚动,
且maxHistory是7,则只保存最近7天的文件,删除之前的旧文件。
注意,删除旧文件时,那些为了归档而创建的目录也会被删除。
-->
<maxHistory>7</maxHistory>
<!--
当日志文件超过maxFileSize指定的大小时,根据上面提到的%i进行日志文件滚动
注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的,
必须配置timeBasedFileNamingAndTriggeringPolicy
-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>50MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
</appender>
<!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<!--
日志输出格式:
%d表示日期时间,%green 绿色
%thread表示线程名,%magenta 洋红色
%-5level:级别从左显示5个字符宽度 %highlight 高亮色
%logger{36} 表示logger名字最长36个字符,否则按照句点分割 %yellow 黄色
%msg:日志消息
%n是换行符
-->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%green(%d{yyyy-MM-dd HH:mm:ss.SSS}) [%magenta(%thread)] %highlight(%-5level) %yellow(%logger{36}): %msg%n</pattern>
</layout>
</appender>
<!--
root与logger是父子关系,没有特别定义则默认为root,任何一个类只会和一个logger对应,
要么是定义的logger,要么是root,判断的关键在于找到这个logger,然后判断这个logger的appender和level。
-->
<root level="info">
<appender-ref ref="CONSOLE" />
<appender-ref ref="APPLICATION" />
</root>
</configuration>
启动项目
启动项目,刷新项目列表,在项目根目录下会新增一个 logs 文件夹,用于存储生成的 log 日志文件
日志记录
两种方式记录
- 在类中声明静态变量
Logger
对象
public class LogbackTest {
private static Logger logger = LoggerFactory.getLogger(LogbackTest.class);
public static void main(String[] args) {
logger.info("使用静态变量 Logger 打印日志消息");
}
}
- 使用
lombok
的@Slf4j
标签,需要在 pom.xml 文件中引入lombok
。
@Slf4j
public class LogbackTest {
public static void main(String[] args) {
log.info("使用 @Slf4j 打印日志");
}
}
lombok 会帮我们声明一个 log 变量