用于任意 XML 的 JAXB @XmlAdapter

Question

我有一个org.w3c.dom.Element，我从我的XmlAdapter 返回一个自定义@XmlElement，我想将它作为任意XML 的JAXB 对象的一部分包含在内（我知道我会必须手工制作 XSD）。但是，JAXB 抱怨

org.w3c.dom.Element is an interface, and JAXB can't handle interfaces.

显然 w3c XML 类型是not supported as Java types，这是一种耻辱。但除此之外，当我使用显然受支持的javax.xml.transform.Result 时，我也会遇到同样的错误。

如何在 JAXB 中包含任意 XML 元素作为元素？

注意：按照https://forums.oracle.com/thread/1668210我也试过了

MessageFactory factory = MessageFactory.newInstance();
message = factory.createMessage();          
SOAPElement element = message.getSOAPBody().addDocument(doc);

但这也给出了同样的错误。

Answer 1

TL;DR

只要您将值类型指定为Object（而不是Element），您就可以拥有一个XmlAdapter，它将您的域对象转换为org.w3c.dom.Element 的实例。

---

下面是一个完整的例子。

XmlAdapter

java.lang.Object 类型的字段/属性会将未知内容保留为 DOM 节点。您可以通过将XmlAdapter 中的值类型指定为Object 来在您的用例中利用这一点。您需要确保从 marshal 方法返回的根元素与 @XmlElement 注释定义的字段/属性相匹配。

import javax.xml.bind.annotation.adapters.XmlAdapter;
import javax.xml.parsers.*;
import org.w3c.dom.*;

public class BarAdapter extends XmlAdapter<Object, Bar>{

    private DocumentBuilder documentBuilder;

    public BarAdapter() {
        try {
            DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
            documentBuilder = dbf.newDocumentBuilder();
        } catch(Exception e) {
            // TODO - Handle Exception
        }
    }

    @Override
    public Bar unmarshal(Object v) throws Exception {
        Bar bar = new Bar();
        Element element = (Element) v;
        bar.value = element.getTextContent();
        return bar;
    }

    @Override
    public Object marshal(Bar v) throws Exception {
        Document document = documentBuilder.newDocument();
        Element root = document.createElement("bar");
        root.setTextContent(v.value);
        return root;
    }

}

Java 模型

Foo

@XmlJavaTypeAdapter 注解用于引用XmlAdapter。

import javax.xml.bind.annotation.*;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

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

    @XmlJavaTypeAdapter(BarAdapter.class)
    private Bar bar;

}

条形

import javax.xml.bind.annotation.*;

@XmlAccessorType(XmlAccessType.FIELD)
public class Bar {

    String value;

}

演示代码

演示

由于创建 DocumentBuilderFactory 是有成本的，我们可以通过在 Marshaller 上设置一个实例来利用 JAXB 处理 XmlAdapter 的有状态实例的能力。

import java.io.File;
import javax.xml.bind.*;

public class Demo {

    public static void main(String[] args) throws Exception {
        JAXBContext jc = JAXBContext.newInstance(Foo.class);

        Unmarshaller unmarshaller = jc.createUnmarshaller();
        File xml = new File("src/forum18272059/input.xml");
        Foo foo = (Foo) unmarshaller.unmarshal(xml);

        Marshaller marshaller = jc.createMarshaller();
        marshaller.setAdapter(new BarAdapter());
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        marshaller.marshal(foo, System.out);
    }

}

input.xml/Output

<?xml version="1.0" encoding="UTF-8"?>
<foo>
    <bar>Hello World</bar>
</foo>