当前位置：首页 > news >正文

logback日志使用

news 2026/3/26 18:07:56

Spring Boot默认就使用Logback作为日志框架。你只需要做一些基础配置，就可以快速实现日志从控制台输出、保存到文件，甚至按日期或大小自动切割归档。

Spring Boot的起步依赖（如spring-boot-starter-web）已经自动包含了spring-boot-starter-logging，它会把Logback以及相关的SLF4J接口都带进来。所以，通常情况下，你不需要在pom.xml中专门为Logback添加任何依赖。

一、引入依赖

为了更方便地在代码中记录日志，建议你添加Lombok依赖：

<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional>
</dependency>

二、创建配置文件

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false"><!-- 定义一些常用变量，方便后面引用 --><property name="log.path" value="./logs" /><property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" /><!-- 从Spring配置中读取应用名 --><springProperty scope="context" name="APP_NAME" source="spring.application.name" defaultValue="app"/><!-- 1. 控制台输出 --><appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"><encoder><!-- 控制台可以使用彩色日志（需要IDE或终端支持） --><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %green([%thread]) %highlight(%-5level) %cyan(%logger{36}) - %msg%n</pattern><charset>UTF-8</charset></encoder></appender><!-- 2. 文件输出：使用RollingFileAppender实现滚动记录 --><appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"><!-- 当前正在写入的日志文件 --><file>${log.path}/${APP_NAME}.log</file><!-- 滚动策略：基于时间和文件大小 --><rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"><!-- 归档文件的命名格式：按日期和索引 --><fileNamePattern>${log.path}/archive/${APP_NAME}-v${APP_VERSION}.%d{yyyy-MM-dd}.%i.log.gz</fileNamePattern><!-- 单个日志文件最大大小 --><maxFileSize>10MB</maxFileSize><!-- 最多保留30天的日志文件 --><maxHistory>30</maxHistory><!-- 所有归档日志的总大小上限 --><totalSizeCap>1GB</totalSizeCap></rollingPolicy><encoder><pattern>${log.pattern}</pattern><charset>UTF-8</charset></encoder></appender><!-- 根日志级别，关联上面定义的两个appender --><root level="INFO"><appender-ref ref="CONSOLE" /><appender-ref ref="FILE" /></root><!-- 为特定包指定日志级别，方便调试，可以不要 --><logger name="com.example.yourpackage" level="DEBUG" additivity="false"><appender-ref ref="FILE" /></logger>
</configuration>

三、代码中使用

@RestController
@Slf4j
@Api(value = "用户管理", description = "用户管理API")
public class UserController {@GetMapping("/test")public String testLog() {log.trace("======= Trace");log.debug("======= Debug");log.info("======= Info");log.warn("======= Warn");log.error("======= Error");return "日志已打印，请检查控制台和日志文件。";}}

四、查看效果