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

相关文章

Conda与Python venv虚拟环境的区别与使用方法详解

《Conda与Pythonvenv虚拟环境的区别与使用方法详解》随着Python社区的成长,虚拟环境的概念和技术也在不断发展,:本文主要介绍Conda与Pythonvenv虚拟环境的区别与使用... 目录前言一、Conda 与 python venv 的核心区别1. Conda 的特点2. Python v

Spring Boot中WebSocket常用使用方法详解

《SpringBoot中WebSocket常用使用方法详解》本文从WebSocket的基础概念出发,详细介绍了SpringBoot集成WebSocket的步骤,并重点讲解了常用的使用方法,包括简单消... 目录一、WebSocket基础概念1.1 什么是WebSocket1.2 WebSocket与HTTP

C#中Guid类使用小结

《C#中Guid类使用小结》本文主要介绍了C#中Guid类用于生成和操作128位的唯一标识符,用于数据库主键及分布式系统,支持通过NewGuid、Parse等方法生成,感兴趣的可以了解一下... 目录前言一、什么是 Guid二、生成 Guid1. 使用 Guid.NewGuid() 方法2. 从字符串创建

Python使用python-can实现合并BLF文件

《Python使用python-can实现合并BLF文件》python-can库是Python生态中专注于CAN总线通信与数据处理的强大工具,本文将使用python-can为BLF文件合并提供高效灵活... 目录一、python-can 库:CAN 数据处理的利器二、BLF 文件合并核心代码解析1. 基础合

Python使用OpenCV实现获取视频时长的小工具

《Python使用OpenCV实现获取视频时长的小工具》在处理视频数据时,获取视频的时长是一项常见且基础的需求,本文将详细介绍如何使用Python和OpenCV获取视频时长,并对每一行代码进行深入解析... 目录一、代码实现二、代码解析1. 导入 OpenCV 库2. 定义获取视频时长的函数3. 打开视频文

Spring IoC 容器的使用详解(最新整理)

《SpringIoC容器的使用详解(最新整理)》文章介绍了Spring框架中的应用分层思想与IoC容器原理,通过分层解耦业务逻辑、数据访问等模块,IoC容器利用@Component注解管理Bean... 目录1. 应用分层2. IoC 的介绍3. IoC 容器的使用3.1. bean 的存储3.2. 方法注

Python内置函数之classmethod函数使用详解

《Python内置函数之classmethod函数使用详解》:本文主要介绍Python内置函数之classmethod函数使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地... 目录1. 类方法定义与基本语法2. 类方法 vs 实例方法 vs 静态方法3. 核心特性与用法(1编程客

Linux中压缩、网络传输与系统监控工具的使用完整指南

《Linux中压缩、网络传输与系统监控工具的使用完整指南》在Linux系统管理中,压缩与传输工具是数据备份和远程协作的桥梁,而系统监控工具则是保障服务器稳定运行的眼睛,下面小编就来和大家详细介绍一下它... 目录引言一、压缩与解压:数据存储与传输的优化核心1. zip/unzip:通用压缩格式的便捷操作2.

使用Python实现可恢复式多线程下载器

《使用Python实现可恢复式多线程下载器》在数字时代,大文件下载已成为日常操作,本文将手把手教你用Python打造专业级下载器,实现断点续传,多线程加速,速度限制等功能,感兴趣的小伙伴可以了解下... 目录一、智能续传:从崩溃边缘抢救进度二、多线程加速:榨干网络带宽三、速度控制:做网络的好邻居四、终端交互

Python中注释使用方法举例详解

《Python中注释使用方法举例详解》在Python编程语言中注释是必不可少的一部分,它有助于提高代码的可读性和维护性,:本文主要介绍Python中注释使用方法的相关资料,需要的朋友可以参考下... 目录一、前言二、什么是注释?示例:三、单行注释语法:以 China编程# 开头,后面的内容为注释内容示例:示例:四