How to use hibernate @ naturalid in springboot?

Jiedao jdon 2021-05-04 17:29:44
use hibernate naturalid springboot

This is a Spring Boot Application cases , Show how to use Hibernate Mapping natural business keys   @NaturalId.

Key points :

1. In entity ( for example ,Product) in , The mark should be taken as a natural sign ID  Properties of ( Business key )  @NaturalId;  Usually , There is only one such attribute in an entity , however here Multiple attributes are also supported .

public class Product implements Serializable {
    private static final long serialVersionUID = 1L;
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    @NaturalId(mutable = false)
    @Column(nullable = false, updatable = false, unique = true, length = 50)
    private String code;
     // @NaturalId(mutable = false)
    // @Column(nullable = false, updatable = false, unique = true)
    // private Long sku;

For immutable id, Mark the column as @NaturalId(mutable = false) and @Column(nullable = false, updatable = false, unique = true, ...)

For variable id, Mark the column as @NaturalId(mutable = true) and  @Column(nullable = false, updatable = true, unique = true, ...)

2. Use nature id Cover equals() and hashCode()

    public boolean equals(Object o) {
        if (this == o) {
            return true;
        if (!(o instanceof Product)) {
            return false;
        Product naturalIdProduct = (Product) o;
        return Objects.equals(getCode(), naturalIdProduct.getCode());
        // including sku 
        // return Objects.equals(getCode(), naturalIdProduct.getCode())
            // && Objects.equals(getSku(), naturalIdProduct.getSku());
    public int hashCode() {
        return Objects.hash(getCode());
        // including sku
        // return Objects.hash(getCode(), getSku());
    public String toString() {
        return "Product{" + "id=" + id + ", name=" + name + ", code=" + code + '}';
        // including sku
        // return "Product{" + "id=" + id + ", name=" + name + ", code=" + code + ", sku=" + sku + '}';

3.  Define a @NoRepositoryBean Interface ( for example NaturalRepository) To define two objects called findBySimpleNaturalId()and Methods findByNaturalId() 

public interface NaturalRepository<T, NID extends Serializable> {
    // use this method when your entity has a single field annotated with @NaturalId
    Optional<T> findBySimpleNaturalId(NID naturalId);
    // use this method when your entity has more than one field annotated with @NaturalId
    Optional<T> findByNaturalId(Map<String, Object> naturalIds);        

4.  Provides an implementation of this interface ( for example , One NaturalRepositoryImpl Realization   ) Depend on Hibernate Of Session Realization bySimpleNaturalId(), and   byNaturalId() Method

@Transactional(readOnly = true)
public abstract class NaturalRepositoryImpl<T, NID extends Serializable>
        implements NaturalRepository<T, NID> {
    private EntityManager entityManager;
    private final Class<T> entityClass;
    public NaturalRepositoryImpl(Class<T> entityClass) {
        this.entityClass = entityClass;
    public Optional<T> findBySimpleNaturalId(NID naturalId) {
        Optional<T> entity = entityManager.unwrap(Session.class)
        return entity;
    public Optional<T> findByNaturalId(Map<String, Object> naturalIds) {
        NaturalIdLoadAccess<T> loadAccess
                = entityManager.unwrap(Session.class).byNaturalId(entityClass);
        return loadAccess.loadOptional();

For entities , Write extended repository classes ( for example , be used for Product Entity write   ProductNaturalRepository)NaturalRepositoryImpl And use it to set the entity class type and nature id type ( When entities use multiple natures ID when , The type is no longer relevant , Just set it to Serializable)

45  Inject this class into your service and call findBySimpleNaturalId() or  findByNaturalId()

The source code can be Get... Here .

本文为[Jiedao jdon]所创,转载请带上原文链接,感谢

  1. Microservice mode: business process saga mode of spring boot + Kafka - vinsguru
  2. Linux / MacOS 修改 ls 显示年月日的时间格式
  3. Linux / MacOS modify the time format of LS display date
  4. 7、Spring Boot检索
  5. 7. Spring boot search
  6. 7、Spring Boot检索
  7. 7. Spring boot search
  8. 10、Spring Boot分布式
  9. 10. Spring boot distributed
  10. Did you know that artifact can also manage SUSE Linux system dependencies
  11. 3、Spring Cloud Rest工程建立(通過IDEA建立)
  12. 3. Spring cloud rest project establishment (through idea)
  13. 4、Spring Cloud Eureka
  14. 4、Spring Cloud Eureka
  15. Did you know that artifact can also manage SUSE Linux system dependencies
  16. k8s搭建zk&pulsar集群——三节点
  17. 7、Spring Cloud Hystrix
  18. Dubbo series -- source code analysis of local service publishing
  19. Netty启动对HTTP/3的孵化器支持
  20. Netty launches incubator support for HTTP / 3
  21. Spring Webflux security configuration tutorial and source code - vinsguru
  22. WebClient: Spring的新的HTTP反应式客户端 -
  23. Webclient: spring's new HTTP reactive client-
  24. 使用Project Reactor进行反应式数据流 -
  25. Using project reactor for reactive data flow-
  26. Humor: k8s is not so hard to deploy on kubernetes personal blog
  27. UNIX domain socket tutorial for java16 - nipafx
  28. Using netty to realize the source code and tutorial of http2 server / client baeldung
  29. Using spring boot reactive r2dbc to realize crud operation source code of PostgreSQL Rajesh
  30. Spring Boot Liquibase基础教程 - josdem
  31. Vlad mihalcea: the best way to map query results to dto using JPA and Hibernate
  32. Using java enumeration in spring boot to automatically serialize parameters and save database - Dario
  33. In depth study of spring cloud load balancer - Piotr
  34. How to use completable future in springboot 2
  35. Basic course of spring boot liquibase - josdem
  36. Volatile side effect in Java: not using CPU cache
  37. Using redis PubSub and spring boot to realize microservice message model vinsguru
  38. Fault tolerant and reliable messaging of Apache Kafka and spring boot – Arnold galovics
  39. Java exception and tuning one stop solution
  40. Using playwright to implement automatic visual testing for Java API - applitools
  41. Oracle database official statement does not support VMWare
  42. [function] Oracle function series (1) -- character function
  43. [function] Oracle function series (1) -- character function
  44. Oracle character set simple diagram, Chinese garbled solution
  45. Oracle lock series
  46. No.2 process kthread of Linux kernel learning
  47. [password] Oracle user password series
  48. [Linux] migrate Oracle installation directory from root directory to logical volume
  49. Oracle 12cr1 RAC installation on VMware Workstation (middle) - graphical interface installation
  50. Driving of Oracle hint_ SITE
  51. Oracle 12cr1 RAC installation on VMware Workstation (middle) - graphical interface installation
  52. [knowledge point sorting] comparison of redo, undo and execution speed under nologing, append, archive and parallel in Oracle
  53. Introduction to Oracle parameters
  54. [method] how to limit IP access to Oracle database
  55. Oracle 12cr1 RAC installation on VMware Workstation (middle) - graphical interface installation
  56. Linux free - M command
  57. Oracle fast recovery area (FRA)
  58. Docker install MySQL 5.7
  59. Oracle 12C EM Express Series
  60. [DG] Oracle 19C uses DBCA to build physical DG