IDEA中lombok的插件配置及使用

Posted 2020-12-23 zxhbk

1. 解释

   Project Lombok is a java library that automatically plugs into your editor and build tools， spicing up your java. Never write another getter or equals method again， with one annotation your class has a fully featured builder， Automate your logging variables， and much more.

   Project Lombok是一个java库，它自动插入到编辑器和构建工具中，增强java的性能。

   不要再编写另一个getter或equals方法，使用一个注释，您的类有一个功能齐全的生成器，自动记录变量，等等。

    

   Lombok原理剖析

   作为一个Java开发者来说，光了解插件或者技术框架的用法只是做到了“知其然而不知其所以然”，如果真正掌握其背后的技术原理，看明白源码设计理念才能真正做到“知其然知其所以然”。

   可能熟悉Java自定义注解的同学已经猜到，Lombok这款插件在Javac编译阶段对自定义的注解进行预处理后生成真正在JVM上面执行的“Class文件”。Lombok插件具体的执行流程如下: .

   

   

   从上面的Lombok执行的流程图中可以看出，在Javac 解析成AST抽象语法树之后，Lombok根据自己编写的注解处理器，动态地修改AST，增加新的节点(即Lombok自定义注解所需要生成的代码)，最终通过分析生成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

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

    

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

   1. javac对源代码进行分析，生成了一棵抽象语法树(AST)

   2. 运行过程中调用实现了“JSR 269 API"的L ombok程序

   3. 此时L ombok就对第一步骤得到的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加一点点业务代码,能极大的简化某些业务场景的代码。所谓取舍，也许就是这时的舍弃一定的规范， 取得极大的方便。

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

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

    

   配置

   1、安装插件

   

   

   

   2、在项目中导入jar包

   

   

   

   

   Lombok常用注解说明

   • @NonNull:用在方法参数前，会自动对该参数进行非空校验，为空抛出NPE (NullPointerException

   • @Cleanup: 自动管理资源，用在局部变量之前，在当前变量范围内即将执行完毕退出前会清理资源，生成try-fially的代码关闭流

   • @Getter/@Setter: 用在属性上，不用自己手写setter和getter方法，还可指定访问范围

   • @ToString: 用在类上，可以自动覆写toString方法

   • @EqualsAndHashCode: 用在类上，自动生成equals方法和hashCode方法

   • @NoArgsConstructor， @RequiredArgsConstructor and @AllArgsConstructor:用在类上，自动生成无参构造和使用所有参数的有参构造函数。

   • @Data:用在类上，相当于同时使用了@ToString、@EqualsAndHashCode、 @Getter、 @Setter

   • @RequiredArgsConstrutor这些注解 ，对POJO类十分有用.

   • @Value:用在类上，是@Data的不可变形式，相当于为属性添加final声明，只提供getter方法，而不提供setter方法

   • @SneakyThrows: 自动抛受检异常，而无需显式在方法上使用throws语句

   • @Synchronized:用在方法上，将方法声明为同步的，并自动加锁

   • @Getter(lazy=true): 可以替代经典的Double Check Lock样板代码

   • @Accessors(chain = true)：开启支持链式编程的写法，比如：User user = new User(); user.setName("123").setAge(12).setbirthday("").....

    

   常用的几个解释

   @Data

   最为常用！

   该注解作用比较全，其包含注解的集合@ToString， @Equal sAndHashCode，所有字段的@Get ter和所有非final字段的@Setter， @RequiredArgsConstructor。

   @Data
   public class Person {
       private Integer id;
       private String name;
   }

   

   @NoArgsConstructor 和 @AllArgsConstructor

   import lombok.AllArgsConstructor;
   import lombok.Data;
   import lombok.NoArgsConstructor;
   
   @Data
   @NoArgsConstructor  // 空构造
   @AllArgsConstructor // 有参构造（包括所有的属性的构造器），定义有参构造后，就没有空参构造
   public class Person {
       private Integer id;
       private String name;
   
       public static void main(String[] args) {
           Person p1 = new Person();
           Person p2 = new Person(1, "张益没有达");
       }
   }

   

   @Accessors()

   import lombok.Data;
   import lombok.experimental.Accessors;
   
   @Data
   @Accessors(chain = true)    // 默认为false
   public class Person {
       private Integer id;
       private String name;
   
       public static void main(String[] args) {
           Person person = new Person();
           person.setId(1).setName("张益没有达");
           System.out.println(person);
       }
   }

   

   @Setter 和 @Getter

   import lombok.Setter;
   
   @Setter
   public class Person {
       private Integer id;
       private String name;
   }

   

   import lombok.Getter;
   
   @Getter
   public class Person {
       private Integer id;
       private String name;
   }

   

   @NonNull

   

   @Cleanup（不推荐使用）

   

   

    

   其他的注解同理，可以自己下去测试！ 

   IDEA中pom依赖导入

   <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
   <dependency>
       <groupId>org.projectlombok</groupId>
       <artifactId>lombok</artifactId>
       <version>1.18.8</version>
       <scope>provided</scope>
   </dependency>

    

   以上是关于IDEA中lombok的插件配置及使用的主要内容，如果未能解决你的问题，请参考以下文章

   Idea安装lombok插件及使用

   IntelliJ IDEA lombok插件的安装和使用

   idea中lombok log找不到符号

   IDEA 安装lombok及使用详解

   IDEA使用lombok配置, 解决pom.xml添加 provided报红问题

   idea 安装 lombok插件