Java에서 @JsonDeserialize 어노테이션으로 커스텀 Deserializer 구현하는 방법

@JsonDeserialize 어노테이션은 JSON 문자열을 Java 객체로 역직렬화(deserialization)할 때 커스텀 역직렬화기(Custom Deserializer)를 지정하는 데 사용됩니다. Jackson 라이브러리의 기본 동작만으로는 원하는 형태로 데이터를 변환할 수 없는 경우에 특히 유용합니다.

커스텀 역직렬화기를 구현하려면 제네릭 타입으로 Employee 클래스를 받는 StdDeserializer 클래스를 상속한 뒤, 해당 클래스의 deserialize() 메서드를 오버라이드(override)하면 됩니다.

문법(Syntax)

@Target(value={ANNOTATION_TYPE,METHOD,FIELD,TYPE,PARAMETER})
@Retention(value=RUNTIME)
public @interface JsonDeserialize

구현 예제

다음 프로그램은 @JsonDeserialize 어노테이션을 사용하여 커스텀 역직렬화기를 구현하는 전체 과정을 보여줍니다.

CustomDeserializer 클래스 — StdDeserializer<Employee>를 상속하고 deserialize() 메서드를 오버라이드하여 JSON 토큰을 하나씩 읽어 Employee 객체를 직접 생성합니다.
Employee 클래스 — 클래스 선언부에 @JsonDeserialize(using=CustomDeserializer.class)를 붙여 이 클래스가 역직렬화될 때 항상 커스텀 역직렬화기가 사용되도록 지정합니다.

import java.io.*;
import com.fasterxml.jackson.core.*;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.annotation.*;
import com.fasterxml.jackson.databind.deser.std.*;

public class JsonDeSerializeAnnotationTest {
   public static void main(String[] args) throws JsonProcessingException, IOException {
      // 객체를 JSON 문자열로 직렬화한 후 다시 역직렬화
      Employee emp = new Employee(115, "Adithya");
      ObjectMapper mapper = new ObjectMapper();
      String jsonString = mapper.writeValueAsString(emp);
      emp = mapper.readValue(jsonString, Employee.class);
      System.out.println(emp);
   }
}

// 커스텀 역직렬화기 클래스
class CustomDeserializer extends StdDeserializer<Employee> {
   public CustomDeserializer(Class<Employee> t) {
      super(t);
   }
   public CustomDeserializer() {
      this(Employee.class);
   }
   @Override
   public Employee deserialize(JsonParser jp, DeserializationContext dc)
         throws IOException, JsonProcessingException {
      int id = 0;
      String name = null;
      JsonToken currentToken = null;
      // JSON 토큰을 순회하며 필드 값을 추출
      while ((currentToken = jp.nextValue()) != null) {
         switch (currentToken) {
            case VALUE_NUMBER_INT:
               if (jp.getCurrentName().equals("id")) {
                  id = jp.getIntValue();
               }
               break;
            case VALUE_STRING:
               switch (jp.getCurrentName()) {
                  case "name":
                     name = jp.getText();
                     break;
                  default:
                     break;
               }
               break;
            default:
               break;
         }
      }
      return new Employee(id, name);
   }
}

// Employee 클래스
@JsonDeserialize(using = CustomDeserializer.class)
class Employee {
   private int id;
   private String name;

   public Employee(int id, String name) {
      this.id = id;
      this.name = name;
   }

   public int getId() {
      return id;
   }

   public String getName() {
      return name;
   }

   @Override
   public String toString() {
      StringBuilder sb = new StringBuilder("ID: ")
            .append(this.id).append("\nName: ").append(this.name);
      return sb.toString();
   }
}

실행 결과(Output)

ID: 115
Name: Adithya

핵심 포인트 정리

@JsonDeserialize(using = ...) 속성을 통해 특정 클래스에 적용할 커스텀 역직렬화기를 지정할 수 있습니다.
StdDeserializer<T>를 상속하면 Jackson의 표준 역직렬화 인프라를 그대로 활용하면서 필요한 부분만 재정의할 수 있습니다.
JsonParser의 nextValue() 메서드로 JSON 토큰을 순차적으로 읽고, JsonToken 타입에 따라 분기 처리하여 원하는 로직을 수행합니다.
날짜 형식 변환, API 응답 구조가 복잡한 경우, 기본 규칙으로 매핑할 수 없는 데이터 등을 처리할 때 커스텀 역직렬화기가 매우 유용합니다.