@Data是集@ToString@ EqualsAndHashCode,所有字段的@Getter,所有非最终字段的@Setter@RequiredArgsConstructor于一体的快捷方式!

引言

@Data是一个方便的快捷方式注解,它将@ToString@EqualsAndHashCode@Getter / @Setter@RequiredArgsConstructor的特性捆绑在一起:换句话说,@Data生成常用简单POJO相关联(普通旧Java对象)和bean的所有样板代码:所有字段的getter,所有非final字段的setter,以及涉及类字段的相应toString,equals和hashCode实现,以及初始化所有final字段以及所有非final字段没有使用@NonNull标记的字段的构造函数,以确保该字段永远不为空。

@Data就像在类上使用@Getter@Setter@ToTtring@EqualsAndHashCode@RequiredArgsConstructor注解一样(如果已经存在显式编写的构造函数,则不会生成构造函数)。但无法使用@Data设置这些注解的参数(例如callSuper,includeFieldNames和exclude)。 如果您需要为这些参数中的任何一个设置非默认值,只需显式添加这些注解; @Data会智能的执行这些注解。

所有生成的getter和setter都将是公共的。要覆盖访问级别,请使用显式的@Setter和/或@Getter注释来注释字段或类。您还可以使用此批注(通过将其与AccessLevel.NONE组合)来完全禁止生成getter和/或setter。

所有标记为transient的字段都不会被视为hashCode和equals。 所有静态字段将完全跳过(不考虑任何生成的方法,并且不会为它们创建setter / getter)。

如果类已经包含与生成方法具有相同名称和参数个数(译者注:参数个数其实不做考虑的)的方法,则不会生成该方法,也不会发出警告或错误。 例如,如果您已经有一个带有签名equals(AnyType param)的方法,则不会生成任何equals方法,即使从技术上讲,由于具有不同的参数类型,它可能是完全不同的方法。 同样的规则适用于构造函数(任何显式构造函数都会阻止@Data生成一个),以及toStringequals和所有gettersetter。 您可以使用@ lombok.experimental.Tolerate标记任何构造函数或方法,以屏蔽lombok的检测。

@Data可以很好地处理字段的泛型参数。 为了在为具有泛型的类构造对象时减少样板代码,可以使用staticConstructor参数来生成私有构造函数,以及返回新实例的静态方法。 这样,javac将推断变量名称。 因此,通过这样声明:@Data(staticConstructor ="of")Foo <T> {private T x;}您可以通过写入来创建Foo的新实例:Foo.of(5); 而不必写:new Foo <Integer>(5);

使用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;
  }
}

普通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] (default: not set) 如果已配置,Lombok会将@Data的任何用法标记为警告或错误。

小提示

请参阅@ToString@EqualsAndHashCode@Getter/@Setter@RequiredArgsConstructor的小提示。

各种众所周知的关于空异常的注解会导致插入空检查并将其复制到相关位置(例如getter的方法,以及构造函数和setter的参数)。有关详细信息,请参阅Getter/Setter文档的小提示。

默认情况下,任何以$符号开头的变量都会自动排除。 您可以通过指定显式注释(例如@Getter@ToString)并使用of参数来包含它们。

原文地址

——————————————————————————
行路不知花开处,蓦然回首芷兰香。