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

- 日理万妓 2023-02-12 05:57 7阅读 0赞

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

*  前言
 *  lombok插件的安装
 *  配置注解处理器
 *  lombok插件的使用
 *  拓展：

# 前言 #

> **前几天在github下来的项目中，无意间发现了大佬对于@Data注解的使用，在经过一番查阅学习后，现在将当时查找学习的资料置于此以便以后学习**

> **lombok**是开源的代码生成库，是一款非常实用的小工具，我们在编辑实体类时可以通过lombok注解减少**getter、setter**等方法的编写，在更改实体类时只需要修改属性即可，减少了很多重复代码的编写工作。本文小编只介绍IntelliJ IDEA中lombok插件的安装和配置以及简单的使用方法。

# lombok插件的安装 #

首先我们需要安装IntelliJ IDEA中的lombok插件，打开IntelliJ IDEA后点击菜单栏中的File–>Settings，或者使用快捷键Ctrl+Alt+S进入到设置页面。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70]  
我们点击设置中的Plugins进行插件的安装，在右侧选择Browse repositories…，然后在搜索页面输入lombok变可以查询到下方的Lombok Plugin，鼠标点击Lombok Plugin可在右侧看到Install按钮，点击该按钮便可安装。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 1]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 2]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 3]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 4]  
我们在安装页面可以看到lombok具体支持的所有注解，在安装过程中有Downloading Plugins的提示，安装过程中进度条会变化。需要提醒的是，在安装过程中一定要保证网络连接可用且良好，否则可能会安装失败。安装成功后我们可以看到右侧的Restart按钮，此时可先不操作，因为我们还有后续的配置工作。安装完成后我们再回到Plugins，此时在右侧可以搜索到lombok，而安装前是不行的。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 5]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 6]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 7]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 8]

# 配置注解处理器 #

同样我们在Settings设置页面，我们点击Build，Execution，Deployment–>选择Compiler–>选中Annotation Processors，然后在右侧勾选Enable annotation processing即可。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 9]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 10]

# lombok插件的使用 #

使用前我们需要说明的是安装的插件只是一个调用，就像我们使用maven插件一样，本机需要安装maven才行。我们在使用lombok前也需要添加lombok的依赖。lombok的版本一直在更新，大家可以在百度搜索框输入lombok maven找到最新的依赖版本。

<dependency>    
    	<groupId>org.projectlombok</groupId>    
    	<artifactId>lombok</artifactId>    
    	<version>1.16.10</version>
    </dependency>

![org.projectlombok    lombok    1.16.10][org.projectlombok lombok 1.16.10]  
接下来我们编辑一个实体类Student，添加三个属性，最后在类上添加@Data属性，这个注解可以帮我们在.class文件中生成类中所有属性的get/set方法、equals、canEqual、hashCode、toString方法等。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 11]  
那么编辑完代码后我们如何查看生成的方法呢？在菜单栏点击View–>Tool Windows–>Structure，便可以看到类中所有的方法了，这些都是lombok帮我自动生成的。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 12]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 13]

# 拓展： #

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

@AllArgsConstructor 加在类上，可以生成含实体类全参数的构造方法。

@NoArgsConstructor 加在类上，可以生成无参构造方法。

@RequiredArgsConstructor 加在类上，配合@NonNull注解使用，生成指定参数的构造方法。比如在age属性前面加@NonNull注解，则User生成需要age参数的构造方法。

@Getter 加在类上，可以生成实体类所有属性的getter方法。

@Setter 加在类上，可以生成实体类所有属性的setter方法。

@ToString 加在类上，调用toString()方法，可以输出实体类中所有属性的值。

--------------------

**持续更新中…**

**文章参考学习地址：[https://jingyan.baidu.com/article/0a52e3f4e53ca1bf63ed725c.html][https_jingyan.baidu.com_article_0a52e3f4e53ca1bf63ed725c.html]**

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200524224415822.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200524224447660.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200524224456324.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200524224517569.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20200524224531812.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20200524224537888.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/2020052422454329.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 7]: https://img-blog.csdnimg.cn/20200524224556194.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 8]: https://img-blog.csdnimg.cn/20200524224612666.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 9]: https://img-blog.csdnimg.cn/20200524224756586.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 10]: https://img-blog.csdnimg.cn/20200524224803930.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA==,size_16,color_FFFFFF,t_70
[org.projectlombok lombok 1.16.10]: https://img-blog.csdnimg.cn/2020052422483139.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 11]: https://img-blog.csdnimg.cn/20200524224937831.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 12]: https://img-blog.csdnimg.cn/20200524225009161.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA_size_16_color_FFFFFF_t_70 13]: https://img-blog.csdnimg.cn/20200524225013629.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyNTQ0NA==,size_16,color_FFFFFF,t_70
[https_jingyan.baidu.com_article_0a52e3f4e53ca1bf63ed725c.html]: https://jingyan.baidu.com/article/0a52e3f4e53ca1bf63ed725c.html