Spring Data JPA - @MapsId

📝 Spring Data JPA의 MapsId

Database 설게를 진행하다보면 1:1 관계에서 부모와 자식처럼 하나의 테이블에 종속되어 있는 테이블이 설계될 경우가 있다.이런 경우 부모 테이블의 PK를 자식테이블에서 PK이자 FK로 사용되어야 하는 경우가 있는데 JPA Entity 설계를 할때 단순 @JoinColumn Annotation으로 설계하게되면 부모테이블에서 PK가 없다고 JPA에서 오류로 받아들일 뿐만 아니라 PK 문제를 해결하더라도 PK 와 FK가 따로 생겨버리는 문제가 발생한다.
따라서 MapsId 라는 Annotation을 이용해서 FK 컬럼을 줄이는 동시에 PK 와 FK를 합쳐서 설계가 되도록 기록해보려고 한다.

🚩 1:1 관계에서의 @MapsId

📝 부모 Entity

■ Source Code

@Entity(name = "speaker_info")
@Getter
@Builder
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@AllArgsConstructor
public class SpeakerInfo {
    @Id
    @Column(name = "speaker_id", length = 15)
    private String speakerId;

    @Column(name = "lte_number", length = 11, nullable = false)
    private String lteNumber;

    @ManyToOne(targetEntity = RegionInfo.class, fetch = FetchType.LAZY)
    @JoinColumn(name = "region_code", nullable = false)
    private RegionInfo regionInfo;

    @Column(name = "latitude")
    private Double latitude;

    @Column(name = "longitude")
    private Double longitude;

    @Column(name = "description", columnDefinition = "TEXT")
    private String description;
}

■ 설명

부모 Entity의 설계는 위와 같이 되어 있다. 스피커 정보에 관한 정보를 담고 있으며 자식 Entity로는 스피커의 설정 정보에 관한 정보를 담고 있도록 설계가 되어 있다.
아래의 자식 Entity의 정보를 보도록 하자.

📝 자식 Entity

■ Source Code

@Entity(name = "speaker_control_value_info")
@Getter
@Builder
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@AllArgsConstructor
public class SpeakerControlValueInfo {
    @Id
    private String speakerInfoId;
    
    @MapsId(value = "speakerInfoId")
    @OneToOne(targetEntity = SpeakerInfo.class, fetch = FetchType.LAZY)
    @JoinColumn(name = "speaker_info_id")
    private SpeakerInfo speakerInfo;

    //    SubCommand 1
    @Column(name = "bgm_volume_ch1")
    @ColumnDefault("0")
    private byte bgmVolumeCh1;
}

■ 설명

자식 Entity의 설계는 위와 같이 되어 있다. 스피커 정보를 부모 Entity로서 1:1로 가지고 있도록 설계하였다. 스피커 정보가 있어야 스피커 설정정보가 있는 것 이므로 1:1로서 데이터가 엇나갈 이유는 없으므로 해당 문제는 배제하도록 한다. Annotation을 기준으로 하나씩 살펴보도록 하자.

• @OneToOne
  스피커 정보 테이블인 부모 Entity와 1:1로 맵핑시키기 위해서 해당 Annotation을 표시하였다.
  인자로 targetEntity와 fetch의 조건을 설정해주었다.

• @JoinColumn
  자식 Entity의 Column이 부모 Entity의 어느 Column 연결될지 설정하는 Annotation이다.

• @Id
  자식 Entity의 실제 PK로서 Database에서 실제 PK로 작동될 unique한 key이다.

• @MapsId
  자식 Entity에서 Database 상이 아닌 JPA 상에서 실제로 사용되는 PK를 설정하는 Annotation이다.
  

📌 마무리

@MapsId Annotation에 관하여 정리해보았다. 블로그를 뒤지다보면 단순히 Column를 줄여주는 역할이라고 나오는데, 정확한 개념을 아직 깨닫지 못하고 사용하는 방법만 깨달은거 같아서 좀 아쉽다. @MapsId 의 개념에 대한 공부를 좀더 해서 나중에 기록해 보려고 하고, 1:N에서 @MapsId를 사용하는 방법이 있다고 하는데 그것도 찾아서 기록해보려고 한다.