Lombok 看这篇就够了

[外链图片转存失败(img-1326kftV-1562726153337)(http://ohfk1r827.bkt.clouddn.com/blog/180107/7JfK07cCbh.png-1)]

前提

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

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

安装

打开 IDEA 的 Settings 面板，并选择 Plugins 选项，然后点击 “Browse repositories”

在输入框输入”lombok”，得到搜索结果，点击安装，然后安装提示重启 IDEA，安装成功;

[外链图片转存失败(img-JghzhtMs-1562726153341)(http://ohfk1r827.bkt.clouddn.com/blog/180106/C33FG37Gk4.png-1)]

引入依赖

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

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

怎么使用？

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

[外链图片转存失败(img-jlgrs0LA-1562726153347)(http://ohfk1r827.bkt.clouddn.com/blog/180106/aCEc8ileJg.png-1)]

有哪些注解？

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

注解详解

@Data

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

[外链图片转存失败(img-OaROYdQa-1562726153361)(http://ohfk1r827.bkt.clouddn.com/blog/180107/mHj1eak6fJ.png-1)]

@Setter

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

[外链图片转存失败(img-V6xcUMNd-1562726153363)(http://ohfk1r827.bkt.clouddn.com/blog/180107/lkkff2b6Dc.png-1)]

[外链图片转存失败(img-mDJlx1cP-1562726153367)(http://ohfk1r827.bkt.clouddn.com/blog/180107/J9mC8FGfc0.png-1)]

@Getter

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

[外链图片转存失败(img-xlN8sdwV-1562726153372)(http://ohfk1r827.bkt.clouddn.com/blog/180107/d0F5h97J5f.png-1)]

[外链图片转存失败(img-zIstCksw-1562726153375)(http://ohfk1r827.bkt.clouddn.com/blog/180107/K0m81cFd6g.png-1)]

@Log4j

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

[外链图片转存失败(img-5aCWr7am-1562726153377)(http://ohfk1r827.bkt.clouddn.com/blog/180107/BChd89Cbh5.png-1)]

@AllArgsConstructor

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

[外链图片转存失败(img-1sf6JRw4-1562726153382)(http://ohfk1r827.bkt.clouddn.com/blog/180107/4iji9AJ0fE.png-1)]

@NoArgsConstructor

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

[外链图片转存失败(img-BuKDlDhX-1562726153385)(http://ohfk1r827.bkt.clouddn.com/blog/180107/JcdfmhDAaB.png-1)]

@EqualsAndHashCode

注解在 类 上, 可以生成 equals、canEqual、hashCode 方法。

[外链图片转存失败(img-ZReunVxa-1562726153390)(http://ohfk1r827.bkt.clouddn.com/blog/180108/CKHe7EICGd.png-1)]

@NonNull

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

[外链图片转存失败(img-O2SON3wr-1562726153395)(http://ohfk1r827.bkt.clouddn.com/blog/180108/g6Lh1eh1jm.png-1)]

@Cleanup

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

[外链图片转存失败(img-5deEGPih-1562726153397)(http://ohfk1r827.bkt.clouddn.com/blog/180108/Ba1bDkKb9J.png-1)]

@ToString

这个注解用在 类 上，可以生成所有参数的 toString 方法，还会生成默认的构造方法。

[外链图片转存失败(img-UkM3unJt-1562726153403)(http://ohfk1r827.bkt.clouddn.com/blog/180108/7LjglDeH8e.png-1)]

@RequiredArgsConstructor

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

[外链图片转存失败(img-hzAL0WON-1562726153407)(http://ohfk1r827.bkt.clouddn.com/blog/180108/CBgAF4ei8m.png-1)]

@Value

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

[外链图片转存失败(img-6kKjrlRm-1562726153409)(http://ohfk1r827.bkt.clouddn.com/blog/180108/b6KeAg0ABi.png-1)]

@SneakyThrows

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

[外链图片转存失败(img-TJDxRLkX-1562726153435)(http://ohfk1r827.bkt.clouddn.com/blog/180108/IfCKh1FGbh.png-1)]

@Synchronized

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

[外链图片转存失败(img-rx7xQB1p-1562726153436)(http://ohfk1r827.bkt.clouddn.com/blog/180108/L95jIc7eJi.png-1)]

总结

以上注解可根据需要一起搭配使用！

虽说轮子好，但是我们不仅要知其然，也要知其所以然！

关注我

[外链图片转存失败(img-XBioJqHN-1562726153436)(http://ohfk1r827.bkt.clouddn.com/blog/180103/C6LG3mGa12.jpg)]

最后

转载请注明原创地址：http://www.54tianzhisheng.cn/2018/01/09/lombok/