Lombok的详细使⽤及优缺点总结
什么是Lombok
Lombok是⼀款Java开发插件，可以通过它定义的注解来精简冗长和繁琐的代码，主要针对简单的Java模型对象（POJO）。好处就显⽽易见了，可以节省⼤量重复⼯作，特别是当POJO类的属性增减时，需要重复修改的Getter/Setter、构造器⽅法、equals⽅法和toString⽅法等。
⽽且Lombok针对这些内容的处理是在编译期，⽽不是通过反射机制，这样的好处是并不会降低系统的性能。
下⾯我们就看看具体的使⽤。
Lombok的安装
Lombok的安装分两部分：Idea插件的安装和maven中pom⽂件的导⼊。
第⼀步，在Idea的插件配置中搜索Lombok或官⽹下载本地安装。
第⼆步，引⼊pom中依赖，当前最细版本1.18.10。
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.10</version>
</dependency>
不知道什么原因，我在使⽤Idea安装插件⼀直失败，所以只在pom中引⼊了依赖，也是能正常使⽤。
Lombok的使⽤
@Data
@Data最常⽤的注解之⼀。注解在类上，提供该类所有属性的getter/setter⽅法，还提供了equals、canEqual、hashCode、toString⽅法。
这⾥的提供什么意思？就是开发⼈员不⽤⼿写相应的⽅法，⽽Lombok会帮你⽣成。
使⽤@Data⽰例如下，最直观的就是不⽤写getter/setter⽅法。
package pojo;
public class User {
private int id;
private String name;
private String pwd;
public User(int id, String hello, String pwd) {
}
public int getId() {
return id;
}
public String getName() {
return name;
}
public String getPwd() {
return pwd;
}
public void setId(int id) {
this.id = id;
}
public void setName(String name) {
this.name = name;
}
public void setPwd(String pwd) {
this.pwd = pwd;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", name='" + name + '\'' +
", pwd='" + pwd + '\'' +
'}';
}
}
@Data
public class User {
private int id;
private String name;
private String pwd;
}
对⽐之下效果显⽽易见。
@Setter
作⽤于属性上，为该属性提供setter⽅法; 作⽤与类上，为该类所有的属性提供setter⽅法，都提供默认构造⽅法。public class Demo {
private int id;
@Setter
private String remark;
}
@Setter
public class Demo {
private int id;
private String remark;
}
@Getter
基本使⽤同@Setter⽅法，不过提供的是getter⽅法，不再赘述。
@Log4j
作⽤于类上，为该类提供⼀个属性名为log的log4j⽇志对象。
@Log4j
public class Demo {
}
该属性⼀般使⽤于Controller、Service等业务处理类上。与此注解相同的还有@Log4j2，顾名思义，针对Log4j2。@AllArgsConstructor
作⽤于类上，为该类提供⼀个包含全部参的构造⽅法，注意此时默认构造⽅法不会提供。
@AllArgsConstructor
public class Demo {
private int id;
private String remark;
}
效果如下：
public class Demo {
private int id;
private String remark;
public Demo(final int id, final String remark) {
this.id = id;
}
}
@NoArgsConstructor
作⽤于类上，提供⼀个⽆参的构造⽅法。可以和@AllArgsConstructor同时使⽤，此时会⽣成两个构造⽅法：⽆参构造⽅法和全参构造⽅法。
@EqualsAndHashCode
作⽤于类上，⽣成equals、canEqual、hashCode⽅法。具体效果参看最开始的@Data效果。
@NonNull
作⽤于属性上，提供关于此参数的⾮空检查，如果参数为空，则抛出空指针异常。
public class Demo {
@NonNull
private int id;
equals()方法private String remark;
}
@RequiredArgsConstructor
作⽤于类上，由类中所有带有@NonNull注解或者带有final修饰的成员变量作为参数⽣成构造⽅法。
@Cleanup
作⽤于变量，保证该变量代表的资源会被⾃动关闭，默认调⽤资源的close()⽅法，如果该资源有其它关闭⽅法，可使⽤
@Cleanup(“methodName”)来指定。
public void jedisExample(String[] args) {
try {
@Cleanup Jedis jedis =  Jedis();
} catch (Exception ex) {
<(“Jedis异常:”,ex)
}
}
效果相当于：
public void jedisExample(String[] args) {
Jedis jedis= null;
try {
jedis = Jedis();
} catch (Exception e) {
<(“Jedis异常:”,ex)
} finally {
if (jedis != null) {
try {
jedis.close();
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
@ToString
作⽤于类上，⽣成包含所有参数的toString⽅法。见@Data中toString⽅法。
@Value
作⽤于类上，会⽣成全参数的构造⽅法、getter⽅法、equals、hashCode、toString⽅法。与@Data相⽐多了全参构造⽅法，少了默认构造⽅法、setter⽅法和canEqual⽅法。
该注解需要注意的是：会将字段添加上final修饰，个⼈感觉此处有些失控，不太建议使⽤。
@SneakyThrows
作⽤于⽅法上，相当于把⽅法内的代码添加了⼀个try-catch处理，捕获异常catch中⽤Lombok.sneakyThrow(e)抛出异常。使⽤@SneakyThrows(BizException.class)指定抛出具体异常。
@SneakyThrows
public int getValue(){
int a = 1;
int b = 0;
return a/b;
}
效果如下：
public int getValue() {
try {
int a = 1;
int b = 0;
return a / b;
} catch (Throwable var3) {
throw var3;
}
}
@Synchronized
作⽤于类⽅法或实例⽅法上，效果与synchronized相同。区别在于锁对象不同，对于类⽅法和实例⽅法，synchronized关键字的锁对象分别是类的class对象和this对象，⽽@Synchronized的锁对象分别是私有静态final对象lock和私有final对象lock。也可以指定锁对象。
public class FooExample {
private final Object readLock = new Object();
@Synchronized
public static void hello() {
System.out.println("world");
}
@Synchronized("readLock")
public void foo() {
System.out.println("bar");
}
}
效果相当于：
public class FooExample {
private static final Object $LOCK = new Object[0];
private final Object readLock = new Object();
public static void hello() {
synchronized($LOCK) {
System.out.println("world");
}
}
public void foo() {
synchronized(readLock) {
System.out.println("bar");
}
}
}
val
使⽤val作为局部变量声明的类型，⽽不是实际写⼊类型。执⾏此操作时，将从初始化表达式推断出类型。
public Map<String, String> getMap() {
val map = new HashMap<String, String>();
map.put("1", "a");
return map;
}
效果如下：
public Map<String, String> getMap() {
HashMap<String, String> map = new HashMap();
map.put("1", "a");
return map;
}
也就是说在局部变量中，Lombok帮你推断出具体的类型，但只能⽤于局部变量中。
@Builder
作⽤于类上，如果你喜欢使⽤Builder的流式操作，那么@Builder可能是你喜欢的注解了。
@Builder
public class Demo {
private int id;
private String remark;
}
效果如下：
public class Demo {
private int id;
private String remark;
Demo(final int id, final String remark) {
this.id = id;
}
public static Demo.DemoBuilder builder() {
return new Demo.DemoBuilder();
}
public static class DemoBuilder {
private int id;
private String remark;
DemoBuilder() {
}
public Demo.DemoBuilder id(final int id) {
this.id = id;
return this;
}
public Demo.DemoBuilder remark(final String remark) {
return this;
}
public Demo build() {
return new Demo(this.id, ark);
}
public String toString() {
return "Demo.DemoBuilder(id="  this.id  ", remark="  ark  ")";
}
}
}
Lombok的优缺点
优点：
1、能通过注解的形式⾃动⽣成构造器、getter/setter、equals、hashcode、toString等⽅法，提⾼了⼀定的开发效
率
2、让代码变得简洁，不⽤过多的去关注相应的⽅法
3、属性做修改时，也简化了维护为这些属性所⽣成的getter/setter⽅法等
缺点：
强X队友
因为Lombok的使⽤要求开发者⼀定要在IDE中安装对应的插件。如果未安装插件的话，使⽤IDE打开⼀个基于Lombok的项⽬的话会提⽰不到⽅法等错误。导致项⽬编译失败。也就是说，如果项⽬组中有⼀个⼈使⽤了

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。