Lombok以简单的注解形式来简化Java代码,提高开发效率。Lombok能通过注解的方式,在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString方法。出现的神奇就是在源码中没有getter和setter方法,但是在编译生成的字节码文件中有getter和setter方法。这样就省去了手动重建这些代码的麻烦,使代码看起来更简洁些。
如何使用:
先是在官网下载jar包->点击下载,然后将jar到入到项目就行,如果是maven下,那么直接在pom.xml下添加依赖就行
<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.20</version>
<scope>provided</scope>
</dependency>
注解的具体用法:
我们先看下不用Lombok的情况下我们创建一个实体类要写的代码:
public class stu {
private int id;
private String name;
private int tid;
public stu(int id, String name, int tid) {
this.id = id;
this.name = name;
this.tid = tid;
}
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getTid() {
return tid;
}
public void setTid(int tid) {
this.tid = tid;
}
@Override
public String toString() {
return "stu{" +
"id=" + id +
", name='" + name + '\'' +
", tid=" + tid +
'}';
}
}
上面实体类使用Lombok后的代码,是不是变得更加简洁了,仅仅用几个注解,就可以将我们要的东西给自动创建出来了
Lombok的注解挺多,下面对其中一些做简介
- @Data注解在类上,会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法,如为final属性,则不会为该属性生成setter方法
- @Getter/@Setter注解,此注解在属性上,可以为相应的属性自动生成Getter/Setter方法
- @NonNull该注解用在属性或构造器上,Lombok会生成一个非空的声明,可用于校验参数,能帮助避免空指针
- @Cleanup该注解会自动调用close()方法,简化代码
- @EqualAndHashCode默认情况下,会使用所有非静态(non-static)和非瞬态(non-transient)属性来生成equals和hasCode,也能通过exclude注解来排除一些属性
- @ToString默认情况下,会输出类名、所有属性(会按照属性定义顺序),用逗号来分割。
- @NoArgsConstructor无参构造器
- @AllArgsConstructor全参构造器
万物皆有两面性,Lombok也有优缺点
优点:
- 能通过注解的形式自动生成构造器、getter/setter、equals、hashcode、toString等方法,提高了一定的开发效率
- 让代码变得简洁,不用过多的去关注相应的方法
- 属性做修改时,也简化了维护为这些属性所生成的getter/setter方法等
缺点:
- 不支持多种参数构造器的重载
- 虽然省去了手动创建getter/setter方法的麻烦,但大大降低了源代码的可读性和完整性,降低了阅读源代码的舒适度