공유된 FK(Foreign Key) JPA 연관 관계 매핑 하기

필자는 JPA(Java Persistence API)로 애플리케이션을 개발 과정에서 아래와 같은 테이블 관계를 JPA로 매핑해야 하는 상황에 닥치게 되었다.

 

plant 테이블은 복합키로 구성 되어 있으며 delivery 테이블과 plant 테이블과 비식별자 1:N 관계이다.

업무상 delivery는 두개의 plant를 가지며 두개의 plant의 brand_cd가 같기 때문에 delivery 는 하나의 brand_cd 사용한다.

ALTER TABLE `delivery`
 ADD CONSTRAINT `delivery_FK` FOREIGN KEY ( `brand_cd`,`receipt_plant_id` )
 REFERENCES `plant` ( `brand_cd`,`plant_id` );
 
ALTER TABLE `delivery`
 ADD CONSTRAINT `delivery_FK1` FOREIGN KEY ( `brand_cd`,`shipment_plant_id` )
 REFERENCES `plant` ( `brand_cd`,`plant_id` );

FK를 공유하게 되는 경우 어떻게 JPA로 연관 관계 매핑 해야 하나?

일단 JPA의 JoinColumns를 사용하여 연관 관계 매핑을 시도 하였다.

delivery 테이블은 실제 하나의 brand_cd를 가지고 있기 때문에 Delivery Entity와 Plant Entity 연관 관계 매핑시 brand_cd 하나로 관계 매핑 하였다.

@Entity
@Table
@IdClass(PlantPK.class)
public class Plant {
    @Id
    @Column(name = "brand_cd", length = 10)
    private String brandCode;
 
    @Id
    @Column(name = "plant_id", length = 10)
    private String plantId;
    ...
}
 
@Entity
@Table
public class Delivery {
    @Id
    @Column(name = "delivery_id")
    private String deliveryNo;
 
    @ManyToOne
    @JoinColumns({
            @JoinColumn(name = "shipment_plant_id",
                    referencedColumnName = "plant_id"),
            @JoinColumn(name = "brand_cd",
                    referencedColumnName = "brand_cd")
    })
    private Plant shipmentPlant;
 
    @ManyToOne
    @JoinColumns({
            @JoinColumn(name = "receipt_plant_id",
                    referencedColumnName = "plant_id"),
            @JoinColumn(name = "brand_cd",
                    referencedColumnName = "brand_cd")
    })
    private Plant receiptPlant;
 
    @Column(name = "brand_cd", length = 10)
    private String brandCode;
    ...
}

MappingException: Repeated column in mapping for entity

위의 코드를 실행 시켜 보면 JPA가 시작될 때 MappingException을 만나게 된다.

 

로그를 해석해 보면, JoinColumn에 ‘brand_cd’가 반복 되기 때문에 insert=”false” update=”false”을 함께 사용하라는 것이다.

insertable = false, updatable = false 사용으로 MappingException은 발생 하지 않지만

로그에서 권고대로 insertable = false, updatable = false 추가로 선언하면 MappingException은 발생하지 않는다.

@Entity
@Table
public class Delivery {
    ...
    @ManyToOne
    @JoinColumns({
            @JoinColumn(name = "shipment_plant_id",
                    referencedColumnName = "plant_id",
                    insertable = false, updatable = false),
            @JoinColumn(name = "brand_cd",
                    referencedColumnName = "brand_cd",
                    insertable = false, updatable = false)
    })
    private Plant shipmentPlant;
 
    @ManyToOne
    @JoinColumns({
            @JoinColumn(name = "receipt_plant_id",
                    referencedColumnName = "plant_id",
                    insertable = false, updatable = false),
            @JoinColumn(name = "brand_cd",
                    referencedColumnName = "brand_cd",
                    insertable = false, updatable = false)
    })
    private Plant receiptPlant;
    ...
}

하지만 필자의 경우 Plant 엔티티와 Delivery 엔티티가 각각 CRUD(Create, Read, Update, Delete)의 시작 지점이다.

경축! 아무것도 안하여 에스천사게임즈가 새로운 모습으로 재오픈 하였습니다.
어린이용이며, 설치가 필요없는 브라우저 게임입니다.
https://s1004games.com

EntityManager em = this.emf.createEntityManager();
       
Plant plantA = new Plant("ABC", "plant A");
em.persist(plantA);
 
Plant plantB = new Plant("ABC", "plant B");
em.persist(plantB);
 
Delivery delivery = new Delivery("DID-0001", plantA, plantB, "ABC");
em.persist(delivery);

위의 코드를 실행해 보면 delivery 테이블에 shipment_plant_id와 receipt_plant_id의 값이 null 이다. 왜냐하면 insertable = false, updatable = false은 참조 엔티티를 읽기 전용으로 매핑하기 때문이다.

이것은 의도한 바가 아니다.

Hibernate 접근 방식 시도

필자는 JPA 구현체를 Hibernate(5.0.12.Final)를 사용하고 있다. Hibernate의 JoinColumnOrFormula를 사용하면 위의 상황을 해결 하는 것이 가능 하다.

import org.hibernate.annotations.JoinColumnOrFormula;
import org.hibernate.annotations.JoinColumnsOrFormulas;
import org.hibernate.annotations.JoinFormula;
 
@Entity
@Table
public class Delivery {
    ...
    @ManyToOne
    @JoinColumnsOrFormulas(value = {
            @JoinColumnOrFormula(column =
            @JoinColumn(name = "shipment_plant_id",
                    referencedColumnName = "plant_id")),
            @JoinColumnOrFormula(formula =
            @JoinFormula(value = "brand_cd",
                    referencedColumnName = "brand_cd")),
    })
    private Plant shipmentPlant;
 
    @ManyToOne
    @JoinColumnsOrFormulas(value = {
            @JoinColumnOrFormula(column =
            @JoinColumn(name = "receipt_plant_id",
                    referencedColumnName = "plant_id")),
            @JoinColumnOrFormula(formula =
            @JoinFormula(value = "brand_cd",
                    referencedColumnName = "brand_cd")),
    })
    private Plant receiptPlant;
 
    @Column(name = "brand_cd", length = 10)
    private String brandCode;
    ...
}

Formula in Hibernate

Hibernate 문서에 따르면 Formula는 파생된 값(derived value)으로 읽기 전용 상태로 표현된다고 정의하고 있다.

Defines a formula (derived value) which is a SQL fragment that acts as a @Column alternative in most cases. Represents read-only state.

https://docs.jboss.org/hibernate/orm/5.1/javadocs/org/hibernate/annotations/Formula.html

필자는 공유된 FK(여기서는 brand_cd)를 derived value로 사용 하여 읽기 전용으로 매핑 하였다.

[출처] https://medium.com/@SlackBeck/%EC%A4%91%EC%B2%A9%EB%90%9C-fk-foreign-key-%EB%A5%BC-jpa%EB%A1%9C-%EC%97%B0%EA%B4%80-%EA%B4%80%EA%B3%84-%EB%A7%A4%ED%95%91-%ED%95%98%EA%B8%B0-216ba5f2b8ed