一、简介
@Data是一个方便的快捷注解，它将@ToString、@EqualsAndHashCode、@Getter/@Setter和@RequiredArgsConstructor的功能捆绑在一起。换句话说，@Data生成了所有通常与简单POJO（Plain Old Java Objects）和Bean相关的模板：所有字段的getters，所有非final字段的setters，以及适当的toString、equals和hashCode实现，这些都涉及到类的字段，还有一个初始化所有final字段的构造函数，以及所有没有初始化器的非final字段，这些都被标记为@NonNull，以确保字段永不为空。
@Data就像在类上有隐式的@Getter、@Setter、@ToString、@EqualsAndHashCode和@RequiredArgsConstructor注解一样（除非如果已经存在任何显式编写的构造函数，则不会生成任何构造函数）。但是，这些注解的参数（如callSuper、includeFieldNames和exclude）不能用@Data设置。如果你需要为这些参数中的任何一个设置非默认值，只需明确添加这些注解即可；@Data很聪明，会遵从这些注解。
所有生成的getter和setter的访问级别都是public。要覆盖访问级别，请使用显式@Setter或@Getter注释对字段或类进行注释。您还可以使用此注释（通过将其与AccessLevel.NONE结合使用）来禁止同时生成getter或setter。
标记为transient的所有字段将不考虑hashCode和equals。所有的静态字段将被完全跳过（不考虑任何生成的方法，也不会为它们生成setter/getter）。
如果类已经包含一个与通常生成的任何方法具有相同名称和参数数量的方法，则不会生成该方法，也不会发出警告或错误。例如，如果您已经有一个签名为equals(AnyType param)的方法，则不会生成equals方法，即使从技术上讲，由于参数类型不同，它可能是一个完全不同的方法。同样的规则也适用于构造函数（任何显式构造函数都会阻止@Data生成构造函数），以及toString、equals和所有getter和setter。您可以使用@lombok.experional.permission标记任何构造函数或方法，以对lombok隐藏它们。
@Data可以很好地处理字段的泛型参数。为了减少为有泛型的类构造对象时的模板，你可以使用staticConstructor参数来生成一个私有构造函数，以及一个返回新实例的静态方法。这样一来，javac就会推断出变量的名字。因此，通过这样的声明。@Data(staticConstructor="of") class Foo<T> { private T x;} 你可以通过Foo.of(5);来创建Foo的新实例。 而不是：new Foo<Integer>(5);。
二、示例比较
1. Lombok 写法
import lombok.AccessLevel;
import lombok.Setter;
import lombok.Data;
import lombok.ToString;
@Data public class DataExample {
private final String name;
@Setter(AccessLevel.PACKAGE) private int age;
private double score;
private String[] tags;
@ToString(includeFieldNames=true)
@Data(staticConstructor="of")
public static class Exercise<T> {
private final String name;
private final T value;
}
}
2. Java 标准写法
import java.util.Arrays;
public class DataExample {
private final String name;
private int age;
private double score;
private String[] tags;
public DataExample(String name) {
this.name = name;
}
public String getName() {
return this.name;
}
void setAge(int age) {
this.age = age;
}
public int getAge() {
return this.age;
}
public void setScore(double score) {
this.score = score;
}
public double getScore() {
return this.score;
}
public String[] getTags() {
return this.tags;
}
public void setTags(String[] tags) {
this.tags = tags;
}
@Override public String toString() {
return "DataExample(" + this.getName() + ", " + this.getAge() + ", " + this.getScore() + ", " + Arrays.deepToString(this.getTags()) + ")";
}
protected boolean canEqual(Object other) {
return other instanceof DataExample;
}
@Override public boolean equals(Object o) {
if (o == this) return true;
if (!(o instanceof DataExample)) return false;
DataExample other = (DataExample) o;
if (!other.canEqual((Object)this)) return false;
if (this.getName() == null ? other.getName() != null : !this.getName().equals(other.getName())) return false;
if (this.getAge() != other.getAge()) return false;
if (Double.compare(this.getScore(), other.getScore()) != 0) return false;
if (!Arrays.deepEquals(this.getTags(), other.getTags())) return false;
return true;
}
@Override public int hashCode() {
final int PRIME = 59;
int result = 1;
final long temp1 = Double.doubleToLongBits(this.getScore());
result = (result*PRIME) + (this.getName() == null ? 43 : this.getName().hashCode());
result = (result*PRIME) + this.getAge();
result = (result*PRIME) + (int)(temp1 ^ (temp1 >>> 32));
result = (result*PRIME) + Arrays.deepHashCode(this.getTags());
return result;
}
public static class Exercise<T> {
private final String name;
private final T value;
private Exercise(String name, T value) {
this.name = name;
this.value = value;
}
public static <T> Exercise<T> of(String name, T value) {
return new Exercise<T>(name, value);
}
public String getName() {
return this.name;
}
public T getValue() {
return this.value;
}
@Override public String toString() {
return "Exercise(name=" + this.getName() + ", value=" + this.getValue() + ")";
}
protected boolean canEqual(Object other) {
return other instanceof Exercise;
}
@Override public boolean equals(Object o) {
if (o == this) return true;
if (!(o instanceof Exercise)) return false;
Exercise<?> other = (Exercise<?>) o;
if (!other.canEqual((Object)this)) return false;
if (this.getName() == null ? other.getValue() != null : !this.getName().equals(other.getName())) return false;
if (this.getValue() == null ? other.getValue() != null : !this.getValue().equals(other.getValue())) return false;
return true;
}
@Override public int hashCode() {
final int PRIME = 59;
int result = 1;
result = (result*PRIME) + (this.getName() == null ? 43 : this.getName().hashCode());
result = (result*PRIME) + (this.getValue() == null ? 43 : this.getValue().hashCode());
return result;
}
}
}
三、支持的配置项
lombok.data.flagUsage = [warning | error] (默认: not set)
如果配置了@Data，Lombok会将任何对@Data的使用标记为警告或错误。
lombok.noArgsConstructor.extraPrivate = [true | false] (默认: false)
如果为true，lombok将为任何@Data注释类生成一个私有的无参数构造函数，该构造函数将所有字段设置为默认值（null/0/false）
四、附属说明
请参阅@ToString、@EqualsAndHashCode、@Getter/@Setter和@RequiredArgsConstructor的附属说明。
关于null性的各种众所周知的注释会导致插入null检查并将其复制到相关位置（例如getter的方法以及构造函数和setter的参数）。有关更多信息，请参阅@Getter/@Setter文档的附属说明。
默认情况下，任何以$符号开头的变量都被自动排除。你可以通过指定一个明确的注释（例如，@Getter或@ToString）并使用 "of "参数来包括它们。
参考文献
Java 面试宝典是大明哥全力打造的 Java 精品面试题，它是一份靠谱、强大、详细、经典的 Java 后端面试宝典。它不仅仅只是一道道面试题，而是一套完整的 Java 知识体系，一套你 Java 知识点的扫盲贴。
它的内容包括：
- 大厂真题：Java 面试宝典里面的题目都是最近几年的高频的大厂面试真题。
- 原创内容：Java 面试宝典内容全部都是大明哥原创，内容全面且通俗易懂，回答部分可以直接作为面试回答内容。
- 持续更新：一次购买，永久有效。大明哥会持续更新 3+ 年，累计更新 1000+，宝典会不断迭代更新，保证最新、最全面。
- 覆盖全面：本宝典累计更新 1000+，从 Java 入门到 Java 架构的高频面试题，实现 360° 全覆盖。
- 不止面试：内容包含面试题解析、内容详解、知识扩展，它不仅仅只是一份面试题，更是一套完整的 Java 知识体系。
- 宝典详情：https://www.yuque.com/chenssy/sike-java/xvlo920axlp7sf4k
- 宝典总览：https://www.yuque.com/chenssy/sike-java/yogsehzntzgp4ly1
- 宝典进展：https://www.yuque.com/chenssy/sike-java/en9ned7loo47z5aw
目前 Java 面试宝典累计更新 400+ 道，总字数 42w+。大明哥还在持续更新中，下图是大明哥在 2024-12 月份的更新情况：
想了解详情的小伙伴，扫描下面二维码加大明哥微信【daming091】咨询
同时，大明哥也整理一套目前市面最常见的热点面试题。微信搜[大明哥聊 Java]或扫描下方二维码关注大明哥的原创公众号[大明哥聊 Java] ，回复【面试题】 即可免费领取。
