1. 介绍
在 Java 开发中，样板代码（Boilerplate Code）是指那些重复、冗长、没有业务逻辑但必须存在的代码。例如，创建类的 getter 和 setter 方法、构造函数等。这些样板代码不仅增加了代码量，还使得代码变得难以维护。
为了减少样板代码，Lombok 库提供了一些非常有用的注解，其中最常用的三个注解就是 @Getter、@Setter 和 @NoArgsConstructor。这些注解通过在编译时生成相应的方法，极大地提高了开发效率。
本文将深入讲解这三个 Lombok 注解的使用方法和它们在实际开发中的应用，帮助你减少繁琐的代码编写。
2. 如何使用 Lombok
首先，你需要在项目中引入 Lombok 库。如果是 Maven 项目，可以在 pom.xml 文件中添加以下依赖：
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.24</version>
<scope>provided</scope>
</dependency>
在 Gradle 项目中，添加如下依赖：
dependencies {
compileOnly 'org.projectlombok:lombok:1.18.24'
annotationProcessor 'org.projectlombok:lombok:1.18.24'
}
注意：Lombok 是在编译时生成代码，因此在 IDE 中，可能需要安装 Lombok 插件来确保 IDE 能识别 Lombok 注解生成的代码。
3. @Getter 注解
@Getter 注解用于为类的所有字段自动生成 getter 方法。通常，对于每个私有字段，我们都需要手动编写一个 getter 方法来访问字段的值。使用 Lombok 后，@Getter 注解可以自动生成这些 getter 方法，减少了大量重复代码。
使用示例：
import lombok.Getter;
public class Person {
@Getter
private String name;
@Getter
private int age;
public Person(String name, int age) {
this.name = name;
this.age = age;
}
}
在上面的代码中，@Getter 会自动为 name 和 age 字段生成如下的 getter 方法：
public String getName() {
return name;
}
public int getAge() {
return age;
}
细节说明：
@Getter注解作用于类的字段，可以单独应用于每个字段或整个类。- 如果需要只生成部分字段的 getter 方法，可以将
@Getter放置在具体字段上，而不是类上。
4. @Setter 注解
@Setter 注解用于为类的所有字段自动生成 setter 方法。与 @Getter 相反，@Setter 注解会为每个字段生成对应的 setter 方法，用于修改字段的值。
使用示例：
import lombok.Setter;
public class Person {
@Setter
private String name;
@Setter
private int age;
public Person(String name, int age) {
this.name = name;
this.age = age;
}
}
在上面的代码中，@Setter 会自动为 name 和 age 字段生成如下的 setter 方法：
public void setName(String name) {
this.name = name;
}
public void setAge(int age) {
this.age = age;
}
细节说明：
@Setter注解作用于类的字段，可以单独应用于每个字段或整个类。- 如果你只希望某些字段可修改（而不是全部字段），可以只对这些字段使用
@Setter。
5. @NoArgsConstructor 注解
@NoArgsConstructor 注解用于自动生成一个无参数的构造函数。通常，Java 类需要显式地定义一个无参数的构造函数，尤其是在使用框架如 Spring 或 Hibernate 时，这种构造函数是必需的。Lombok 提供的 @NoArgsConstructor 可以自动生成这个无参构造函数，简化类的编写。
使用示例：
import lombok.NoArgsConstructor;
@NoArgsConstructor
public class Person {
private String name;
private int age;
// 生成无参构造函数后，就不再需要显式地定义它了
}
上述代码中，@NoArgsConstructor 会自动为 Person 类生成如下的构造函数：
public Person() {
// 默认构造函数
}
细节说明：
@NoArgsConstructor只会生成一个默认的无参数构造函数。- 如果类中已经定义了其他构造函数，
@NoArgsConstructor生成的无参数构造函数仍然有效，不会与现有的构造函数冲突。
6. @Getter、@Setter 和 @NoArgsConstructor 的应用场景
1. 数据传输对象（DTO）
在很多应用中，我们常常需要定义一些简单的 Java 类（例如 DTO、VO 类），用于传输数据。这些类通常只包含字段、getter、setter 方法以及构造函数。使用 Lombok 的 @Getter、@Setter 和 @NoArgsConstructor 注解可以让我们避免手动编写这些样板代码，使得代码更加简洁。
import lombok.Getter;
import lombok.Setter;
import lombok.NoArgsConstructor;
@Getter
@Setter
@NoArgsConstructor
public class PersonDTO {
private String name;
private int age;
}
2. 实体类（Entity）
在实体类中，我们通常需要定义构造函数、getter 和 setter 方法。Lombok 的注解帮助我们减少这些重复代码，特别是在使用 ORM 框架（如 Hibernate 或 JPA）时，实体类需要有无参构造函数。
import lombok.Getter;
import lombok.Setter;
import lombok.NoArgsConstructor;
@Getter
@Setter
@NoArgsConstructor
public class Product {
private Long id;
private String name;
private double price;
}
3. 简化 Bean 类的编写
Lombok 的注解特别适合用于 POJO 类（Plain Old Java Object），在这些类中，我们经常需要手动编写 getter、setter 和构造函数。Lombok 可以帮助开发者避免这些重复代码，使得类更加简洁易读。
7. 延伸问题：Lombok 的常见问题及解决方案
问题 1：Lombok 生成的代码不可见
在 IDE 中，Lombok 生成的代码可能无法正确显示，导致我们无法查看 getter、setter 等方法。通常是由于 IDE 未正确识别 Lombok 注解。
解决方案：
- 确保 IDE 已经安装 Lombok 插件（如 IntelliJ IDEA 和 Eclipse 都有 Lombok 插件）。
- 在项目中启用 annotation processor。
问题 2：和其他工具/框架的兼容性
Lombok 和一些框架或工具（如 Spring、Hibernate）可能会存在兼容性问题，特别是在使用构造函数注入时。
解决方案：
- 使用
@AllArgsConstructor或@RequiredArgsConstructor来生成所需的构造函数。 - 手动为某些字段添加构造函数，避免 Lombok 生成不符合框架要求的构造函数。
问题 3：Lombok 与反射工具的兼容性
某些反射工具（如 Jackson）可能无法正确处理 Lombok 自动生成的代码，导致序列化和反序列化出错。
解决方案：
- 使用
@JsonProperty注解或配置 Jackson 的自定义序列化器。
8. 总结
Lombok 是一个非常强大的 Java 库，通过使用注解 @Getter、@Setter 和 @NoArgsConstructor，我们可以极大地减少样板代码，提高开发效率。它尤其适用于数据传输对象（DTO）、实体类和其他需要频繁使用 getter、setter 或构造函数的场景。
通过本文的介绍，你应该对 Lombok 提供的这三个注解有了更深入的理解，并知道如何在日常开发中使用它们来简化代码。如果你尚未使用 Lombok，建议尝试将它集成到项目中，以提高代码的简洁性和可维护性。
