jaxb - JAXB 和继承

Question

我正在尝试读取 JSON 文件，例如：

{
  "a": "abc",
  "data" : {
      "type" : 1,
      ...
  }
}

其中 ... 部分可根据以下类型替换：

{
  "a": "abc",
  "data" : {
      "type" : 1,
      "b" : "bcd"
  }
}

或者：

{
  "a": "abc",
  "data" : {
      "type" : 2,
      "c" : "cde",
      "d" : "def",
  }
}

对于我的一生，我无法找出正确的 JAXB 注释/类来实现这一点。如果需要，将类型变量移到数据块之外我没有问题。

我正在使用 Glassfish 3.1.2.2。

编辑：

根据 Perception 提供的代码，我做了一个快速的尝试……但在 glassfish 中不起作用：

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = As.PROPERTY, property = "type")
@JsonSubTypes(
{
    @JsonSubTypes.Type(value = DataSubA.class, name = "1"),
    @JsonSubTypes.Type(value = DataSubB.class, name = "2") 
})
@XmlRootElement
public abstract class Data implements Serializable 
{
    private static final long serialVersionUID = 1L;

    public Data() 
    {
        super();
    }
}

@XmlRootElement
@XmlAccessorType(XmlAccessType.NONE)
public class DataSubA 
    extends Data 
{
    private static final long serialVersionUID = 1L;

    @XmlElement
    private BigDecimal expenditure;

    public DataSubA() {
        super();
    }

    public DataSubA(final BigDecimal expenditure) {
        super();
        this.expenditure = expenditure;
    }

    @Override
    public String toString() {
        return String.format("%s[expenditure = %s]\n", 
                             getClass().getSimpleName(), getExpenditure());
    }

    public BigDecimal getExpenditure() {
        return expenditure;
    }

    public void setExpenditure(BigDecimal expenditure) {
        this.expenditure = expenditure;
    }
}

@XmlRootElement
@XmlAccessorType(XmlAccessType.NONE)
public class DataSubB 
    extends Data 
{
    private static final long serialVersionUID = 1L;

    @XmlElement
    private String name;

    @XmlElement
    private Integer age;

    public DataSubB() 
    {
        super();
    }

    public DataSubB(final String name, final Integer age) 
    {
        super();
        this.name = name;
        this.age = age;
    }

    @Override
    public String toString() 
    {
        return String.format("%s[name = %s, age = %s]\n", 
                             getClass().getSimpleName(), getName(), getAge());
    }

    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;
    }
}

@XmlRootElement
@XmlAccessorType(XmlAccessType.NONE)
public class DataWrapper
{ 
    @XmlElement
    private Data data;

    public Data getData() {
        return data;
    }

    public void setData(Data data) {
        this.data = data;
    }
}

还有一个简单的 POST 将其纳入：

@Stateless
@Path("x")
public class Endpoint
{
    @POST
    @Consumes(
    {
        MediaType.APPLICATION_JSON,
    })
    @Produces(
    {
        MediaType.APPLICATION_JSON,
    })
    public String foo(final DataWrapper wrapper)
    {
        return ("yay");
    }
}

当我像这样传入 JSON 时：

{
    "data" : 
    {
        "type" : 1,
        "expenditure" : 1
    }
}

我收到如下消息：

Can not construct instance of Data, problem: abstract types can only be instantiated with additional type information
 at [Source: org.apache.catalina.connector.CoyoteInputStream@28b92ec1; line: 2, column: 5] (through reference chain: DataWrapper["data"])

score 11 · Accepted Answer

在DataClass添加一个@XmlSeeAlso指定所有子类的注释：

@XmlRootElement
@XmlSeeAlso({DataSubA.class, DataSubB.class})
public abstract class Data implements Serializable {

然后在每个子类上使用@XmlType注解来指定类型名称。

@XmlType(name="1")
public class DataSubA extends Data {

更新

注意： 我是EclipseLink JAXB (MOXy)负责人，也是JAXB (JSR-222)专家组的成员。

JAXB (JSR-222) 规范不包括 JSON 绑定。JAX-RS 允许您通过 JAXB 注释指定 JSON 映射的不同方式：

JAXB 实现加上 Jettison 之类的库，可将 StAX 事件转换为 JSON（请参阅： http ://blog.bdoughan.com/2011/04/jaxb-and-json-via-jettison.html ）
通过利用提供 JSON 绑定的 JAXB 实现（参见： http ://blog.bdoughan.com/2011/08/json-binding-with-eclipselink-moxy.html ）
利用提供对某些 JAXB 元数据（即 Jackson）的支持的 JSON 绑定工具。

由于您的模型似乎没有像预期的那样对注释做出反应，我猜您正在使用场景 3。下面我将演示解决方案，就像您使用场景 2 一样。

数据包装器

import javax.xml.bind.annotation.*;

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class DataWrapper { 

    private String a;
    private Data data;

}

数据

import javax.xml.bind.annotation.*;

@XmlAccessorType(XmlAccessType.FIELD)
@XmlSeeAlso({DataSubA.class, DataSubB.class})
public class Data {

}

数据子A

import javax.xml.bind.annotation.XmlType;

@XmlType(name="1")
public class DataSubA extends Data {

    private String b;

}

数据子B

import javax.xml.bind.annotation.XmlType;

@XmlType(name="2")
public class DataSubB extends Data {

    private String c;
    private String d;

}

jaxb.properties

要将 MOXy 指定为您的 JAXB 提供程序，您需要包含一个jaxb.properties在与域模型相同的包中调用的文件，其中包含以下条目（请参阅： http ://blog.bdoughan.com/2011/05/specifying-eclipselink-moxy-as -你的.html）：

javax.xml.bind.context.factory=org.eclipse.persistence.jaxb.JAXBContextFactory

演示

import java.util.*;
import javax.xml.bind.*;
import javax.xml.transform.stream.StreamSource;
import org.eclipse.persistence.jaxb.JAXBContextProperties;

public class Demo {

    public static void main(String[] args) throws Exception {
        Map<String, Object> properties = new HashMap<String, Object>();
        properties.put(JAXBContextProperties.MEDIA_TYPE, "application/json");
        properties.put(JAXBContextProperties.JSON_INCLUDE_ROOT, false);
        JAXBContext jc = JAXBContext.newInstance(new Class[] {DataWrapper.class}, properties);

        Unmarshaller unmarshaller = jc.createUnmarshaller();
        StreamSource json = new StreamSource("src/forum16429717/input.json");
        DataWrapper dataWrapper = unmarshaller.unmarshal(json, DataWrapper.class).getValue();

        Marshaller marshaller = jc.createMarshaller();
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        marshaller.marshal(dataWrapper, System.out);
    }

}

输入.json/输出

MOXy 可以读入数值2作为继承指示符，但目前它总是将其写为"2". 我已打开以下增强请求来解决此问题： http ://bugs.eclipse.org/407528 。

{
   "a" : "abc",
   "data" : {
      "type" : "2",
      "c" : "cde",
      "d" : "def"
   }
}

了解更多信息

以下链接将帮助您在 JAX-RS 实现中使用 MOXy。

http://blog.bdoughan.com/2012/05/moxy-as-your-jax-rs-json-provider.html

jaxb - JAXB 和继承

1 回答 1

Related

Reference