Getter/Setter方法大家再熟悉不过了,为了我们代码的安全性和可法性,我们的Model中经常会把属性设为private,但是属性一旦多了之后,就要写一大堆Getter/Setter方法,即使现在很多IDE已经有快捷键帮我们实现Getter/Setter方法,但是还是会导致我们的类看起来很臃肿。
上面只是一个小例子,平时开发中我们所遇到的臃肿而不实用的代码还有很多,为了解决上述问题,Lombok就应运而生了,Lombok的应用有很多,它可以通过注解来帮我们简化平时很臃肿的Java代码。
Lombok的官方网址:https://projectlombok.org/
要让IDE支持Lombok,首先需要安装插件,某种其无法识别Lombok的注解,安装插件步骤如下:
在IDEA中:File->Settings->Plugins->Browse repositories->输入lombok->点击install->重启IDEA
Eclipse/MyEclipse:手动安装 lombok
1.将 lombok.jar 复制到 myeclipse.ini / eclipse.ini 所在的文件夹目录下
2.打开 eclipse.ini / myeclipse.ini,在最后面插入以下两行并保存:
-Xbootclasspath/a:lombok.jar
-javaagent:lombok.jar
3.重启 eclipse / myeclipse
如果是Maven项目,在Maven项目中引入:
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.16</version>
<scope>provided</scope>
</dependency>
如果是普通的WEB项目,直接拷贝Jar到工程下面的lib目录
配置好之后就可以使用Lombok了
Lombok的注解详细文档:https://projectlombok.org/features/all
下面解释几个比较常用的
@Data:注解在类上;提供类所有属性的 getting 和 setting 方法,此外还提供了equals、canEqual、hashCode、toString 方法
@Setter:注解在属性上;为属性提供 setting 方法
@Getter:注解在属性上;为属性提供 getting 方法
@Log4j2 :注解在类上;为类提供一个 属性名为log 的 log4j 日志对象,和@Log4j注解类似
@NoArgsConstructor:注解在类上;为类提供一个无参的构造方法
@AllArgsConstructor:注解在类上;为类提供一个全参的构造方法
@EqualsAndHashCode:默认情况下,会使用所有非瞬态(non-transient)和非静态(non-static)字段来生成equals和hascode方法,也可以指定具体使用哪些属性。
@toString:生成toString方法,默认情况下,会输出类名、所有属性,属性会按照顺序输出,以逗号分割。
@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor
无参构造器、部分参数构造器、全参构造器,当我们需要重载多个构造器的时候,只能自己手写了
@NonNull:注解在属性上,如果注解了,就必须不能为Null
@val:注解在属性上,如果注解了,就是设置为final类型,可查看源码的注释知道
已@data为例,演示如下:
没加@Data注解之前,属性是黑色的,提示我们没有写Getter/Setter方法
加了注解之后,可以看到属性已经变颜色了
我们调用测试一下,可以看到,的确可以调用Get和Set方法了