Lombok 看这篇就够了

前提

自从进公司实习后，项目代码中能用 Lombok 的都用了，毕竟这么好的轮子要充分利用好。也能够减小一些 get/set/toString 方法的编写，虽然说 IDEA 的插件能够自动生成 get/set/toString 方法，可是使用 Lombok 可让代码更简洁。

下面看看如何在 IDEA　中如何安装 Lombok：

1. 安装

打开 IDEA 的 Settings 面板，并选择 Plugins 选项，而后点击 “Browse repositories” 在输入框输入 ”lombok”，获得搜索结果，点击安装，而后安装提示重启 IDEA，安装成功 ;

2. 引入依赖

在本身的项目里添加 lombok 的编译支持，在 pom 文件里面添加 dependency

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.18</version>
    <scope>provided</scope>
</dependency>

3. 怎么使用？

在实体类上引入相关的注解就行：

---

有哪些注解？

• @Data
• @Setter
• @Getter
• @Log4j
• @AllArgsConstructor
• @NoArgsConstructor
• @EqualsAndHashCode
• @NonNull
• @Cleanup
• @ToString
• @RequiredArgsConstructor
• @Value
• @SneakyThrows
• @Synchronized

---

注解详解

@Data

注解在 类 上；提供类全部属性的 get 和 set 方法，此外还提供了 equals、canEqual、hashCode、toString 方法。

---

@Setter

注解在 属性 上；为单个属性提供 set 方法; 注解在 类 上，为该类全部的属性提供 set 方法， 都提供默认构造方法。

---

@Getter

注解在 属性 上；为单个属性提供 get 方法; 注解在 类 上，为该类全部的属性提供 get 方法，都提供默认构造方法。

---

@Log4j

注解在 类 上；为类提供一个 属性名为 log 的 log4j 日志对象，提供默认构造方法。

---

@AllArgsConstructor

注解在 类 上；为类提供一个全参的构造方法，加了这个注解后，类中不提供默认构造方法了。

---

@NoArgsConstructor

注解在 类 上；为类提供一个无参的构造方法。

---

@EqualsAndHashCode

注解在 类 上, 能够生成 equals、canEqual、hashCode 方法。

---

@NonNull

注解在 属性 上，会自动产生一个关于此参数的非空检查，若是参数为空，则抛出一个空指针异常，也会有一个默认的无参构造方法。

---

@Cleanup

这个注解用在 变量 前面，能够保证此变量表明的资源会被自动关闭，默认是调用资源的 close() 方法，若是该资源有其它关闭方法，可以使用 @Cleanup(“methodName”) 来指定要调用的方法，也会生成默认的构造方法。

---

@ToString

这个注解用在 类 上，能够生成全部参数的 toString 方法，还会生成默认的构造方法。

---

@RequiredArgsConstructor

这个注解用在 类 上，使用类中全部带有 @NonNull 注解的或者带有 final 修饰的成员变量生成对应的构造方法。

---

@Value

这个注解用在 类 上，会生成含全部参数的构造方法，get 方法，此外还提供了equals、hashCode、toString 方法。

---

@SneakyThrows

这个注解用在 方法 上，能够将方法中的代码用 try-catch 语句包裹起来，捕获异常并在 catch 中用 Lombok.sneakyThrow(e) 把异常抛出，可使用 @SneakyThrows(Exception.class) 的形式指定抛出哪一种异常，也会生成默认的构造方法。

---

@Synchronized

这个注解用在 类方法 或者 实例方法 上，效果和 synchronized 关键字相同，区别在于锁对象不一样，对于类方法和实例方法，synchronized 关键字的锁对象分别是类的 class 对象和 this 对象，而 @Synchronized 的锁对象分别是 私有静态 final 对象 lock 和 私有 final 对象 lock，固然，也能够本身指定锁对象，此外也提供默认的构造方法。

---

总结

以上注解可根据须要一块儿搭配使用！

虽然说轮子好，可是咱们不只要知其然，也要知其因此然！

做者：zhisheng
连接： Lombok 看这篇就够了 声明：本文来源于极乐科技签约博主：zhisheng，版权归做者全部，转载请注明做者与出处，谢谢！