Lombok学习与应用

Lombok

LomBok存在的意义

Lombok能以简单的注解形式来简化java代码，提高开发人员的开发效率。
例如开发中经常需要写的javaBean，都需要花时间去添加相应的getter/setter，也许还要去写构造器、equals等方法，而且需要维护，当属性多时会出现大量的getter/setter方法。

Lombok能通过注解的方式，在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString方法。这样就省去了手动重建这些代码的麻烦，使代码看起来更简洁些。

Lombok官网：https://projectlombok.org
各注解官网解析：https://projectlombok.org/features/all

Maven依赖：

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.20</version>
</dependency>

IDEA安装lombok插件

由于lombok的注解属于编译时解析注解 （后面会说到），所以在编写代码时，IDE并会认为此实体类没有get set，所以调用时会报错。此时就需要安装插件了，IDEA和Eclipse都有相应插件，搜lombok就行。
以下是idea安装插件的方法：
File–>Settings–>Plugins 右侧下方浏览库 Browse repositories… 然后搜索lombok

常用注解

注解	说明
@Data	注解在类上，会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。
@Getter/@Setter	此注解在属性上，可以为相应的属性自动生成Getter/Setter方法
@NonNull	该注解用在属性或构造器上，Lombok会生成一个非空的声明，可用于校验参数，能帮助避免空指针。
@Cleanup	该注解能帮助我们自动调用close()方法，例如IO流。
@EqualsAndHashCode	默认情况下，会使用所有非静态（non-static）和非瞬态（non-transient）属性来生成equals和hasCode，也能通过exclude注解来排除一些属性。
@ToString	类使用@ToString注解，Lombok会生成一个toString()方法，默认情况下，会输出类名、所有属性（会按照属性定义顺序），用逗号来分割。通过将includeFieldNames参数设为true，就能明确的输出toString()属性。这一点是不是有点绕口，通过代码来看会更清晰些。
@NoArgsConstructor	无参构造器
@RequiredArgsConstructor	部分参数构造器
@AllArgsConstructor	全参构造器

详细内容，非常建议到lombok官网查看实例，简单易懂

Lombok工作原理

自动生成的代码到底是如何产生的呢？核心之处就是对于注解的解析上。JDK5引入了注解的同时，也提供了两种解析方式。

• 运行时解析

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

• 编译时解析

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

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

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

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

---

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等等。

Lombok的优缺点

• 优点：

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

• 缺点：

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

版权声明：文章内容总结于网络，如侵犯到原作者权益，请与我联系删除或授权事宜