Jackson 将额外字段反序列化为 Map

Question

我希望将 JSON 对象中的任何未知字段反序列化为Map中的条目， Map是 POJO 的成员。

例如，这里是 JSON：

{
  "knownField" : 5,
  "unknownField1" : "926f7c2f-1ae2-426b-9f36-4ba042334b68",
  "unknownField2" : "ed51e59d-a551-4cdc-be69-7d337162b691"
}

这是POJO：

class MyObject {
  int knownField;
  Map<String, UUID> unknownFields;
  // getters/setters whatever
}

有没有办法用杰克逊配置这个？ 如果没有，是否有一种有效的方法来编写StdDeserializer来做到这一点（假设unknownFields的值可以是更复杂但众所周知的一致类型）？

Answer 1

有一个特性和一个注释完全符合这个目的。

我进行了测试，它可以与您的示例中的 UUID 一起使用：

class MyUUIDClass {
    public int knownField;

    Map<String, UUID> unknownFields = new HashMap<>();

    // Capture all other fields that Jackson do not match other members
    @JsonAnyGetter
    public Map<String, UUID> otherFields() {
        return unknownFields;
    }

    @JsonAnySetter
    public void setOtherField(String name, UUID value) {
        unknownFields.put(name, value);
    }
}

它会像这样工作：

    MyUUIDClass deserialized = objectMapper.readValue("{" +
            "\"knownField\": 1," +
            "\"foo\": \"9cfc64e0-9fed-492e-a7a1-ed2350debd95\"" +
            "}", MyUUIDClass.class);

还有更常见的类型，如字符串工作：

class MyClass {
    public int knownField;

    Map<String, String> unknownFields = new HashMap<>();

    // Capture all other fields that Jackson do not match other members
    @JsonAnyGetter
    public Map<String, String> otherFields() {
        return unknownFields;
    }

    @JsonAnySetter
    public void setOtherField(String name, String value) {
        unknownFields.put(name, value);
    }
}

（ 我首先在这篇博文中发现了这个功能）。

Answer 2

你需要编写自定义反序列化器这样的东西

class CustomDeserializer extends StdDeserializer<MyObject>{

    public CustomDeserializer(Class<MyObject> t) {
        super(t);
    }

    @Override
    public MyObject deserialize(JsonParser parser, DeserializationContext context)
            throws IOException, JsonProcessingException {
        int knownField=0;
        Map<String, UUID> unknownFields = new HashMap<String, UUID>();

        JsonToken currentToken = null;
      while ((currentToken = parser.nextValue()) != null) {
          switch (currentToken) {
              case VALUE_NUMBER_INT:
                  if (parser.getCurrentName().equals("knownField")) {
                      knownField = parser.getIntValue();
                  }
                  break;
              case VALUE_STRING:
                  if (parser.getCurrentName().startsWith("unknownField")){
                      unknownFields.put(parser.getCurrentName(),UUID.fromString(parser.getValueAsString()));
                  }
                  break;
              default:
                  break;
          }
      }
      return new MyObject(knownField,unknownFields);
    }
}

然后按如下方式设置自定义反序列化器

ObjectMapper mapper = new ObjectMapper();
        SimpleModule mod = new SimpleModule("TestModule");
        mod.addDeserializer(MyObject.class, new CustomDeserializer(MyObject.class));
        mapper.registerModule(mod);
        MyObject myObj = mapper.readValue(contents, MyObject.class);

编辑：您可以在按START_OBJECT标记时反序列化任何复杂对象。 并使用DeserializationContext.readValue(JsonParser, Class<MyObject>)来反序列化MyObject