springboot jackson自定义序列化和反序列化实例

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);
    }
}

频道导航