lombok作为一个java插件,在java项目中应用很广泛,但是在不同的地方和场景下,要使用合适的注解,才能达到最好的效果,今天来分析下这个插件的原理和使用
在开发时,使用的步骤如下:
1、引入maven依赖:
<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.10</version> </dependency>
2、在ideal中安装lombok插件:File --- setting ----plugin----搜索lombok----install---重启idea
3、在项目中需要的地方添加注解即可
lombok的优点:
- 能通过注解的形式自动生成构造器、getter/setter、equals、hashcode、toString等方法,提高了一定的开发效率
- 让代码变得简洁,不用过多的去关注相应的方法
- 属性做修改时,也简化了维护为这些属性所生成的getter/setter方法等
缺点:
- 不支持多种参数构造器的重载
- 虽然省去了手动创建getter/setter方法的麻烦,但大大降低了源代码的可读性和完整性,降低了阅读源代码的舒适度
常用注解:
@Data:这个注解是很霸道的,包含了如下几个注解:
- @Getter:设置get方法
- @Setter:设置Set方法
- @ToString:设置ToStringI()方法
- @EqualsAndHashCode:设置hashCode和equals方法
上面的4个注解都是可以添加一些参数限制:of="field"表示只包含某些字段 exinclude="field" 表示字段不包含,在没有指定这些限制的时候,就会对所有的字段适用,在有些情况下时不需要这么多的,比如:equals和hashcode只需要根据id字段生成即可,tostring时,有些时间字段是不需要的,可以根据情况设置
@AllArgsConstructor:所有字段都包含的有参构造器
@NoArgsConstructor:无参构造器
@NonNull:用在属性或者构造器上,Lombok会生成一个非空的声明,可用于校验参数,能帮助避免空指针。
lombok处理过程:在编译器进行
- javac对源代码进行分析,生成了一棵抽象语法树(AST)
- 运行过程中调用实现了“JSR 269 API”的Lombok程序
- 此时Lombok就对第一步骤得到的AST进行处理,找到@Data注解所在类对应的语法树(AST),然后修改该语法树(AST),增加注解对应的方法;
- javac使用修改后的抽象语法树(AST)生成字节码文件,即给class增加新的节点(代码块)
验证:使用反编译工具,查看编译后的字节码文件,是否生成对应的方法:
在http://jd.benow.ca上下载jd-gui,下载后,打开工具,选择class文件即可看见源码