Should I write equals() and hashCode() methods in JPA entities?

by

Not necessarily. There are three options:

  • don’t override – thus you will be working with instances. This is fine in cases when you are working with the collections with only entities that are attached to the session (and hence guaranteed to be the same instance). This is (for me) the preferred way in many cases, because it requires less code and less consideration when overriding

  • override hashCode() and equals() with a business key. That may be a subset of properties that identify the entity. For example, for a User a good business key might be the username or the email. This is considered good practice.

  • override hashCode() and equals() using the ID field only. This is fine in some cases, especially if you have a manually-assigned identifier (like an UUID). It is also fine if your entity will never go into a collection. But for transient entities (with no identifier) that go into collections, it causes problems, so careful with this option. As seanizer noted – you should avoid it. Generally, always, unless you are really aware of what you are doing (and perhaps documenting it)

See this article for more details. Also note that equals()and hashCode() are tied and should be implemented both with exactly the same fields.

More Related Contents:

  1. What issues should be considered when overriding equals and hashCode in Java?
  2. Why do I need to override the equals and hashCode methods in Java?
  3. Best implementation for hashCode method for a collection
  4. PersistentObjectException: detached entity passed to persist thrown by JPA and Hibernate
  5. How to fix the Hibernate “object references an unsaved transient instance – save the transient instance before flushing” error
  6. Understanding the workings of equals and hashCode in a HashMap
  7. What is the difference between persist() and merge() in JPA and Hibernate?
  8. How should equals and hashcode be implemented when using JPA and Hibernate
  9. How to ensure hashCode() is consistent with equals()?
  10. Apache Commons equals/hashCode builder [closed]
  11. Hashcode and Equals for Hashset [duplicate]
  12. Why should I override hashCode() when I override equals() method?
  13. How to clone a JPA entity
  14. what is the difference between == operator and equals()? (with hashcode() ???)
  15. How to implement hashCode and equals method
  16. Is it possible in java make something like Comparator but for implementing custom equals() and hashCode()
  17. JPA, How to use the same class (entity) to map different tables?
  18. How default .equals and .hashCode will work for my classes?
  19. Disable caching in JPA (eclipselink)
  20. Create the perfect JPA entity [closed]
  21. Java: Use hashCode() inside of equals() for convenience?
  22. Java comparison with == of two strings is false? [duplicate]
  23. How to store Java Date to Mysql datetime with JPA
  24. Setting default values for columns in JPA
  25. BigDecimal, precision and scale
  26. JPA: update only specific fields
  27. Java – equals method in base class and in subclasses
  28. Setting a parameter as a list for an IN expression
  29. How to set the timeout period on a JPA EntityManager query
  30. LOAD and CACHE application-scoped data with @Singleton and @Stateless

Leave a Comment