Lombok插件的安装以及使用

2024-08-21 03:32
文章标签 安装 使用 lombok 插件

本文主要是介绍Lombok插件的安装以及使用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

12. Lombok插件的安装以及使用

LomboK介绍和配置(能用就用如果使用出问题就不要用)

1.目标

  • 掌握LomboK的配置

2.路径

  1. 什么是LomboK

  2. LomboK的作用

  3. LomboK的配置

3.讲解

3.1什么是LomboK

Lombok是一个Java库,能自动插入编辑器并构建工具,简化Java开发。

官网: https://www.projectlombok.org/

3.2Lombok的作用

通过添加注解的方式,Lombok能以简单的注解形式来简化java代码,提高开发人员的开发效率。

例如开发中经常需要写的javabean,都需要花时间去添加相应的getter/setter,也许还要去写构造器、equals等方法,而且需要维护,当属性多时会出现大量的getter/setter方法,这些显得很冗长也没有太多技术含量,一旦修改属性,就容易出现忘记修改对应方法的失误。

而使用 Lombok 插件后,就不需要在代码里面写getter/setter/toString/HashCode等等方法,将会在编译后的class文件中自动添加,使代码看起来更简洁些。

3.3 Lombok的配置
3.3.1 添加maven依赖
image-20201213235926585
<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.18.8</version><scope>provided</scope>
</dependency>
3.3.2 安装插件

使用Lombok还需要插件的配合,我使用开发工具为idea. 打开idea的设置,点击Plugins,点击Browse repositories,在弹出的窗口中搜索lombok,然后安装即可.

image-20191121092349714

另外,新版本的安装界面如下:

image-20201214000558886

安装完了插件之后,基本就完成了。

可以开启服务,测试能否正常启动编译如下:

image-20201214001720045

不过也有些时候会碰到编译时出错的情况,可以按照下面进行解决。

3.3.3 解决编译时出错问题

编译时出错,可能是没有enable注解处理器。Annotation Processors > Enable annotation processing。设置完成之后程序正常运行。

image-20191121092543928

4.小结

  1. Lombox: 就是一个工具, 简化java代码开发

  2. Lombok环境

  • 添加坐标

  • 添加插件

Lombok的常用注解

1.目标

  • 掌握Lombox的常用注解

2.路径

  1. @Data

  2. @Getter/@Setter

  3. @ToString

  4. @NoArgsConstructor, @AllArgsConstructor

3.讲解

3.1@Data

@Data注解在类上,会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法,如为final属性,则不会为该属性生成setter方法。

3.1.1 在项目中创建 JavaBean,创建一个User类,并使用 @Data 注解
image-20201214002022649
package com.bean;import lombok.Data;/**** Data注解:* 可以添加get、set、toString、equals、hashcode等等方法* * @author Aron.li* @date 2020/12/14 0:19*/
@Data
public class User {private Integer id;private String username;private String password;private String address;private String nickname;private String gender;private String email;private String status;
}
3.1.2 创建一个单元测试,测试能否执行 get、set、toString、equals、hashcode等等方法
image-20201214002411173
public class UserTest {@Testpublic void test01(){User user = new User();user.setUsername("肥子白");user.setNickname("fat boy");user.setEmail("381789@qq.com");System.out.println(user.getUsername());System.out.println(user);}}
3.1.3 查看编译后生成的 class 文件,可以看到 Lombok 自动生成的代码
image-20201214002838343

如果想要确认自动生成了什么,可以看编译后的 class 文件更加直观。

3.2@Getter/@Setter

如果觉得@Data太过粗暴不够精细,可以使用@Getter/@Setter注解,此注解在属性上,可以为相应的属性自动生成Getter/Setter方法.

3.2.1 针对某个属性进行 @Getter/@Setter注解
image-20201214003032293
public class User implements Serializable {@Setter@Getterprivate Integer id;private String username;private String password;private String address;private String nickname;private String gender;private String email;private String status;
}
3.2.2 查看再次执行编译后的 class 文件
image-20201214003143140

可以看到只生成了空参构造器,以及 id 的 getter/setter

3.3@ToString

类使用@ToString注解,Lombok会生成一个toString()方法,默认情况下,会输出类名、所有属性(会按照属性定义顺序),用逗号来分割。通过exclude属性指定忽略字段不输出,

3.3.1 @ToString 使用 exclude 指定忽略 id 字段不输出
image-20201214003351799
@ToString(exclude = {"id"})
public class User implements Serializable {private Integer id;private String username;private String password;private String address;private String nickname;private String gender;private String email;private String status;
}
3.3.2 查看再次执行编译后的 class 文件
image-20201214003453370
3.4@xxxConstructor
  • @NoArgsConstructor: 无参构造器

@NoArgsConstructor
public class User implements Serializable{private Integer id;private String username;private String password;private String address;private String nickname;private String gender;private String email;private String status;
}
  • @AllArgsConstructor: 全参构造器

@AllArgsConstructor
public class User implements Serializable{private Integer id;private String username;private String password;private String address;private String nickname;private String gender;private String email;private String status;
}
3.4.1 设置自动生成 无参构造器 以及 全参构造器
image-20201214003636190
@AllArgsConstructor
@NoArgsConstructor
@ToString(exclude = {"id"})
public class User implements Serializable {private Integer id;private String username;private String password;private String address;private String nickname;private String gender;private String email;private String status;
}
3.4.2  查看再次执行编译后的 class 文件
image-20201214003729107

4.小结

4.1注解
  • @Data

    • 用在类上面的 , 生成set,get, toString, hashCode,canEqual、toString方法

  • @Getter

  • 用在字段, 生成get方法

  • @Setter

    • 用在字段, 生成set方法

  • @ToString

    • 用在类上面的   生成toString方法

  • @xxxConstructor

    • 用在类上面的 生成构造方法 (只能生成无参和全参的构造方法)

4.2优缺点

优点:

  1. 能通过注解的形式自动生成构造器、getter/setter、equals、hashcode、toString等方法,提高了一定的开发效率

  2. 让代码变得简洁,不用过多的去关注相应的方法

  3. 属性做修改时,也简化了维护为这些属性所生成的getter/setter方法等

缺点:

  1. 不支持多种参数构造器的重载

  2. 由于环境问题可能会导致lombok失效,如果遇到这种情况,直接不要使用lombok

这篇关于Lombok插件的安装以及使用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1092000

相关文章

Java中String字符串使用避坑指南

《Java中String字符串使用避坑指南》Java中的String字符串是我们日常编程中用得最多的类之一,看似简单的String使用,却隐藏着不少“坑”,如果不注意,可能会导致性能问题、意外的错误容... 目录8个避坑点如下:1. 字符串的不可变性:每次修改都创建新对象2. 使用 == 比较字符串,陷阱满

Python使用国内镜像加速pip安装的方法讲解

《Python使用国内镜像加速pip安装的方法讲解》在Python开发中,pip是一个非常重要的工具,用于安装和管理Python的第三方库,然而,在国内使用pip安装依赖时,往往会因为网络问题而导致速... 目录一、pip 工具简介1. 什么是 pip?2. 什么是 -i 参数?二、国内镜像源的选择三、如何

使用C++实现链表元素的反转

《使用C++实现链表元素的反转》反转链表是链表操作中一个经典的问题,也是面试中常见的考题,本文将从思路到实现一步步地讲解如何实现链表的反转,帮助初学者理解这一操作,我们将使用C++代码演示具体实现,同... 目录问题定义思路分析代码实现带头节点的链表代码讲解其他实现方式时间和空间复杂度分析总结问题定义给定

Linux使用nload监控网络流量的方法

《Linux使用nload监控网络流量的方法》Linux中的nload命令是一个用于实时监控网络流量的工具,它提供了传入和传出流量的可视化表示,帮助用户一目了然地了解网络活动,本文给大家介绍了Linu... 目录简介安装示例用法基础用法指定网络接口限制显示特定流量类型指定刷新率设置流量速率的显示单位监控多个

JavaScript中的reduce方法执行过程、使用场景及进阶用法

《JavaScript中的reduce方法执行过程、使用场景及进阶用法》:本文主要介绍JavaScript中的reduce方法执行过程、使用场景及进阶用法的相关资料,reduce是JavaScri... 目录1. 什么是reduce2. reduce语法2.1 语法2.2 参数说明3. reduce执行过程

如何使用Java实现请求deepseek

《如何使用Java实现请求deepseek》这篇文章主要为大家详细介绍了如何使用Java实现请求deepseek功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1.deepseek的api创建2.Java实现请求deepseek2.1 pom文件2.2 json转化文件2.2

python使用fastapi实现多语言国际化的操作指南

《python使用fastapi实现多语言国际化的操作指南》本文介绍了使用Python和FastAPI实现多语言国际化的操作指南,包括多语言架构技术栈、翻译管理、前端本地化、语言切换机制以及常见陷阱和... 目录多语言国际化实现指南项目多语言架构技术栈目录结构翻译工作流1. 翻译数据存储2. 翻译生成脚本

C++ Primer 多维数组的使用

《C++Primer多维数组的使用》本文主要介绍了多维数组在C++语言中的定义、初始化、下标引用以及使用范围for语句处理多维数组的方法,具有一定的参考价值,感兴趣的可以了解一下... 目录多维数组多维数组的初始化多维数组的下标引用使用范围for语句处理多维数组指针和多维数组多维数组严格来说,C++语言没

在 Spring Boot 中使用 @Autowired和 @Bean注解的示例详解

《在SpringBoot中使用@Autowired和@Bean注解的示例详解》本文通过一个示例演示了如何在SpringBoot中使用@Autowired和@Bean注解进行依赖注入和Bean... 目录在 Spring Boot 中使用 @Autowired 和 @Bean 注解示例背景1. 定义 Stud

使用 sql-research-assistant进行 SQL 数据库研究的实战指南(代码实现演示)

《使用sql-research-assistant进行SQL数据库研究的实战指南(代码实现演示)》本文介绍了sql-research-assistant工具,该工具基于LangChain框架,集... 目录技术背景介绍核心原理解析代码实现演示安装和配置项目集成LangSmith 配置(可选)启动服务应用场景