@JsonAnyGetter和@JsonAnySetter

@JsonAnyGetter和@JsonAnySetter

起男 89 2025-02-11

@JsonAnyGetter和@JsonAnySetter

@JsonAnyGetter和@JsonAnySetter是jackson的序列化注解

  • @JsonAnyGetter：允许将一个map字段作为标准属性来使用。在序列化过程中，map中的键值对会被平铺为json对象的属性
  • @JsonAnySetter：标记一个方法，该方法用来接收并处理json对象中未被映射的键值对

DEMO

pojo：

public class MyObj {
    private String name;
    private Integer age;
    private Map<String,Object> map = new HashMap<>();

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @JsonAnyGetter
    public Map<String, Object> getMap() {
        return map;
    }
	
    @JsonAnySetter
    public void setMap(String key,Object value) {
        this.map.put(key,value);
    }

    @Override
    public String toString() {
        return "MyObj{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", map=" + map +
                '}';
    }
}
  • 被 @JsonAnyGetter 注解的方法必须是非静态的、无参数的，并且返回值必须为 Map 类型
  • 被@JsonAnySetter注解的方法参数是key-value形式的

test：

        ObjectMapper objectMapper = new ObjectMapper();
        String s = "{\"name\":\"张三\",\"age\":30,\"city\":\"北京\",\"gender\":\"男\"}";
        MyObj myObj = objectMapper.readValue(s, MyObj.class);
        System.out.println("@JsonAnySetter:"+myObj);

        String s1 = objectMapper.writeValueAsString(myObj);
        System.out.println("@JsonAnyGetter:"+s1);

result：

@JsonAnySetter:MyObj{name='张三', age=30, map={gender=男, city=北京}}
@JsonAnyGetter:{"name":"张三","age":30,"gender":"男","city":"北京"}
  • @JsonAnySetter：未被定义的gender和city被map接收
  • @JsonAnyGetter：map中的内容被平铺到json字符串中
json jackson