springboot jackson自定義序列化和反序列化實例

Posted on by

jackson自定義序列化和反序列

spingmvc使用httpmessageconverter接口來轉換http請求和響應。

如果需要添加和自定義轉換器，則可以使用spring boot的HttpMessageConverters類；任何存在於上下文中的HttpMessageConverter的ben都會被添加到轉換器列表中。

如果想使用Jackson對json進行序列化和反序列化，則可能需要編寫自己的JsonSerializer和JsonDeserializer類。使用spring boot的@JsonComponent註釋。使用@JsonComponent註釋會自動被註冊到Jackson；

序列化JsonSerializer

首先繼承JsonSerializer，重寫Serialize函數

@JsonComponent   //此註釋會自動將 Serialize和Deserializer註冊到jackson之中。
public class CustomeJackSon {
    public static class Serialize extends JsonSerializer<Date>{
        @Override
        public void serialize(Date date, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
            SimpleDateFormat _format = new SimpleDateFormat("yyyy-mm--dd");
            String _dateStr =  _format.format(date);
            jsonGenerator.writeString(_dateStr);
        }
    } 
}

然後在需要序列化的對象屬性上添加註解@JsonSerialize(using = CustomeJackSon.Serialize.class)

@JsonSerialize(using = CustomeJackSon.Serialize.class)
    private Date date;

最後請求http返回對象

User home(User id){
        applicationArguments.getOptionNames();
        User _user = new User();
        _user.setId(1);
        _user.setName("張三豐");
        _user.setDate(new Date());
        return _user;
        //return new Date();
    }

反序列化JsonDeserializer

首先繼承JsonDeserializer類，重寫deserialize函數，自定義自己的反序列化邏輯

@JsonComponent   //此註釋會自動將 Serialize和Deserializer註冊到jackson之中。
public class CustomeJackSon {
    public static class Deserializer extends JsonDeserializer<Date>{
 
        @Override
        public Date deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
            String _name = jsonParser.getCurrentName();
            long _ss = jsonParser.getLongValue();
            return null;
        }
    }
}

然後在反序列化的屬性上添加@JsonDeserialize註釋

@JsonDeserialize(using = CustomeJackSon.Deserializer.class)
    private Date date;
最後在controller參數要使用@RequestBody
@RequestMapping(value = "getValue")
    public String getValue(@RequestBody User user){
        return  "0000000";
    }

客戶端在請求相應的時候請求的Content-Type需要是application/json

小結一下

需要自定義jackson的序列化和反序列化，在需要繼承JsonSerializer 和JsonDeserializer類並重寫其序列化和反序列化函數；

序列化時需要在要序列化的對象屬性上添加@JsonSerialize註釋；

反序列化時需要controller參數使用@RequestBody註釋，要反序列化的對象屬性上使用@JsonDeserialize註釋，客戶端請求的Content-Type需要是application/json

springboot 自定義序列化器

@SpringBootConfiguration
public class WebConfig extends WebMvcConfigurationSupport {
    /**
     * 自定義序列化器
     */
    @Override
    protected void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        final MappingJackson2HttpMessageConverter jackson2HttpMessageConverter = new MappingJackson2HttpMessageConverter();
        // Long->String
        final ToStringSerializer toStringSerializer = new ToStringSerializer(Long.class);
        // date-> pattern format
        final DateSerializer dateSerializer = new DateSerializer(false, new SimpleDateFormat("yyyy-MM-dd hh:mm:ss"));
        SimpleModule simpleModule = new SimpleModule();
        simpleModule.addSerializer(toStringSerializer);
        simpleModule.addSerializer(dateSerializer);
        jackson2HttpMessageConverter.getObjectMapper().registerModule(simpleModule);
        converters.add(jackson2HttpMessageConverter);
        super.configureMessageConverters(converters);
    }
}

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：