[JPA] @ManyToOne - PK가 아닌 필드를 참조할 때 (feat.referencedColumnName)

개요

@ManyToOne 연관관계에서 pk 가 아닌 값을 참조할 때 겪은 문제를 기록했습니다.

기존에는 연관관계를 맺지 않고 FK를 단순 String 으로 참조했기 때문에 두 테이블을 간단히 조인하여 원하는 결과를 얻을 수 있었습니다. 하지만 연관관계를 맺고 FK 의 타입을 String 에서 Entity로 변경했을 땐, 원하는 결과를 반환 받을 수 없었습니다.

문제의 원인과 해결 방법을 풀어 설명해보겠습니다. 

 

문제 상황

Hospital 엔티티에서 Address 엔티티를 참조하는 addressCode 라는 Foreign Key 가 있습니다.

정확히 말하면 FK 처럼 사용하려고 선언한 addressCode 필드가 있습니다. 어이없게도 해당 필드의 타입을 Address 로 선언하지 않고, String 으로 지정한 실수가 있었습니다. 객체지향적이지 못하고, 연관관계가 맺어지지 않은 상태에서 참조만 하는 상태로 볼 수 있습니다.

@Entity
@Table(name = "hospital")
public class Hospital {

    @Id @GeneratedValue(strategy = IDENTITY)
    @Column(name = "id", nullable = false)
    private Integer id;

    @Column(name = "address_code")
    private String addressCode;

}

@Entity
@Table(name = "address")
public class Address implements Serializable {

   private static final long serialVersionUID = 1L;

   @Id
   @Column(name = "id", nullable = false)
   @GeneratedValue(strategy = GenerationType.IDENTITY)
   private Integer id;

   @Column(name = "code")
   private String code;

}

이 글을 읽는 분들은Hospital 엔티티의 addressCode 의 타입이 어색하다는 것을 단번에 알아차리실 겁니다. OOP답게 코드를 작성하려면 String -> Address 타입으로 변경해줘야 합니다. 

 

해당 부분을 변경 했습니다.

@Entity
@Table(name = "hospital")
public class Hospital {

    @Id @GeneratedValue(strategy = IDENTITY)
    @Column(name = "id", nullable = false)
    private Integer id;


    // 변경 전
//    @Column(name = "address_code")
//    private String addressCode;

    
    // 변경 후 
    @ManyToOne
    @JoinColumn(name = "address_code")
    private Addresss address;

}

 

수정한 내용을 반영하여 QueryDSL JPA도 실행해보겠습니다. 해당 코드는 hospital 이 address 를 참조하여, address 엔티티의 정보를 가져오기 위해 사용됩니다.

public Page<HospitalListDto> getHospitals(Pageable pageable) {
        JPQLQuery<HospitalListDto> limit = getQuerydsl().createQuery()
                .select(home)
                .from(hospital)
                .leftJoin(address).on(hospital.address.code.eq(address.code))
                .groupBy(hospital.id)
                .limit(pageable.getPageSize());
                
		... 

    }

leftjoin 쿼리에서 hospital의 address 필드가 address의 code 필드를 참조한다는 것을 알 수 있습니다.

테이블 상에선 아래와 같은 모습이죠.

테이블의 address_code 라는 컬럼명이, Java 코드에선 아래처럼 표현됩니다.

@Column(name = "address_code")
private Addresss address;

 

QueryDSL 코드가 실행 된 후 정상적으로 값이 반환 될 것이라 기대했지만, 아무런 값도 나오지 않았습니다.

원인 파악을 위해 실제 sql 쿼리가 어떻게 나갔는지 p6spy 라이브러리를 통해 확인했습니다.

 

select distinct hospital0_.id,
                hospital0_.address_code

from core_hospital hospital0_
         left outer join address address2_ on hospital0_.address_code = address2_.id
         left outer join address address1_ on (address1_.code = address2_.code)

group by hospital0_.id
limit 20;

분명 QueryDSL 코드에선 left Join 을 한번만 걸었는데, 실제로 나간 쿼리를 보면 left join 이 두번 걸려있는 것을 확인할 수 있습니다. 무엇이 문제일가요? 

@newsroom season1

 

원인 파악

우선 두번나간 left join 쿼리가 어떤 형태인지 확인해보겠습니다.

left outer join address address2_ on hospital0_.address_code = address2_.id -- (1)
left outer join address address1_ on (address1_.code = address2_.code) -- (2)

 

1) hospital 테이블의 address_code  컬럼이 address 테이블의 id 와 조인합니다. queryDSL 코드대로라면 address_code 는 address의 code 컬럼과 조인해야하는데 말이죠. 

 

2) 두번째 조인문에선, address 테이블의 code 컬럼이, (1) 에서 조인할 때 사용된 address 테이블의 code 컬럼과 조인됩니다. 도통 무슨 소리인지, 어떻게 해석해야할지 감이 오지 않습니다.

 

문제 원인

공식문서와 구글링을 통해 왜 위와 같은 이상한 join 문이 발생했는지 알 수 있었습니다.

아래는 JoinColumn 어노테이션의 옵션인 referencedColumnName 에 관한 설명입니다. 

@JoinColumn 어노테이션 공식문서

하이라이팅된 부분을 의역해보면, @JoinColumn(name="value")의 value는 참조 테이블의 primary key 와 같은 이름으로 디폴트 지정된다는 것을 추론할 수 있습니다. 여기서 value는 hospital 의 address_code 에 해당되는 값 입니다. 

이쯤에서 address와 hospital 엔티티를 다시 보겠습니다.

@Entity
@Table(name = "address")
public class Address implements Serializable {

   private static final long serialVersionUID = 1L;

   @Id
   @Column(name = "id", nullable = false)
   @GeneratedValue(strategy = GenerationType.IDENTITY)
   private Integer id;

   @Column(name = "code")
   private String code;

}

@Entity
@Table(name = "hospital")
public class Hospital {

    @Id @GeneratedValue(strategy = IDENTITY)
    @Column(name = "id", nullable = false)
    private Integer id;

    @ManyToOne
    @JoinColumn(name = "address_code")
    private Addresss address;

}

눈치 채셨나요?

2번이나 출력된 left join 문이, referencedColumnName 의 default 속성과 연관돼 있음을 알 수 있습니다.

referencedColumnName을 별도로 지정하지 않았기 때문에 디폴트로 pk 값인 address.id 를 참조한 것임을 파악할 수 있었습니다. 그렇기 때문에 queryDSL 상의 조인문과 실제 query 의 조인문이 차이를 가진 것이죠. queryDSL 에서 hospital의 fk 는 address 의 code 를 참조하려고 하지만,  @JoinColumn 의 디폴트 옵션이 id(pk) 를 참조해버립니다. 실제 쿼리 (1) 에서 address.id 가 등장하는 이유를 이제는 이해할 수 있습니다.

 

문제 해결

@Entity
@Table(name = "hospital")
public class Hospital {

    @Id @GeneratedValue(strategy = IDENTITY)
    @Column(name = "id", nullable = false)
    private Integer id;

    @ManyToOne
    @JoinColumn(name = "address_code", referencedColumnName = "code")
    private Address address;
}

이제 @JoinColumn 의 옵션 referencedColumnName 에 우리가 실제로 참조하고자 하는 컬럼명 code 을 적습니다. queryDSL 을 다시 실행해보면 원하는 결과가 출력되는 것을 확인할 수 있습니다. 

 

 

정리

1. 연관관계 매핑 시 참조하는 컬럼이 pk 인지 아닌지 확인 해야한다.
2. 참조하는 컬럼이 pk 라면 @JoinColumn 을 그대로 사용해도 되지만, 그렇지 않을 경우 referencedColumnName 에 참조하려는 column 명을 넘겨줘야 한다. 

 

결론만 놓고 보면, @JoinColumn 의 referencedColumnName 을 설정하면 되는 간단한 문제입니다.

맞습니다, 간단한 문제지만 구절구절 풀어쓴 셈이죠. 위 문제를 해결하는 과정에서 JPA 의 연관관계나 어노테이션 등의 지식이 부족함을 느꼈습니다. @JoinColumn 이 디폴트로 참조하는 값이 pk 라는 지식이 머리속에 정리 돼 있었다면, 더 제대로 된 구글링을 통해 문제를 빨리 해결할 수 있지 않았을까 생각이 듭니다. 그럼 다시 JPA 기본을 공부하러 20000 . . .