SpringBoot之Json的序列化和反序列化问题怎么解决

这篇文章主要讲解了“SpringBoot之Json的序列化和反序列化问题怎么解决”，文中的讲解内容简单清晰，易于学习与理解，下面请大家跟着小编的思路慢慢深入，一起来研究和学习“SpringBoot之Json的序列化和反序列化问题怎么解决”吧！

控制json序列化/反序列化

1. @JsonIgnoreProperties的用法

@JsonIgnoreProperties(value = { "prop1","prop2" })

用来修饰Pojo类, 在序列化和反序列化的时候忽略指定的属性, 可以忽略一个或多个属性.

@JsonIgnoreProperties(ignoreUnknown = true)

用来修饰Pojo类, 在反序列化的时候忽略那些无法被设置的属性, 包括无法在构造子设置和没有对应的setter方法.

2. @JsonProperty 注解

如果 json field 的名称和Pojo 的属性名不一致的时, 可以用 @JsonProperty 来注解 getter() 或 setter() 方法, 该注解设定json 对应的属性名, 另外@JsonProperty也经常用来注解构造子的形参, 这时候构造子应该加@JsonCreator 注解.

3. @JsonCreator 注解

如果 Pojo 类定义有参数的构造子, 但没有提供无参构造子时, 在反序列化时是会报错. 有下面两个办法:

• 方法1：增加一个无参构造子

• 方法2：为这个有参数的构造子, 加上 @JsonCreator 注解, 同时参数需要加上 @JsonProperty 注解.

4. @JsonSetter 和 @JsonGetter 注解

如果 json field 的名称和Pojo 的属性名不一致的时, 可以使用@JsonGetter来注解 getter(), 使用 @JsonSetter 来注解setter() 方法. 这两个注解都可以指定一个属性名. 这两个注解都可以用 @JsonProperty 替换.

5. @JsonAnySetter 注解

一般对象属性名都是确定的, 比如 Car 这个对象, 有 brand/price 等具名属性, 但有时候我们还需要为Car这个对象设定一些扩展属性, 这些扩展属性名称暂时不好确定, 通常使用 Map<String, String> 来存放这些扩展属性的K/V. 要把json 数据中的这些属性反序列化到类的Map中, 需要在类上增加一个K/V的setter方法, 而且这个setter方法要加上@JsonAnySetter注解.

public class Car {    public String brand;    private Map<String, String> properties;     @JsonAnySetter    public void add(String key, String value) {        properties.put(key, value);    }}

一旦类加上了@JsonAnySetter后可将下面的 json 数据反序列化到Map中:

{"brand":"Benz","attr2":"val2","attr1":"val1"}

6. @JsonAnyGetter 注解

和@JsonAnySetter 注解相对应, 如果要将类中的Map K/V属性序列化到json中, 需要在类上增加一个 @JsonAnyGetter 方法, 该方法直接返回KV map就行.

public class Car {    public String brand;    private Map<String, String> properties;     @JsonAnyGetter    public Map<String, String> getProperties() {        return properties;    }}

序列化后的json为:

{"brand":"Benz","attr2":"val2","attr1":"val1"}

7. @JsonFormat 注解

通常明确Date/Time 属性序列化用的时间格式.

public class Event {    public String name;     @JsonFormat(      shape = JsonFormat.Shape.STRING, pattern = "dd-MM-yyyy hh:mm:ss")    public Date eventDate;}

8.@JsonSerialize 和 @JsonDeserialize 注解

@JsonSerialize注解可以为类属性设定专门的序列化函数, @JsonDeserialize注解用来为json属性定制化反序列化函数

SpringBoot序列化规则

• Include.Include.ALWAYS 默认

• Include.NON_DEFAULT 属性为默认值不序列化

• Include.NON_EMPTY 属性为 空（“”） 或者为 NULL 都不序列化

• Include.NON_NULL 属性为NULL 不序列化

1.全局设置

@Configurationpublic class JacksonConfig{    @Bean    @Primary    @ConditionalOnMissingBean(ObjectMapper.class)    public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder)    {        ObjectMapper objectMapper = builder.createXmlMapper(false).build();        // 通过该方法对mapper对象进行设置，所有序列化的对象都将按改规则进行系列化        // Include.Include.ALWAYS 默认        // Include.NON_DEFAULT 属性为默认值不序列化        // Include.NON_EMPTY 属性为 空（""） 或者为 NULL 都不序列化，则返回的json是没有这个字段的。这样对移动端会更省流量        // Include.NON_NULL 属性为NULL 不序列化,就是为null的字段不参加序列化        //objectMapper.setSerializationInclusion(Include.NON_EMPTY);        objectMapper.setSerializationInclusion(JsonInclude.Include.NON_EMPTY);        return objectMapper;    }}

或者

spring.jackson.default-property-inclusion=non_nullspring:  jackson:    default-property-inclusion: non_null

2.局部设置

在需要设置的实体类或者字段上加上注解

@JsonInclude(Include.NON_NULL)

3.自定义局部序列化

（1）、自定义一个序列化工具类，需要实现StdSerializer<T>或者JsonSerializer<T>

public class ClientObjectSerialize extends JsonSerializer<CreditBorrowerRepaymentRequestDto>{ @Override public void serialize(CreditBorrowerRepaymentRequestDto dto, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException, JsonProcessingException {   jsonGenerator.writeStartObject();  try {   Field[] fields = dto.getClass().getDeclaredFields();   for (Field field : fields) {    field.setAccessible(true);    if(null == field.get(dto)){     continue;     }    jsonGenerator.writeFieldName(field.getName());    jsonGenerator.writeObject(field.get(dto));   }  } catch (Exception e) {   e.printStackTrace();  }  jsonGenerator.writeEndObject(); }}

（2）使用注解作用在实体类上

@JsonSerialize(using = ClientObjectSerialize.class)public class CreditBorrowerRepaymentRequestDto{}

（3）可以作用在实体对象字段上，对NULL值的处理，或者转换

@JsonSerialize(using = ClientStringSerialize.class)private String name; @JsonSerialize(using = ClientDtaeSerialize.class)private Date date;public class ClientStringSerialize extends JsonSerializer<String> {  @Override public void serialize(String string, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {   if(string == null){   jsonGenerator.writeString(string + "[NULL]");  }else{   jsonGenerator.writeString(string);  } }} public class ClientDtaeSerialize extends JsonSerializer<Date> { @Override public void serialize(Date createDate, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {  jsonGenerator.writeString(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(createDate)); }}

4.自定义全局 null 转换 序列化

SpringBoot返回Json数据中null值处理，将字符串类型null值转换为""，将集合数组类型null值转换为[]，将原始数据类型null值转换为0，将布尔类型null值转换为false，将实体对象null值转换为{}。

（1）自定义null值序列化处理器

import com.fasterxml.jackson.core.JsonGenerator;import com.fasterxml.jackson.databind.JsonSerializer;import com.fasterxml.jackson.databind.SerializerProvider;import java.io.IOException;public class CustomizeNullJsonSerializer {   public static class NullArrayJsonSerializer extends JsonSerializer<Object> {  @Override  public void serialize(Object value, JsonGenerator jsonGenerator,     SerializerProvider serializerProvider) throws IOException {   jsonGenerator.writeStartArray();   jsonGenerator.writeEndArray();  } }   public static class NullStringJsonSerializer extends JsonSerializer<Object> {  @Override  public void serialize(Object value, JsonGenerator jsonGenerator,     SerializerProvider serializerProvider) throws IOException {   jsonGenerator.writeString("");  } }   public static class NullNumberJsonSerializer extends JsonSerializer<Object> {  @Override  public void serialize(Object value, JsonGenerator jsonGenerator,         SerializerProvider serializerProvider) throws IOException {   jsonGenerator.writeNumber(0);  } }   public static class NullBooleanJsonSerializer extends JsonSerializer<Object> {  @Override  public void serialize(Object value, JsonGenerator jsonGenerator,         SerializerProvider serializerProvider) throws IOException {   jsonGenerator.writeBoolean(false);  } }   public static class NullObjectJsonSerializer extends JsonSerializer<Object> {  @Override  public void serialize(Object value, JsonGenerator jsonGenerator,         SerializerProvider serializerProvider) throws IOException {   jsonGenerator.writeStartObject();   jsonGenerator.writeEndObject();  } }}

（2）序列化程序修改器

import com.fasterxml.jackson.databind.BeanDescription;import com.fasterxml.jackson.databind.SerializationConfig;import com.fasterxml.jackson.databind.ser.BeanPropertyWriter;import com.fasterxml.jackson.databind.ser.BeanSerializerModifier;import java.util.Collection;import java.util.List; public class MyBeanSerializerModifier extends BeanSerializerModifier {  @Override public List<BeanPropertyWriter> changeProperties(SerializationConfig config,               BeanDescription beanDesc,              List<BeanPropertyWriter> beanProperties) {  // 循环所有的beanPropertyWriter  for (int i = 0; i < beanProperties.size(); i++) {   BeanPropertyWriter writer = beanProperties.get(i);   // 判断字段的类型，如果是数组或集合则注册nullSerializer   if (isArrayType(writer)) {    // 给writer注册一个自己的nullSerializer     writer.assignNullSerializer(new CustomizeNullJsonSerializer.NullArrayJsonSerializer());   }   if (isStringType(writer)) {    writer.assignNullSerializer(new CustomizeNullJsonSerializer.NullStringJsonSerializer());   }  }  return beanProperties; }   private boolean isArrayType(BeanPropertyWriter writer) {  Class<?> clazz = writer.getType().getRawClass();  return clazz.isArray() || Collection.class.isAssignableFrom(clazz); }   private boolean isStringType(BeanPropertyWriter writer) {  Class<?> clazz = writer.getType().getRawClass();  return CharSequence.class.isAssignableFrom(clazz) || Character.class.isAssignableFrom(clazz); }   private boolean isNumberType(BeanPropertyWriter writer) {  Class<?> clazz = writer.getType().getRawClass();  return Number.class.isAssignableFrom(clazz); }   private boolean isBooleanType(BeanPropertyWriter writer) {  Class<?> clazz = writer.getType().getRawClass();  return clazz.equals(Boolean.class); }}

（3）配置Jackson实体

import com.fasterxml.jackson.databind.ObjectMapper;import com.fasterxml.jackson.databind.SerializerProvider;import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.context.annotation.Primary;import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder; @Configurationpublic class JacksonConfig { @Bean @Primary @ConditionalOnMissingBean(ObjectMapper.class) public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {  ObjectMapper objectMapper = builder.createXmlMapper(false).build();    objectMapper.setSerializerFactory(objectMapper.getSerializerFactory()    .withSerializerModifier(new MyBeanSerializerModifier()));   SerializerProvider serializerProvider = objectMapper.getSerializerProvider();  serializerProvider.setNullValueSerializer(new CustomizeNullJsonSerializer .NullObjectJsonSerializer());  return objectMapper; }}

感谢各位的阅读，以上就是“SpringBoot之Json的序列化和反序列化问题怎么解决”的内容了，经过本文的学习后，相信大家对SpringBoot之Json的序列化和反序列化问题怎么解决这一问题有了更深刻的体会，具体使用情况还需要大家实践验证。这里是编程网，小编将为大家推送更多相关知识点的文章，欢迎关注！