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

时间:2014-12-03 11:56:33

标签: java json annotations jackson

我目前正在尝试开发一个与某个在线服务进行通信的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实例的集合,每个实例都有类型
  • 结构由外部属性 type
  • 决定
  • 在给出的示例中,有3种类型 - >日期,名称和单值字符串
  • 生日周年纪念日类型均符合日期结构
  • 有几种类型可映射到单个值字符串,例如电子邮件类型, twitterId 类型,公司类型等。
  
    

我的问题是我似乎无法将此结构正确映射到Java对象

  

这是我到目前为止所做的事情。以下是课程及其杰克逊注释(省略了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。

注意:我提前为任何缺乏信息而道歉,以使此问题足够清晰。请说明我的配方有任何问题。

1 个答案:

答案 0 :(得分:2)

您已在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注释并添加getter / setter / constructors,代码也可以。

所以,我们的想法是你有一个Contact类(它是你的JSON的根)和一个Fields列表(其中Field是一个接口)。每个Field类型都有自己的实现,如NameField实现Field,并将NameFieldValue作为属性。这里的技巧是你可以改变getValue()方法声明并声明它返回公共接口或Object(我使用了Object但接口也可以工作)。

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