PS:在开发过程中,偶然在网上看到了lombok,研究了一番后,发现lombok对于java开发还是比较友好的。特别是对于现在追求简洁开发,去xml配置的“懒码农”更是不错的福音。下面我就简单的介绍一下吧!如果写的不好或者有问题,欢迎geek。
1. Lombok是什么?
Lombok是一个通过注解以达到减少代码的Java库,如通过注解的方式减少get,set方法,构造方法等。
官方地址:https://www.projectlombok.org/
2. 如何安装Lombok?
在maven项目的pom.xml文件中添加以下依赖:
org.projectlombok lombok 1.16.12
这样就可以使用Lombok的相关API了,但是Intelij idea默认是不能识别的,我们需要安装插件使得idea识别起来。(如果你是用的eclipse,呵呵呵呵,当然一样需要安装插件。)
Intellij Idea方法:
File->settings->Plugins->Browse repositories->Lombok 如图所示:
3 如何使用Lombok?
Lombok提供注解方式来提高代码的简洁性,常用注解有:
@Data
@Setter @Getter
@NonNull
@Synchronized
@ToString
@EqualsAndHashCode
@Cleanup
@SneakyThrows
下面分别介绍每个方法的作用以及对应的源代码
@Data
相当于同时加上以下注@Setter@Getter,@ToString,
@EqualsAndHashCode,作用于类中使用:
@Data
public class Person {
private String address;
private String city;
private String state;
private String zip;
private Date brithday;
}
@Getter@Setter
作用于属性上,自动生成get,set方法.
@NonNull
快速判断是否为空,如果为空,则抛出java.lang.NullPointerException
使用方法:
public class Person {
private String name;
@Setter@Getter@NonNull
private List<Person> member;
}
源码:
@NonNull
private List<Person> members;
public Family(@NonNull final List<Person> members) {
if (members == null)throw newjava.lang.NullPointerException("members");
this.members = members;
}
@NonNull
public List<Person> getMembers() {return members;}
if (members == null)
throw new java.lang.NullPointerException("members");
this.members = members;}
@Synchronized
自动添加到同步机制,有趣的是,生成的代码并不是直接锁方法,而是锁代码块, 作用范围是方法上
使用方法:
private DateFormat format =
new SimpleDateFormat("MM-dd-YYYY");
@Synchronized
public String synchronizedFormat(Date date) {
return format.format(date);
}
生成等价源码:
private final java.lang.Object $lock = new java.lang.Object[0];
private DateFormat format = new SimpleDateFormat("MM-dd-YYYY");
public String synchronizedFormat(Date date){ synchronized ($lock) { } }
@ToString
该方法大家应该非常熟悉,但需要注意的是:@ToString有多个属性可以进一步设置:
callSuper 是否输出父类的toString方法,默认为false
includeFieldNames 是否包含字段名称,默认为true
exclude 排除生成tostring的字段
使用方法:
@ToString(callSuper = true,exclude ={"name"})
public class Person {
private String name;
private String address;
}
等价源码:
public String toString() {
return "Person{" + "address='" + address + '\'' + '}';
}
@Cleanup
注释可用于确保已分配的资源被释放,如IO的连接关闭。
使用方法:
public void testCleanUp() {
try {
@Cleanup
ByteArrayOutputStream baos = new ByteArrayOutputStream();
baos.write(new byte[] {'Y','e','s'});
System.out.println(baos.toString());
} catch (IOException e) {e.printStackTrace();}}
等价源码:
public void testCleanUp() {
try {
ByteArrayOutputStream baos = new ByteArrayOutputStream(); try {
baos.write(new byte[]{'Y', 'e', 's'}); System.out.println(baos.toString());
} finally {baos.close();}
} catch (IOException e) {e.printStackTrace();}}
@Builder
final ListNode node = ListNode.builder.value(10).build();
创建builder后,在源码里创建了一个ListNodeExample这个类,这个类暴露了set方法;
创建value后,在源码里调用了ListNodeExample的setvalue方法,将value赋值为10;
创建builer后,在源码了return new ListNode 对象并调用有参方法赋值。