Lombok 使用详解,简化Java编程(上)

简介: Lombok 使用详解,简化Java编程(上)

前言


在 Java 应用程序中存在许多重复相似的、生成之后几乎不对其做更改的代码,但是我们还不得不花费很多精力编写它们来满足 Java 的编译需求


比如,在 Java 应用程序开发中,我们几乎要为所有 Bean 的成员变量添加 get() ,set() 等方法,这些相对固定但又不得不编写的代码浪费程序员很多精力,同时让类内容看着更杂乱,我们希望将有限的精力关注在更重要的地方。


微信图片_20220510114338.jpg

Lombok 已经诞生很久了,甚至在 Spring Boot Initalizr 中都已加入了 Lombok 选项,


微信图片_20220510114415.jpg


这里我们将 Lombok 做一下详细说明:


Lombok


官网的介绍:Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java. Never write another getter or equals method again. Early access to future java features such as val, and much more.


直白的说: Lombok 是一种 Java™ 实用工具,可用来帮助开发人员消除 Java 的冗长,尤其是对于简单的 Java 对象(POJO)。它通过注解实现这一目的,且看:


Bean 的对比


传统的 POJO 类是这样的


微信图片_20220510114535.png


通过Lombok改造后的 POJO 类是这样的


微信图片_20220510114649.png


一眼可以观察出来我们在编写 Employee 这个类的时候通过 @Data 注解就已经实现了所有成员变量的 get()set() 方法等,同时 Employee 类看起来更加清晰简洁。Lombok 的神奇之处不止这些,丰富的注解满足了我们开发的多数需求。


Lombok的安装


查看下图,@Data的实现,我们发现这个注解是应用在编译阶段的


微信图片_20220510114731.png


这和我们大多数使用的注解,如 Spring 的注解(在运行时,通过反射来实现业务逻辑)是有很大差别的,如Spring 的@RestController 注解


微信图片_20220510114755.png


一个更直接的体现就是,普通的包在引用之后一般的 IDE 都能够自动识别语法,但是 Lombok 的这些注解,一般的 IDE 都无法自动识别,因此如果要使用 Lombok 的话还需要配合安装相应的插件来支持 IDE 的编译,防止IDE 的自动检查报错,下面以 IntelliJ IDEA 举例安装插件。


在Repositories中搜索Lombok,安装后重启IDE即可


微信图片_20220510114818.png


在Maven或Gradle工程中添加依赖


微信图片_20220510114837.jpg


至此我们就可以应用 Lombok 提供的注解干些事情了。


Lombok注解详解


Lombok官网提供了许多注解,但是 “劲酒虽好,可不要贪杯哦”,接下来逐一讲解官网推荐使用的注解(有些注解和原有Java编写方式没太大差别的也没有在此处列举,如@ Synchronized等)


微信图片_20220510114858.png


@Getter和@Setter


该注解可应用在类或成员变量之上,和我们预想的一样,@Getter@Setter 就是为成员变量自动生成 get 和 set 方法,默认生成访问权限为 public 方法,当然我们也可以指定访问权限 protected 等,如下图:


微信图片_20220510114930.png


成员变量name指定生成set方法,并且访问权限为protected;boolean类型的成员变量 female 只生成get方法,并修改方法名称为 isFemale()。当把该注解应用在类上,默认为所有非静态成员变量生成 get 和 set 方法,也可以通过 AccessLevel.NONE 手动禁止生成get或set方法,如下图:


微信图片_20220510114947.png


@ToString


该注解需应用在类上,为我们生成 Object 的 toString 方法,而该注解里面的几个属性能更加丰富我们想要的内容, exclude 属性禁止在 toString 方法中使用某字段,而of属性可以指定需要使用的字段,如下图:


微信图片_20220510115009.png


查看编译后的Employee.class得到我们预期的结果,如下图


微信图片_20220510115030.png


@EqualsAndHashCode


该注解需应用在类上,使用该注解,lombok会为我们生成 equals(Object other) 和 hashcode() 方法,包括所有非静态属性和非transient的属性,同样该注解也可以通过 exclude 属性排除某些字段,of 属性指定某些字段,也可以通过 callSuper 属性在重写的方法中使用父类的字段,这样我们可以更灵活的定义bean的比对,如下图:


微信图片_20220510115059.png


查看编译后的Employee.class文件,如下图:


微信图片_20220510115120.png


@NonNull


该注解需应用在方法或构造器的参数上或属性上,用来判断参数的合法性,默认抛出 NullPointerException 异常


微信图片_20220510115140.png


查看NonNullExample.class文件,会为我们抛出空指针异常,如下图:


微信图片_20220510115200.png


当然我们可以通过指定异常类型抛出其他异常,lombok.nonNull.exceptionType = [NullPointerException | IllegalArgumentException] , 为实现此功能我们需要在项目的根目录新建lombok.config文件:


微信图片_20220510115219.png


重新编译NonNullExample类,已经为我们抛出非法参数异常:


微信图片_20220510115616.png


@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor


以上三个注解分别为我们生成无参构造器,指定参数构造器和包含所有参数的构造器,默认情况下,@RequiredArgsConstructor, @AllArgsConstructor 生成的构造器会对所有标记 @NonNull 的属性做非空校验。


无参构造器很好理解,我们主要看看后两种,先看 @RequiredArgsConstructor


微信图片_20220510115637.jpg


从上图中我们可以看出, @RequiredArgsConstructor 注解生成有参数构造器时只会包含有 final 和 @NonNull 标识的 field,同时我们可以指定 staticName 通过生成静态方法来构造对象


查看Employee.class文件


微信图片_20220510115741.jpg


当我们把 staticName 属性去掉我们来看遍以后的文件:


微信图片_20220510115804.jpg


相信你已经注意到细节


@AllArgsConstructor 就更简单了,请大家自行查看吧

相关文章
|
3天前
|
数据采集 安全 Java
Java并发编程学习12-任务取消(上)
【5月更文挑战第6天】本篇介绍了取消策略、线程中断、中断策略 和 响应中断的内容
30 4
Java并发编程学习12-任务取消(上)
|
1天前
|
Java 编译器
Java 并发编程中的锁优化策略
【5月更文挑战第17天】在 Java 并发编程中,锁是一种常见的同步机制,用于保护共享资源的访问。然而,不当使用锁可能导致性能问题和死锁风险。本文将探讨 Java 中的锁优化策略,包括锁粗化、锁消除、锁降级以及读写锁等技术,以提高并发程序的性能和可靠性。
|
1天前
|
Java 编译器
Java并发编程中的锁优化策略
【5月更文挑战第17天】在Java并发编程中,锁是一种常见的同步机制,用于保护共享资源。然而,使用不当的锁可能导致性能下降和死锁等问题。本文将探讨Java中锁的优化策略,包括锁粗化、锁消除、锁排序等方法,以提高程序的性能和可靠性。
|
2天前
|
存储 关系型数据库 MySQL
《MySQL 入门教程》第 05 篇 账户和权限,Java高并发编程详解深入理解pdf
《MySQL 入门教程》第 05 篇 账户和权限,Java高并发编程详解深入理解pdf
|
2天前
|
NoSQL Dubbo Java
StringBoot编程式事务与声明式事务java工程师面试突击第一季
StringBoot编程式事务与声明式事务java工程师面试突击第一季
|
3天前
|
安全 Java 开发者
深入理解Java并发编程:线程安全与性能优化
【5月更文挑战第15天】本文将深入探讨Java并发编程的核心概念,包括线程安全和性能优化。我们将通过实例分析,理解线程安全的重要性,并学习如何通过各种技术和策略来实现它。同时,我们也将探讨如何在保证线程安全的同时,提高程序的性能。
|
3天前
|
Java 编译器 开发者
Java并发编程中的锁优化策略
【5月更文挑战第15天】 在Java的多线程编程中,锁机制是实现线程同步的关键。然而,不当的锁使用往往导致性能瓶颈甚至死锁。本文深入探讨了Java并发编程中针对锁的优化策略,包括锁粗化、锁消除、锁分离以及读写锁的应用。通过具体实例和性能分析,我们将展示如何有效避免竞争条件,减少锁开销,并提升应用程序的整体性能。
|
3天前
|
消息中间件 并行计算 Java
Java中的多线程编程:基础知识与实践
【5月更文挑战第15天】 在现代计算机编程中,多线程是一个复杂但必不可少的概念。特别是在Java这种广泛使用的编程语言中,理解并掌握多线程编程是每个开发者必备的技能。本文将深入探讨Java中的多线程编程,从基础概念到实际应用场景,为读者提供全面的理论支持和实践指导。
|
3天前
|
Java 程序员 调度
Java中的多线程编程:从理论到实践
【5月更文挑战第14天】在现代计算机技术中,多线程编程是一个重要的概念。它允许多个线程并行执行,从而提高程序的运行效率。本文将从理论和实践两个角度深入探讨Java中的多线程编程,包括线程的基本概念、创建和控制线程的方法,以及如何处理线程同步和通信问题。
|
3天前
|
Java 开发者
深入理解Java并发编程:从基础到高级
【5月更文挑战第13天】本文将深入探讨Java并发编程的各个方面,从基础知识到高级概念。我们将首先介绍线程的基本概念,然后深入讨论Java中的多线程编程,包括线程的创建和控制,以及线程间的通信。接下来,我们将探讨并发编程中的关键问题,如同步、死锁和资源竞争,并展示如何使用Java的内置工具来解决这些问题。最后,我们将讨论更高级的并发编程主题,如Fork/Join框架、并发集合和并行流。无论你是Java新手还是有经验的开发者,这篇文章都将帮助你更好地理解和掌握Java并发编程。