Lombok使用详解
Github https://github.com/rzwitserloot/lombok
官网 https://projectlombok.org/
Lombok是什么?
Lombok是一个通过注解以达到减少代码的Java库,如通过注解的方式减少get,set方法,构造方法等。
安装使用Lombok
步骤一:加入jar包
方法一
通过向lib文件夹中添加lombok.jar包即可,
方法二 推荐
如果使用的是Maven,则可在项目的pom.xml文件中添加以下依赖:
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.12</version>
</dependency>
步骤二 识别lombok
通过以上两种方法的确可以使用Lombok的相关API了,但无论是Intelij idea,还是Eclipse默认情况下是不能识别的,我们还要让idea识别起来。
Intellij Idea方法:
File->settings->Plugins->Browse repositories->Lombok 如图所示:
使用Lombok 注解
Lombok提供注解方式来提高代码的简洁性,常用注解有:
@Data
@Setter @Getter
@NonNull
@Synchronized
@ToString
@EqualsAndHashCode
@Cleanup
@SneakyThrows
下面分别介绍每个方法的作用以及对应的源代码
@Data 作用于类
@Data
该注解相当于同时加上以下注解@Setter@Getter,@ToString,@EqualsAndHashCode
@Data作用于类上方
使用,代表为类中的每个属性都加了getter,setter,tostring,equals,hashcode
方法
@Data
public class Person {
private String name;
private String address;
private String city;
private String state;
private String zip;
private Date brithday;
}
效果如下:
@Getter@Setter作用于属性上
,自动生成get,set方法.
public class Person {
@Getter@Setter
private String name;
}
等价源码:
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
@AllArgsConstructor 作用于类
作用于类上,为该类提供一个包含全部属性的构造方法
,注意此时默认构造方法不会提供。
@AllArgsConstructor
public class Demo {
private int id;
private String name;
}
效果如下:
public class Demo {
private int id;
private String name;
public Demo(final int id, final String name) {
this.id = id;
this.name = name;
}
}
@NoArgsConstructor 作用于类
作用于类上,提供一个无参的构造方法
。可以和@AllArgsConstructor同时使用,此时会生成两个构造方法:无参
@Builder
@Builder提供了一种比较推崇的构建值对象的方式; 非常推荐的一种构建值对象的方式。标注@Builder的类, 会在类内部生成一个内部类,内部类中定义一个build()方法用于生成值对象
缺点就是父类的属性不能产于builder
使用方法:
@Builder
public class Demo {
private final int finalVal = 10;
private String name;
private int age;
}
编译生成后等价于
public class Demo {
private final int finalVal = 10;
private String name;
private int age;
Demo(String name, int age) {
this.name = name;
this.age = age;
}
public static Demo.DemoBuilder builder() {
return new Demo.DemoBuilder();
}
public static class DemoBuilder {
private String name;
private int age;
DemoBuilder() {
}
public Demo.DemoBuilder name(String name) {
this.name = name;
return this;
}
public Demo.DemoBuilder age(int age) {
this.age = age;
return this;
}
public Demo build() {
return new Demo(this.name, this.age);
}
public String toString() {
return "Demo.DemoBuilder(name=" + this.name + ", age=" + this.age + ")";
}
}
}
@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 new java.lang.NullPointerException("members");
this.members = members;
}
@NonNull
public List<Person> getMembers() {
return members;
}
public void setMembers(@NonNull final List<Person> members) {
if (members == null) throw new java.lang.NullPointerException("members");
this.members = members;
}
@Slf4j
该注解的作用主要是操作在idea中的控制台中打印的日志信息。该注解相当于代替了以下的代码:private final Logger logger = LoggerFactory.getLogger(当前类名.class);
就是使用指定类初始化日志对象,在日志输出的时候,可以打印出日志信息所在的类。
@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) {
return format.format(date);
}
}
@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();
}
}