SpringBoot系列: Json的序列化和反序列化

/ Java / 没有评论 / 1712浏览

SpringBoot

一. @JsonIgnoreProperties的用法

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

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

@JsonIgnoreProperties(ignoreUnknown = true)

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

二. @JsonProperty 注解

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

三. @JsonCreator 注解

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

  1. 增加一个无参构造子
  2. 为这个有参数的构造子, 加上 @JsonCreator 注解, 同时参数需要加上 @JsonProperty 注解.

四. @JsonSetter 和 @JsonGetter 注解

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

五. @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"
}

六. @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"
}

七. @JsonFormat 注解

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

public class Event {
    public String name;

    @JsonFormat(
        shape = JsonFormat.Shape.STRING, pattern = "dd-MM-yyyy hh🇲🇲ss")
    public Date eventDate;
}

八. @JsonSerialize 和 @JsonDeserialize 注解

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

参考

https://www.baeldung.com/jackson https://www.baeldung.com/jackson-annotations

本文由 创作，采用 知识共享署名4.0 国际许可协议进行许可。本站文章除注明转载/出处外，均为本站原创或翻译，转载前请务必署名。最后编辑时间为: 2020/05/17 02:44

→ ← ↓ ↑