How should equals and hashcode be implemented when using JPA and Hibernate
I don't think that the accepted answer is accurate.
To answer the original question:
Is the default implementation good enough for most cases?
The answer is yes, in most cases it is.
You only need to override equals()
and hashcode()
if the entity will be used in a Set
(which is very common) AND the entity will be detached from, and subsequently re-attached to, hibernate sessions (which is an uncommon usage of hibernate).
The accepted answer indicates that the methods need to be overriden if either condition is true.
Hibernate has a nice and long description of when / how to override equals()
/ hashCode()
in documentation
The gist of it is you only need to worry about it if your entity will be part of a Set
or if you're going to be detaching / attaching its instances. The latter is not that common. The former is usually best handled via:
- Basing
equals()
/hashCode()
on a business key - e.g. a unique combination of attributes that is not going to change during object (or, at least, session) lifetime. - If the above is impossible, base
equals()
/hashCode()
on primary key IF it's set and object identity /System.identityHashCode()
otherwise. The important part here is that you need to reload your Set after new entity has been added to it and persisted; otherwise you may end up with strange behavior (ultimately resulting in errors and / or data corruption) because your entity may be allocated to a bucket not matching its currenthashCode()
.