JPA @OneToMany - targetEntity

Objective

💡 JPA의 @OneToMany 연관 관계에서 연관 엔티티가 open class 인 경우 read-only 컬렉션을 사용하지 못하고 Mutable 컬렉션을 사용하도록 하는데, 원인과 read-only 컬렉션을 사용할 수 있는 해결 방안을 공유합니다.

 

Background

build.gradle.kts

allOpen {
	annotation("javax.persistence.Entity")
	annotation("javax.persistence.MappedSuperclass")
	annotation("javax.persistence.Embeddable")
}

OrderEntity.kt

OrderProductEntity.kt

Error Message

• One To Many 속성 값의 데이터는 ‘? extends OrderProductEntity’ 가 될 수 없다.

Collection has neither generic type or OneToMany.targetEntity() defined: 
moonee.order.storage.db.core.entity.OrderEntity.orderProductList

• 컬렉션은 제네릭 타입을 가질 수 없거나, OneToMany의 targetEntity를 정의해야 한다.

 

원인

public interface List<out E> : Collection<E>

• List는 공변성을 가진다.
  • 공변적이다 ?
    • 하위 타입 관계가 유지된다.
    • A가 B의 하위 타입일 때, List<A>가 List<B>의 하위타입이다.
    • A가 B의 하위 타입일 때, List<A> 타입의 값이 들어갈 자리에 List<B> 타입의 값을 사용할 수 있다.
  • 코틀린의 클래스는 기본적으로 final이나, allOpen 설정을 통해 @Entity 클래스는 상속 가능한 클래스이다.
    • orderProductList의 타입을 List<OrderProductEntity> 로 하게 되면, List<OrderProductEntity> 타입이 들어올 수도, OrderProductEntity 를 상속한 List<? extends OrderProductEntity 타입이 들어올 수도 있다.
• Hibernate는 Collection 타입에 대해 Generic 타입을 허용하지 않는다.
  • 런타임에서 타입이 동적으로 바뀔 수 있는 것을 지원하지 않는다.
  • 뭔가 관련된 것 같은 문서를 발견했는데 정확한 해석이 어렵습니다. (참고)

 

Solution

Solution 1. MutableList를 사용한다 ?

• Intellij 에서는 이 경우, MutableList를 사용하라고 권고한다.
• 왜 MutableList는 될까?
  • 왜냐하면…. MutableList는 무공변이다. out 키워드가 없음.

⇒ 하지만 orderProductList는 변경되지 않는 데이터이기 때문에 MutableList로 사용하고 싶지 않다. (탈락)

Solution 2. Entity를 상속 불가능하게 한다 ?

• OrderProductEntity가 open class 이기 때문에, List 를 사용하면 정확히 어떤 타입이 들어올지 알 수 없으니 발생하는 오류라고 판단해서 allOpen 설정을 지워봤다.
• …. 그러니까 해결은 됐다.
• 하지만, 몇 주 전 케브님의 JPA 지연로딩 뽀개기 에서 들었듯이, @~ToOne 관계에서 지연로딩을 할 때 JPA는 해당 클래스를 상속하여 프록시를 만드는 방식으로 지연 로딩을 한다고 했다.

⇒ 그래서 allOpen을 지우는 건 좋은 해결책은 아니다.

Solution 3. val 을 사용한다.

@OneToMany(cascade = [CascadeType.ALL], fetch = FetchType.LAZY, mappedBy = "order")
val orderProductList: List<OrderProductEntity>

• var 대신 val 를 사용하면 생성할 때 초기화되고 바뀌지 않기 때문에 List 를 사용할 수 있는 것 같았다.

⇒ 하지만 OrderProductEntity 는 order 또는 orderId 를 가지고 있기 때문에, OrderEntity를 생성하면서 동시에 OrderProductEntity를 생성할 수 없기 때문에 val 를 사용하기 어렵다.

Solution 4. targetEntity 속성을 이용한다.

번역 / (선택 사항) 연결 대상인 엔터티 클래스입니다. 컬렉션 속성이 Java 제네릭을 사용하여 정의된 경우에만 선택 사항입니다. 달리 지정해야 합니다. 제네릭을 사용하여 정의된 경우 컬렉션의 매개 변수화된 유형이 기본값입니다.

• 그렇다고 합니다. 사용하니까 해결되었습니다.
• 아마 JPA 에게 OrderProductEntity 또는 ? extends OrderProductEntity 타입들 중 어떤 타입을 사용할지 정확하게 알려주는 것이니 해결이 되었다고 이해했습니다.

 

결론

• targetEntity 속성을 이용하자
• Hibernate의 implicit Polymorphism 에 대해 조금 공부해보고 싶은데 어렵다. (같이 보실 분 모집합니다)
  • https://docs.jboss.org/hibernate/core/3.3/reference/en/html/inheritance.html#inheritance-tableperconcreate-polymorphism