Java和xml的互相转换,依靠强大的JAXBContext可以轻松实现。
下面通过一个简单案例学习一下JAXBContext
首先准备好一个JavaBean供实验:
注意
1、类文件注解:@XmlRootElement不可缺少
2、2个Student的构造方法不能少
[java] view plaincopy
1. @XmlRootElement
2. public class Student {
3. private String name;
4. private String width;
5. private String height;
6. private int age;
7.
8.
9. public Student(String name, String width, String height, int age) {
10. super();
11. this.name = name;
12. this.width = width;
13. this.height = height;
14. this.age = age;
15. }
16. public String getName() {
17. return name;
18. }
19. public void setName(String name) {
20. this.name = name;
21. }
22. public String getWidth() {
23. return width;
24. }
25. public void setWidth(String width) {
26. this.width = width;
27. }
28. public String getHeight() {
29. return height;
30. }
31. public void setHeight(String height) {
32. this.height = height;
33. }
34. public int getAge() {
35. return age;
36. }
37. public void setAge(int age) {
38. this.age = age;
39. }
40. public Student() {
41. super();
42. }
43.
44. }
[java] view plain copy
- @XmlRootElement
- public class Student {
- private String name;
- private String width;
- private String height;
- private int age;
-
- public Student(String name, String width, String height, int age) {
- super();
- this.name = name;
- this.width = width;
- this.height = height;
- this.age = age;
- }
- public String getName() {
- return name;
- }
- public void setName(String name) {
- this.name = name;
- }
- public String getWidth() {
- return width;
- }
- public void setWidth(String width) {
- this.width = width;
- }
- public String getHeight() {
- return height;
- }
- public void setHeight(String height) {
- this.height = height;
- }
- public int getAge() {
- return age;
- }
- public void setAge(int age) {
- this.age = age;
- }
- public Student() {
- super();
- }
-
- }
JavaToXml:
[java] view plaincopy
1. @Test
2. public void test01(){
3. try {
4. JAXBContext jc = JAXBContext.newInstance(Student.class);
5. Marshaller ms = jc.createMarshaller();
6. Student st = new Student(“zhang”, “w”, “h”, 11);
7. ms.marshal(st, System.out);
8. } catch (JAXBException e) {
9. // TODO Auto-generated catch block
10. e.printStackTrace();
11. }
12. }
[java] view plain copy
- @Test
- public void test01(){
- try {
- JAXBContext jc = JAXBContext.newInstance(Student.class);
- Marshaller ms = jc.createMarshaller();
- Student st = new Student(“zhang”, “w”, “h”, 11);
- ms.marshal(st, System.out);
- } catch (JAXBException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- }
- }
XmlToJava
[java] view plaincopy
1. //xml转换Java
2. @Test
3. public void test02() throws JAXBException{
4. String xml = “
return unmarshaller.unmarshal(reader);
在JAXB中(用于JAVA对象和xml之间的转换),经常出现各类的 @XmlElement这样的标记,
下面就来以一个例子小结下,加深学习:
Java代码
1.
2. import java.util.*;
3. import javax.xml.bind.annotation.*;
4.
5. @XmlRootElement
6. @XmlAccessorType(XmlAccessType.FIELD)
7. public class Customer {
8.
9. private List emailAddresses;
10.
11. public Customer() {
12. emailAddresses = new ArrayList();
13. }
14.
15. public List getEmailAddresses() {
16. return emailAddresses;
17. }
18.
19. public void setEmailAddresses(List emailAddresses) {
20. this.emailAddresses = emailAddresses;
21. }
22.
23. }
[java] view plain copy
- import java.util.*;
- import javax.xml.bind.annotation.*;
-
- @XmlRootElement
- @XmlAccessorType(XmlAccessType.FIELD)
- public class Customer {
-
- private List emailAddresses;
-
- public Customer() {
- emailAddresses = new ArrayList();
- }
-
- public List getEmailAddresses() {
- return emailAddresses;
- }
-
- public void setEmailAddresses(List emailAddresses) {
- this.emailAddresses = emailAddresses;
- }
-
- }
这个是一个典型的POJO了,其中引用了对象emailAddress,是一个List,那么下面演示各类用法:
先看默认的调用代码如下:
Java代码
1. import javax.xml.bind.JAXBContext;
2. import javax.xml.bind.Marshaller;
3.
4. public class Demo {
5.
6. public static void main(String[] args) throws Exception {
7. JAXBContext jc = JAXBContext.newInstance(Customer.class);
8.
9. Customer customer = new Customer();
10. customer.getEmailAddresses().add(“janed@example.com”);
11. customer.getEmailAddresses().add(“jdoe@example.org”);
12.
13. Marshaller marshaller = jc.createMarshaller();
14. marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
15. marshaller.marshal(customer, System.out);
16. }
17. }
[java] view plain copy
- import javax.xml.bind.JAXBContext;
- import javax.xml.bind.Marshaller;
-
- public class Demo {
-
- public static void main(String[] args) throws Exception {
- JAXBContext jc = JAXBContext.newInstance(Customer.class);
-
- Customer customer = new Customer();
- customer.getEmailAddresses().add(“janed@example.com”);
- customer.getEmailAddresses().add(“jdoe@example.org”);
-
- Marshaller marshaller = jc.createMarshaller();
- marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
- marshaller.marshal(customer, System.out);
- }
}
默认的把这个对象输出为一般的XML:
janed@example.com
jdoe@example.org
下面逐一看每个注解的用法
1) @XmlElement
@XmlElement(name=”email-address”)
private List emailAddresses;
加上这个注解的话,则按自定义的xml标签名去输出某个属性,如下:
janed@example.com
jdoe@example.org
2) @XmlElementWrapper
这个注解等于在最外面再包一层了,
@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class Customer {
@XmlElementWrapper(name="email-addresses")
@XmlElement(name="email-address")
private List<String> emailAddresses;
}
输出:
janed@example.com
jdoe@example.org
3) @XmlList
这个等于是在同一行中,把list中的输出,以空格形式分隔开来,
Java代码
1. @XmlRootElement
2. @XmlAccessorType(XmlAccessType.FIELD)
3. public class Customer {
4.
5. @XmlList
6. private List emailAddresses;
7.
8. }
[java] view plain copy
- @XmlRootElement
- @XmlAccessorType(XmlAccessType.FIELD)
- public class Customer {
-
- @XmlList
- private List emailAddresses;
-
- }
输出:
janed@example.com jdoe@example.org
4)
@XmlList和 @XmlAttribute混合使用
@XmlList
@XmlAttribute
private List emailAddresses;
输出:
一.Jaxb处理java对象和xml之间转换常用的annotation有:
1. @XmlType
2. @XmlElement
3. @XmlRootElement
4. @XmlAttribute
5. @XmlAccessorType
6. @XmlAccessorOrder
7. @XmlTransient
8. @XmlJavaTypeAdapter
二.常用annotation使用说明
- @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