史上最全 Lombok Features 註解詳解

文章目錄

一、@Getter and @Setter

使用@Getter和/或@Setter註釋任何字段，以使lombok自動生成默認的getter / setter。

默認的getter只是返回該字段，如果該字段被稱爲foo，則名爲getFoo（如果該字段的類型爲boolean，則爲isFoo）。

默認生成的 getter / setter方法是公共的，除非你明確指定一個AccessLevel。合法訪問級別爲PUBLIC，PROTECTED，PACKAGE和PRIVATE。

你還可以在類上添加@Getter和/或@Setter註釋。在這種情況下，就好像你使用該註釋來註釋該類中的所有非靜態字段一樣。

你始終可以使用特殊的AccessLevel.NONE訪問級別來手動禁用任何字段的getter / setter生成。這使你可以覆蓋類上的@Getter，@Setter或@Data註釋的行爲。

With Lombok：

import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;

public class GetterSetterExample {
  
  @Getter 
  @Setter 
  private int age = 10;
  
  @Setter(AccessLevel.PROTECTED) 
  private String name;
  
  @Override 
  public String toString() {
    return String.format("%s (age: %d)", name, age);
  }
}

Native Java：

public class GetterSetterExample {

  private int age = 10;

  private String name;
  
  @Override 
  public String toString() {
    return String.format("%s (age: %d)", name, age);
  }
  
  public int getAge() {
    return age;
  }
  
  public void setAge(int age) {
    this.age = age;
  }
  
  protected void setName(String name) {
    this.name = name;
  }
}

二、@ToString

任何類定義都可以使用@ToString註釋，以使lombok生成toString()方法的實現。

默認情況下，將打印所有非靜態字段。如果要跳過某些字段，可以使用@ ToString.Exclude註釋這些字段。或者，可以通過使用@ToString（onlyExplicitlyIncluded = true），然後使用@ToString.Include標記要包含的每個字段，來確切指定希望使用的字段。

通過將callSuper設置爲true，可以將toString的超類實現的輸出包含到輸出中。請注意，java.lang.Object中toString() 的默認實現幾乎毫無意義。

With Lombok：

import lombok.ToString;

@ToString
public class ToStringExample {
  private static final int STATIC_VAR = 10;
  private String name;
  private Shape shape = new Square(5, 10);
  private String[] tags;
  @ToString.Exclude 
  private int id;
  
  public String getName() {
    return this.name;
  }
  
  @ToString(callSuper=true, includeFieldNames=true)
  public static class Square extends Shape {
    private final int width, height;
    
    public Square(int width, int height) {
      this.width = width;
      this.height = height;
    }
  }
}

Native Java：

import java.util.Arrays;

public class ToStringExample {
  private static final int STATIC_VAR = 10;
  private String name;
  private Shape shape = new Square(5, 10);
  private String[] tags;
  private int id;
  
  public String getName() {
    return this.name;
  }
  
  public static class Square extends Shape {
    private final int width, height;
    
    public Square(int width, int height) {
      this.width = width;
      this.height = height;
    }
    
    @Override 
    public String toString() {
      return "Square(super=" + super.toString() + ", width=" + this.width + ", height=" + this.height + ")";
    }
  }
  
  @Override 
  public String toString() {
    return "ToStringExample(" + this.getName() + ", " + this.shape + ", " + Arrays.deepToString(this.tags) + ")";
  }
}

三、@EqualsAndHashCode

任何類定義都可以使用@EqualsAndHashCode進行註釋，以使lombok生成equals(Object other)和hashCode()方法的實現。默認情況下，它將使用所有非靜態，非瞬態字段，但是您可以通過使用@EqualsAndHashCode.Include標記類型成員來修改使用哪些字段（甚至指定要使用各種方法的輸出）。 @EqualsAndHashCode.Exclude。或者，可以通過使用@ EqualsAndHashCode.Include標記並使用@EqualsAndHashCode(onlyExplicitlyIncluded = true)來精確指定要使用的字段或方法。

如果將@EqualsAndHashCode應用於擴展另一個類的類，則此功能會有些棘手。通常，爲此類自動生成equals和hashCode方法是一個壞主意，因爲超類還定義了字段，該字段也需要equals / hashCode代碼，但不會生成此代碼。通過將callSuper設置爲true，可以在生成的方法中包括超類的equals和hashCode方法。

With Lombok：

import lombok.EqualsAndHashCode;

@EqualsAndHashCode
public class EqualsAndHashCodeExample {
  private transient int transientVar = 10;
  private String name;
  private double score;
  @EqualsAndHashCode.Exclude 
  private Shape shape = new Square(5, 10);
  private String[] tags;
  @EqualsAndHashCode.Exclude 
  private int id;
  
  public String getName() {
    return this.name;
  }
  
  @EqualsAndHashCode(callSuper=true)
  public static class Square extends Shape {
    private final int width, height;
    
    public Square(int width, int height) {
      this.width = width;
      this.height = height;
    }
  }
}

Native Java：

import java.util.Arrays;

public class EqualsAndHashCodeExample {
  private transient int transientVar = 10;
  private String name;
  private double score;
  private Shape shape = new Square(5, 10);
  private String[] tags;
  private int id;
  
  public String getName() {
    return this.name;
  }
  
  @Override 
  public boolean equals(Object o) {
    if (o == this) return true;
    if (!(o instanceof EqualsAndHashCodeExample)) return false;
    EqualsAndHashCodeExample other = (EqualsAndHashCodeExample) o;
    if (!other.canEqual((Object)this)) return false;
    if (this.getName() == null ? other.getName() != null : !this.getName().equals(other.getName())) return false;
    if (Double.compare(this.score, other.score) != 0) return false;
    if (!Arrays.deepEquals(this.tags, other.tags)) return false;
    return true;
  }
  
  @Override 
  public int hashCode() {
    final int PRIME = 59;
    int result = 1;
    final long temp1 = Double.doubleToLongBits(this.score);
    result = (result*PRIME) + (this.name == null ? 43 : this.name.hashCode());
    result = (result*PRIME) + (int)(temp1 ^ (temp1 >>> 32));
    result = (result*PRIME) + Arrays.deepHashCode(this.tags);
    return result;
  }
  
  protected boolean canEqual(Object other) {
    return other instanceof EqualsAndHashCodeExample;
  }
  
  public static class Square extends Shape {
    private final int width, height;
    
    public Square(int width, int height) {
      this.width = width;
      this.height = height;
    }
    
    @Override 
    public boolean equals(Object o) {
      if (o == this) return true;
      if (!(o instanceof Square)) return false;
      Square other = (Square) o;
      if (!other.canEqual((Object)this)) return false;
      if (!super.equals(o)) return false;
      if (this.width != other.width) return false;
      if (this.height != other.height) return false;
      return true;
    }
    
    @Override 
    public int hashCode() {
      final int PRIME = 59;
      int result = 1;
      result = (result*PRIME) + super.hashCode();
      result = (result*PRIME) + this.width;
      result = (result*PRIME) + this.height;
      return result;
    }
    
    protected boolean canEqual(Object other) {
      return other instanceof Square;
    }
  }
}

四、@AllArgsConstructor, @RequiredArgsConstructor and @NoArgsConstructor

@NoArgsConstructor將生成沒有參數的構造函數。如果字段由final修飾，則將導致編譯器錯誤，除非使用@NoArgsConstructor(force = true)，否則所有final字段都將初始化爲0 / false / null。對於具有約束的字段(例如@NonNull字段)，不會生成任何檢查。

@RequiredArgsConstructor爲每個需要特殊處理的字段生成一個帶有1個參數的構造函數。所有未初始化的final字段都會獲取一個參數，以及所有未聲明其位置的未標記爲@NonNull的字段。

@AllArgsConstructor爲類中的每個字段生成一個帶有1個參數的構造函數。標有@NonNull的字段將對這些參數進行空檢查。

With Lombok：

import lombok.AccessLevel;
import lombok.RequiredArgsConstructor;
import lombok.AllArgsConstructor;
import lombok.NonNull;

@RequiredArgsConstructor(staticName = "of")
@AllArgsConstructor(access = AccessLevel.PROTECTED)
public class ConstructorExample<T> {
  private int x, y;
  @NonNull 
  private T description;
  
  @NoArgsConstructor
  public static class NoArgsExample {
    @NonNull 
    private String field;
  }
}

Native Java：

public class ConstructorExample<T> {
  private int x, y;
  @NonNull 
  private T description;
  
  private ConstructorExample(T description) {
    if (description == null) throw new NullPointerException("description");
    this.description = description;
  }
  
  public static <T> ConstructorExample<T> of(T description) {
    return new ConstructorExample<T>(description);
  }
  
  @java.beans.ConstructorProperties({"x", "y", "description"})
  protected ConstructorExample(int x, int y, T description) {
    if (description == null) throw new NullPointerException("description");
    this.x = x;
    this.y = y;
    this.description = description;
  }
  
  public static class NoArgsExample {
    @NonNull 
    private String field;
    
    public NoArgsExample() {
    }
  }
}

五、@Data

@Data是一個方便的快捷方式批註，它將@ToString，@EqualsAndHashCode，@ Getter / @Setter和@RequiredArgsConstructor的功能捆綁在一起：換句話說，@Data生成通常與簡單POJO關聯的所有樣板（普通的舊Java對象）和bean：所有字段的getter，所有非final字段的setter，以及涉及類字段的適當的toString，equals和hashCode實現，以及初始化所有final字段以及所有非final字段的構造函數沒有使用@NonNull標記的初始化程序，以確保該字段永遠不會爲null。

With 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;
  }
}

Native 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;
    }
  }
}

六、@Value

@Value註解和@Data類似，區別在於它會把所有成員變量默認定義爲private final修飾，並且不會生成set方法。

七、@Builder

構建者模式

只能標註到類上，將生成類的一個當前流程的一種鏈式構造工廠，如下：

User buildUser = User.builder().username("riemann").password("123").build();

可配合@Singular註解使用，@Singular註解使用在jdk內部集合類型的屬性，Map類型的屬性以及Guava的com.google.common.collect 的屬性上。例如未標註@Singular的屬性，一般setter時，會直接覆蓋原來的引用，標註了@Singular的屬性，集合屬性支持添加操作，會在屬性原來的基礎上增加。

With Lombok：

import lombok.Builder;
import lombok.Singular;
import java.util.Set;

@Builder
public class BuilderExample {
  @Builder.Default 
  private long created = System.currentTimeMillis();
  private String name;
  private int age;
  @Singular 
  private Set<String> occupations;
}

Native Java：

import java.util.Set;

public class BuilderExample {
  private long created;
  private String name;
  private int age;
  private Set<String> occupations;
  
  BuilderExample(String name, int age, Set<String> occupations) {
    this.name = name;
    this.age = age;
    this.occupations = occupations;
  }
  
  private static long $default$created() {
    return System.currentTimeMillis();
  }
  
  public static BuilderExampleBuilder builder() {
    return new BuilderExampleBuilder();
  }
  
  public static class BuilderExampleBuilder {
    private long created;
    private boolean created$set;
    private String name;
    private int age;
    private java.util.ArrayList<String> occupations;
    
    BuilderExampleBuilder() {
    }
    
    public BuilderExampleBuilder created(long created) {
      this.created = created;
      this.created$set = true;
      return this;
    }
    
    public BuilderExampleBuilder name(String name) {
      this.name = name;
      return this;
    }
    
    public BuilderExampleBuilder age(int age) {
      this.age = age;
      return this;
    }
    
    public BuilderExampleBuilder occupation(String occupation) {
      if (this.occupations == null) {
        this.occupations = new java.util.ArrayList<String>();
      }
      
      this.occupations.add(occupation);
      return this;
    }
    
    public BuilderExampleBuilder occupations(Collection<? extends String> occupations) {
      if (this.occupations == null) {
        this.occupations = new java.util.ArrayList<String>();
      }

      this.occupations.addAll(occupations);
      return this;
    }
    
    public BuilderExampleBuilder clearOccupations() {
      if (this.occupations != null) {
        this.occupations.clear();
      }
      
      return this;
    }

    public BuilderExample build() {
      // complicated switch statement to produce a compact properly sized immutable set omitted.
      Set<String> occupations = ...;
      return new BuilderExample(created$set ? created : BuilderExample.$default$created(), name, age, occupations);
    }
    
    @java.lang.Override
    public String toString() {
      return "BuilderExample.BuilderExampleBuilder(created = " + this.created + ", name = " + this.name + ", age = " + this.age + ", occupations = " + this.occupations + ")";
    }
  }
}

八、@Accessors

鏈式風格

@Accessors批註用於配置lombok如何生成和查找getter和setter。

默認情況下，lombok遵循針對getter和setter的bean規範：例如，名爲Pepper的字段的getter是getPepper。但是，有些人可能希望打破bean規範，以得到更好看的API。 @Accessors允許您執行此操作。

可標註在類或屬性上，當然最實用的功能還是標註到類上。

標註到類上，chain屬性設置爲true時，類的所有屬性的setter方法返回值將爲this，用來支持setter方法的鏈式寫法。如：

new User().setUsername("riemann").setPassword("123");

fluent屬性設置爲true時，類的所有getter，setter方法將省略get和set前綴，獲取屬性值直接使用屬性名相同的無參方法，設置屬性值使用屬性名相同的有參方法，並且返回值爲this。如：

User user = new User().username("riemann").password("123");
String username = user.username();
String password = user.password();

標註到屬性上，使用prefix設置需要省略的屬性生成getter，setter方法時的前綴，且屬性必須爲駝峯式命名。

@Accessors(prefix = "r")
@Getter
@Setter
private String rUsername = "riemann";

編譯之後爲

public String getUsername() {
    return rUsername;
}
public void setUsername(String rUsername) {
    this.rUsername = rUsername;
}

九、@Slf4j and @Log4j

在需要打印日誌的類中使用，項目中使用slf4j、log4j日誌框架

十、@NonNull

該註解快速判斷是否爲空,爲空拋出java.lang.NullPointerException。

十一、@Synchronized

註解自動添加到同步機制，生成的代碼並不是直接鎖方法,而是鎖代碼塊，作用範圍是方法上。

十二、@Cleanup

註解用於確保已分配的資源被釋放（IO的連接關閉）。

史上最全 Lombok Features 註解詳解

文章目錄

一、@Getter and @Setter

二、@ToString

三、@EqualsAndHashCode

四、@AllArgsConstructor, @RequiredArgsConstructor and @NoArgsConstructor

五、@Data

六、@Value

七、@Builder

八、@Accessors

九、@Slf4j and @Log4j

十、@NonNull

十一、@Synchronized

十二、@Cleanup

SQL優化-20231016

我的架構夢：（十九）Nginx搭建、反向代理、負載均衡、動靜分離以及底層進程機制詳解

我的架構夢：（十三）SpringBoot 原理深入以及源碼分析

我的架構夢：（十七）Tomcat 源碼構建以及源碼剖析

我的架構夢：（十八）Tomcat 性能優化策略

我的架構夢：（十六）手寫Tomcat服務器

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結