JAXB--@XmlElementWrapper注解和泛型一起使用

时间:2023-03-09 03:28:56
JAXB--@XmlElementWrapper注解和泛型一起使用

当java对象的某个属性使用泛型时,普通对象都没问题,但是遇到HashSet这种集合类封装的元素时,就会出现元素内容序列化不出来的问题,详见如下:

一、示例:

第一步:定义java对象

  1. package step3;
  2. import javax.xml.bind.annotation.XmlAccessType;
  3. import javax.xml.bind.annotation.XmlAccessorType;
  4. import javax.xml.bind.annotation.XmlRootElement;
  5. @XmlRootElement
  6. @XmlAccessorType(value = XmlAccessType.PROPERTY)
  7. public class Customer<T> {
  8. String name;
  9. int age;
  10. int id;
  11. T t;
  12. public String getName() {
  13. return name;
  14. }
  15. public void setName(String name) {
  16. this.name = name;
  17. }
  18. public int getAge() {
  19. return age;
  20. }
  21. public void setAge(int age) {
  22. this.age = age;
  23. }
  24. public int getId() {
  25. return id;
  26. }
  27. public void setId(int id) {
  28. this.id = id;
  29. }
  30. @Override
  31. public String toString() {
  32. return "Customer [id=" + id + ",name=" + name + ",age=" + age + ",t=" + t + "]";
  33. }
  34. public T getT() {
  35. return t;
  36. }
  37. public void setT(T t) {
  38. this.t = t;
  39. }
  40. }
  1. package step3;
  2. import javax.xml.bind.annotation.XmlAccessType;
  3. import javax.xml.bind.annotation.XmlAccessorType;
  4. @XmlAccessorType(value = XmlAccessType.PROPERTY)
  5. public class Book {
  6. private String id;
  7. private String name;
  8. private float price;
  9. public String getId() {
  10. return id;
  11. }
  12. public void setId(String id) {
  13. this.id = id;
  14. }
  15. public String getName() {
  16. return name;
  17. }
  18. public void setName(String name) {
  19. this.name = name;
  20. }
  21. public float getPrice() {
  22. return price;
  23. }
  24. public void setPrice(float price) {
  25. this.price = price;
  26. }
  27. @Override
  28. public String toString() {
  29. return "Book [id=" + id + ",name=" + name + ",price=" + price + "]";
  30. }
  31. }

第二步:编组(JAXBContext.newInstance(Customer.class,HashSet.class);方法添加了

HashSet的class对象,以提供给JAXBContext使用。)

  1. package step3;
  2. import java.io.File;
  3. import java.util.HashSet;
  4. import javax.xml.bind.JAXBContext;
  5. import javax.xml.bind.JAXBException;
  6. import javax.xml.bind.Marshaller;
  7. //Marshaller
  8. public class Object2XmlDemo {
  9. public static void main(String[] args) {
  10. Customer<HashSet<Book>> customer = new Customer<HashSet<Book>>();
  11. customer.setId(100);
  12. customer.setName("suo");
  13. customer.setAge(29);
  14. Book book = new Book();
  15. book.setId("1");
  16. book.setName("哈里波特");
  17. book.setPrice(100);
  18. Book book2 = new Book();
  19. book2.setId("2");
  20. book2.setName("苹果");
  21. book2.setPrice(50);
  22. HashSet<Book> bookSet = new HashSet<Book>();
  23. bookSet.add(book);
  24. bookSet.add(book2);
  25. customer.setT(bookSet);
  26. try {
  27. File file = new File("C:\\file1.xml");
  28. JAXBContext jaxbContext = JAXBContext.newInstance(Customer.class,
  29. HashSet.class);
  30. Marshaller jaxbMarshaller = jaxbContext.createMarshaller();
  31. // output pretty printed
  32. jaxbMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
  33. jaxbMarshaller.marshal(customer, file);
  34. jaxbMarshaller.marshal(customer, System.out);
  35. } catch (JAXBException e) {
  36. e.printStackTrace();
  37. }
  38. }
  39. }

得到的xml:

  1. <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  2. <customer>
  3. <age>29</age>
  4. <id>100</id>
  5. <name>suo</name>
  6. <t xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="hashSet"/>
  7. </customer>

注:

1.泛型使用集合元素替代时,泛型属性所对应的xml没有序列化出来。

2.若JAXBContext.newInstance(Customer.class,HashSet.class);不添加HashSet

的class对象,则报错:

[javax.xml.bind.JAXBException: class java.util.HashSet nor any of its super class is known to this context.]

解决办法:

第一步:新增HashSet的包装类

Book类和Customer类相关代码均不需要改变,新增一个HashSet的包装类,定义如下:

  1. package step4;
  2. import java.util.HashSet;
  3. import javax.xml.bind.annotation.XmlElement;
  4. import javax.xml.bind.annotation.XmlElementWrapper;
  5. public class BookSet {
  6. private HashSet<Book> bookSet = new HashSet<Book>();
  7. //仅包含get方法,未包含set方法
  8. @XmlElementWrapper(name = "bookSet")//该注解非必须,仅是标注集合元素
  9. @XmlElement(name="book")
  10. public HashSet<Book> getBookSet() {
  11. return bookSet;
  12. }
  13. public void addBook(Book book){
  14. bookSet.add(book);
  15. }
  16. }

注:

1.BookSet类内部使用HashSet实现.

2.BookSet类在get方法上添加了@XmlElementWrapper(name = "bookSet")注解。

第二步:编组

  1. package step4;
  2. import java.io.File;
  3. import javax.xml.bind.JAXBContext;
  4. import javax.xml.bind.JAXBException;
  5. import javax.xml.bind.Marshaller;
  6. //Marshaller
  7. public class Object2XmlDemo {
  8. public static void main(String[] args) {
  9. Customer<BookSet> customer = new Customer<BookSet>();
  10. customer.setId(100);
  11. customer.setName("suo");
  12. customer.setAge(29);
  13. Book book = new Book();
  14. book.setId("1");
  15. book.setName("哈里波特");
  16. book.setPrice(100);
  17. Book book2 = new Book();
  18. book2.setId("2");
  19. book2.setName("苹果");
  20. book2.setPrice(50);
  21. BookSet bookSet = new BookSet();
  22. bookSet.addBook(book);
  23. bookSet.addBook(book2);
  24. customer.setT(bookSet);
  25. try {
  26. File file = new File("C:\\file1.xml");
  27. JAXBContext jaxbContext = JAXBContext.newInstance(Customer.class,
  28. BookSet.class);
  29. Marshaller jaxbMarshaller = jaxbContext.createMarshaller();
  30. // output pretty printed
  31. jaxbMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
  32. jaxbMarshaller.marshal(customer, file);
  33. jaxbMarshaller.marshal(customer, System.out);
  34. } catch (JAXBException e) {
  35. e.printStackTrace();
  36. }
  37. }
  38. }

注:

1.定义Customer对象时,使用包装类,即:

Customer<BookSet> customer = new Customer<BookSet>();

2.JAXBContext调用newInstance()方法时,传入BookSet的class对象,告知BookSet的类型,即:JAXBContext.newInstance(Customer.class,BookSet.class);

得到的xml:

  1. <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  2. <customer>
  3. <age>29</age>
  4. <id>100</id>
  5. <name>suo</name>
  6. <t xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="bookSet">
  7. <bookSet>
  8. <book>
  9. <id>2</id>
  10. <name>苹果</name>
  11. <price>50.0</price>
  12. </book>
  13. <book>
  14. <id>1</id>
  15. <name>哈里波特</name>
  16. <price>100.0</price>
  17. </book>
  18. </bookSet>
  19. </t>
  20. </customer>