SpringBootでカスタムシリアル化を行う方法は何ですか？

2年 ago
綾乃, 一希
1 minute

Spring Bootでカスタムシリアライゼーションを行う方法は、org.springframework.core.serializer.Serializerインタフェースまたはorg.springframework.core.serializer.SmartSerializerインタフェースを実装することです。

  1. Serializerインターフェースを実装する場合は、serialize(Object object, OutputStream outputStream)メソッドを実装する必要があります。このメソッドはオブジェクトをバイト配列にシリアル化し、出力ストリームに書き込む役割を担います。
  2. SmartSerializerインターフェースを実装する場合、serializeメソッドだけでなく、boolean canSerialize(Class<?> clazz, MediaType mediaType)メソッドも実装する必要があります。このメソッドは、指定されたクラスをシリアライズできるかどうかを判断するために使用されます。

カスタムシリアライゼーションメソッドを作成した後に、Spring Bootの設定クラスで@Beanアノテーションを使用してカスタムシリアライザをSpringコンテナに注入し、そのシリアライザを使用するために設定ファイルで構成します。

例えば、Jacksonライブラリを使用してJSONシリアライズをカスタマイズする例を以下に示す：

import org.springframework.core.serializer.Serializer;
import com.fasterxml.jackson.databind.ObjectMapper;

public class JacksonJsonSerializer implements Serializer<Object> {

    private final ObjectMapper objectMapper;

    public JacksonJsonSerializer() {
        this.objectMapper = new ObjectMapper();
    }

    @Override
    public void serialize(Object object, OutputStream outputStream) throws IOException {
        objectMapper.writeValue(outputStream, object);
    }
}

その後、Spring Bootの設定クラスにそのシリアライザをSpringコンテナに注入します。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;

@Configuration
public class MyConfig {

    @Bean
    public JacksonJsonSerializer jacksonJsonSerializer() {
        return new JacksonJsonSerializer();
    }

    @Bean
    public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter(JacksonJsonSerializer serializer) {
        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        converter.setObjectMapper(serializer.objectMapper);
        return converter;
    }
}

最後に、設定ファイルでカスタムのシリアライザを設定してください。

spring.http.converters.preferred-json-mapper=jacksonJsonSerializer
bannerAds