杰克逊JSON多态性

时间:2013-03-25 21:18:04

标签: json jackson

我一直在尝试应用http://programmerbruce.blogspot.com/2011/05/deserialize-json-with-jackson-into.html)\上的内容,并将其应用到我一直在做的事情上。虽然它适用于JSON结构中我称之为“外部”元素的功能,但我遇到了令人沮丧的问题,即没有太多文档。

首先,我的代码有点像:

interface Parameters {
    // Couple random properties -- no problem here

    SubTypeParameters getSubTypeParameters(); // where SubTypeParameters are polymorphic
    void setSubTypeParameters(SubTypeParameters value);
}

@JsonSubTypes({
    @JsonSubTypes.Type(name = "a", value = ASubTypeParameters.class),
    @JsonSubTypes.Type(name = "b", value = BSubTypeParameters.class)
})
interface SubTypeParameters {
    String getValue();
    void setValue(String value);
}

@JsonTypeName(value = "a")
class ASubTypeParameters implements SubTypeParameters {
    // getter/setter implemented
}

@JsonTypeName(value = "b")
class BSubTypeParameters implements SubTypeParameters {
    // getter/setter implemented
}

我要做的是在链接的博客文章中实现第6个选项,以便JSON显示如下(注意没有指定'type'元素 - 它基于上下文):

{
    // other properties corresponding to the Parameters object
    "a": {
        "value": "value for a"
    }
}

{
    // other properties corresponding to the Parameters object
    "b": {
        "value": "value for b"
    }
}

我想避免的是在JSON对象中引入另一个“类型”变量。相反,我更愿意使用上述任一JSON示例中提供的上下文来知道我应该基于“a”或“b”的存在来构建ASubTypeParameters或BSubTypeParameters对象。

有趣的是,Parameters类/对象也是多态的,所以我已经注册了自己的自定义反序列化器类,如下所示:

ObjectMapper mapper = new ObjectMapper();
StdDeserializer<Parameters> parameterDeserializer = new ParameterDeserializer();
SimpleModule module = new SimpleModule ( ... ); // simplifying this--no problem here
module.addDeserializer(Parameters.class, parameterDeserializer);
mapper.registerModule(module);
mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

但是,当上面的反序列化程序试图反序列化上述任何一个JSON示例时,它将到达尝试反序列化“a”或“b”的部分,并指示它不知道如何处理这些properties(如果我删除未知属性行上的失败,则为UnrecognizedPropretyException)。我的问题实际上归结为:我缺少什么(注释或其他)?

我也尝试过添加:

mapper.registerSubtypes(ASubTypeParameters.class, BSubTypeParameters.class)

以及

mapper.registerSubtypes(
    new NamedType(ASubTypeParameters.class, "a"),
    new NamedType(BSubTypeParameters.class, "b")
);

无济于事。

我知道我已经相当接近,我的猜测是我需要编写某种自定义子类型处理程序,但是文档似乎缺乏我想做的事情(特别是当你反序列化时)多态类型/类,也包含多态元素。)

1 个答案:

答案 0 :(得分:2)

使用Jackson,您可以配置为使用以下注释将类型信息存储为单个字段的名称:@JsonTypeInfo(use=JsonTypeInfo.Id.NAME, include=JsonTypeInfo.As.WRAPPER_OBJECT)。结果应该类似于您的JSON示例。

我稍微修改了您的代码以演示它:

public class JacksonPolymorphic2 {
    @JsonTypeInfo(use=JsonTypeInfo.Id.NAME, include=JsonTypeInfo.As.WRAPPER_OBJECT)
    @JsonSubTypes({
            @JsonSubTypes.Type(name = "a", value = ASubTypeParameters.class),
            @JsonSubTypes.Type(name = "b", value = BSubTypeParameters.class)
    })
    interface SubTypeParameters {
        String getValue();
        void setValue(String value);
    }

    @JsonTypeName(value = "a")
    static class ASubTypeParameters implements SubTypeParameters {
        ASubTypeParameters(String value) {
            this.value = value;
        }

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

        @Override
        public void setValue(String value) {
            this.value = value;
        }
    }

    @JsonTypeName(value = "b")
    static class BSubTypeParameters implements SubTypeParameters {
        BSubTypeParameters(String value) {
            this.value = value;
        }

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

        @Override
        public void setValue(String value) {
            this.value = value;
        }
    }

    public static void main(String[] args) throws JsonProcessingException {
        ASubTypeParameters a = new ASubTypeParameters("aType");
        BSubTypeParameters b = new BSubTypeParameters("bType");
        List<? super SubTypeParameters> list = new ArrayList<>();
        list.add(a);
        list.add(b);

        ObjectMapper mapper = new ObjectMapper();
        System.out.printf(mapper
                .writerWithType(new TypeReference<List<SubTypeParameters>>() {})
                .withDefaultPrettyPrinter()
                .writeValueAsString(list));
    }
}

输出:

[ {
  "a" : {
    "value" : "aType"
  }
}, {
  "b" : {
    "value" : "bType"
  }
} ]