---
title: "12-@Slf4j"
created: 2025-12-02
tags:
  - 项目
aliases:
  - @Slf4j
---
# @Slf4j

@Slf4j 注解

使用后可以在程序中添加log 以便出错后查找问题

`@Slf4j` 是 Lombok 提供的一个注解，用于在类中自动生成 `Logger` 日志对象，使得在编写代码时可以更方便地记录日志信息。通过使用 `@Slf4j`，我们可以省去手动定义日志对象的步骤，并且可以直接在类中使用 `log` 对象来输出调试信息和错误信息，从而提升代码的可读性和可维护性。

使用 `@Slf4j` 的主要好处包括以下几点：

1. **减少样板代码**：通常情况下，如果不使用 Lombok 的 `@Slf4j` 注解，我们需要手动定义日志对象，如：

```java
   private static final Logger logger = LoggerFactory.getLogger(YourClass.class);
   ```

   使用 `@Slf4j` 后，只需在类上添加该注解，`log` 对象会自动生成。
2. **统一的日志接口**：`@Slf4j` 注解会生成 `org.slf4j.Logger` 类型的日志对象，这样便于在不同的日志框架之间进行切换，例如使用
   Log4j、Logback 等框架。
3. **方便的日志方法**：可以使用 `log.info()`, `log.debug()`, `log.warn()`, `log.error()` 等方法来记录不同级别的日志信息，这对于查找问题和追踪应用运行情况非常重要。
4. **减少出错后的排查成本**：在代码中添加日志后，可以实时监控应用的状态，记录关键的执行信息、变量值和异常堆栈信息，在出错后可以根据日志快速定位问题，提高排查和解决问题的效率。

### 示例代码

```java
import lombok.extern.slf4j.Slf4j;

@Slf4j

public class ExampleClass {

    public void doSomething() {

        log.info("Start of method doSomething()");

        try {

            int result = 10 / 0; // 触发异常

        } catch (Exception e) {

            log.error("An error occurred: {}", e.getMessage(), e); // 打印详细的异常信息

        }

        log.info("End of method doSomething()");

    }

}
```

### 应用场景

`@Slf4j` 注解适用于任何需要日志记录的 Java 类，尤其在以下场景中效果显著：

- **错误排查**：记录异常和出错信息，便于在应用出错时快速找到原因。
- **调试信息**：在开发或测试环境下记录程序的执行流程和变量状态，以了解程序的行为。
- **性能监控**：在特定代码段记录开始和结束时间，估算方法的执行时长，用于发现性能瓶颈。

通过以上的用法和优势，`@Slf4j` 可以帮助开发者提高代码的可维护性和可调试性，使得 Java 应用的日志管理更加高效。

---

**项目分区导航**：⬅️ [[11-mynote|11-mynote]] | 12-@Slf4j | ➡️ [[13-javadoc注释|13-javadoc注释]]