首页 > Java > java教程 > 正文

Lombok 释放:通过 Getters、Setters、Constructors、Builders 等提高 Java 效率

王林
发布: 2024-07-16 17:46:50
原创
550 人浏览过

Lombok Unleashed: Elevating Java Efficiency with Getters, Setters, Constructors, Builders, and More

龙目岛项目简介

Project Lombok 是一个流行的 Java 库,旨在通过提供在编译时自动生成常见 Java 代码的注释来节省大量时间和精力,从而减少样板代码并提高编码人员的工作效率

什么是龙目岛计划?

Lombok 项目通过提供注释来解决 Java 的冗长问题,这些注释消除了手动编写重复代码构造(例如 getter、setter、构造函数、equals、hashCode 和 toString 方法)的需要。通过使用 Lombok 注解来注解字段或类,编码人员可以指示编译器自动生成这些方法,从而减少样板代码量并使 Java 类更加紧凑和可读。

我们为什么使用 Lombok 项目?

在 Java 中使用 Project Lombok 具有多项引人注目的优势,有助于提高生产力、代码质量和可维护性。
以下是选择龙目岛项目的几个理由。
它减少了“样板代码”。
它还提高了代码的可重用性和可读性。
实现起来非常简单,没有任何复杂性。
轻松与“IDE”集成。

如何在 Maven 项目上用 Java 实现 Lombok

我们的大部分项目都是基于Maven的。因此,我们只需将“Project Lombok”依赖项添加到项目中的“Pom.xml”文件中即可。

转到maven存储库并从那里复制Lombok Maven存储库,在“Pom.xml”中添加最新的lombok依赖项并保存,然后刷新项目。

Java 中 Lombok 项目的 Getters、Setter 功能

在 Java 中,迄今为止最常见的做法是使用“Java Beans”模式添加 getter 和 setter。大多数 IDE 会自动为这些模式生成代码。

让我们通过代码在“数据对象”和“数据工厂”的帮助下创建 getter 和 setter 来理解这种方法:

没有 Lombok 的数据对象

虽然手动创建 getter 和 setter 方法的传统 JavaBeans 方法可以完成工作,但它有几个缺点和限制,使其不太理想,特别是在现代 Java 开发环境中,其缺点主要在 Lombok 中被涵盖。

因此,我们更喜欢使用 Lombok 模式,而不是这个。下面是它在 Java 中的实现方式:

Java 中 Lombok 项目的构造函数特性

没有 Lombok 的构造函数,我们必须手动定义每个构造函数,这可能很乏味且容易出错,特别是对于具有许多字段的类。此外,我们需要处理各种构造函数配置,这会增加代码的复杂性。

Lombok 通过 @NoArgsConstructor、@AllArgsConstructor 和 @RequiredArgsConstructor 注解简化了这个过程。

没有 Lombok 的构造函数

使用 Lombok 注释减少了需要手动编写的样板代码量。使用 Lombok,您只需注释类和字段,构造函数就会根据指定的条件自动生成。这会导致代码更干净、更简洁。

各种龙目岛特征和属性

  1. ToString 生成
  • 在 Java 中,toString() 是 java.lang.Object 类中定义的方法,其作用是返回对象的字符串表示形式。 toString() 方法被 Java 中的所有类继承,它在 Object 类中的默认实现返回一个字符串,其中包含类名后跟“at”符号 (@) 以及对象哈希码的十六进制表示形式。
  • 但是,Object 提供的 toString() 的默认实现对于特定类可能并不总是有意义或有用。因此,开发人员的常见做法是在自己的类中重写 toString() 方法,以提供更好地描述对象的状态或属性的自定义字符串表示形式。
  • 根据我们的示例,Profile 类可能会重写 toString() 以返回包含名字、姓氏、职称、年龄信息的字符串。重写 toString() 允许以人类可读的格式轻松打印或记录对象信息,这有助于调试、记录或向用户显示信息。
  • 如果不使用 ToString Lombok 注释,我们必须在 Profile 类中手动实现 toString() 方法。我们连接名字、姓氏、职称和年龄字段以创建所需的字符串表示形式。这种手动实现实现了与 Lombok 的 @ToString 注解相同的结果。

不使用 ToString 注释功能

  • @ToString 注释为类生成一个 toString() 方法,提供其字段的字符串表示形式。当我们丰富我们的数据模型时,无需自己编写和维护它。
  • 使用此注释,在配置文件实例上调用 toString() 将返回一个包含其字段值的字符串。
  • @Exclude 注释对于各种不同的注释都很有用,例如 Getters、Setter、ToString、EqualAndHashCode 等。让我们通过 @ToString 注释示例来了解这一点。
  • 通过使用@ToString(exclude = {“designation”})注释指定字段
  • Lombok 不将其包含在 @ToString 生成的 toString() 方法中。如果您想避免在对象的字符串表示形式中显示某些字段,这会很有用。

2。 EqualAndHashCode 生成

  • 在Java中,equals()和hashCode()是两个常用的方法,分别用于实现对象相等和哈希码生成。
  • equals() 方法:equals() 方法用于比较两个对象是否相等。默认情况下,Object 类提供的 equals() 方法比较对象引用,这意味着仅当比较的两个对象是内存中的同一实例时,它才返回 true。然而,通常需要重写自定义类中的 equals() 方法,以基于对象属性定义有意义的相等概念。
  • hashCode() 方法:hashCode() 方法用于生成对象的哈希码值。哈希码是表示对象状态的整数值,通常用于基于哈希的数据结构(例如哈希表)。 hashCode() 方法很重要,因为它允许在基于哈希的集合中有效地存储和检索对象。
  • 在我们的示例中,我们手动实现并重写了 equals() 方法来比较两个 Profile 对象的字段是否相等,以及 hashCode() 方法来根据字段生成哈希码。
  • 我们使用 java.util.Objects 类中的 Objects.equals() 方法来比较字段是否相等,并使用 Objects.hash() 方法来生成哈希码。

不使用 EqualAndHashCode 注释功能

  • @EqualsAndHashCode 注解根据类的字段生成 equals() 和 hashCode() 方法。
  • 通过这个注解,Lombok 使用类的所有字段生成 equals() 和 hashCode() 方法。
  • 这消除了手动实现这些方法的需要,减少了样板代码并提高了代码的可维护性。

3。数据注释
如果不使用 @data 注释,我们必须手动在代码中实现 getter、setter 和 Constructors 功能。

  • 不使用数据注释功能

  • @data 注释是一个方便的快捷方式,它捆绑了 @Getter、@setter、@NoArgsConstructor、@AllArgsConstructor、@RequiredArgsConstructor、@ToString、@EqualsAndHashCode 和更多注释。

  • 使用@data,Lombok根据类中声明的字段自动为我们生成这些方法。这显着减少了我们需要编写和维护的样板代码量,使我们的代码更加简洁和可读。

  1. 构建器模式
  • 回到我们的 Profile 示例,构造一个新实例需要使用一个可能包含多个四个参数的构造函数,当我们向类中引入其他属性时,这项任务会变得很笨重。
  • 值得庆幸的是,Lombok 通过其 @builder 功能提供了一个强大的解决方案,这有助于利用构建器模式来创建新实例。让我们将此功能集成到我们的 Profile 类中。

包org.example.dataobjects;

导入lombok.*;

@Getter
@设置者
@NoArgsConstructor
@AllArgsConstructor
@RequiredArgsConstructor
@ToString(exclude = {"designation"})
@EqualsAndHashCode
@builder
@数据
公开课简介{
私有字符串名字;
私有字符串姓氏;
私有字符串指定;
私有整数年龄;

public static void main(String[] args) {

// 使用构建器创建 Profile 的实例
配置文件 profile = Profile.builder()
.firstName("部分")
.lastName("Kathrotiya")
.designation("QA 自动化工程师")
.年龄(23)
.build();
}
}

德伦博克

  • Delombok 是 Lombok 项目提供的一个工具,它可以逆转 Lombok 注释的效果,本质上是“delombok 化”你的代码。它允许您通过扩展注释并将其替换为它们将生成的相应样板代码来将包含 Lombok 注释的 Java 源代码转换为纯 Java 代码。
  • Delombok 的主要目的是促进与不直接支持 Lombok 注释的环境或工具的兼容性和互操作性。例如,如果您需要与开发环境中没有安装 Lombok 的开发人员共享您的代码,或者您想使用不理解 Lombok 注解的工具来分析或重构 Lombok 注解的代码,您可以使用 Delombok 进行转换将代码转换为在这些上下文中可以理解和使用的形式。
  • Delombok 可以通过命令行调用或集成到 Maven 或 Gradle 等构建工具中。当您在源代码上运行 Delombok 时,它会处理 Java 文件、扩展 Lombok 注释并生成没有任何 Lombok 注释的新 Java 文件。生成的代码在功能上与原始代码相同,但不依赖于 Lombok。
  • 总体而言,Delombok 是 Lombok 项目提供的一个有用的工具,它使用 Lombok 注释增强了代码库的互操作性和可维护性,使开发人员能够利用 Lombok 的优势,同时仍然确保与各种开发环境和工具的兼容性。

结论

虽然这篇文章重点介绍了我发现最有用的功能,但 Lombok 提供了大量附加功能和自定义功能。
Lombok 的文档是宝贵的资源,为每个注释提供了深入的解释和示例。如果您对这篇文章感兴趣,我强烈建议您深入研究 Lombok 的文档,以发现更多可能性。
此外,该项目网站还提供了有关跨各种编程环境集成 Lombok 的综合指南。无论您使用 Eclipse、NetBeans、IntelliJ 还是其他工具,请放心,Lombok 都能与您的工作流程无缝集成。作为经常在 IDE 之间切换的人,我可以证明 Lombok 在所有平台上的多功能性和可靠性。
总体而言,Project Lombok 提供了一套全面的功能,可以简化 Java 开发、减少代码冗长并促进最佳实践。
Project Lombok 提供了一套全面的功能,可以简化 Java 测试、减少代码冗长并促进最佳实践。通过合并 Lombok 构建器和 Lombok 构造器,测试人员可以进一步简化代码并提高可维护性。

以上是Lombok 释放:通过 Getters、Setters、Constructors、Builders 等提高 Java 效率的详细内容。更多信息请关注PHP中文网其他相关文章!

来源:dev.to
本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板