Skip to content

Latest commit

 

History

History
26 lines (20 loc) · 2.73 KB

README.md

File metadata and controls

26 lines (20 loc) · 2.73 KB

How To Use Hibernate @NaturalId in SpringBoot

Description: This is a SpringBoot application that maps a natural business key using Hibernate @NaturalId.

Key points:

  • in the entity (e.g., Book), mark the fields (business keys) that should act as natural IDs with @NaturalId; commonly, there is a single such property, but multiple are suppored as well as here.
  • for non-mutable ids, mark the columns as @NaturalId(mutable = false) and @Column(nullable = false, updatable = false, unique = true, ...)
  • for mutable ids, mark the columns as @NaturalId(mutable = true) and @Column(nullable = false, updatable = true, unique = true, ...)
  • override the equals() and hashCode() using the natural id(s)
  • define a @NoRepositoryBean interface (NaturalRepository) to define two methods, named findBySimpleNaturalId() and findByNaturalId()
  • provide an implementation for this interface (NaturalRepositoryImpl) relying on Hibernate, Session, bySimpleNaturalId() and byNaturalId() methods
  • for the entity, write a repository class (e.g., for the Book entity write BookNaturalRepository) that extends the NaturalRepositoryImpl and use it for setting the entity class type and the natural id type (when an entity uses more than one natural ID, the type is not relevant anymore, simply set it to Serializable)
  • inject this class in your services and call findBySimpleNaturalId() or findByNaturalId()
If you need a deep dive into the performance recipes exposed in this repository then I am sure that you will love my book "Spring Boot Persistence Best Practices"If you need a hand of tips and illustrations of 100+ Java persistence performance issues then "Java Persistence Performance Illustrated Guide" is for you.