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

在spring boot中使用Logback

news 2025/6/21 11:44:01

在 Spring Boot 中使用 Logback 作为日志框架是开发中的常见需求，因其高性能和灵活配置而广受青睐。以下是详细实践指南，结合了配置方法、代码示例及最佳实践：

🔧 一、依赖配置

Spring Boot 默认集成了 Logback，无需手动添加依赖：

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId> <!-- 默认包含 logging 模块 -->
</dependency>

若需切换至 Log4j2，需排除默认日志依赖并引入 Log4j2：

更多配置细节可参考：Spring Boot 日志系统配置（上）、Logback 配置文件详解。

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><exclusions><exclusion><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId></exclusion></exclusions>
</dependency>
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

⚙️ 二、配置方式

1. 基础配置（application.yml/properties）

适用于简单场景，如设置日志级别和输出路径：

logging:level:root: INFOcom.example.service: DEBUG  # 包级自定义日志级别file:name: logs/app.log         # 指定日志文件路径pattern:console: "%d{yyyy-MM-dd} [%thread] %-5level %logger{36} - %msg%n"

注意：logging.file.name 和 logging.file.path 不可同时使用。

2. 高级配置（logback-spring.xml）

创建 src/main/resources/logback-spring.xml，支持复杂策略如滚动日志、环境隔离：

<configuration><!-- 动态读取 Spring 应用名 --><springProperty name="app.name" source="spring.application.name" default="app"/><property name="LOG_PATH" value="./logs/${app.name}"/><!-- 控制台输出 --><appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"><encoder><pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %highlight(%-5level) %cyan(%logger{36}) - %msg%n</pattern></encoder></appender><!-- 按天滚动日志文件 --><appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${LOG_PATH}/app.log</file><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><fileNamePattern>${LOG_PATH}/app-%d{yyyy-MM-dd}.%i.log</fileNamePattern><maxHistory>30</maxHistory> <!-- 保留30天 --><maxFileSize>10MB</maxFileSize> <!-- 单文件最大10MB --></rollingPolicy><encoder><pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern></encoder></appender><!-- 环境隔离配置 --><springProfile name="dev"><root level="DEBUG"> <!-- 开发环境启用DEBUG --><appender-ref ref="CONSOLE"/><appender-ref ref="FILE"/></root></springProfile><springProfile name="prod"><root level="INFO"> <!-- 生产环境仅INFO及以上 --><appender-ref ref="FILE"/></root></springProfile>
</configuration>

关键特性：
✅ 动态属性：<springProperty> 读取 Spring 配置
✅ 环境隔离：<springProfile> 按环境（dev/prod）切换配置
✅ 滚动策略：避免日志文件过大（按时间/大小分割）

💻 三、代码中使用日志

通过 SLF4J 接口记录日志，避免直接依赖 Logback：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;@RestController
public class UserController {private static final Logger logger = LoggerFactory.getLogger(UserController.class);@GetMapping("/users")public List<User> getUsers() {logger.debug("查询用户列表开始"); // DEBUG级别仅在开发环境输出logger.info("请求处理中...");try {// 业务逻辑} catch (Exception e) {logger.error("用户查询失败", e); // 记录异常堆栈}return userList;}
}

最佳实践：
🔹 使用 {} 占位符避免字符串拼接开销：logger.info("用户ID: {}", userId);
🔹 异常日志需传递异常对象：logger.error("错误描述", exception)

🚀 四、高级特性

异步日志
提升性能，减少 I/O 阻塞：

<appender name="ASYNC_FILE" class="ch.qos.logback.classic.AsyncAppender"><queueSize>500</queueSize> <!-- 队列容量 --><discardingThreshold>0</discardingThreshold> <!-- 不丢弃日志 --><appender-ref ref="FILE"/>
</appender>

MDC（诊断上下文）
添加请求 ID 实现链路追踪：

MDC.put("requestId", UUID.randomUUID().toString());
logger.info("订单创建");
MDC.remove("requestId");

配置 logback-spring.xml 输出 MDC 值：

<pattern>%d{yyyy-MM-dd} [%X{requestId}] %msg%n</pattern>

敏感信息脱敏
自定义转换器屏蔽敏感数据（如手机号、密码）。

⚠️ 五、常见问题解决

问题	原因与解决方案
日志文件未生成	检查路径权限或配置冲突（`logging.file.name` vs `logging.file.path`）
日志级别不生效	确保配置文件中无冲突的 `<logger>` 定义，或检查依赖冲突（如多个日志框架共存）
配置变更未加载	开启热更新：`<configuration scan="true" scanPeriod="30 seconds">`
生产环境日志过大	启用滚动策略 + 异步写入，定期清理历史日志（`maxHistory`）