No serializer found for class - @JsonProperty로 해결

 개발 과정에서 다음과 같은 오류 발생

cohttp://m.fasterxml.jackson.databind.exc.InvalidDefinitionException: No serializer found for class cohttp://m.example.demo.main.domain.Menu and no properties discovered to create BeanSerializer (to avoid exception, disable SerializationFeature.FAIL_ON_EMPTY_BEANS) (through reference chain: java.util.ArrayList[0])

1. 문제 원인

스프링 부트는 기본적으로 JSON 데이터와 Java 객체 간의 변환을 담당하는 라이브러리로 Jackson을 사용하고 있다. Jackson은 Java 객체를 JSON으로 변환(Serialize)하거나 JSON을 Java 객체로 변환(Deserialize)하는 작업을 수행한다.

이 변환 작업을 수행할 때, Jackson은 Java 객체의 필드에 직접 접근하기 보다는 해당 객체의 getter 및 setter 메소드를 이용하는데 만약 Java 객체의 필드가 `private`로 선언되어 있고 해당 필드에 대한 getter나 setter 메소드가 제공되지 않는다면, Jackson은 해당 필드에 접근할 수 없게 된다. 그 결과로, 이 객체를 JSON으로 변환하는 과정에서 문제가 발생하게 된다.

요약하자면, Jackson은 Java 객체의 private 필드에 접근하기 위해 getter와 setter 메소드를 사용하므로, 해당 메소드가 없을 경우 JSON 변환 과정에서 오류가 발생할 수 있다는 것이다.

2. 해결 방법

문제 원인에 따라 Jackson이 Java 객체에 정상적으로 접근할 수 있도록 해주면 된다. 1) ObjectMapper 인스턴스에서 private 필드 접근이 가능하도록 하거나 2)@JsonProperty를 사용하거나 3)@JasonAutoDetect를 사용하면 된다.

이번 오류의 경우 @JsonProperty로 해결했다.

 

3. @JsonProperty의 주요기능

1. 필드 이름 변경 : 객체를 JSON으로 직렬화할 때 사용할 프로퍼티 이름을 지정하거나, JSON을 객체로 역직렬화할 때 사용할 프로퍼티 이름을 지정한다. 이를 통해 Java 필드 이름과 JSON 프로퍼티 이름 사이의 매핑을 변경할 수 있다.

   public class User {
       @JsonProperty("user_name")
       private String username;
   }

위 예제에서, Java 객체를 JSON으로 변환하면 {"user_name":"...value..."} 형태의 JSON이 생성된다.

 

2. 직렬화/역직렬화 시 접근 제어: @JsonProperty를 사용하면 특정 필드가 직렬화 및/또는 역직렬화 되는 것을 제어할 수 있다. 예를 들어, @JsonProperty(access = Access.WRITE_ONLY)는 해당 필드가 직렬화되지 않게 하지만 역직렬화에는 문제가 없게 합니다.
3. 선택적 사용: 필수적으로 직렬화/역직렬화해야 하는 프로퍼티를 명시하기 위해 @JsonProperty(required = true)를 사용할 수 있습니다. 이렇게 설정하면 해당 프로퍼티가 없는 JSON을 역직렬화하려고 하면 오류가 발생한다.
4. 순서 지정: @JsonPropertyOrder 어노테이션과 함께 사용하여 JSON 직렬화 시 프로퍼티의 순서를 지정할 수 있다.