Java是一个强类型的语言，那么会有很多样板代码，样板代码像getter、setter、equals、hashCode、toString等方法，这些方法的编写不仅耗时，而且代码阅读性也不友好。而Project Lombok的出现，彻底改变了这一现状。这个Java库可以自动插入到你的编辑器和构建工具中，为你的Java代码增添简便，让你再也不用编写另一个getter或equals方法。只需一个注解，你的类就能拥有功能齐全的构建器，自动化日志变量管理，以及更多实用功能。

Project Lombok简介

Project Lombok是一个开源的Java库，它通过注解处理器在编译时自动生成必要的代码，从而减少Java开发中的样板代码。Lombok不是框架，也不是库，而是一个Java编译器插件，它通过在编译过程中修改抽象语法树（AST）来实现代码的自动生成。

Lombok的设计理念是"让Java代码更简洁、更优雅"，它通过一系列的注解，让开发者可以专注于业务逻辑，而不是重复的、机械的代码编写。正如Lombok官网所描述的："Never write another getter or equals method again, with one annotation your class has a fully featured builder, automate your logging variables, and much more."官网地址是
https://projectlombok.org/

Lombok的核心功能

Lombok提供了丰富的注解，覆盖了Java开发中常见的样板代码场景：

1. @Data注解

最常用的注解之一，@Data是以下注解的组合：

@Getter
@Setter
@ToString
@EqualsAndHashCode
@RequiredArgsConstructor

使用@Data注解，你可以自动生成所有字段的getter和setter方法、toString、equals和hashCode方法，以及构造函数（如果需要的话）。这大大减少了编写这些样板代码的时间。

@Data
public class User {
    private Long id;
    private String name;
    private int age;
}

2. @Builder注解

@Builder注解用于创建构建器模式，让你可以以链式调用的方式创建对象，避免构造函数参数过多的问题。

@Builder
public class User {
    private Long id;
    private String name;
    private int age;
}

// 使用方式
User user = User.builder()
               .id(1L)
               .name("John Doe")
               .age(30)
               .build();

3. @Slf4j注解

@Sl4j注解用于自动生成日志变量，避免每次都要写private static final Logger log = LoggerFactory.getLogger(ClassName.class);。

@Slf4j
public class UserService {
    public void createUser(User user) {
        log.info("Creating user: {}", user.getName());
    }
}

4. @NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor

这三个注解用于生成不同参数的构造函数：

@NoArgsConstructor：生成无参构造函数
@RequiredArgsConstructor：生成包含所有final字段和标记为@NonNull的字段的构造函数
@AllArgsConstructor：生成包含所有字段的构造函数

5. @Getter和@Setter

单独使用，用于为特定字段生成getter和setter方法。

public class User {
    @Getter
    @Setter
    private String name;
    
    private int age;
}

6. @ToString

生成toString方法，可以指定包含哪些字段。

@ToString(exclude = "password")
public class User {
    private String name;
    private String password;
}

7. @EqualsAndHashCode

生成equals和hashCode方法，可以指定包含哪些字段。

@EqualsAndHashCode(exclude = "password")
public class User {
    private String name;
    private String password;
}

8. @Accessors(chain = true)

生成链式调用的setter方法，使setter方法返回this。

@Accessors(chain = true)
public class User {
    private String name;
    private int age;
    
    // 生成的setter方法会返回this
}

// 使用方式
User user = new User().setName("John").setAge(30);

Lombok的安装与配置

Lombok支持多种IDE和构建工具，安装过程相对简单。

1. IDE配置

IntelliJ IDEA

下载Lombok插件：在IntelliJ IDEA中，进入File > Settings > Plugins，搜索"Lombok"并安装。
重启IDE。
在项目中添加Lombok依赖（Maven或Gradle）。

Eclipse

下载Lombok的jar文件（从官网下载）。
运行java -jar lombok.jar，按照向导完成安装。
重启Eclipse。

VS Code

安装Lombok插件。
在项目中添加Lombok依赖。

2. 构建工具配置

Maven

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.30</version>
    <scope>provided</scope>
</dependency>

Gradle

dependencies {
    compileOnly 'org.projectlombok:lombok:1.18.30'
    annotationProcessor 'org.projectlombok:lombok:1.18.30'
}

Lombok的高级特性

1. @Builder的高级用法

Lombok的@Builder注解提供了丰富的配置选项：

@Builder(builderMethodName = "userBuilder", builderClassName = "UserBuilder")
public class User {
    private Long id;
    private String name;
    private int age;
    private String email;
    private String password;
}

这会生成一个名为UserBuilder的构建器类，使用userBuilder方法来创建构建器实例。

2. @SneakyThrows

@SneakyThrows注解可以将checked异常转换为unchecked异常，避免在方法签名中声明异常。

@SneakyThrows
public void readFile(String filePath) {
    FileInputStream fis = new FileInputStream(filePath);
    // 读取文件
}

3. @Cleanup

@Cleanup注解可以自动关闭资源，类似于try-with-resources语句。

@Cleanup
InputStream fis = new FileInputStream("file.txt");
// 使用文件流

4. @Getter(lazy=true)

@Getter(lazy=true)用于创建懒加载的getter方法，只有在第一次调用时才会计算值。

@Getter(lazy = true)
private final long value = expensiveOperation();

private long expensiveOperation() {
    // 模拟昂贵操作
    return 42;
}

Lombok的优势与局限性

优势

减少样板代码：Lombok可以显著减少Java代码中的样板代码，使代码更加简洁、易读。
提高开发效率：开发者可以专注于业务逻辑，而不是编写重复的getter、setter等方法。
减少错误：手动编写getter、setter等方法容易出错，Lombok自动生成可以避免这些错误。
保持一致性：Lombok生成的代码遵循一致的风格，避免了不同开发者编写风格不一致的问题。
支持多种IDE：Lombok支持主流的Java IDE，如IntelliJ IDEA、Eclipse、VS Code等。

局限性

调试困难：由于Lombok生成的代码在编译时才存在，调试时可能看不到这些方法。
IDE依赖：Lombok需要IDE支持，否则在编辑器中可能无法正确识别生成的方法。
学习曲线：对于不熟悉Lombok的开发者，需要学习其注解和用法。
版本兼容性：Lombok版本与Java版本、IDE版本可能存在兼容性问题。

四时宝库

程序员的知识宝库

Project Lombok:让Java代码更简洁、更优雅的神器

Project Lombok简介

Lombok的核心功能

Lombok的安装与配置

Lombok的高级特性

Lombok的优势与局限性