Spring에 Jackson Custom Serialization 적용

스프링부트는 기본적으로 Jackson라이브러리를 통해 자바 기본 컬렉션 객체들을 Json으로 Serialize를 진행해준다.

하지만, 기존 레거시 코드에 있던 사용자 정의객체를 json형태로 반환할 일이 생기면서 에러가 발생했다.

사용자 정의객체를 어떻게 Serialize해야할지 정의되어 있지 않아서 생기는 문제였다.

 

이를 해결하기 위해 serializtion을 커스터마이징해서 objectMapper에 추가하고 이를 스프링에서 사용할 수 있게 빈 등록해주는 과정을 진행했다.

 

아래 코드는 HashMap을 상속받은 사용자정의 DataSet객체를 직렬화하는 과정이다.

writeObject()를 통해 재귀적으로 관련된 직렬화를 진행하여 json 문자열을 만들어 반환하게 된다.

public class DataSetSerializer extends JsonSerializer<DateSet> {

    @Override
    public void serialize(DateSet dataSet, JsonGenerator gen, SerializerProvider serializers) throws IOException, JsonProcessingException {
        gen.writeStartObject();
		
        for (Object o : dataSet.keySet()) {
        	String fieldName = String.valueOf(o);
            	gen.writeFieldName(fieldName);
            	gen.writeObject(dataSet.get(fieldName)); // 재귀적으로 Serializer 호출
        }

	gen.writeEndObject();
    }
}

  

이렇게 만든 Serializer는 아래 코드 처럼 module에 추가한 후 ObjectMapper에 등록해줘야만 한다.

@Configuration
public class ObjectMapperConfig {

    @Bean
    public ObjectMapper objectMapper() {
        ObjectMapper mapper = new ObjectMapper();
        SimpleModule simpleModule = new SimpleModule();
        simpleModule.addSerializer(DataSet.class, new DataSetSerializer());
        mapper.registerModule(javaTimeModule);
        return mapper;
    }
}

 

이렇게 하면 추가된 Serializer의 ObjectMapper가 빈에 등록되어 DataSet객체를 반환시에도 정상적으로 직렬화가 진행된다.