文章来源公众号：猿人谷

官方介绍如下：

  1. Project Lombok makes java a spicier language by adding 'handlers' that know how to build and compile simple, boilerplate-free, not-quite-java code.

大致意思是Lombok通过增加一些“处理程序”，可以让java变得简洁、快速。

Lombok能以简单的注解形式来简化java代码，提高开发人员的开发效率。例如开发中经常需要写的javabean，都需要花时间去添加相应的getter/setter，也许还要去写构造器、equals等方法，而且需要维护，当属性多时会出现大量的getter/setter方法，这些显得很冗长也没有太多技术含量，一旦修改属性，就容易出现忘记修改对应方法的失误。

Lombok能通过注解的方式，在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString方法。出现的神奇就是在源码中没有getter和setter方法，但是在编译生成的字节码文件中有getter和setter方法。这样就省去了手动重建这些代码的麻烦，使代码看起来更简洁些。

Lombok的使用跟引用jar包一样，可以在官网（https://projectlombok.org/download）下载jar包，也可以使用maven添加依赖：

  1. <dependency>
  2.     <groupId>org.projectlombok</groupId>
  3.     <artifactId>lombok</artifactId>
  4.     <version>1.16.20</version>
  5.     <scope>provided</scope>
  6. </dependency>

接下来我们来分析Lombok中注解的具体用法。

@Data注解在类上，会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。

官方实例如下：

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

如不使用Lombok，则实现如下：

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

如果觉得@Data太过残暴（因为@Data集合了@ToString、@EqualsAndHashCode、@Getter/@Setter、@RequiredArgsConstructor的所有特性）不够精细，可以使用@Getter/@Setter注解，此注解在属性上，可以为相应的属性自动生成Getter/Setter方法，示例如下：

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

如果不使用Lombok：

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

该注解用在属性或构造器上，Lombok会生成一个非空的声明，可用于校验参数，能帮助避免空指针。

示例如下：

  1. import lombok.NonNull;
  3. public class NonNullExample extends Something {
  4.   private String name;
  5.   
  6.   public NonNullExample(@NonNull Person person) {
  7.     super("Hello");
  8.     this.name = person.getName();
  9.   }
  10. }

不使用Lombok：

  1. import lombok.NonNull;
  3. public class NonNullExample extends Something {
  4.   private String name;
  5.   
  6.   public NonNullExample(@NonNull Person person) {
  7.     super("Hello");
  8.     if (person == null) {
  9.       throw new NullPointerException("person");
  10.     }
  11.     this.name = person.getName();
  12.   }
  13. }

该注解能帮助我们自动调用close()方法，很大的简化了代码。

示例如下：

  1. import lombok.Cleanup;
  2. import java.io.*;
  4. public class CleanupExample {
  5.   public static void main(String[] args) throws IOException {
  6.     @Cleanup InputStream in = new FileInputStream(args[0]);
  7.     @Cleanup OutputStream out = new FileOutputStream(args[1]);
  8.     byte[] b = new byte[10000];
  9.     while (true) {
  10.       int r = in.read(b);
  11.       if (r == -1) break;
  12.       out.write(b, 0, r);
  13.     }
  14.   }
  15. }

如不使用Lombok，则需如下：

  1. import java.io.*;
  3. public class CleanupExample {
  4.   public static void main(String[] args) throws IOException {
  5.     InputStream in = new FileInputStream(args[0]);
  6.     try {
  7.       OutputStream out = new FileOutputStream(args[1]);
  8.       try {
  9.         byte[] b = new byte[10000];
  10.         while (true) {
  11.           int r = in.read(b);
  12.           if (r == -1) break;
  13.           out.write(b, 0, r);
  14.         }
  15.       } finally {
  16.         if (out != null) {
  17.           out.close();
  18.         }
  19.       }
  20.     } finally {
  21.       if (in != null) {
  22.         in.close();
  23.       }
  24.     }
  25.   }
  26. }

默认情况下，会使用所有非静态（non-static）和非瞬态（non-transient）属性来生成equals和hasCode，也能通过exclude注解来排除一些属性。

示例如下：

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

类使用@ToString注解，Lombok会生成一个toString()方法，默认情况下，会输出类名、所有属性（会按照属性定义顺序），用逗号来分割。

通过将includeFieldNames参数设为true，就能明确的输出toString()属性。这一点是不是有点绕口，通过代码来看会更清晰些。

使用Lombok的示例：

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

不使用Lombok的示例如下：

  1. import java.util.Arrays;
  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.   private int id;
  9.   
  10.   public String getName() {
  11.     return this.getName();
  12.   }
  13.   
  14.   public static class Square extends Shape {
  15.     private final int width, height;
  16.     
  17.     public Square(int width, int height) {
  18.       this.width = width;
  19.       this.height = height;
  20.     }
  21.     
  22.     @Override public String toString() {
  23.       return "Square(super=" + super.toString() + ", width=" + this.width + ", height=" + this.height + ")";
  24.     }
  25.   }
  26.   
  27.   @Override public String toString() {
  28.     return "ToStringExample(" + this.getName() + ", " + this.shape + ", " + Arrays.deepToString(this.tags) + ")";
  29.   }
  30. }

无参构造器、部分参数构造器、全参构造器。Lombok没法实现多种参数构造器的重载。

Lombok示例代码如下：

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

不使用Lombok的示例如下：

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

会发现在Lombok使用的过程中，只需要添加相应的注解，无需再为此写任何代码。自动生成的代码到底是如何产生的呢？

核心之处就是对于注解的解析上。JDK5引入了注解的同时，也提供了两种解析方式。

  • 运行时解析

运行时能够解析的注解，必须将@Retention设置为RUNTIME，这样就可以通过反射拿到该注解。java.lang,reflect反射包中提供了一个接口AnnotatedElement，该接口定义了获取注解信息的几个方法，Class、Constructor、Field、Method、Package等都实现了该接口，对反射熟悉的朋友应该都会很熟悉这种解析方式。

  • 编译时解析

编译时解析有两种机制，分别简单描述下：

1）Annotation Processing Tool

apt自JDK5产生，JDK7已标记为过期，不推荐使用，JDK8中已彻底删除，自JDK6开始，可以使用Pluggable Annotation Processing API来替换它，apt被替换主要有2点原因：

  • api都在com.sun.mirror非标准包下
  • 没有集成到javac中，需要额外运行

2）Pluggable Annotation Processing API

JSR 269自JDK6加入，作为apt的替代方案，它解决了apt的两个问题，javac在执行的时候会调用实现了该API的程序，这样我们就可以对编译器做一些增强，这时javac执行的过程如下：

123

Lombok本质上就是一个实现了“JSR 269 API”的程序。在使用javac的过程中，它产生作用的具体流程如下：

  1. javac对源代码进行分析，生成了一棵抽象语法树（AST）
  2. 运行过程中调用实现了“JSR 269 API”的Lombok程序
  3. 此时Lombok就对第一步骤得到的AST进行处理，找到@Data注解所在类对应的语法树（AST），然后修改该语法树（AST），增加getter和setter方法定义的相应树节点
  4. javac使用修改后的抽象语法树（AST）生成字节码文件，即给class增加新的节点（代码块）

拜读了Lombok源码，对应注解的实现都在HandleXXX中，比如@Getter注解的实现时HandleGetter.handle()。还有一些其它类库使用这种方式实现，比如Google Auto、Dagger等等。

优点：

  1. 能通过注解的形式自动生成构造器、getter/setter、equals、hashcode、toString等方法，提高了一定的开发效率
  2. 让代码变得简洁，不用过多的去关注相应的方法
  3. 属性做修改时，也简化了维护为这些属性所生成的getter/setter方法等

缺点：

  1. 不支持多种参数构造器的重载
  2. 虽然省去了手动创建getter/setter方法的麻烦，但大大降低了源代码的可读性和完整性，降低了阅读源代码的舒适度

Lombok虽然有很多优点，但Lombok更类似于一种IDE插件，项目也需要依赖相应的jar包。Lombok依赖jar包是因为编译时要用它的注解，为什么说它又类似插件？因为在使用时，eclipse或IntelliJ IDEA都需要安装相应的插件，在编译器编译时通过操作AST（抽象语法树）改变字节码生成，变向的就是说它在改变java语法。它不像spring的依赖注入或者mybatis的ORM一样是运行时的特性，而是编译时的特性。这里我个人最感觉不爽的地方就是对插件的依赖！因为Lombok只是省去了一些人工生成代码的麻烦，但IDE都有快捷键来协助生成getter/setter等方法，也非常方便。

知乎上有位大神发表过对Lombok的一些看法：

  1. 这是一种低级趣味的插件，不建议使用。JAVA发展到今天，各种插件层出不穷，如何甄别各种插件的优劣？能从架构上优化你的设计的，能提高应用程序性能的 ，
  2. 实现高度封装可扩展的...， 像lombok这种，像这种插件，已经不仅仅是插件了，改变了你如何编写源码，事实上，少去了代码你写上去又如何？ 
  3. 如果JAVA家族到处充斥这样的东西，那只不过是一坨披着金属颜色的屎，迟早会被其它的语言取代。

虽然话糙但理确实不糙，试想一个项目有非常多类似Lombok这样的插件，个人觉得真的会极大的降低阅读源代码的舒适度。

虽然非常不建议在属性的getter/setter写一些业务代码，但在多年项目的实战中，有时通过给getter/setter加一点点业务代码，能极大的简化某些业务场景的代码。所谓取舍，也许就是这时的舍弃一定的规范，取得极大的方便。

我现在非常坚信一条理念，任何编程语言或插件，都仅仅只是工具而已，即使工具再强大也在于用的人，就如同小米加步枪照样能赢飞机大炮的道理一样。结合具体业务场景和项目实际情况，无需一味追求高大上的技术，适合的才是王道。

Lombok有它的得天独厚的优点，也有它避之不及的缺点，熟知其优缺点，在实战中灵活运用才是王道。

参考：

https://projectlombok.org/features/

https://github.com/rzwitserloot/lombok?spm=a2c4e.11153940.blogcont59972.5.2aeb6d32hayLHv

https://www.zhihu.com/question/42348457

https://blog.csdn.net/ghsau/article/details/52334762

版权声明：本文为alterem原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://www.cnblogs.com/alterem/p/11611417.html