深入解析Lombok的@EqualsAndHashCode

最新推荐文章于 2024-10-05 19:23:25 发布

li.wz

最新推荐文章于 2024-10-05 19:23:25 发布

阅读量786

点赞数 28

分类专栏： JavaSE 文章标签：哈希算法散列表算法

本文链接：https://blog.csdn.net/Li_WenZhang/article/details/142641655

版权

JavaSE 专栏收录该内容

28 篇文章 0 订阅

订阅专栏

深入解析Lombok的`@EqualsAndHashCode`

背景

在Java中，equals和hashCode方法是非常重要的，它们影响着对象比较、集合操作（如HashSet和HashMap）等。手动实现这两个方法虽然不难，但重复的模板代码容易引发bug。为此，Lombok提供了@EqualsAndHashCode注解，简化开发，同时确保逻辑一致性。

`@EqualsAndHashCode`的基本用法

@EqualsAndHashCode注解可以自动为类生成equals和hashCode方法。示例：

import lombok.EqualsAndHashCode;

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

Lombok会基于所有非静态字段生成合理的equals和hashCode方法。

原理解析

`equals`方法生成原理

在Java中，equals的约定是判断两个对象的"值"是否相等，具体步骤为：

检查对象本身引用是否相同，若相同直接返回true。
检查对象是否为同一类型。
逐个比较类的字段值是否相等。

Lombok生成的equals遵循这些原则，代码大致如下：

@Override
public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;
    Person person = (Person) o;
    return age == person.age && Objects.equals(name, person.name);
}

Lombok通过反射或者AST改写的方式，自动生成上述逻辑，避免手动编写代码。

`hashCode`方法生成原理

hashCode是配合equals使用的重要方法，尤其在哈希结构（如HashMap）中起关键作用。Java中的约定是：相等的对象必须有相同的哈希值，而不相等的对象尽量避免相同哈希值。

Lombok生成的hashCode方法通常基于对象的所有字段来计算哈希值。例如：

@Override
public int hashCode() {
    return Objects.hash(name, age);
}

Objects.hash方法会根据传入字段的内容生成哈希值，并且保证相等对象的哈希值相同。

自定义行为

Lombok允许对@EqualsAndHashCode进行定制，满足不同场景的需求：

排除某些字段： 可以通过exclude参数排除不需要比较或生成哈希值的字段。例如，不希望id字段参与比较：

@EqualsAndHashCode(exclude = "id")
public class Person {
    private Long id;
    private String name;
    private int age;
}

调用父类方法： @EqualsAndHashCode默认不使用父类的equals和hashCode方法，如果需要，可以通过callSuper = true启用：

@EqualsAndHashCode(callSuper = true)
public class Employee extends Person {
    private String position;
}

只包含某些字段： 可以通过onlyExplicitlyIncluded来指定明确的字段参与比较和哈希值生成：

@EqualsAndHashCode(onlyExplicitlyIncluded = true)
public class Person {
    @EqualsAndHashCode.Include
    private String name;
    @EqualsAndHashCode.Include
    private int age;
}

深度解析

Lombok的工作原理

Lombok通过注解处理器（Annotation Processor）在编译时生成代码。注解处理器会扫描源代码中的Lombok注解，并根据注解生成相应的字节码。这意味着Lombok并不会在源代码中直接插入代码，而是在编译过程中动态生成。

`equals`方法的深度解析

equals方法的实现需要遵循以下几个原则：

自反性（Reflexive）： 对于任何非空引用值x，x.equals(x)应该返回true。
对称性（Symmetric）： 对于任何非空引用值x和y，如果x.equals(y)返回true，那么y.equals(x)也应该返回true。
传递性（Transitive）： 对于任何非空引用值x、y和z，如果x.equals(y)返回true，且y.equals(z)返回true，那么x.equals(z)也应该返回true。
一致性（Consistent）： 对于任何非空引用值x和y，只要对象的状态没有改变，多次调用x.equals(y)应该返回相同的结果。
非空性（Non-nullity）： 对于任何非空引用值x，x.equals(null)应该返回false。