JPA 연관 관계가 있는 엔티티 생성 패턴

Objective

💡 JPA 연관 관계가 있는 엔티티를 생성하기 위해서는 연관 엔티티를 var nullable 타입으로 선언하여 생성해야 합니다. 하지만 데이터로 보았을 때 해당 엔티티는 var 타입도 nullable 타입도 아니길 원하는 경우 val non-nullable 타입으로 설정하고 JPA 엔티티를 생성하는 패턴에 대해 공유합니다.

 

Background

OrderEntity.kt

OrderProductEntity.kt

OrderService.kt

@Service
class OrderService(
	private val orderRepository : OrderRepository
) {
	fun saveOrder(param : OrderCreateParam) {
		val order = OrderEntity(
				orderId = param.orderId
		)
		val orderProductList = param.orderProductList.map {
				OrderProductEntity(
						order = order
				)
		}
		order.orderProductList = orderProductList

		orderRepository.save(order)
	}
}

• OrderEntity 를 먼저 생성하고, 먼저 생성한 Order와 함께 OrderProductEntity를 생성하여 orderProductList를 set 해야 한다.
• 번거로운 것은 둘째치고, orderProductList의 타입이 var이라서 언제 어디서 바뀔 수 있다는 단점이 있다.

⇒ 그래서 저는 orderProductList를 val로 사용하고 싶었습니다..

 

 

알고 있는 데이터들만 가지고 생성자를 호출하고, init 에서 처리하자

CreateOrderParam.kt

data class CreateOrderParam(
    val userId: Long,
    val orderProductList: List<CreateOrderProductParam>
)

data class CreateOrderProductParam(
    val productId:  Long
)

• 생성자 파라미터로 넘길 클래스입니다. 이 클래스만 가지고 Service 코드에서 OrderEntity를 생성할 것입니다.

OrderService.kt

@Service
class OrderService(
	private val orderRepository : OrderRepository
) {
	fun saveOrder(param : CreateOrderParam) {
		val order = OrderEntity(param)
		orderRepository.save(order)
	}
}

• 서비스 코드는 이렇게 될 것입니다.

OrderEntity.kt

@Entity
@Table(name = "ORDER")
class OrderEntity(createOrderParam: CreateOrderParam) {
    @Id
    @Column(name = "ORDER_ID")
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    val orderId: Long? = null

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

    @Column(name = "USER_ID")
    val userId: Long

    init {
        this.userId = createOrderParam.userId
        this.orderProductList = createOrderParam.orderProductList.map {
            OrderProductEntity(
                createOrderProductParam = it,
                order = this
            )
        }
    }
}

• OrderEntity 의 init 에서 프로퍼티를 초기화하고, OrderProductEntity를 생성할 때 order로는 this 키워드를 통해 OrderEntity를 넘깁니다.

OrderProductEntity.kt

@Entity
@Table(name = "ORDER_PRODUCT")
class OrderProductEntity(
    createOrderProductParam: CreateOrderProductParam,
    order: OrderEntity,
) {
    @Id
    @Column(name = "ORDER_PRODUCT_ID")
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    val orderProductId: Long? = null

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "ORDER_ID", referencedColumnName = "ORDER_ID")
    val order: OrderEntity

    @Column(name = "PRODUCT_ID")
    val productId: Long

    init {
        this.order = order
        this.productId = createOrderProductParam.productId
    }
}

• OrderProductEntity 에서는 생성자에서 받은 OrderEntity로 order를 초기화해줍니다.

 

코틀린의 init

• 생성자를 통해 인스턴스가 만들어질 때 호출되는 함수입니다.
• 인스턴스가 만들어질 때, init 내부의 코드를 통해 프로퍼티를 초기화할 수 있습니다.
• 여기서 발생할 수 있는 문제가 있는데요…

• init 내부에서 초기화하는 프로퍼티를 final 로 설정하라는 문구가 뜹니다.
  • 참고 링크
  • 이 경우 Derived 에서는 NPE 가 발생할 수 있습니다.
  • Base의 init 코드를 수행 시 size 프로퍼티를 사용하는데, Derived의 size는 items.size 로 초기화하고 있습니다. 하지만 이 때, items는 초기화가 되지 않은 시점이니 NPE가 발생합니다.⇒ 따라서, open class의 init 내부에서 접근하는 어떤 프로퍼티는 하위 클래스에 의해 조작되어 예외가 발생할 수 있는 상황들이 있어 final 프로퍼티로 사용하는 것이 좋습니다.

open class Base {
    open val size: Int = 0
    init { 
				println("size = $size") 
		}
}

class Derived : Base() {
    val items = mutableListOf(1, 2, 3)
    override val size: Int get() = items.size
}

 

기본 생성자에 컬럼에 대응하는 프로퍼티들이 없어도 될까?

• Hibernate는 클래스의 인스턴스를 생성할 때 reflection 기법을 사용하여 객체를 초기화 한다.
• 필드와 컬럼을 매핑하는 @Column 어노테이션을 통해 매핑할 수 있기 때문에 기본 생성자에 꼭 컬럼에 대응하는 필드들이 있어야 하는 것이 아닙니다.

 

결론

• 연관 관계가 있는 엔티티를 생성할 때 연관 엔티티를 꼭 var nullable type으로 설정하지 않아도 생성할 수 있는 패턴을 적용해보았다.
• 호불호가 갈릴 수 있기 때문에 팀원들의 의견이 궁금합니다.
• 혹시 발생할 수 있는 문제는 없을지도 이야기 해주시면 감사하겠습니다.