Как добавить инструкции обработки XML во время маршала JAXB - PullRequest
Новая
       39

Как добавить инструкции обработки XML во время маршала JAXB

6 голосов
/ 03 августа 2011

Я хотел бы добавить инструкцию обработки всякий раз, когда свойство коллекции / массива сериализуется, чтобы получить что-то вроде 

<alice>
  <? array bob ?>
  <bob>edgar</bob>
  <bob>david</bob>
</alice>

Возможно ли это с JAXB?Или хотя бы с какой-то конкретной реализацией JAXB?

1 Ответ

6 голосов
/ 09 августа 2011

Вы можете использовать XMLStreamWriter и XmlAdapter, чтобы сделать это:

BobAdapter

Что следует помнить о XmlAdapter:

  • Он с состоянием и ссылается на XMLStreamWriter.Позже мы будем использовать способность JAXB устанавливать состояние XmlAdapter для Marshaller.
  • Он преобразуется из List<String> в List<String>, мы просто используем XmlAdapter здесь, чтобы получитьмероприятие.
  • В методе marshal мы вызываем writeProcessingInstruction для XMLStreamWriter: 

package forum6931520;

import java.util.List;

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

public class BobAdapter extends XmlAdapter<List<String>, List<String>> {

    private boolean first = true;
    private XMLStreamWriter xmlStreamWriter;

    public BobAdapter() {
    }

    public BobAdapter(XMLStreamWriter xmlStreamWriter) {
        this();
        this.xmlStreamWriter = xmlStreamWriter;
    }

    @Override
    public List<String> marshal(List<String> stringList) throws Exception {
        if(first) {
            xmlStreamWriter.writeProcessingInstruction("array", "bob");
            first = false;
        }
        return stringList;
    }

    @Override
    public List<String> unmarshal(List<String> stringList) throws Exception {
        return stringList;
    }

}

Алиса

Аннотация @XmlJavaTypeAdapter используется для связывания XmlAdapter с полем / свойством: 

package forum6931520;

import java.util.List;

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

@XmlRootElement
public class Alice {

    private List<String> bob;

    @XmlJavaTypeAdapter(BobAdapter.class)
    public List<String> getBob() {
        return bob;
    }

    public void setBob(List<String> bob) {
        this.bob = bob;
    }

}

Демо 

package forum6931520;

import java.io.File;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.Marshaller;
import javax.xml.bind.Unmarshaller;
import javax.xml.stream.XMLOutputFactory;
import javax.xml.stream.XMLStreamWriter;

public class Demo {

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

        File xml = new File("src/forum6931520/input.xml");
        Unmarshaller unmarshaller = jc.createUnmarshaller();
        Alice alice = (Alice) unmarshaller.unmarshal(xml);

        Marshaller marshaller = jc.createMarshaller();
        XMLOutputFactory xof = XMLOutputFactory.newFactory();
        XMLStreamWriter xmlStreamWriter = xof.createXMLStreamWriter(System.out);
        marshaller.setAdapter(new BobAdapter(xmlStreamWriter));
        marshaller.marshal(alice, xmlStreamWriter);
    }

}

input.xml 

<?xml version="1.0" encoding="UTF-8"?>
<alice>
  <?array bob?>
  <bob>edgar</bob>
  <bob>david</bob>
</alice>

Выход 

<?xml version='1.0' encoding='UTF-8'?><alice><?array bob?><bob>edgar</bob><bob>david</bob></alice>

Примечание

В этом примере необходимоработать с EclipseLink JAXB (MOXy) , поскольку JAXB RI сгенерирует следующее исключение (я веду MOXy): 

Exception in thread "main" com.sun.xml.internal.bind.v2.runtime.IllegalAnnotationsException: 2 counts of IllegalAnnotationExceptions
java.util.List is an interface, and JAXB can't handle interfaces.
    this problem is related to the following location:
        at java.util.List
        at public java.util.List forum6931520.Alice.getBob()
        at forum6931520.Alice
java.util.List does not have a no-arg default constructor.
    this problem is related to the following location:
        at java.util.List
        at public java.util.List forum6931520.Alice.getBob()
        at forum6931520.Alice

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

ОБНОВЛЕНИЕ

Я ввел запрос на улучшение (https://bugs.eclipse.org/354286), чтобы добавить встроенную поддержку для инструкций по обработке. Это в конечном итоге позволит вам указать следующее в своем свойстве:

@XmlProcessingInstruction(target="array", value="bob")
public List<String> getBob() {
    return bob;
}
...