一、什么是Lombok
通俗地来讲,Lombok就是用注解帮你完成getter、setter、equals等方法编写的工具。当变量发生改变时,也不再需要修改对这些方法进行修改,Lombok会搞定这件事。
二、Lombok的使用
1、maven依赖引用
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.18</version>
<scope>provided</scope>
</dependency>
2、安装Lombok插件(IDEA)
File->Settings->plugins 搜索Lombok Install并重启IDEA
File->Settings->Build,Execution,Deployment->compiler->Annocation Processors 勾选Enable annotation processing
三、常用Lombok注解
@Getter/@Setter
作用类上,生成所有成员变量的getter/setter方法;作用于成员变量上,生成该成员变量的getter/setter方法。可以设定访问权限及是否懒加载等。
@ToString
作用于类,覆盖默认的toString()方法,可以通过of属性限定显示某些字段,通过exclude属性排除某些字段。
@EqualsAndHashCode
作用于类,覆盖默认的equals和hashCode
@NonNull
主要作用于成员变量和参数中,标识不能为空,否则抛出空指针异常。
@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor
作用于类上,用于生成构造函数。有staticName、access等属性。
staticName属性一旦设定,将采用静态方法的方式生成实例,access属性可以限定访问权限。
@NoArgsConstructor
生成无参构造器;
@RequiredArgsConstructor
生成包含final和@NonNull注解的成员变量的构造器;
@AllArgsConstructor
生成全参构造器
@Data
作用于类上,是以下注解的集合:@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor
@Builder
作用于类上,将类转变为建造者模式
四、使用Lombok可能存在的隐患
1、Lombok会帮忙自动生成的代码是在编译阶才会生成的,所以在开发的过程中,其实很多代码其实是缺失的。这就给代码调试带来一定的问题,例如我们想要知道某个类中的某个属性的getter方法都被哪些类引用的话,就没那么简单了。
2、当我们使用@Data定义一个类的时候,会自动帮我们生成equals()方法 。但是如果只使用了@Data,而不使用@EqualsAndHashCode(callSuper=true)的话,会默认是@EqualsAndHashCode(callSuper=false),这时候生成的equals()方法只会比较子类的属性,不会考虑从父类继承的属性,无论父类属性访问权限是否开放,这就可能得到意想不到的结果。
五 、出处
本文来自如下两篇文章(仅部分删改及整合)
Lombok的基本使用
作为一名资深后端开发,为什么从不推荐别人使用Lombok
由于这两篇标的也是转载的,我也找不到出处去找授权什么的,还是标了原创文章,应该…没什么问题吧,如有侵权请联系我~