Как добавить пространство имен XML (xmlns) при сериализации объекта в XML - PullRequest
Новая
       66

Как добавить пространство имен XML (xmlns) при сериализации объекта в XML

9 голосов
/ 25 мая 2011

Я сериализую объекты в XML с помощью XStream. Как мне сказать XStream вставить xmlns в вывод XML моего объекта?

Например, у меня есть простой объект, который я хочу сериализовать: 

@XStreamAlias(value="domain")
public class Domain
{
    @XStreamAsAttribute
    private String type;

    private String os;

    (...)
}

Как мне получить точно следующий вывод с XStream? 

<domain type="kvm" xmlns:qemu="http://libvirt.org/schemas/domain/qemu/1.0">
  <os>linux</os>
</domain>

Ответы [ 3 ]

16 голосов
/ 25 мая 2011

XStream не поддерживает пространства имен, но StaxDriver, который он использует, поддерживает. Вам необходимо установить детали вашего пространства имен в QNameMap и передать их в StaxDriver: 

QNameMap qmap = new QNameMap();
qmap.setDefaultNamespace("http://libvirt.org/schemas/domain/qemu/1.0");
qmap.setDefaultPrefix("qemu");
StaxDriver staxDriver = new StaxDriver(qmap);    
XStream xstream = new XStream(staxDriver);
xstream.autodetectAnnotations(true);
xstream.alias("domain", Domain.class);

Domain d = new Domain("kvm","linux");
String xml = xstream.toXML(d);

Выход: 

<qemu:domain type="kvm" xmlns:qemu="http://libvirt.org/schemas/domain/qemu/1.0">
  <qemu:os>linux</qemu:os>
</qemu:domain>
5 голосов
/ 25 мая 2011

Кроме того, этот вариант использования может быть достаточно легко обработан с помощью реализации JAXB ( Metro , EclipseLink MOXy , Apache JaxMe и т. Д.):

Домен 

package com.example;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class Domain
{
    private String type;
    private String os;

    @XmlAttribute
    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    public String getOs() {
        return os;
    }

    public void setOs(String os) {
        this.os = os;
    }

}

пакет-информация 

@XmlSchema(xmlns={
        @XmlNs(
            prefix="qemu", 
            namespaceURI="http://libvirt.org/schemas/domain/qemu/1.0")
})
package com.example;

import javax.xml.bind.annotation.XmlNs;
import javax.xml.bind.annotation.XmlSchema;

Демо 

package com.example;

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

public class Demo {

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

        Domain domain = new Domain();
        domain.setType("kvm");
        domain.setOs("linux");

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


}

выход 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<domain xmlns:qemu="http://libvirt.org/schemas/domain/qemu/1.0" type="kvm">
    <os>linux</os>
</domain>

Для получения дополнительной информации

4 голосов
/ 26 июня 2012

Это что-то вроде хака, но это быстро и просто: добавьте в ваш класс поле с именем xmlns, и оно будет иметь значение, не равное NULL, во время сериализации.Чтобы продолжить ваш пример: 

@XStreamAlias(value="domain")
public class Domain
{
    @XStreamAsAttribute
    private String type;

    private String os;

    (...)

    @XStreamAsAttribute
    @XStreamAlias("xmlns:qemu")
    String xmlns;

    public void serialise(File path) {
        XStream xstream = new XStream(new DomDriver());
        xstream.processAnnotations(Domain.class);
        (...)

        PrintWriter out = new PrintWriter(new FileWriter(path.toFile()));
        xmlns = "http://libvirt.org/schemas/domain/qemu/1.0";
        xstream.toXML(this, out);
        xmlns = null;
    }
}

Для завершения настройки xmlns = null должно быть в предложении finally.Использование PrintWriter также позволяет вам вставить XML-объявление в начале вывода, если хотите.

...