前言
在Java中,封装是一个非常好的机制,最常见的封装莫过于get,set方法了,无论是Intellij idea 还是Eclipse,都提供了快速生成get,set方法的快捷键,使用起来很是方便,其实,我们还有更方便的办法,就是今天的主角-Lombok
Lombok是什么?
Lombok是一个通过注解以达到减少代码的Java库,如通过注解的方式减少get,set方法,构造方法等。
如何安装Lombok?
如何安装使用Lombok呢?
方法一
通过向lib文件夹中添加lombok.jar包即可,
方法二
如果使用的是Maven,则可在项目的pom.xml文件中添加以下依赖:
<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.16.12</version></dependency>
通过以上两种方法的确可以使用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
该注解相当于同时加上以下注解@Setter @Getter,@ToString,@EqualsAndHashCode,作用于类中 使用:
/*** author: andy* date: 17-4-22* blog: www.andyqian.com*/@Datapublic class Person {private String name;private String address;private String city;private String state;private String zip;private Date brithday;}
效果如下:
@Getter@Setter
作用于属性上,自动生成get,set方法.
/*** author: andy* date: 17-4-22* blog: www.andyqian.com*/public class Person {@Getter@Setterprivate String name;}
等价源码:
public String getName() {return name;}public void setName(String name) {this.name = name;}
@NonNull
该注解快速判断是否为空,如果为空,则抛出java.lang.NullPointerException使用方法:
/*** author: andy* date: 17-4-22* blog: www.andyqian.com*/public class Person {private String name;@Setter@Getter@NonNullprivate List<Person> member;}
源码:
@NonNullprivate List<Person> members;public Family(@NonNull final List<Person> members) {if (members == null) throw new java.lang.NullPointerException("members");this.members = members;}@NonNullpublic 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;}
@Synchronized
该注解自动添加到同步机制,有趣的是,生成的代码并不是直接锁方法,而是锁代码块, 作用范围是方法上使用方法:
private DateFormat format = new SimpleDateFormat("MM-dd-YYYY");@Synchronizedpublic 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的字段
使用方法:
/*** author: andy* date: 17-4-22* blog: www.andyqian.com*/@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();}}
小结
通过前面从安装,到使用的案例章节的讲解,希望Lbok能够给你带来更大的coding快感。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。
本文标题: 深入了解java Lombok的使用方法
以上就上有关深入了解javaLombok的使用方法的相关介绍,要了解更多java,lombok内容请登录学步园。