概序
Lombok 是一种 Java Archive (JAR) 文件,可用来消除 Java 代码的冗长。
一个标准的 Java bean,一个典型的 Java bean 一般具有几个属性,getter 和 setter。通常还会有一个 toString()
方法、一个 equals()
方法和一个 hashCode()
方法。
为了消除代码行,Lombok 使用注释来标识类和 Java 代码块。所有的 getter、setter 以及其他三个方法都是在编译时被暗示并包括进来的。
Lombok 还让您得以简化代码的其他部分 — 不仅仅是 Java bean。比如,还可以减少 try/catch/finally 块内以及同步方法内的冗余代码。
IDEA安装Lombok 插件
- 打开IDEA的Settings面板,并选择Plugins选项,然后点击 “Browse repositories..”
- 在输入框输入”lombok”,得到搜索结果,Lombok plugin,点击安装,然后安装提示重启IDEA,安装成功;
项目集成Lombok
方式一:添加lombok的maven依赖
<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok-maven -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok-maven</artifactId>
<version>1.16.18.1</version>
</dependency>
方式二:手动添加lombok.jar.
使用lombok
创建一个简单的JavaBean
public class Food{
private String name;
private int size;
private String color;
private String style;
}
@Data注解的使用
使用@Data注解为上面的JavaBean添加getter、setter、equals、hashcode、toString等方法。
import lombok.Data
@Data
public class Food{
private String name;
private int size;
private String color;
private String style;
}
看编译后的.class
在生成 getter/setter 方法时,Lombok 遵从传统的标准。所有这些方法名都以 get 或 set 开头并且属性名都是大写的。当然,如果属性是一个 Boolean,情况例外。在这种情况下,getter 以 is 开始,而非 get。这是 Java bean 的一种标准实践。
@Cleanup 注解使用
为了消除 try/catch/finally 块的冗余,只需使用 @Cleanup 注释
public static void main(String[] args) throws IOException {
@Cleanup InputStream in = new FileInputStream(args[0]);
@Cleanup OutputStream out = new FileOutputStream(args[1]);
}
这个代码块不仅消除了 try/catch/finally 块,而且还关闭了开放流
@Synchronized 注解使用
Lombok 还可以减少同步方法所需的代码的冗余。很自然,这是用 @Synchronized 方法实现的。
@Synchronized
private int foo() {
//some magic done here
return 1;
}
如果用 @Synchronized
注释的这个方法是静态的,那么 Lombok 就会创建一个名为 $LOCK
的类对象,并会针对该对象同步这个方法。