Lombok 注解 @Slf4j

@Slf4j 是一个由 Lombok 库提供的注解，用于在类中自动生成一个日志记录器（Logger）对象。

核心概念

它是什么？
- 它是一个编译时注解。这意味着它在你的源代码编译成字节码时起作用，而不是在程序运行时。
- 它的作用是帮你自动生成代码 。具体来说，它会帮你创建一行类似这样的代码：
  java 复制代码
```
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(YourClassName.class);
```
它属于谁？
- 它是 Project Lombok 项目的一部分。Lombok 旨在通过注解来减少 Java 中的样板代码（例如 getter/setter、构造函数、toString 方法等）。
它生成什么？
- 它生成一个名为 log 的静态常量，其类型是 org.slf4j.Logger。

为什么要使用它？（优点）

在没有 Lombok 之前，你需要在每个类的顶部手动编写那行 Logger 的声明代码：

java 复制代码

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

@Slf4j
public class MyService {
    // 手动声明 - 繁琐且容易出错/不一致
    private static final Logger logger = LoggerFactory.getLogger(MyService.class);

    public void doSomething() {
        // 使用 lombok 的 @Slf4j，你可以直接使用 'log'
        log.info("Doing something...");
        try {
            // some business logic
        } catch (Exception e) {
            // 使用 lombok 的 @Slf4j，你可以直接使用 'log'
            log.error("An error occurred while doing something", e);
        }
    }
}

使用 @Slf4j 后，代码变得非常简洁：

java 复制代码

import lombok.extern.slf4j.Slf4j; // 引入 Lombok 的 Slf4j 注解

@Slf4j // 只需添加这一个注解
public class MyService {

    public void doSomething() {
        log.info("Doing something..."); // 直接使用 'log' 对象
        try {
            // some business logic
        } catch (Exception e) {
            log.error("An error occurred while doing something", e); // 直接使用 'log' 对象
        }
    }
}

主要优点：

简洁：无需在每个类中重复编写声明日志对象的样板代码。
一致：确保整个项目中日志记录器的名称（log）和类型是一致的。
易于重构 ：如果你重命名了类，Lombok 会在编译时自动更新 getLogger(MyService.class) 中的类名，而手动声明则可能需要你手动修改。

如何使用它？

添加依赖 ：

首先，你需要在项目中引入 Lombok 依赖。

Maven :

xml 复制代码

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>最新版本</version>
    <scope>provided</scope>
</dependency>

Gradle :

gradle 复制代码

compileOnly 'org.projectlombok:lombok:最新版本'
annotationProcessor 'org.projectlombok:lombok:最新版本'

安装 IDE 插件 ：

为了让你的 IDE（如 IntelliJ IDEA 或 Eclipse）能够识别 Lombok 注解并在编辑器中提供代码补全和语法高亮，你需要安装对应的 Lombok 插件。IntelliJ IDEA 新版本通常已内置支持。
在类上添加注解 ：

在任何你需要的类上添加 @Slf4j 注解即可。

重要说明：`SLF4J` 本身不是日志实现

@Slf4j 生成的是 SLF4J（Simple Logging Facade for Java）的接口。SLF4J 是一个日志门面（抽象层），它本身不打印日志。你需要为它绑定一个具体的日志实现库，例如：

Logback（最常用，Spring Boot 的默认选择）
Log4j 2
java.util.logging (JUL)

你的项目依赖中只需要包含其中一个实现库，SLF4J 会自动绑定它。在 Spring Boot 项目中，spring-boot-starter-logging 通常已经帮你做好了这一切。

其他类似的 Lombok 日志注解

Lombok 也支持其他日志框架，你可以根据项目使用的框架选择对应的注解：

注解	生成的 Logger 类型
`@Slf4j`	`org.slf4j.Logger`
`@Log4j`	`org.apache.log4j.Logger`（用于 Log4j 1.x）
`@Log4j2`	`org.apache.logging.log4j.Logger`（用于 Log4j 2.x）
`@CommonsLog`	`org.apache.commons.logging.Log`（用于 Apache Commons Logging）
`@JBossLog`	`org.jboss.logging.Logger`
`@XSlf4j`	`org.slf4j.ext.XLogger`

总结

@Slf4j 是一个 Lombok 注解，它通过在编译时自动生成 private static final Logger log = ... 这行代码，极大地简化了在 Java 类中使用 SLF4J 日志记录器的过程，使代码更简洁、更易于维护。

Lombok 注解 @Slf4j