Lombok @EqualsAndHashCode 注解:简化对象比较

更新时间 2023-07-26 14:37:21

一则小广告

最近,小哈正在带小伙伴做前后端分离博客项目,采用技术栈 Spring Boot + Mybatis Plus + Vue 3.2 + Vite 4,手把手教学,前端 + 后端全栈开发,从 0 到 1 讲解每个功能开发过程,1v1 答疑,陪伴式直到项目上线,目前第六章 《Element Plus 手搭 Admin 后台管理骨架》已快完结,截止到目前,已更新 52 节内容,共计 81557 字,演示截图:433 张,持续更新中,后续还会上新更多项目,欢迎点击加入

本小节中,我们要讲的是 @EqualsAndHashCode 注解,这是一个能帮我们自动产生 equalshashCode 方法的神奇注解。在 Java 中,这两个方法是非常重要的,用于比较对象的相等性和生成对象的哈希码。接下来,让我们一起看看要如何使用它!

1. 什么是 @EqualsAndHashCode

@EqualsAndHashCode 是 Lombok 提供的一个注解,它能够帮助我们自动生成 equalshashCode 方法。在 Java 中,当我们需要比较两个对象的相等性或者将对象放入集合(如 HashSet 或 HashMap)中时,这两个方法就十分重要。然而,手动编写它们非常繁琐并且容易出错,而 Lombok 的 @EqualsAndHashCode 就可以帮我们自动完成。

2. 如何使用 @EqualsAndHashCode

和其他 Lombok 注解一样,使用 @EqualsAndHashCode 也非常简单。你只需要在类上添加这个注解,Lombok 就会自动为你生成 equalshashCode 方法。下面是一个简单的例子:

import lombok.EqualsAndHashCode;

@EqualsAndHashCode
public class Student {
    private String name;
    private int age;
}

有了 @EqualsAndHashCode 注解,Student 类就拥有了自己的 equalshashCode 方法,你可以像使用自定义方法一样使用它们。

3. 自定义 @EqualsAndHashCode

Lombok 提供了一些选项,让你可以自定义 equalshashCode 方法的行为。这些选项包括:

  • doNotUseGetters:是否直接使用字段值而非调用 getter 方法,默认为 false
  • callSuper:是否在 equalshashCode 方法中调用超类的方法,默认为 false
  • exclude:排除某些字段,不在 equalshashCode 方法中使用。
  • of:明确要在 equalshashCode 方法中使用的字段。

这是一个使用了这些选项的例子:

import lombok.EqualsAndHashCode;

@EqualsAndHashCode(callSuper = true, exclude = "age")
public class Student extends Person {
    private String name;
    private int age;
}

在这个例子中,Student 类的 equalshashCode 方法会调用超类 Person 的方法,并且只会使用 name 字段,不会使用 age 字段。

4. 结语

看看,是不是感觉 Lombok 的 @EqualsAndHashCode 注解让对象比较变得更容易了呢?