Java Lombok

一、@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：

  1. import lombok.AccessLevel;
  2. import lombok.Getter;
  3. import lombok.Setter;
  4. public class GetterSetterExample {
  6.   @Getter 
  7.   @Setter 
  8.   private int age = 10;
  10.   @Setter(AccessLevel.PROTECTED) 
  11.   private String name;
  13.   @Override 
  14.   public String toString() {
  15.     return String.format("%s (age: %d)", name, age);
  16.   }
  17. }

Native Java：

  1. public class GetterSetterExample {
  2.   private int age = 10;
  3.   private String name;
  5.   @Override 
  6.   public String toString() {
  7.     return String.format("%s (age: %d)", name, age);
  8.   }
  10.   public int getAge() {
  11.     return age;
  12.   }
  14.   public void setAge(int age) {
  15.     this.age = age;
  16.   }
  18.   protected void setName(String name) {
  19.     this.name = name;
  20.   }
  21. }

二、@ToString

任何类定义都可以使用@ToString注释，以使lombok生成toString()方法的实现。
默认情况下，将打印所有非静态字段。如果要跳过某些字段，可以使用@ ToString.Exclude注释这些字段。或者，可以通过使用@ToString（onlyExplicitlyIncluded = true），然后使用@ToString.Include标记要包含的每个字段，来确切指定希望使用的字段。
通过将callSuper设置为true，可以将toString的超类实现的输出包含到输出中。请注意，java.lang.Object中toString() 的默认实现几乎毫无意义。
With Lombok：

  1. import lombok.ToString;
  2. @ToString
  3. public class ToStringExample {
  4.   private static final int STATIC_VAR = 10;
  5.   private String name;
  6.   private Shape shape = new Square(5, 10);
  7.   private String[] tags;
  8.   @ToString.Exclude 
  9.   private int id;
  11.   public String getName() {
  12.     return this.name;
  13.   }
  15.   @ToString(callSuper=true, includeFieldNames=true)
  16.   public static class Square extends Shape {
  17.     private final int width, height;
  19.     public Square(int width, int height) {
  20.       this.width = width;
  21.       this.height = height;
  22.     }
  23.   }
  24. }

Native Java：

  1. import java.util.Arrays;
  2. public class ToStringExample {
  3.   private static final int STATIC_VAR = 10;
  4.   private String name;
  5.   private Shape shape = new Square(5, 10);
  6.   private String[] tags;
  7.   private int id;
  9.   public String getName() {
  10.     return this.name;
  11.   }
  13.   public static class Square extends Shape {
  14.     private final int width, height;
  16.     public Square(int width, int height) {
  17.       this.width = width;
  18.       this.height = height;
  19.     }
  21.     @Override 
  22.     public String toString() {
  23.       return "Square(super=" + super.toString() + ", width=" + this.width + ", height=" + this.height + ")";
  24.     }
  25.   }
  27.   @Override 
  28.   public String toString() {
  29.     return "ToStringExample(" + this.getName() + ", " + this.shape + ", " + Arrays.deepToString(this.tags) + ")";
  30.   }
  31. }

三、@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：

  1. import lombok.EqualsAndHashCode;
  2. @EqualsAndHashCode
  3. public class EqualsAndHashCodeExample {
  4.   private transient int transientVar = 10;
  5.   private String name;
  6.   private double score;
  7.   @EqualsAndHashCode.Exclude 
  8.   private Shape shape = new Square(5, 10);
  9.   private String[] tags;
  10.   @EqualsAndHashCode.Exclude 
  11.   private int id;
  13.   public String getName() {
  14.     return this.name;
  15.   }
  17.   @EqualsAndHashCode(callSuper=true)
  18.   public static class Square extends Shape {
  19.     private final int width, height;
  21.     public Square(int width, int height) {
  22.       this.width = width;
  23.       this.height = height;
  24.     }
  25.   }
  26. }

Native Java：

  1. import java.util.Arrays;
  2. public class EqualsAndHashCodeExample {
  3.   private transient int transientVar = 10;
  4.   private String name;
  5.   private double score;
  6.   private Shape shape = new Square(5, 10);
  7.   private String[] tags;
  8.   private int id;
  10.   public String getName() {
  11.     return this.name;
  12.   }
  14.   @Override 
  15.   public boolean equals(Object o) {
  16.     if (o == this) return true;
  17.     if (!(o instanceof EqualsAndHashCodeExample)) return false;
  18.     EqualsAndHashCodeExample other = (EqualsAndHashCodeExample) o;
  19.     if (!other.canEqual((Object)this)) return false;
  20.     if (this.getName() == null ? other.getName() != null : !this.getName().equals(other.getName())) return false;
  21.     if (Double.compare(this.score, other.score) != 0) return false;
  22.     if (!Arrays.deepEquals(this.tags, other.tags)) return false;
  23.     return true;
  24.   }
  26.   @Override 
  27.   public int hashCode() {
  28.     final int PRIME = 59;
  29.     int result = 1;
  30.     final long temp1 = Double.doubleToLongBits(this.score);
  31.     result = (result*PRIME) + (this.name == null ? 43 : this.name.hashCode());
  32.     result = (result*PRIME) + (int)(temp1 ^ (temp1 >>> 32));
  33.     result = (result*PRIME) + Arrays.deepHashCode(this.tags);
  34.     return result;
  35.   }
  37.   protected boolean canEqual(Object other) {
  38.     return other instanceof EqualsAndHashCodeExample;
  39.   }
  41.   public static class Square extends Shape {
  42.     private final int width, height;
  44.     public Square(int width, int height) {
  45.       this.width = width;
  46.       this.height = height;
  47.     }
  49.     @Override 
  50.     public boolean equals(Object o) {
  51.       if (o == this) return true;
  52.       if (!(o instanceof Square)) return false;
  53.       Square other = (Square) o;
  54.       if (!other.canEqual((Object)this)) return false;
  55.       if (!super.equals(o)) return false;
  56.       if (this.width != other.width) return false;
  57.       if (this.height != other.height) return false;
  58.       return true;
  59.     }
  61.     @Override 
  62.     public int hashCode() {
  63.       final int PRIME = 59;
  64.       int result = 1;
  65.       result = (result*PRIME) + super.hashCode();
  66.       result = (result*PRIME) + this.width;
  67.       result = (result*PRIME) + this.height;
  68.       return result;
  69.     }
  71.     protected boolean canEqual(Object other) {
  72.       return other instanceof Square;
  73.     }
  74.   }
  75. }

四、@AllArgsConstructor、@RequiredArgsConstructor，@NoArgsConstructor

@NoArgsConstructor将生成没有参数的构造函数。如果字段由final修饰，则将导致编译器错误，除非使用@NoArgsConstructor(force = true)，否则所有final字段都将初始化为0 / false / null。对于具有约束的字段(例如@NonNull字段)，不会生成任何检查。
@RequiredArgsConstructor为每个需要特殊处理的字段生成一个带有1个参数的构造函数。所有未初始化的final字段都会获取一个参数，以及所有未声明其位置的未标记为@NonNull的字段。
@AllArgsConstructor为类中的每个字段生成一个带有1个参数的构造函数。标有@NonNull的字段将对这些参数进行空检查。
With Lombok：

  1. import lombok.AccessLevel;
  2. import lombok.RequiredArgsConstructor;
  3. import lombok.AllArgsConstructor;
  4. import lombok.NonNull;
  5. @RequiredArgsConstructor(staticName = "of")
  6. @AllArgsConstructor(access = AccessLevel.PROTECTED)
  7. public class ConstructorExample<T> {
  8.   private int x, y;
  9.   @NonNull 
  10.   private T description;
  12.   @NoArgsConstructor
  13.   public static class NoArgsExample {
  14.     @NonNull 
  15.     private String field;
  16.   }
  17. }

Native Java：

  1. public class ConstructorExample<T> {
  2.   private int x, y;
  3.   @NonNull 
  4.   private T description;
  6.   private ConstructorExample(T description) {
  7.     if (description == null) throw new NullPointerException("description");
  8.     this.description = description;
  9.   }
  11.   public static <T> ConstructorExample<T> of(T description) {
  12.     return new ConstructorExample<T>(description);
  13.   }
  15.   @java.beans.ConstructorProperties({"x", "y", "description"})
  16.   protected ConstructorExample(int x, int y, T description) {
  17.     if (description == null) throw new NullPointerException("description");
  18.     this.x = x;
  19.     this.y = y;
  20.     this.description = description;
  21.   }
  23.   public static class NoArgsExample {
  24.     @NonNull 
  25.     private String field;
  27.     public NoArgsExample() {
  28.     }
  29.   }
  30. }

五、@Data

@Data是一个方便的快捷方式批注，它将@ToString，@EqualsAndHashCode，@ Getter / @Setter和@RequiredArgsConstructor的功能捆绑在一起：换句话说，@Data生成通常与简单POJO关联的所有样板（普通的旧Java对象）和bean：所有字段的getter，所有非final字段的setter，以及涉及类字段的适当的toString，equals和hashCode实现，以及初始化所有final字段以及所有非final字段的构造函数没有使用@NonNull标记的初始化程序，以确保该字段永远不会为null。
With Lombok：

  1. import lombok.AccessLevel;
  2. import lombok.Setter;
  3. import lombok.Data;
  4. import lombok.ToString;
  5. @Data 
  6. public class DataExample {
  7.   private final String name;
  8.   @Setter(AccessLevel.PACKAGE) 
  9.   private int age;
  10.   private double score;
  11.   private String[] tags;
  13.   @ToString(includeFieldNames=true)
  14.   @Data(staticConstructor="of")
  15.   public static class Exercise<T> {
  16.     private final String name;
  17.     private final T value;
  18.   }
  19. }

Native Java：

  1. import java.util.Arrays;
  2. public class DataExample {
  3.   private final String name;
  4.   private int age;
  5.   private double score;
  6.   private String[] tags;
  8.   public DataExample(String name) {
  9.     this.name = name;
  10.   }
  12.   public String getName() {
  13.     return this.name;
  14.   }
  16.   void setAge(int age) {
  17.     this.age = age;
  18.   }
  20.   public int getAge() {
  21.     return this.age;
  22.   }
  24.   public void setScore(double score) {
  25.     this.score = score;
  26.   }
  28.   public double getScore() {
  29.     return this.score;
  30.   }
  32.   public String[] getTags() {
  33.     return this.tags;
  34.   }
  36.   public void setTags(String[] tags) {
  37.     this.tags = tags;
  38.   }
  40.   @Override 
  41.   public String toString() {
  42.     return "DataExample(" + this.getName() + ", " + this.getAge() + ", " + this.getScore() + ", " + Arrays.deepToString(this.getTags()) + ")";
  43.   }
  45.   protected boolean canEqual(Object other) {
  46.     return other instanceof DataExample;
  47.   }
  49.   @Override 
  50.   public boolean equals(Object o) {
  51.     if (o == this) return true;
  52.     if (!(o instanceof DataExample)) return false;
  53.     DataExample other = (DataExample) o;
  54.     if (!other.canEqual((Object)this)) return false;
  55.     if (this.getName() == null ? other.getName() != null : !this.getName().equals(other.getName())) return false;
  56.     if (this.getAge() != other.getAge()) return false;
  57.     if (Double.compare(this.getScore(), other.getScore()) != 0) return false;
  58.     if (!Arrays.deepEquals(this.getTags(), other.getTags())) return false;
  59.     return true;
  60.   }
  62.   @Override 
  63.   public int hashCode() {
  64.     final int PRIME = 59;
  65.     int result = 1;
  66.     final long temp1 = Double.doubleToLongBits(this.getScore());
  67.     result = (result*PRIME) + (this.getName() == null ? 43 : this.getName().hashCode());
  68.     result = (result*PRIME) + this.getAge();
  69.     result = (result*PRIME) + (int)(temp1 ^ (temp1 >>> 32));
  70.     result = (result*PRIME) + Arrays.deepHashCode(this.getTags());
  71.     return result;
  72.   }
  74.   public static class Exercise<T> {
  75.     private final String name;
  76.     private final T value;
  78.     private Exercise(String name, T value) {
  79.       this.name = name;
  80.       this.value = value;
  81.     }
  83.     public static <T> Exercise<T> of(String name, T value) {
  84.       return new Exercise<T>(name, value);
  85.     }
  87.     public String getName() {
  88.       return this.name;
  89.     }
  91.     public T getValue() {
  92.       return this.value;
  93.     }
  95.     @Override 
  96.     public String toString() {
  97.       return "Exercise(name=" + this.getName() + ", value=" + this.getValue() + ")";
  98.     }
  100.     protected boolean canEqual(Object other) {
  101.       return other instanceof Exercise;
  102.     }
  104.     @Override 
  105.     public boolean equals(Object o) {
  106.       if (o == this) return true;
  107.       if (!(o instanceof Exercise)) return false;
  108.       Exercise<?> other = (Exercise<?>) o;
  109.       if (!other.canEqual((Object)this)) return false;
  110.       if (this.getName() == null ? other.getValue() != null : !this.getName().equals(other.getName())) return false;
  111.       if (this.getValue() == null ? other.getValue() != null : !this.getValue().equals(other.getValue())) return false;
  112.       return true;
  113.     }
  115.     @Override 
  116.     public int hashCode() {
  117.       final int PRIME = 59;
  118.       int result = 1;
  119.       result = (result*PRIME) + (this.getName() == null ? 43 : this.getName().hashCode());
  120.       result = (result*PRIME) + (this.getValue() == null ? 43 : this.getValue().hashCode());
  121.       return result;
  122.     }
  123.   }
  124. }

六、@Value

@Value注解和@Data类似，区别在于它会把所有成员变量默认定义为private final修饰，并且不会生成set方法。

七、@Builder

构建者模式
只能标注到类上，将生成类的一个当前流程的一种链式构造工厂，如下：

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

可配合@Singular注解使用，@Singular注解使用在jdk内部集合类型的属性，Map类型的属性以及Guava的com.google.common.collect 的属性上。例如 未标注@Singular的属性，一般setter时，会直接覆盖原来的引用，标注了@Singular的属性，集合属性支持添加操作，会在属性原来的基础上增加。
With Lombok：

  1. import lombok.Builder;
  2. import lombok.Singular;
  3. import java.util.Set;
  4. @Builder
  5. public class BuilderExample {
  6.   @Builder.Default 
  7.   private long created = System.currentTimeMillis();
  8.   private String name;
  9.   private int age;
  10.   @Singular 
  11.   private Set<String> occupations;
  12. }

Native Java：

  1. import java.util.Set;
  2. public class BuilderExample {
  3.   private long created;
  4.   private String name;
  5.   private int age;
  6.   private Set<String> occupations;
  8.   BuilderExample(String name, int age, Set<String> occupations) {
  9.     this.name = name;
  10.     this.age = age;
  11.     this.occupations = occupations;
  12.   }
  14.   private static long $default$created() {
  15.     return System.currentTimeMillis();
  16.   }
  18.   public static BuilderExampleBuilder builder() {
  19.     return new BuilderExampleBuilder();
  20.   }
  22.   public static class BuilderExampleBuilder {
  23.     private long created;
  24.     private boolean created$set;
  25.     private String name;
  26.     private int age;
  27.     private java.util.ArrayList<String> occupations;
  29.     BuilderExampleBuilder() {
  30.     }
  32.     public BuilderExampleBuilder created(long created) {
  33.       this.created = created;
  34.       this.created$set = true;
  35.       return this;
  36.     }
  38.     public BuilderExampleBuilder name(String name) {
  39.       this.name = name;
  40.       return this;
  41.     }
  43.     public BuilderExampleBuilder age(int age) {
  44.       this.age = age;
  45.       return this;
  46.     }
  48.     public BuilderExampleBuilder occupation(String occupation) {
  49.       if (this.occupations == null) {
  50.         this.occupations = new java.util.ArrayList<String>();
  51.       }
  53.       this.occupations.add(occupation);
  54.       return this;
  55.     }
  57.     public BuilderExampleBuilder occupations(Collection<? extends String> occupations) {
  58.       if (this.occupations == null) {
  59.         this.occupations = new java.util.ArrayList<String>();
  60.       }
  61.       this.occupations.addAll(occupations);
  62.       return this;
  63.     }
  65.     public BuilderExampleBuilder clearOccupations() {
  66.       if (this.occupations != null) {
  67.         this.occupations.clear();
  68.       }
  70.       return this;
  71.     }
  72.     public BuilderExample build() {
  73.       // complicated switch statement to produce a compact properly sized immutable set omitted.
  74.       Set<String> occupations = ...;
  75.       return new BuilderExample(created$set ? created : BuilderExample.$default$created(), name, age, occupations);
  76.     }
  78.     @java.lang.Override
  79.     public String toString() {
  80.       return "BuilderExample.BuilderExampleBuilder(created = " + this.created + ", name = " + this.name + ", age = " + this.age + ", occupations = " + this.occupations + ")";
  81.     }
  82.   }
  83. }

八、@Accessors

链式风格
@Accessors批注用于配置lombok如何生成和查找getter和setter。
默认情况下，lombok遵循针对getter和setter的bean规范：例如，名为Pepper的字段的getter是getPepper。但是，有些人可能希望打破bean规范，以得到更好看的API。 @Accessors允许您执行此操作。
可标注在类或属性上，当然最实用的功能还是标注到类上。
标注到类上，chain属性设置为true时，类的所有属性的setter方法返回值将为this，用来支持setter方法的链式写法。如：

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

fluent属性设置为true时，类的所有getter，setter方法将省略get和set前缀，获取属性值直接使用属性名相同的无参方法，设置属性值使用属性名相同的有参方法，并且返回值为this。如：

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

标注到属性上，使用prefix设置需要省略的属性生成getter，setter方法时的前缀，且属性必须为驼峰式命名。

  1. @Accessors(prefix = "r")
  2. @Getter
  3. @Setter
  4. private String rUsername = "riemann";

编译之后为

  1. public String getUsername() {
  2.     return rUsername;
  3. }
  4. public void setUsername(String rUsername) {
  5.     this.rUsername = rUsername;
  6. }

九、@Slf4j and @Log4j

在需要打印日志的类中使用，项目中使用slf4j、log4j日志框架

十、@NonNull

该注解快速判断是否为空,为空抛出java.lang.NullPointerException。

十一、@Synchronized

注解自动添加到同步机制，生成的代码并不是直接锁方法,而是锁代码块， 作用范围是方法上。

十二、@Cleanup

注解用于确保已分配的资源被释放（IO的连接关闭）。