ObjectMapper readValue 다형성 적용하기 (+ Jackson2JsonRedisSerializer)

😵 배경

ObjectMapper의 readValue(InputStream in, Class<T> valueType)를 사용하기 위해서는 Class<T>가 필요하다. 일반적인 경우 구체적인 POJO 클래스 타입을 명시해서 사용하면 된다.

 

하지만 Bean으로 등록한 RestTeamplte에 Jackson2JsonRedisSerializer<T>를 추가하는 것처럼 클래스 타입을 초기 설정한 이후 변경이 어려운 경우, 인터페이스 또는 추상 클래스를 활용한 다형성이 필요할 수 있다.

 

이런 경우 일반적인 상속 방식으로는 적용되지 않으며 별도의 설정이 필요하다. 해당 방법에 대해서 알아보자.

1. 하나의 구현체만 있는 경우

오직 하나의 구현체만 있는 경우, @JsonDeserialze 어노테이션을 통해서 Jackson에게 역직렬화 방법에 대해서 알려주면 해결이 가능하다.

 

public class JacksonTest {

    @Test
    void jacksonTest() throws IOException {

        ObjectMapper objectMapper = new ObjectMapper();
        ShibaHolic blackShiba = new BlackShiba("흑시바");
        byte[] serializedBlackShiba = objectMapper.writeValueAsBytes(blackShiba);

        ShibaHolic shibaHolic = objectMapper.readValue(serializedBlackShiba, ShibaHolic.class);
        System.out.println(shibaHolic);
    }

    @JsonDeserialize(as = BlackShiba.class)
    public interface ShibaHolic {}
    
    @NoArgsConstructor
    @AllArgsConstructor
    @Getter
    @ToString
    public static class BlackShiba implements ShibaHolic {

        private String name;
    }
}

2. 둘 이상의 구현체가 있는 경우

구현체가 둘 이상 있는 경우는 조금 복잡해질 수 있다. Jackson에게 사용할 구현체를 구분할 수 있는 방법을 제공해야 한다. 

 

public class JacksonTest {

    @Test
    void jacksonTest() throws IOException {

        ObjectMapper objectMapper = new ObjectMapper();
        ShibaHolic blackShiba = new BlackShiba("흑시바");
        byte[] serializedBlackShiba = objectMapper.writeValueAsBytes(blackShiba);

        ShibaHolic deserializedBlackShiba = objectMapper.readValue(serializedBlackShiba, ShibaHolic.class);
        System.out.println(deserializedBlackShiba);

        String jsonBlackShiba = objectMapper.writeValueAsString(deserializedBlackShiba);
        System.out.println(jsonBlackShiba);

        ShibaHolic whiteShiba = new WhiteShiba("백시바");
        byte[] serializedWhiteShiba = objectMapper.writeValueAsBytes(whiteShiba);

        ShibaHolic deserializedWhiteShiba = objectMapper.readValue(serializedWhiteShiba, ShibaHolic.class);
        System.out.println(deserializedWhiteShiba);

        String jsonWhiteShiba = objectMapper.writeValueAsString(deserializedWhiteShiba);
        System.out.println(jsonWhiteShiba);
        
    }

    @JsonTypeInfo(
            use = JsonTypeInfo.Id.NAME,
            include = JsonTypeInfo.As.PROPERTY,
            property = "type"
    )
    @JsonSubTypes({
            @JsonSubTypes.Type(value = BlackShiba.class, name = "black"),
            @JsonSubTypes.Type(value = WhiteShiba.class, name = "white")
    })
    public interface ShibaHolic {}

    @NoArgsConstructor
    @AllArgsConstructor
    @ToString
    @Getter
    public static class BlackShiba implements ShibaHolic {

        private String name;
    }

    @NoArgsConstructor
    @AllArgsConstructor
    @ToString
    @Getter
    public static class WhiteShiba implements ShibaHolic {

        private String name;
    }
}

 

구현 방법은 상당히 단순하다. 여러 구현체를 사용하기 위해 단지 @JsonTypeInfo, @JsonSubTypes.Type 어노테이션을 선언해서 Jackson이 type이라는 속성을 읽고 올바른 구현체를 선택할 수 있도록 알려주기만 하면 된다.

 

테스트를 실행할 경우 출력되는 결과

하지만 해당 방식은 결국 API에 type 속성을 노출한다는 단점이 있다. type 속성은 Jackson에서만 사용되기 때문에 API에 포함하는 것이 과연 올바른지에 대해 판단하는 것은 구현자의 몫이다.