IDEA-lombok插件的安装@Data注解指南

前言

前几天在GitHub上下载的项目中，无意间发现一位大佬对@Data注解的使用，经过一番查阅学习后，把当时的资料整理出来，方便后续回顾。

Lombok是一个开源的代码生成库，算得上非常实用的小工具。编辑实体类时，通过Lombok注解可以减少getter、setter等方法的编写；修改实体类时只需调整属性，就能省去大量重复代码。本文只介绍IntelliJ IDEA中Lombok插件的安装、配置以及简单使用方法。

Lombok插件的安装

首先需要安装IntelliJ IDEA中的Lombok插件。打开IntelliJ IDEA后，点击菜单栏File→Settings，或者使用快捷键Ctrl+Alt+S进入设置页面。

点击设置中的Plugins进行插件安装，在右侧选择Browse repositories…，然后在搜索页面输入lombok，即可查询到下方的Lombok Plugin。鼠标点击Lombok Plugin，右侧会出现Install按钮，点击即可安装。

在安装页面可以看到Lombok具体支持的所有注解。安装过程中会有Downloading Plugins的提示，进度条会变化。

需要提醒的是，安装过程中一定要保证网络连接可用且良好，否则可能安装失败。

安装成功后，右侧会出现Restart按钮，此时可先不操作，因为还有后续配置工作。

安装完成后，再回到Plugins页面，右侧可以搜索到lombok，而安装前是搜不到的。

配置注解处理器

同样在Settings设置页面，点击Build，Execution，Deployment→选择Compiler→选中Annotation Processors，然后在右侧勾选Enable annotation processing即可。

Lombok插件的使用

使用前需要说明：安装的插件只是一个调用，就像使用Maven插件一样，本机需要先安装Maven才行。使用Lombok前也需要添加Lombok的依赖。

Lombok的版本一直在更新，可以在百度搜索框中输入“lombok maven”找到最新的依赖版本。

    
	org.projectlombok    
	lombok    
	1.16.10

接下来编辑一个实体类Student，添加三个属性，最后在类上添加@Data注解。这个注解可以帮助在.class文件中生成类中所有属性的get/set方法、equals、canEqual、hashCode、toString方法等。

编辑完代码后如何查看生成的方法呢？

在菜单栏点击View→Tool Windows→Structure，便可以看到类中所有的方法，这些都是Lombok自动生成的。

拓展

还有一些比较常用的注解，比如：

• @AllArgsConstructor：加在类上，生成包含实体类全部参数的构造方法。
• @NoArgsConstructor：加在类上，生成无参构造方法。
• @RequiredArgsConstructor：加在类上，配合@NonNull注解使用，生成指定参数的构造方法。比如在age属性前加@NonNull注解，则User生成需要age参数的构造方法。
• @Getter：加在类上，生成实体类所有属性的getter方法。
• @Setter：加在类上，生成实体类所有属性的setter方法。
• @ToString：加在类上，调用toString()方法，输出实体类中所有属性的值。

总结

以上是经验分享，希望能给大家一个参考。