通过扩展Jaxb生成的类来添加/覆盖行为

时间:2011-09-26 08:13:35

标签: jaxb unmarshalling xjc

我有一个响应xml数据的Web服务器和一个使用它的客户端。 两者共享相同的域代码。其中一个域对象如下所示:

@XmlAccessorType(XmlAccessType.PUBLIC_MEMBER)
@XmlRootElement(name = "image")
public class Image {

    private String filename;
    private ImageTypeEnum type;

    @XmlElement(name = "imageUri")
    public String getAbsoluteUri() {
        // some complex computation
        return uri;
    }
}

当我尝试将服务器的响应解组到此对象中时,由于没有针对absoluteUri的setter,我在类中没有imageUri。所以我将它扩展为:

public class FEImage extends Image{
private String imageUri;
    public String getAbsoluteUri() {
        return imageUri;
    }
    public void setAbsoluteUri(String imageUri) {
        this.imageUri = imageUri;
    }   
}

我的ObjectFactory

@XmlRegistry
public class ObjectFactory {
    public Image createImage(){
        return new FEImage();
    }
}

我的解组代码在这里:

JAXBContext context = JAXBContext.newInstance(ObjectFactory.class);
Unmarshaller unmarshaller = context.createUnmarshaller();
unmarshaller.setProperty("com.sun.xml.bind.ObjectFactory",new ObjectFactory());         
((JAXBElement)unmarshaller.unmarshal((InputStream) response.getEntity())).getValue();

但是,在解组时setAbsoluteUri似乎没有调用FEImage。当我在setAbsoluteUri中添加虚拟Image.java时,一切都按预期工作。

有人可以告诉我如何从Image.java干净地延伸?

1 个答案:

答案 0 :(得分:4)

注意:我是EclipseLink JAXB (MOXy)主管,是JAXB 2 (JSR-222)专家组的成员。


在实例化对象时,不需要JAXB实现来使用ObjectFactory类。您可以使用@XmlType注释通过工厂类配置实例化:

@XmlType(factoryClass=ObjectFactory.class, factoryMethod="createImage")
public class Image {

    private String filename;
    private ImageTypeEnum type;

    @XmlElement(name = "imageUri")
    public String getAbsoluteUri() {
        // some complex computation
        return uri;
    }
}

如果您执行上述操作,那么您的JAXB实现仍将使用Image类来派生元数据,因此无法解决您的问题。另一种方法是在此用例中使用XmlAdapter

更好的是,当您的域对象上的某个属性没有setter时,您可以告诉您 JAXB实现(EclipseLink MOXy,Metro,Apache JaxMe等)使用@XmlAccessorType(XmlAccessType.FIELD)来使用字段(实例变量)访问:

@XmlAccessorType(XmlAccessType.FIELD)
public class Image {
}

更新#1

如果您无法修改域对象,那么您可能对MOXy的外部化元数据感兴趣。此扩展通过XML提供了一种方法,为您无法修改源的类提供JAXB元数据。

了解更多信息


更新#2 - 根据聊天结果

<强> 图像

以下是我将用于此示例的Image类的实现。对于getAbsoluteUri()的复杂计算,我只需在文件名中添加前缀“CDN”:

package forum7552310;

import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;

@XmlAccessorType(XmlAccessType.PUBLIC_MEMBER)
@XmlRootElement(name = "image")
public class Image {

    private String filename;
    private ImageTypeEnum type;

    @XmlElement(name = "imageUri")
    public String getAbsoluteUri() {
        return "CDN" + filename;
    }

}

<强> binding.xml

下面是我放在一起的MOXy绑定文档。在这个文件中,我做了一些事情:

  • XmlAccessorType设为FIELD
  • 将absoluteURI属性标记为XmlTransient,因为我们将映射filename字段。
  • 指定XmlAdapter将与filename字段一起使用。这是为了应用getAbsoluteUri()方法中完成的逻辑。

<?xml version="1.0"?>
<xml-bindings
    xmlns="http://www.eclipse.org/eclipselink/xsds/persistence/oxm"
    package-name="forum7552310">
    <java-types>
        <java-type name="Image" xml-accessor-type="FIELD">
            <java-attributes>
                <xml-element java-attribute="filename" name="imageUri">
                    <xml-java-type-adapter value="forum7552310.FileNameAdapter"/>
                </xml-element>
                <xml-transient java-attribute="absoluteUri"/>
            </java-attributes>
        </java-type>
    </java-types>
</xml-bindings>

<强> FileNameAdapter

以下是应用与XmlAdapter方法相同名称算法的getAbsoluteUri()的实现:

package forum7552310;

import javax.xml.bind.annotation.adapters.XmlAdapter;

public class FileNameAdapter extends XmlAdapter<String, String> {

    @Override
    public String marshal(String string) throws Exception {
        return "CDN" + string;
    }

    @Override
    public String unmarshal(String adaptedString) throws Exception {
        return adaptedString.substring(3);
    }

}

<强> 演示

以下是演示代码,演示如何在创建JAXBContext时应用绑定文件:

package forum7552310;

import java.io.File;
import java.util.HashMap;
import java.util.Map;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.Marshaller;
import javax.xml.bind.Unmarshaller;

import org.eclipse.persistence.jaxb.JAXBContextFactory;

public class Demo {

    public static void main(String[] args) throws Exception {
        Map<String, Object> properties = new HashMap<String, Object>(1);
        properties.put(JAXBContextFactory.ECLIPSELINK_OXM_XML_KEY, "forum7552310/binding.xml");
        JAXBContext jc = JAXBContext.newInstance(new Class[] {Image.class}, properties);

        File xml = new File("src/forum7552310/input.xml");
        Unmarshaller unmarshaller = jc.createUnmarshaller();
        Image image = (Image) unmarshaller.unmarshal(xml);

        System.out.println(image.getAbsoluteUri());

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

<强> jaxb.properties

您需要在jaxb.properties类的同一个包中包含名为Image的文件,其中包含以下内容:

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

<强> input.xml中

以下是我使用的XML输入:

<?xml version="1.0" encoding="UTF-8"?>
<image>
    <imageUri>CDNURI</imageUri>
</image>

<强> 输出

以下是运行演示代码的输出:

CDNURI
<?xml version="1.0" encoding="UTF-8"?>
<image>
   <imageUri>CDNURI</imageUri>
</image>