JAXB--学习2

一.Jaxb处理java对象和xml之间转换常用的annotation有：

1. @XmlType
2. @XmlElement
3. @XmlRootElement
4. @XmlAttribute
5. @XmlAccessorType
6. @XmlAccessorOrder
7. @XmlTransient
8. @XmlJavaTypeAdapter

　二.常用annotation使用说明

1. @XmlType

　　@XmlType用在class类的注解，常与@XmlRootElement，@XmlAccessorType一起使用。它有三个属性：name、propOrder、namespace，经常使用的只有前两个属性。如：

@XmlType(name = "basicStruct", propOrder = {
    "intValue",
    "stringArray",
    "stringValue"
)

在使用@XmlType的propOrder 属性时，必须列出JavaBean对象中的所有属性，否则会报错。

　　2.@XmlElement

　　@XmlElement将java对象的属性映射为xml的节点，在使用@XmlElement时，可通过name属性改变java对象属性在xml中显示的名称。如：

　　@XmlElement(name="Address")　　

　　private String yourAddress;

　　3.@XmlRootElement

　　@XmlRootElement用于类级别的注解，对应xml的跟元素，常与 @XmlType 和 @XmlAccessorType一起使用。如：

　　@XmlType
　　@XmlAccessorType(XmlAccessType.FIELD)
　　@XmlRootElement
　　public class Address {}

　　4.@XmlAttribute

　　@XmlAttribute用于把java对象的属性映射为xml的属性,并可通过name属性为生成的xml属性指定别名。如：

　　@XmlAttribute(name="Country")
　　private String state;

　　5.@XmlAccessorType

　　@XmlAccessorType用于指定由java对象生成xml文件时对java对象属性的访问方式。常与@XmlRootElement、@XmlType一起使用。它的属性值是XmlAccessType的4个枚举值，分别为：

　　XmlAccessType.FIELD:java对象中的所有成员变量

　　XmlAccessType.PROPERTY：java对象中所有通过getter/setter方式访问的成员变量

　　XmlAccessType.PUBLIC_MEMBER：java对象中所有的public访问权限的成员变量和通过getter/setter方式访问的成员变量

　　XmlAccessType.NONE:java对象的所有属性都不映射为xml的元素

　　注意：

　　@XmlAccessorType的默认访问级别是XmlAccessType.PUBLIC_MEMBER，因此，如果java对象中的private成员变量设置了public权限的getter/setter方法，就不要在private变量上使用　　　　　　   　　@XmlElement和@XmlAttribute注解，否则在由java对象生成xml时会报同一个属性在java类里存在两次的错误。

　　同理，如果@XmlAccessorType的访问权限为XmlAccessType.NONE，如果在java的成员变量上使用了@XmlElement或@XmlAttribute注解，这些成员变量依然可以映射到xml文件。

　　6.@XmlAccessorOrder

　　@XmlAccessorOrder用于对java对象生成的xml元素进行排序。它有两个属性值：

　　AccessorOrder.ALPHABETICAL：对生成的xml元素按字母书序排序

　　XmlAccessOrder.UNDEFINED:不排序

　　7.@XmlTransient

　　@XmlTransient用于标示在由java对象映射xml时，忽略此属性。即，在生成的xml文件中不出现此元素。

　　8.@XmlJavaTypeAdapter

　　@XmlJavaTypeAdapter常用在转换比较复杂的对象时，如map类型或者格式化日期等。使用此注解时，需要自己写一个adapter类继承XmlAdapter抽象类，并实现里面的方法。

　　@XmlJavaTypeAdapter(value=xxx.class),value为自己定义的adapter类

　　XmlAdapter如下：

public abstract class XmlAdapter<ValueType,BoundType> {
    // Do-nothing constructor for the derived classes.
    protected XmlAdapter() {}
    // Convert a value type to a bound type.
    public abstract BoundType unmarshal(ValueType v);
    // Convert a bound type to a value type.
    public abstract ValueType marshal(BoundType v);
}

　三.示例

　　1.Shop.java

1. package jaxb.shop;
2. import java.util.Set;
3. import javax.xml.bind.annotation.XmlAccessOrder;
4. import javax.xml.bind.annotation.XmlAccessType;
5. import javax.xml.bind.annotation.XmlAccessorType;
6. import javax.xml.bind.annotation.XmlAttribute;
7. import javax.xml.bind.annotation.XmlElement;
8. import javax.xml.bind.annotation.XmlRootElement;
9. import javax.xml.bind.annotation.XmlType;
10. import javax.xml.bind.annotation.XmlElementWrapper;
11. import javax.xml.bind.annotation.XmlAccessorOrder;
12. @XmlAccessorOrder(XmlAccessOrder.ALPHABETICAL)
13. @XmlAccessorType(XmlAccessType.FIELD)
14. @XmlType(name = "shop", propOrder = { "name", "number", "describer", "address","orders" })

1. @XmlRootElement(name = "CHMart")
2. public class Shop {
3. @XmlAttribute
4. private String name;
5. // @XmlElement
6. private String number;
7. @XmlElement
8. private String describer;
9. @XmlElementWrapper(name = "orders")
10. @XmlElement(name = "order")
11. private Set<Order> orders;
12. @XmlElement
13. private Address address;
14. public Shop() {
15. }
16. public Shop(String name, String number, String describer, Address address) {
17. this.name = name;
18. this.number = number;
19. this.describer = describer;
20. this.address = address;
21. }
22. getter/setter略

1. //同时使用了@XmlType（propOrder={}）和@XmlAccessorOrder(XmlAccessOrder.ALPHABETICAL)，但是生成的xml只按照propOrder定义的顺序生成元素

　　2.Order.java

1. package jaxb.shop;
2. import java.math.BigDecimal;
3. import java.util.Date;
4. import javax.xml.bind.annotation.XmlAccessType;
5. import javax.xml.bind.annotation.XmlAccessorType;
6. import javax.xml.bind.annotation.XmlAttribute;
7. import javax.xml.bind.annotation.XmlRootElement;
8. import javax.xml.bind.annotation.XmlType;
9. import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
10. @XmlType(name="order",propOrder={"shopName","orderNumber","price","amount","purDate","customer"})
11. @XmlAccessorType(XmlAccessType.FIELD)
12. @XmlRootElement
13. public class Order {
14. //  @XmlElement　　
15. private String shopName;
16. @XmlAttribute
17. private String orderNumber;
18. //  @XmlElement
19. @XmlJavaTypeAdapter(value=DateAdapter.class)
20. private Date purDate;
21. //  @XmlElement
22. private BigDecimal price;
23. //  @XmlElement
24. private int amount;
25. //  @XmlElement
26. private Customer customer;
27. public Order() {
28. }
29. public Order(String shopName, String orderNumber, Date purDate,
30. BigDecimal price, int amount) {
31. this.shopName = shopName;
32. this.orderNumber = orderNumber;
33. this.purDate = purDate;
34. this.price = price;
35. this.amount = amount;
36. }

1. getter/setter略

1. //@XmlAccessorType(XmlAccessType.FIELD)，所以此处注释掉了@XmlElement，xml中依然会生成这些元素

　　3.Customer.java

1. package jaxb.shop;
2. import java.util.Set;
3. import javax.xml.bind.annotation.XmlType;
4. import javax.xml.bind.annotation.XmlAttribute;
5. import javax.xml.bind.annotation.XmlElement;
6. import javax.xml.bind.annotation.XmlRootElement;
7. import javax.xml.bind.annotation.XmlAccessType;
8. import javax.xml.bind.annotation.XmlAccessorType;
9. @XmlType
10. @XmlAccessorType(XmlAccessType.FIELD)
11. @XmlRootElement
12. public class Customer {
13. @XmlAttribute
14. private String name;
15. private String gender;
16. private String phoneNo;
17. private Address address;
18. private Set<Order> orders;
19. public Customer() {
20. }
21. public Customer(String name, String gender, String phoneNo, Address address) {
22. this.name = name;
23. this.gender = gender;
24. this.phoneNo = phoneNo;
25. this.address = address;
26. }

1. getter/setter略

　　4.Address.java

1. package jaxb.shop;
2. import javax.xml.bind.annotation.XmlAttribute;
3. import javax.xml.bind.annotation.XmlType;
4. import javax.xml.bind.annotation.XmlElement;
5. import javax.xml.bind.annotation.XmlRootElement;
6. import javax.xml.bind.annotation.XmlAccessType;
7. import javax.xml.bind.annotation.XmlAccessorType;
8. import javax.xml.bind.annotation.XmlAccessOrder;
9. import javax.xml.bind.annotation.XmlAccessorOrder;
10. @XmlType(propOrder={"state","province","city","street","zip"})
11. @XmlAccessorOrder(XmlAccessOrder.ALPHABETICAL)
12. @XmlAccessorType(XmlAccessType.NONE)
13. @XmlRootElement
14. public class Address {
15. @XmlAttribute　
16. private String state;
17. @XmlElement
18. private String province;
19. @XmlElement
20. private String city;
21. @XmlElement
22. private String street;
23. @XmlElement
24. private String zip;
25. public Address() {
26. super();
27. }
28. public Address(String state, String province, String city, String street,
29. String zip) {
30. super();
31. this.state = state;
32. this.province = province;
33. this.city = city;
34. this.street = street;
35. this.zip = zip;
36. }

1. getter/setter略

1. //注意：虽然@XmlAccessorType为XmlAccessType.NONE,但是在java类的私有属性上加了@XmlAttribute和@XmlElement注解后，这些私有成员会映射生成xml的元素

　　5.DateAdapter.java

1. package jaxb.shop;
2. import java.util.Date;
3. import java.text.SimpleDateFormat;
4. import javax.xml.bind.annotation.adapters.XmlAdapter;
5. public class DateAdapter extends XmlAdapter<String, Date> {
6. private String pattern = "yyyy-MM-dd HH:mm:ss";
7. SimpleDateFormat fmt = new SimpleDateFormat(pattern);
8. @Override
9. public Date unmarshal(String dateStr) throws Exception {
10. return fmt.parse(dateStr);
11. }
12. @Override
13. public String marshal(Date date) throws Exception {
14. return fmt.format(date);
15. }
16. }

1. //用于格式化日期在xml中的显示格式，并且由xml unmarshal为java对象时，将字符串解析为Date对象

　　6.ShopTest.java

1. package jaxb.shop;
2. import java.io.FileReader;
3. import java.io.FileWriter;
4. import java.io.IOException;
5. import java.math.BigDecimal;
6. import java.util.Date;
7. import java.util.HashSet;
8. import java.util.Set;
9. import javax.xml.bind.JAXBContext;
10. import javax.xml.bind.JAXBException;
11. import javax.xml.bind.Marshaller;
12. import javax.xml.bind.Unmarshaller;
13. public class ShopTest {
14. public static void main(String[] args) throws JAXBException, IOException{
15. Set<Order> orders = new HashSet<Order>();
16. Address address1 = new Address("China", "ShangHai", "ShangHai", "Huang", "200000");
17. Customer customer1 = new Customer("Jim", "male", "13699990000", address1);
18. Order order1 = new Order("Mart", "LH59900", new Date(), new BigDecimal(60), 1);
19. order1.setCustomer(customer1);
20. Address address2 = new Address("China", "JiangSu", "NanJing", "ZhongYangLu", "210000");
21. Customer customer2 = new Customer("David", "male", "13699991000", address2);
22. Order order2 = new Order("Mart", "LH59800", new Date(), new BigDecimal(80), 1);
23. order2.setCustomer(customer2);
24. orders.add(order1);
25. orders.add(order2);
26. Address address3 = new Address("China", "ZheJiang", "HangZhou", "XiHuRoad", "310000");
27. Shop shop = new Shop("CHMart", "100000", "EveryThing",address3);
28. shop.setOrder(orders);
29. FileWriter writer = null;
30. JAXBContext context = JAXBContext.newInstance(Shop.class);
31. try {
32. Marshaller marshal = context.createMarshaller();
33. marshal.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
34. marshal.marshal(shop, System.out);
35. writer = new FileWriter("shop.xml");
36. marshal.marshal(shop, writer);
37. } catch (Exception e) {
38. e.printStackTrace();
39. }
40. Unmarshaller unmarshal = context.createUnmarshaller();
41. FileReader reader = new FileReader("shop.xml") ;
42. Shop shop1 = (Shop)unmarshal.unmarshal(reader);
43. Set<Order> orders1 = shop1.getOrder();
44. for(Order order : orders1){
45. System.out.println("***************************");
46. System.out.println(order.getOrderNumber());
47. System.out.println(order.getCustomer().getName());
48. System.out.println("***************************");
49. }
50. }
51. }

　　7.生成的xml文件

1. <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
2. <CHMart name="CHMart">
3. <number>100000</number>
4. <describer>EveryThing</describer>
5. <address state="China">
6. <province>ZheJiang</province>
7. <city>HangZhou</city>
8. <street>XiHuRoad</street>
9. <zip>310000</zip>
10. </address>
11. <orders>
12. <order orderNumber="LH59800">
13. <shopName>Mart</shopName>
14. <price>80</price>
15. <amount>1</amount>
16. <purDate>2012-03-25 12:57:23</purDate>
17. <customer name="David">
18. <gender>male</gender>
19. <phoneNo>13699991000</phoneNo>
20. <address state="China">
21. <province>JiangSu</province>
22. <city>NanJing</city>
23. <street>ZhongYangLu</street>
24. <zip>210000</zip>
25. </address>
26. </customer>
27. </order>
28. <order orderNumber="LH59900">
29. <shopName>Mart</shopName>
30. <price>60</price>
31. <amount>1</amount>
32. <purDate>2012-03-25 12:57:23</purDate>
33. <customer name="Jim">
34. <gender>male</gender>
35. <phoneNo>13699990000</phoneNo>
36. <address state="China">
37. <province>ShangHai</province>
38. <city>ShangHai</city>
39. <street>Huang</street>
40. <zip>200000</zip>
41. </address>
42. </customer>
43. </order>
44. </orders>
45. </CHMart>

　　以上是以一个简单的商店订单模型作为示例。