Как я могу добавить атрибуты xml в аннотированный класс Jaxb XmlElementWrapper? - PullRequest
24 голосов
/ 08 сентября 2010

У меня есть класс с аннотацией XmlElementWrapper, такой как:

...

  @XmlElementWrapper(name="myList")
    @XmlElements({
    @XmlElement(name="myElement") }
    )
    private List<SomeType> someList = new LinkedList();

... Этот код до сих пор производит XML как

<myList>
  <myElement> </myElement>
  <myElement> </myElement>
  <myElement> </myElement>
</myList>

так хорошо.

Но теперь мне нужно добавить атрибуты в тег списка, чтобы получить XML вроде

<myList number="2">
  <myElement> </myElement>
  <myElement> </myElement>
  <myElement> </myElement>
</myList>

Есть ли «умный» способ достичь этого без создания нового класса, который представляетсписок?

Ответы [ 3 ]

27 голосов
/ 21 сентября 2011

У меня есть лучшее решение для вашего вопроса.

Для создания Xml-объекта Java используйте следующий код:

import java.util.*;
import javax.xml.bind.annotation.*;

@XmlRootElement(name="myList")
public class Root {

    private String number;
    private List<String> someList;

    @XmlAttribute(name="number")
    public String getNumber() {
        return number;
    }

    public void setNumber(String number) {
        this.number = number;
    }

    @XmlElement(name="myElement")
    public List<String> getSomeList() {
        return someList;
    }

    public void setSomeList(List<String> someList) {
        this.someList = someList;
    } 

    public Root(String numValue,List<String> someListValue) {
        this();
        this.number = numValue;
        this.someList = someListValue;  
    }

    /**
     * 
     */
    public Root() {
        // TODO Auto-generated constructor stub
    }

}

Для запуска вышеуказанного кода с использованием JAXB используйте следующее:

   import java.util.ArrayList;
import java.util.List;

import javax.xml.bind.*;

public class Demo {

        public static void main(String[] args) throws Exception {
            List<String> arg = new ArrayList<String>();
            arg.add("FOO");
            arg.add("BAR");
            Root root = new Root("123", arg);

            JAXBContext jc = JAXBContext.newInstance(Root.class);
            Marshaller marshaller = jc.createMarshaller();
            marshaller.marshal(root, System.out);
        }
}

В результате будет получен следующий XML:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <myList number="123">
        <myElement>FOO</myElement>
        <myElement>BAR</myElement>
    </myList>

Я думаю, что это более полезно для вас.

Спасибо ..

11 голосов
/ 08 сентября 2010

Реализация MOXy JAXB (я технический руководитель) имеет расширение ( @ XmlPath ) для обработки этого случая:

import java.util.*;
import javax.xml.bind.annotation.*;
import org.eclipse.persistence.oxm.annotations.XmlPath;

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

    @XmlPath("myList/@number")
    private int number;

    @XmlElementWrapper(name="myList") 
    @XmlElement(name="myElement") 
    private List<String> someList = new LinkedList<String>();

    public int getNumber() {
        return number;
    }

    public void setNumber(int number) {
        this.number = number;
    }

    public List<String> getSomeList() {
        return someList;
    }

    public void setSomeList(List<String> someList) {
        this.someList = someList;
    } 

}

Произведетследующий XML:

<?xml version="1.0" encoding="UTF-8"?>
<root>
   <myList number="123">
      <myElement>FOO</myElement>
      <myElement>BAR</myElement>
   </myList>
</root>

Когда этот код выполняется:

import javax.xml.bind.*;

public class Demo {

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

        Root root = new Root();
        root.setNumber(123);
        root.getSomeList().add("FOO");
        root.getSomeList().add("BAR");

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

Чтобы заставить это работать, используя строго стандартный код JAXB, вам нужно будет использовать адаптер XML:

Примечание:

Чтобы использовать MOXy JAXB, вам необходимо добавить файл с именем jaxb.properties в вашу модельклассы со следующей записью:

javax.xml.bind.context.factory=org.eclipse.persistence.jaxb.JAXBContextFactory
4 голосов
/ 30 декабря 2011

Если вы не используете MOXy или просто хотите придерживаться стандартных аннотаций JAXB, вы можете расширить ответ Noby, чтобы добавить поддержку универсального класса-оболочки.Ответ Noby в настоящее время поддерживает только список строк, но, например, скажем, вы собираетесь использовать один и тот же универсальный класс-обертку для нескольких разных классов.В моем примере я хочу создать общий класс «PagedList», который будет маршалировать в нечто, похожее на список, но также содержит информацию о смещении страницы и общем количестве элементов в невыгружаемом списке.

Недостатком этого решения является то, что вам нужно добавить дополнительные сопоставления @XmlElement для каждого типа класса, который будет упакован.В целом, хотя, возможно, лучшее решение, чем создание нового класса для каждого элемента pagable.

@XmlType
public class PagedList<T> {
    @XmlAttribute
    public int offset;

    @XmlAttribute
    public long total;

    @XmlElements({
        @XmlElement(name="order", type=Order.class),
        @XmlElement(name="address", type=Address.class)
        // additional as needed
    })
    public List<T> items;
}

@XmlRootElement(name="customer-profile")
public class CustomerProfile {
    @XmlElement
    public PagedList<Order> orders;
    @XmlElement
    public PagedList<Address> addresses;
}

Анализ этого примера даст вам:

<customer-profile>
    <order offset="1" total="100">
        <order> ... </order>
        <order> ... </order>
        <order> ... </order>
        ...
    </orders>
    <addresses offset="1" total="5">
        <address> ... </address>
        <address> ... </address>
        <address> ... </address>
        <address> ... </address>
        <address> ... </address>
    <addresses>
</customer-profile>

Надеюсь, что это поможет.Это решение, на котором я остановился, по крайней мере.

...