java - 将 JSON 映射到具有单属性和多属性的多态 POJO

Question

我目前正在尝试开发一个与特定在线服务通信的 REST 客户端。此在线服务返回一些 JSON 响应，我希望使用 Jackson 将其映射到 Java 对象。

一个 JSON 响应的例子是:

{
    "id" : 1,
    "fields" : [ {
      "type" : "anniversary",
      "value" : {
        "day" : 1,
        "month" : 1,
        "year" : 1970
      }
    }, {
      "type" : "birthday",
      "value" : {
        "day" : 1,
        "month" : 1,
        "year" : 1970
      }
    }, {
      "type" : "simple",
      "value" : "simple string"
    },{
       "type": "name",
       "value": {
           "firstName": "Joe",
           "lastName": "Brown"
       }
    } ]
}

注意以下几点:

• 这个结构包含一个简单的 id 和 Field 实例的集合，每个实例都有一个类型和一个值
• value 结构由外部属性 type 决定
• 在给定的例子中，有3种类型->日期、姓名和单值字符串
• birthday 和anniversary 类型都匹配date 结构
• 有几种映射到单个值字符串的类型，如 email 类型、twitterId 类型、company 类型等。

My problem is that I do not seem to be able to correctly map this structure to the Java objects

这是我到目前为止所做的。以下是类及其 Jackson 注释(省略了 getter 和 setter)。

public class Contact {
    private int id;
    private List<Field> fields;
}

public class Field {
    private FieldType type;
    private FieldValue value;
}

public enum FieldType {
    EMAIL, NICKNAME, NAME, ADDRESS, BIRTHDAY, ANNIVERSARY
}

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.EXTERNAL_PROPERTY, property = "type",
        defaultImpl = SingleFieldValue.class)
@JsonSubTypes({
        @JsonSubTypes.Type(value = NameFieldValue.class, name = "name"),
        @JsonSubTypes.Type(value = DateFieldValue.class, name = "anniversary"),
        @JsonSubTypes.Type(value = DateFieldValue.class, name = "birthday"),
        @JsonSubTypes.Type(value = SingleFieldValue.class, name = "nickname"),
        @JsonSubTypes.Type(value = SingleFieldValue.class, name = "email"),
        //other types that map to SingleFieldValue
})
public abstract FieldValue {
}


public class NameFieldValue extends FieldValue {

    private String firstName;
    private String lastName;
 }

public class DateFieldValue extends FieldValue {

    private int day;
    private int month;
    private int year;
}

public class SingleFieldValue extends FieldValue {

    private String value;
}

ObjectMapper不包含任何配置，使用默认配置。

您对正确映射这些有什么建议？我想避免制作自定义反序列化器，而只是遍历 Json 对象，例如 JsonNode。

注意:对于缺乏足够的信息来明确说明这个问题，我提前表示歉意。请说明我的公式有任何问题。

Answer 1

您已经在 FieldValue 级别上使用了一个抽象类，以便在 FIeld 类中使用它。在这种情况下，您可以使用 type=email 和 value=address 构造对象，这可能会导致一些问题...

我建议为每个具有特定 FieldValue 类型的类型创建一个特定类。 以下代码将 JSON 序列化/反序列化为来自/到 POJO 的所需格式:

public class Main {
    String json = "{\"id\":1,\"fields\":[{\"type\":\"SIMPLE\",\"value\":\"Simple Value\"},{\"type\":\"NAME\",\"value\":{\"firstName\":\"first name\",\"lastName\":\"last name\"}}]}";

    public static void main(String []args) throws IOException {
        ObjectMapper objectMapper = new ObjectMapper();

        String json = objectMapper.writeValueAsString(generate());
        System.out.println(json);

        System.out.println(objectMapper.readValue(json, Contact.class));
    }

    private static Contact generate() {
        SimpleField simpleField = SimpleField.builder().type(FieldType.SIMPLE).value("Simple Value").build();

        NameFieldValue nameFieldValue = NameFieldValue.builder().firstName("first name").lastName("last name").build();
        NameField nameField = NameField.builder().type(FieldType.NAME).value(nameFieldValue).build();

        return Contact.builder().id(1).fields(Arrays.asList(simpleField, nameField)).build();
    }
}

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.EXTERNAL_PROPERTY, property = "type")
@JsonSubTypes({
        @JsonSubTypes.Type(value = SimpleField.class, name = "SIMPLE"),
        @JsonSubTypes.Type(value = NameField.class, name = "NAME")
})
interface Field {
    FieldType getType();
    Object getValue();
}

enum FieldType {
    SIMPLE, NAME
}

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
class Contact {
    private int id;
    private List<Field> fields;
}

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
class SimpleField implements Field {
    private FieldType type;
    private String value;

    @Override
    public FieldType getType() {
        return this.type;
    }

    @Override
    public String getValue() {
        return this.value;
    }
}

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
class NameField implements Field {
    private FieldType type;
    private NameFieldValue value;

    @Override
    public FieldType getType() {
        return this.type;
    }

    @Override
    public Object getValue() {
        return this.value;
    }
}

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
class NameFieldValue {
    private String firstName;
    private String lastName;
}

我在这里使用 lombok 库只是为了最小化代码并避免创建 getter/setter 以及构造函数。您可以删除 lombok 注释并添加 getters/setters/constructors，代码将同样工作。

因此，我们的想法是您有一个 Contact 类(它是您的 JSON 的根)和一个 Fields 列表(其中 Field 是一个接口(interface))。每个 Field 类型都有自己的实现，例如 NameField 实现 Field 并将 NameFieldValue 作为属性。这里的技巧是您可以更改 getValue() 方法声明并声明它返回通用接口(interface)或对象(我使用了对象，但接口(interface)也可以)。

此解决方案不需要任何自定义序列化器/反序列化器，并且易于维护。