Spring Boot 中 Lombok EqualsAndHashCode用法介绍

在 Spring Boot 项目中Lombok 是一个非常实用的工具库它通过注解简化了 Java 类的编写避免了大量的样板代码如 getter/setter、构造函数等。其中EqualsAndHashCode是 Lombok 提供的用于自动生成equals(Object other)和hashCode()方法的注解。本文将详细介绍EqualsAndHashCode的用法及其在 Spring Boot 开发中的注意事项。1. 什么是EqualsAndHashCodeEqualsAndHashCode是 Lombok 的一个注解标注在类上Lombok 会在编译时自动生成该类的equals和hashCode方法。默认情况下它会使用类中所有非静态、非 transient的字段来生成这两个方法这与Data注解的行为一致。基本示例javaimport lombok.EqualsAndHashCode; EqualsAndHashCode public class User { private Long id; private String name; private int age; }编译后Lombok 会生成类似于以下逻辑的代码equals比较两个对象的id、name、age字段是否都相等。hashCode根据相同的字段计算哈希值。2.EqualsAndHashCode的常用属性EqualsAndHashCode提供了一些属性让我们可以灵活地定制生成的方法。2.1callSuper作用指定生成的equals和hashCode方法是否包含父类的字段比较。取值boolean默认false。使用场景当类有明确的父类且父类也有字段需要参与相等性判断时应设置为true。javaEqualsAndHashCode(callSuper true) public class Employee extends User { private String department; }此时生成的equals会先调用父类User的equals再比较departmenthashCode也会组合父类哈希值。2.2of和exclude作用指定哪些字段参与或不参与生成。of指定使用哪些字段逗号分隔其他字段将被忽略。exclude指定排除哪些字段其余字段都参与。注意二者不能同时使用。javaEqualsAndHashCode(of {id, name}) // 只使用 id 和 name // 或 EqualsAndHashCode(exclude {age}) // 排除 age使用 id 和 name public class User { private Long id; private String name; private int age; }2.3doNotUseGetters作用是否直接访问字段即使存在 getter 方法。默认false即通过 getter 方法访问字段。使用场景如果希望直接使用字段值避免 getter 可能包含的额外逻辑可设为true。2.4onlyExplicitlyIncluded作用配合EqualsAndHashCode.Include或EqualsAndHashCode.Exclude使用当设为true时只有显式标注EqualsAndHashCode.Include的字段才会参与。示例javaEqualsAndHashCode(onlyExplicitlyIncluded true) public class User { EqualsAndHashCode.Include private Long id; private String name; // 不会参与 }3. 在 Spring Boot 中的使用建议Spring Boot 项目中EqualsAndHashCode常用于实体类、DTO、配置属性类等。尤其在与 JPA 等持久化框架结合时需要特别注意一些陷阱。3.1 与 JPA 实体一起使用JPA 实体通常包含关联关系如OneToMany、ManyToOne此时直接使用默认的EqualsAndHashCode可能导致无限递归或性能问题。问题场景双向关联User有ListOrderOrder有User属性。如果两个实体都包含对方字段在调用equals或hashCode时会相互调用最终导致栈溢出或循环引用。解决方法使用exclude排除关联字段例如javaEntity EqualsAndHashCode(exclude {orders}) public class User { Id private Long id; private String name; OneToMany(mappedBy user) private ListOrder orders; }或者使用EqualsAndHashCode.Exclude注解在字段上javaEntity EqualsAndHashCode public class User { Id private Long id; private String name; OneToMany(mappedBy user) EqualsAndHashCode.Exclude private ListOrder orders; }另一种常见做法仅使用业务主键如数据库自增 ID作为equals和hashCode的依据通过of {id}或onlyExplicitlyIncluded true实现。3.2 懒加载问题JPA 中关联字段通常是懒加载的FetchType.LAZY。如果在equals或hashCode中访问这些字段可能会触发不必要的数据库查询甚至因会话关闭而抛出LazyInitializationException。因此强烈建议排除所有懒加载的关联字段。3.3 与Data的关系Data是一个组合注解包含了ToString、EqualsAndHashCode、Getter/Setter和RequiredArgsConstructor。当使用Data时默认的equals/hashCode行为与EqualsAndHashCode相同包含所有非静态非 transient 字段。如果实体有继承或需要排除字段可以单独添加EqualsAndHashCode覆盖默认配置javaData EqualsAndHashCode(callSuper true, exclude {orders}) public class User extends BaseEntity { // ... }3.4 与Builder结合如果同时使用Builder和EqualsAndHashCode通常不会有冲突。但需要注意Builder生成的内部类与实体类本身不共享equals/hashCode逻辑因此对实体类的equals没有影响。3.5 DTO 类中的使用对于数据传输对象DTO通常需要重写equals和hashCode以便在集合中进行比较。使用EqualsAndHashCode可以快速生成一般无需特殊配置但同样注意排除非必要字段如不需要比较的临时属性。4. 完整示例下面是一个在 Spring Boot JPA 项目中使用EqualsAndHashCode的示例javaEntity Table(name users) Data EqualsAndHashCode(callSuper true, onlyExplicitlyIncluded true) NoArgsConstructor AllArgsConstructor Builder public class User extends BaseAuditEntity { Id GeneratedValue(strategy GenerationType.IDENTITY) EqualsAndHashCode.Include private Long id; Column(nullable false, unique true) EqualsAndHashCode.Include private String username; private String email; // 不参与 equals/hashCode OneToMany(mappedBy user, fetch FetchType.LAZY) ToString.Exclude EqualsAndHashCode.Exclude private ListOrder orders; // 懒加载关联排除 }说明callSuper true父类BaseAuditEntity可能包含createdDate等审计字段需要参与比较。onlyExplicitlyIncluded true只有标注了EqualsAndHashCode.Include的字段id、username参与比较。orders被显式排除避免循环依赖和懒加载问题。ToString.Exclude同样用于避免toString时的循环引用。5. 注意事项与常见陷阱不要滥用callSuper仅当父类确实有业务含义的字段需要比较时才设为true否则可能引入不必要的耦合。避免修改参与equals/hashCode的字段如果对象被放入HashSet或作为HashMap的键修改这些字段的值会导致对象无法被正确找到。与Builder的潜在冲突如果使用Builder且某些字段未设置默认值可能会导致生成的equals比较时出现null与非null的误判但通常没问题。ID 生成策略问题对于 JPA 实体如果id在持久化前为null持久化后有值可能导致equals/hashCode变化从而影响对象在集合中的行为。此时可以考虑使用业务上的自然键如用户名作为equals依据。继承层次过深时谨慎使用多层继承时callSuper会逐层调用父类的equals可能带来性能损耗。6. 总结EqualsAndHashCode是 Lombok 提供的强大注解能显著减少手动编写equals和hashCode的工作量。在 Spring Boot 项目中使用时应特别注意在 JPA 实体中排除关联字段避免循环依赖和懒加载异常。结合onlyExplicitlyIncluded和EqualsAndHashCode.Include明确参与比较的字段。合理使用callSuper处理继承关系。关注字段可变性对集合行为的影响。正确使用EqualsAndHashCode可以让代码更简洁、更安全提升开发效率。