Java如何添加日志？

为什么需要日志？

• 故障排查：快速定位运行时错误。
• 行为追踪：记录用户操作或系统事件。
• 性能监控：分析耗时操作。
• 审计合规：满足安全审计要求。

主流Java日志框架

Java生态常用框架及选择建议：

1. Logback（推荐）
   • Log4j的升级版,性能优越，Spring Boot默认集成。
   • 支持动态配置更新,兼容SLF4J API。
2. Log4j 2
   • 异步日志性能强,避免阻塞主线程。
   • 支持插件扩展（如JSON格式输出）。
3. java.util.logging (JUL)

   JDK内置,无需额外依赖，功能较基础。

4. SLF4J（日志门面）
   • 必选：作为抽象层，解耦具体实现（如Logback/Log4j2），便于切换框架。

框架对比
| 框架 | 性能 | 灵活性 | 易用性 |
|————-|——|——–|——–|
| Logback | 高 | 高 | 高 |
| Log4j 2 | 极高 | 高 | 中 |
| JUL | 中 | 低 | 高 |

添加日志的步骤（以Logback + SLF4J为例）

步骤1：添加Maven依赖

<!-- SLF4J门面 -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>2.0.7</version>
</dependency>
<!-- Logback实现 -->
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.4.11</version>
</dependency>

步骤2：创建日志配置文件

在 src/main/resources 下新建 logback.xml：

<configuration>
    <!-- 控制台输出 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    <!-- 文件输出（每日滚动） -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logs/app.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logs/app.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory> <!-- 保留30天 -->
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    <!-- 设置日志级别 -->
    <root level="INFO">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="FILE" />
    </root>
    <!-- 特定包使用DEBUG级别 -->
    <logger name="com.example.service" level="DEBUG" />
</configuration>

步骤3：在代码中记录日志

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class UserService {
    // 创建Logger实例
    private static final Logger logger = LoggerFactory.getLogger(UserService.class);
    public void createUser(String username) {
        try {
            logger.info("创建用户: {}", username); // 占位符避免字符串拼接开销
            // 业务逻辑...
            logger.debug("用户详情: {}", getDetails(username)); // DEBUG级别日志
        } catch (Exception e) {
            logger.error("用户创建失败: ", e); // 记录异常栈
        }
    }
}

最佳实践

1. 日志级别合理使用
   • TRACE < DEBUG < INFO < WARN < ERROR
   • 生产环境用 INFO，开发环境用 DEBUG。
2. 避免性能陷阱
   • 使用占位符 替代字符串拼接（如 logger.debug("Value: {}", expensiveOperation())），避免不必要计算。
3. 日志格式规范

   包含时间、线程、类名、日志级别和消息（参考示例配置）。

4. 敏感信息脱敏

   禁止记录密码、密钥等数据。

5. 异步日志提升性能
   • Log4j 2支持异步Appender，减少I/O阻塞：

     <AsyncLogger name="com.example" level="DEBUG" />

常见问题解决

• 日志不输出？
  检查配置路径、依赖冲突（用 mvn dependency:tree 排除重复日志包）。
• 如何动态调整日志级别？
  Logback支持通过JMX或 logback.xml 热更新（修改后自动重载）。
• 多环境配置
  使用Spring Profile指定配置：

  <springProfile name="prod">
    <root level="WARN" />
  </springProfile>

Java日志是系统可观测性的基石,通过SLF4J+Logback/Log4j2的组合，结合清晰的配置和规范编码，可构建高效、易维护的日志体系，重点注意：

1. 使用门面模式（SLF4J）解耦具体实现。
2. 配置文件标准化（时间滚动、级别控制）。
3. 遵循性能和安全最佳实践。

引用说明：

• Logback官方文档：https://logback.qos.ch
• SLF4J手册：https://www.slf4j.org
• Log4j 2指南：https://logging.apache.org/log4j/2.x
  本文基于Java 17和Logback 1.4.x编写，适用于大多数生产环境。