日志框架

引言：为什么需要日志？

日志（Logging）是软件开发中不可或缺的部分，用于记录程序运行时的信息，帮助开发人员调试问题、监控性能和追踪问题。

飞机黑匣子记录：
- 起飞时间、飞行高度
- 机组操作、塔台通讯
- 任何异常情况

日志的作用相同：
- 记录程序运行的关键节点
- 帮助定位bug
- 分析用户行为
- 审计和安全追踪

想象没有日志：程序出错就像飞机出事却没有黑匣子，根本不知道发生了什么！

日志框架体系

Java日志框架分为两部分：日志门面（API）和日志实现。

日志框架对比

日志级别

日志级别从低到高排列，级别越高，日志越重要。

日志级别示例

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LoggingExample {
    private static final Logger log = LoggerFactory.getLogger(LoggingExample.class);

    public void processOrder(String orderId) {
        log.trace("进入方法: processOrder, orderId={}", orderId);

        if (orderId == null || orderId.isEmpty()) {
            log.warn("订单ID为空!");
            return;
        }

        log.debug("开始处理订单: {}", orderId);

        try {
            // 处理订单逻辑
            log.info("订单处理成功: {}", orderId);
        } catch (Exception e) {
            log.error("处理订单失败: {}, 错误: {}", orderId, e.getMessage());
        }

        log.trace("方法结束: processOrder");
    }
}

SLF4J详解

SLF4J（Simple Logging Facade for Java）是一个日志门面，提供统一的日志接口，底层可以切换不同的日志实现。

Maven依赖

<!-- SLF4J API -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.36</version>
</dependency>

<!-- Logback实现（Spring Boot默认） -->
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.11</version>
</dependency>

Logger获取

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

// 方式1：推荐 - 传入类.class
public class MyService {
    private static final Logger log = LoggerFactory.getLogger(MyService.class);
}

// 方式2：传入类名字符串
private static final Logger log = LoggerFactory.getLogger("MyService");

// 方式3：使用匿名类
private static final Logger log = LoggerFactory.getLogger(getClass());

占位符 {} 的使用

// 使用占位符（推荐）
log.info("用户{}登录成功", username);
log.debug("订单{}的状态从{}更新为{}", orderId, oldStatus, newStatus);

// 不要用字符串拼接！
// 错误: log.info("用户" + username + "登录成功");

// 占位符优势：
// 1. 代码更简洁
// 2. 避免字符串拼接的开销（只有需要打印时才拼接）
// 3. 可读性更好

Logback配置

Logback是SLF4J的默认实现，配置简单且功能强大。

配置文件位置

1. logback-test.xml（测试环境）
2. logback.groovy（Groovy格式）
3. logback.xml（生产环境） - 放在 src/main/resources 下

基本配置示例

<configuration>
    <!-- 定义日志格式 -->
    <property name="LOG_PATTERN" value="%d{HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n"/>

    <!-- 控制台输出 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <!-- 文件输出 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logs/application.log</file>
        <encoder>
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logs/application.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
    </appender>

    <!-- 根日志级别 -->
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
    </root>

    <!-- 指定包的日志级别 -->
    <logger name="com.example.service" level="DEBUG"/>
    <logger name="org.springframework" level="WARN"/>
</configuration>

日志格式说明

日志级别配置

不同环境使用不同的日志级别：

Spring Boot配置（application.yml）

logging:
  level:
    root: INFO  # 根日志
    com.example: DEBUG  # 指定包
    org.springframework: WARN  # Spring框架
    org.hibernate: INFO  # Hibernate
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n"
  file:
    name: logs/application.log  # 日志文件

环境切换

# application-dev.yml（开发环境）
logging:
  level:
    root: DEBUG
    com.example: TRACE

# application-prod.yml（生产环境）
logging:
  level:
    root: WARN
    com.example: INFO

最佳实践

推荐日志记录内容

// 1. 业务关键节点
log.info("用户{}成功登录系统", username);
log.info("订单{}已创建，金额{}", orderId, amount);

// 2. 系统状态变化
log.info("系统启动完成，端口{}", port);
log.info("配置重新加载，新值={}", newValue);

// 3. 警告信息
log.warn("尝试登录失败，用户{}已失败{}次", username, failCount);
log.warn("内存使用率超过80%，当前{}%", usagePercent);

// 4. 异常信息
log.error("处理请求失败: {}", e.getMessage(), e);

// 不推荐：
log.debug("进入方法1");
log.debug("进入方法2");
log.debug("变量x={}", x);  // 过多无意义的debug

不推荐的做法

// 错误1: 使用字符串拼接
log.info("用户" + username + "登录成功");
// 应该: log.info("用户{}登录成功", username);

// 错误2: 在日志中记录敏感信息
log.info("用户密码: {}", password);
// 危险！密码会出现在日志中

// 错误3: 日志过多
for (int i = 0; i < 10000; i++) {
    log.debug("处理第{}条", i);  // 会产生大量日志
}

// 错误4: 只记录异常消息不记录堆栈
log.error("出错了: " + e.getMessage());
// 应该: log.error("出错了", e);

// 错误5: 使用System.out代替日志
System.out.println("用户登录");  // 不好，无法控制级别
log.info("用户登录");  // 好

集成 Lombok（可选）

使用 Lombok 可以简化日志声明：

import lombok.extern.slf4j.Slf4j;

@Slf4j  // Lombok自动生成 log 字段
public class UserService {

    public void createUser(String name) {
        log.info("创建用户: {}", name);
        // ...
    }
}

小结