[Spring] Kotlin에서 data class의 필드가 1개일 때 역직렬화가 안 되는 문제 (no delegate- or property-based Creator)

🌱 문제 상황

간단하게 테스트하고 싶은 내용이 생겨서 DTO용 data class를 생성하였는데, 아래와 같이 Jackson의 역직렬화 관련 오류가 발생하였다.

Resolved [org.springframework.http.converter.HttpMessageNotReadableException: JSON parse error: Cannot construct instance of `study.ticketService.domain.application.dto.ConcertTicketCreateRequest` (although at least one Creator exists): cannot deserialize from Object value (no delegate- or property-based Creator)]

대충 오류를 보면 역직렬화를 해야 하는데 기본 생성자가 없어서 할 수 없다는 내용이다.

 

data class ConcertTicketCreateRequest(
    @NotNull(message = "사용자 아이디는 비어있을 수 없습니다.")
    val userId: Long
)

 

문제가 된 data class는 위와 같다. 

 

Jackson fails to deserialize 1 field POJO · Issue #3085 · FasterXML/jackson-databind

이 깃허브 이슈에 가면 친절하게 그 이유를 설명해준다.

필드가 1개인 경우 기본 생성자를 만드는 전략이 Delegating / Properties-based로 나뉘는데, 두 모드 중에서 어떤 것을 선택해야 할지 알 수 없어서 발생한 오류인 것이다.

위 이슈에서는 @JsonCreator 어노테이션을 통해서 명시적으로 모드를 지정해주는 방법을 소개하는데, data class에서 어떻게 기본 생성자를 만들 수 있을까?

 

---

 

🌱 해결 방법

결론부터 말하자면, 기본값을 명시적으로 지정하거나, 부생성자를 활용하거나, @JsonProperty를 사용하면 된다.

 

💬 기본 값 지정하기

data class ConcertTicketCreateRequest(
    @NotNull(message = "사용자 아이디는 비어있을 수 없습니다.")
    val userId: Long = 0L
)

주생성자 자체에 기본 값을 지정해준다. id 값은 항상 빈 값이 들어오지 않기 때문에 어차피 대체될 값이라서 상관없다.

 

 

💬 부생성자 사용하기

data class ConcertTicketCreateRequest(
    @NotNull(message = "사용자 아이디는 비어있을 수 없습니다.")
    val userId: Long
) {
    constructor() : this(0)
}

혹은, 부생성자를 활용해서 내부적으로 기본값을 초기화해준 생성자를 만들어줄 수 있다.

 

 

💬 @JsonProperty 활용하기

data class ConcertTicketCreateRequest(
    @JsonProperty("userId")
    @NotNull(message = "사용자 아이디는 비어있을 수 없습니다.")
    val userId: Long
)

하지만, 기본값을 지정하거나 기본 생성자를 만들어둔다는 게 상당히 찝찝한 일처럼 느껴질 수 있다.

이때는 @JsonProperty를 통해서 명시적으로 json 값의 key와 해당 객체의 필드를 매칭시켜줄 수 있다.

해당 어노테이션에 대해서 좀 더 알고 싶다면 이 글을 참고해 주세요! 😎

 

 

개인적으로는 1번 방법이 가장 깔끔해서 그냥 기본값을 지정해주는 걸로 만들었다.

오류 없이 잘 들어가는 것을 볼 수 있다.