JAXB

Question

我有这个 POJO，它封装了一个动态的、非嵌套的 Atom 条目元素：

public class SimpleElement {

    private Namespace namespace;
    private String tagName;
    private String value;
    private Collection<Attribute> attributes;

    /* getters/setters/... */

为了完整起见，Attribute

public class Attribute {

    private String name;
    private String value;
    private Namespace namespace;  

    /* getters/setters/... */

和Namespace：

public class Namespace {

    private final String uri;
    private final String prefix;

    /* getters/setters/... */

SimpleElementAdapter 将 SimpleElement 序列化为对应的 org.w3c.dom.Element。

这种方法的唯一问题是名称空间总是在元素级别结束，而不是在文档根目录。

有没有办法在文档根目录动态声明命名空间？

Answer 1

我的建议

我的建议是让 JAXB 实现编写它认为合适的命名空间声明。只要元素是适当的命名空间限定的，命名空间声明出现在哪里并不重要。

如果您忽略我的建议，可以使用以下方法。

原始答案

指定要包含在根元素上的命名空间

您可以使用 NamespacePrefixMapper 扩展来向根元素添加额外的名称空间声明（参见：https://jaxb.java.net/nonav/2.2.11/docs/ch05.html#prefixmapper）。您将需要从您自己的对象模型派生出哪些命名空间应该在根目录中声明。

注： NamespacePrefixMapper在com.sun.xml.bind.marshaller包中。这意味着您将需要在您的类路径中使用 JAXB 引用实现 jar（请参阅：https://jaxb.java.net/）。

import com.sun.xml.bind.marshaller.*;

public class MyNamespacePrefixMapper extends NamespacePrefixMapper {

    @Override
    public String getPreferredPrefix(String arg0, String arg1, boolean arg2) {
        return null;
    }

    @Override
    public String[] getPreDeclaredNamespaceUris2() {
        return new String[] {"ns1", "http://www.example.com/FOO", "ns2", "http://www.example.com/BAR"};
    }


}

在 `Marshaller`

上指定 NamespacePrefixMapper

com.sun.xml.bind.namespacePrefixMapper属性用于指定Marshaller上的NamespacePrefixMapper。

marshaller.setProperty("com.sun.xml.bind.namespacePrefixMapper", new MyNamespacePrefixMapper());

演示代码

Java 型号 (Foo)

import javax.xml.bind.annotation.*;

@XmlRootElement
public class Foo {

    private Object object;

    @XmlAnyElement
    public Object getObject() {
        return object;
    }

    public void setObject(Object object) {
        this.object = object;
    }

}

演示

import javax.xml.bind.*;
import javax.xml.parsers.*;
import org.w3c.dom.*;
import org.w3c.dom.Element;

public class Demo {

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

        Foo foo = new Foo();

        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
        DocumentBuilder db = dbf.newDocumentBuilder();
        Document document = db.newDocument();
        Element element = document.createElementNS("http://www.example.com/FOO", "ns1:foo");
        foo.setObject(element);

        Marshaller marshaller = jc.createMarshaller();
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        marshaller.setProperty("com.sun.xml.bind.namespacePrefixMapper", new MyNamespacePrefixMapper());
        marshaller.marshal(foo, System.out);
    }

}

输出

下面是将生成的示例输出：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<foo xmlns:ns1="http://www.example.com/FOO" xmlns:ns2="http://www.example.com/BAR">
    <ns1:foo/>
</foo>

更新

Clear answer, thanks. However, I need access to the NSMapper from SimpleElementAdapter. What do you suggest? The only way I see right now is making the NSMapper a mutable singleton so that SimpleElementAdapter can add namespaces if needed.

我忘了你的 XmlAdapter。

Java型号

下面是一个更复杂的模型迭代，其中 Foo 持有 DOM 元素的实例，它持有 Bar 的实例，该实例被改编成DOM 元素的实例。

富

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

@XmlRootElement
public class Foo {

    private Bar bar;

    @XmlAnyElement
    @XmlJavaTypeAdapter(BarAdapter.class)
    public Bar getBar() {
        return bar;
    }

    public void setBar(Bar bar) {
        this.bar = bar;
    }

}

栏

public class Bar {

    private String value;

    public String getValue() {
        return value;
    }

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

}

BarAdapter

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

public class BarAdapter extends XmlAdapter<Object, Bar>{

    @Override
    public Object marshal(Bar bar) throws Exception {
        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
        DocumentBuilder db = dbf.newDocumentBuilder();
        Document document = db.newDocument();
        Element element = document.createElementNS("http://www.example.com/BAR", "ns:bar");
        element.setTextContent(bar.getValue());
        return element;
    }

    @Override
    public Bar unmarshal(Object arg0) throws Exception {
        // TODO Auto-generated method stub
        return null;
    }

}

获取命名空间声明

由于您的对象模型不直接包含 DOM 元素，因此您无法遍历它来获取命名空间声明。相反，我们可以对 ContentHandler 做一个元帅来收集它们。以下是编组为 ContentHandler 的原因：

它为我们提供了一个简单的事件，我们可以使用它来收集命名空间声明。
它实际上不会产生任何东西，因此它是我们可以使用的最轻的元帅目标。

NsContentHandler contentHandler = new NsContentHandler();
marshaller.marshal(foo, contentHandler);

NsContentHandler

ContentHandler 的实现类似于：

import java.util.*;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;

public class NsContentHandler extends DefaultHandler {

    private Map<String, String> namespaces = new TreeMap<String, String>();

    @Override
    public void startPrefixMapping(String prefix, String uri) throws SAXException {
        if(!namespaces.containsKey(prefix)) {
            namespaces.put(prefix, uri);
        }
    }

    public Map<String, String> getNamespaces() {
        return namespaces;
    }

}

指定要包含在根元素上的命名空间

MyNamespacePrefixMapper 的实现稍作更改，以使用从我们的 ContentHandler.

捕获的命名空间

import java.util.Map;
import java.util.Map.Entry;
import com.sun.xml.bind.marshaller.*;

public class MyNamespacePrefixMapper extends NamespacePrefixMapper {

    private String[] namespaces;

    public MyNamespacePrefixMapper(Map<String, String> namespaces) {
        this.namespaces = new String[namespaces.size() * 2];
        int index = 0;
        for(Entry<String, String> entry : namespaces.entrySet()) {
            this.namespaces[index++] = entry.getKey();
            this.namespaces[index++] = entry.getValue();
        }
    }

    @Override
    public String getPreferredPrefix(String arg0, String arg1, boolean arg2) {
        return null;
    }

    @Override
    public String[] getPreDeclaredNamespaceUris2() {
        return namespaces;
    }

}

演示代码

import javax.xml.bind.*;

public class Demo {

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

        Bar bar = new Bar();
        bar.setValue("Hello World");
        Foo foo = new Foo();
        foo.setBar(bar);

        Marshaller marshaller = jc.createMarshaller();

        // Marshal First Time to Get Namespace Declarations
        NsContentHandler contentHandler = new NsContentHandler();
        marshaller.marshal(foo, contentHandler);

        // Marshal Second Time for Real
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        marshaller.setProperty("com.sun.xml.bind.namespacePrefixMapper", new MyNamespacePrefixMapper(contentHandler.getNamespaces()));
        marshaller.marshal(foo, System.out);
    }

}

输出

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<foo xmlns:ns="http://www.example.com/BAR">
    <ns:bar>Hello World</ns:bar>
</foo>

JAXB - 将动态生成的名称空间移动到文档根目录

JAXB - Move dynamically generated namespaces to document root

java

xml

xml-namespaces

我的建议

原始答案

指定要包含在根元素上的命名空间

在 `Marshaller`

演示代码

更新

Java型号

获取命名空间声明

指定要包含在根元素上的命名空间

演示代码

JAXB - 将动态生成的名称空间移动到文档根目录

JAXB - Move dynamically generated namespaces to document root

java

xml

jaxb

xml-namespaces

我的建议

原始答案

指定要包含在根元素上的命名空间

在 Marshaller

演示代码

更新

Java型号

获取命名空间声明

指定要包含在根元素上的命名空间

演示代码

在 `Marshaller`