Lambok是一款开源的可用于java平台的代码生成库。我们在定义JavaBean的时候,会使用IDE自动生成构造方法、getter、setter、equals、hashCode、toString等方法,一旦类的属性有修改就要重新生成。Lambok直接通过在类上加@Data注解便可以帮我们免去这些重复劳动,简化java代码。
工具/原料
-
Eclipse集成开发工具
-
Lambok插件
方法/步骤
-
1
Lambok在使用前必须安装,否则IDE无法解析lambok的注解,从官网下载lombok.jar文件,双击下载的jar文件,会自动寻找使用的IDE,此时会弹出确认eclipse安装路径的对话框,点击install/update按钮,即可完成安装。
-
2
安装完可以查看eclipse中是否成功安装了Lambok插件,打开eclipse的安装目录可以看到生成了lambok.jar文件;用文本编辑器notpad++等打开eclipse.ini文件,可以看到lambok相关的内容;打开Eclipse-->Help-->About Eclipse可以看到Lambok相关的installed信息。
-
3
如果自动安装失败,可以尝试手动安装Lambok,将下载的lambok.jar复制到myeclipse.ini/eclipse.ini所在文件目录,打开myeclipse.ini/eclipse.ini文件,在最后添加-javaagent:lombok.jar(如步骤2截图)并保存,重启myeclipse/eclipse即可。
END
Lambok的使用
-
1
在使用lambok注解时要将lambok.jar导入到项目的工程下,以maven管理的项目为例,在pom.xml文件中添加如下的配置。
<!-- 消除JavaBean代码的冗余 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.14.8</version>
</dependency>
-
2
lambok注解的介绍:
@Data注解在类上,提供类中所有属性的get/set方法、equals、canEqual、hashCode、toString方法;
@NoArgsConstructor注解在类上,为类生成一个无参的构造方法;
@AllArgsConstructor注解在类上,为类生成一个全参的构造方法;
这些方法否不会再java代码中显式生成,而是自动生成到.class文件中。
还有注解在属性上的方法等,这里就不一一列举了,更多介绍可以参考官网。
-
3
下面用Eclipse下创建的一个Student类来举例,如下图所示,类中只有四个属性,通过使用lombok注解,如果可以看到在右侧outline视图中生成了相应的get/set方法、无参构造、有参构造等。因为.java文件中看不到这些代码,若想查看是否有代码生成,可用反编译工具打开.class文件查看,从下图的结果中可以看到,已经成功生成了相应的代码。
-
4
下面再介绍两个实用的lambok注解: @SneakyThrows抛出异常和@Cleanup关闭流, 不用再try--catch--finally写繁琐的关闭流代码了。由此可见使用lambok注解,使得java代码的编写简洁高效。
END
注意事项
-
IED必须安装Lambok才可以解析lambok注解
-
项目中必须依赖lambok.jar包