Lombok的使用及其原理

Lombok简介说明:

  Lombok是一款Java开发插件, 使得Java开发者 可以通过其定义的一些注解来消除业务工程中冗长和繁琐的代码,尤其对于简单的Java模型对象(POJO) 。在开发环境中使用Lombok插件后,Java开发人员可以节省出重复构建,诸如hashCode和equals这样的方法以及各种业务对象模型的accessor和ToString等方法的大量时间。对于这些方法,它能够在编译源代码期间自动帮我们生成这些方法,并没有如反射那样降低程序的性能。

  • Lombok项目是一个Java库
  • 它会自动插入编辑器和构建工具中,
  • Lombok提供了一组有用的注释,用来消除Java类中的大量样板代码。
  • 代码从而产生干净,简洁且易于维护的Java类。

使用步骤:

1.在IDEA中安装Lombok插件
在File --> setting 中lombok ,如下:
Lombok的使用及其原理_第1张图片

2.在项目中导入lombok的jar包(坐标)

 <dependency>
   <groupId>org.projectlombokgroupId>
   <artifactId>lombokartifactId>
   <version>1.18.10version>
 dependency>

3.在实体类上加注解即可。

常用注解说明:

  • @Setter :注解在类或字段,注解在类时为所有字段生成setter方法,注解在字段上时只为该字段生成setter方法。
  • @Getter :使用方法同上,区别在于生成的是getter方法。
  • @ToString :注解在类,添加toString方法。
  • @EqualsAndHashCode: 注解在类,生成hashCode和equals方法。
  • @NoArgsConstructor: 注解在类,生成无参的构造方法。
  • @RequiredArgsConstructor: 注解在类,为类中需要特殊处理的字段生成构造方法,比如final和被@NonNull注解的字段。
  • @AllArgsConstructor: 注解在类,生成包有参的构造方法。
  • @Data: 注解在类,生成setter/getter、equals、canEqual、hashCode、toString方法,如为final属性,则不会为该属性生成setter方法。
  • @Slf4j: 注解在类,生成log变量,严格意义来说是常量。
  • @NonNull: 用在方法参数前,会自动对该参数进行非空校验,为空抛出NPE (NullPointerException)
  • @Cleanup: 自动管理资源,用在局部变量之前,在当前变量范围内即将执行完毕退出前会清理资源,生成try-finally的代码关闭流
  • @Value: 用在类上,是@Data的不可变形式,相当于为属性添加finaI声明,只提供getter方法, 而不提供setter方法
  • @SneakyThrows: 自动抛受检异常, 而无需显式在方法上使用throws语
  • @Synchronized: 用在方法上,将方法声明为同步的,并自动加锁
  • @Getter(azy=true): 可以替代经典的Double Check Lock样板代码

Lombok原理剖析

  作为一个Java开发者来说,光了解插件或者技术框架的用法只是做到了“知其然而不知其所以然”,如果真正掌握其背后的技术原理,看明白源码设计理念才能真正做到“知其然知其所以然"。
  可能熟悉Java自定义注解的同学已经猜到,Lombok这款插件在Javac编译阶段对自定 义的注解进行预处理后生成真正在JVM,上面执行的“Class文件”。Lombok插件 具体的执行流程如下
Lombok的使用及其原理_第2张图片

  从上面的Lombok执行的流程图中可以看出,在Javac 解析成AST抽象语法树之后,Lombok根据自己编写的注解处理器,动态地修改AST。增加新的节点(即ILombok自定义注解所需要生成的代码)。最终通过分析生成JVM可执行的字节码Class文件。 使用注解处理自定义注解是在编译阶段进行修改,而JDK的反射技术是在运行时动态修改,两者相比。反射虽然更加灵活一些但是带来的性能损耗更加大。

  需要更加深入理解Lombok插件的细节,自己查阅其源代码是必比可少的。对开源框架代码比较有执着追求的重鞋可以将Lombok的源代码工程从github上download到本地进行阅读和自己调试。

  lombok的官方地址: https://projectlombok.org/

  lombok的Github地址: https://github.com/rzwitserloot/lombok

注解如何解析

在Lombok使用的过程中,只需要添加相应的注解,无需再为此写任何代码。自动生成的代码到底是如何产生的呢?
核心之处就是对于注解的解析上。JDK5引入了注解的同时,也提供了两种解析方式。

运行时解析–动态性–反射

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

编译时解析

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

  1. Annotation Processing Tool

    apt自JDK5产生,JDK7已标记为过期,不推荐使用, JDK8中已彻底删除,没有集成到javac中,要额外运行。

    自JDK6开始,可以使用Pluggable[ 可插拔] Annotation Processing API来替换它,

  2. Pluggable Annotation Processing API

    [插入式注解处理APIJSR 269) ]作为apt的替代方案,它解决了apt的两个问题,javac在执行的时候会调用实现了该API的程序,这样我们就可以对编译器做一些增强。

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()。

Lombok的优缺点

优点:

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

  虽然话糙但理确实不糙,试想一个项目有非常多类似Lombok这样的插件,个人觉得真的会极大的降低阅读源代码的舒适度。虽然非常不建议在属性的getter/setter写一些业务代码, 但在多年项目的实战中,有时通过给getter/setter加一 点点业务代码,能极大的简化某些业务场景的代码。所谓取舍,也许就是这时的舍弃一定的规范,取得极大的方便。

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

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


如果有收获!!! 希望老铁们来个三连,点赞、收藏、转发
创作不易,别忘点个赞,可以让更多的人看到这篇文章,顺便鼓励我写出更好的博客

你可能感兴趣的:(第三方插件,lombok,lombok使用步骤,lombok常用注解,lombok注解原理,lombok优缺点)