Xml与Java Object 的转换[JAXB]

http://a123159521.iteye.com/blog/1987300

博客分类：
• XML
• JAXB

Java代码

1. packageycl.learn.xml.jaxb;
3. importjava.io.File;
4. importjava.io.FileInputStream;
5. importjava.io.FileNotFoundException;
6. importjava.io.FileOutputStream;
7. importjava.io.InputStream;
8. importjava.io.OutputStream;
10. importjavax.xml.bind.JAXBContext;
11. importjavax.xml.bind.JAXBException;
12. importjavax.xml.bind.Marshaller;
13. importjavax.xml.bind.Unmarshaller;
15. publicclassJAXBUtil<T>{
17. @SuppressWarnings("unchecked")
18. publicTunmarshal(Class<T>clazz,InputStreamis)throwsJAXBException{
19. JAXBContextcontext=JAXBContext.newInstance(clazz);
20. Unmarshallerun=context.createUnmarshaller();
21. return(T)un.unmarshal(is);
22. }
24. publicTunmarshal(Class<T>clazz,Filefile)throwsJAXBException,FileNotFoundException{
25. returnunmarshal(clazz,newFileInputStream(file));
26. }
28. publicvoidmarshal(Telement,OutputStreamos)throwsJAXBException{
29. JAXBContextjc=JAXBContext.newInstance(element.getClass());
30. Marshallerm=jc.createMarshaller();
31. m.marshal(element,os);
32. }
34. publicvoidmarshal(Telement,Fileoutput)throwsFileNotFoundException,JAXBException{
35. marshal(element,newFileOutputStream(output));
36. }
39. }

this is the simple util that packaging the JAXB operator.
then we can use it simplely.

1. we just export simple Jodo to xml

Java代码

1. packageycl.learn.xml.jaxb;
3. importjavax.xml.bind.annotation.XmlRootElement;
5. @XmlRootElement
6. publicclassEmployeeDO{
7. privateintid;
9. privateStringgender;
11. privateintage;
13. privateStringname;
15. privateStringrole;
17. privateStringpassword;
19. publicStringgetpassword(){
20. returnpassword;
21. }
23. publicvoidsetPassword(Stringpassword){
24. this.password=password;
25. }
27. publicintgetId(){
28. returnid;
29. }
31. publicvoidsetId(intid){
32. this.id=id;
33. }
35. publicintgetAge(){
36. returnage;
37. }
39. publicvoidsetAge(intage){
40. this.age=age;
41. }
43. publicStringgetName(){
44. returnname;
45. }
47. publicvoidsetName(Stringname){
48. this.name=name;
49. }
51. publicStringgetGender(){
52. returngender;
53. }
55. publicvoidsetGender(Stringgender){
56. this.gender=gender;
57. }
59. publicStringgetRole(){
60. returnrole;
61. }
63. publicvoidsetRole(Stringrole){
64. this.role=role;
65. }
67. @Override
68. publicStringtoString(){
69. return"ID="+id+"NAME="+name+"AGE="+age+"GENDER="
70. +gender+"ROLE="+role+"PASSWORD="+password;
71. }
72. }

we must add @XmlRootElement to point this object is the root object for export.

Java代码

1. packageycl.learn.xml.jaxb;
3. importjava.io.File;
4. importjava.io.FileNotFoundException;
6. importjavax.xml.bind.JAXBException;
8. publicclassJAXBUtilTest{
9. privatestaticfinalStringFILE_NAME="jaxb-emp-jaxbutil.xml";
10. /**
11. *@paramargs
12. *@throwsJAXBException
13. *@throwsFileNotFoundException
14. */
15. publicstaticvoidmain(String[]args)throwsFileNotFoundException,JAXBException{
16. //TodoAuto-generatedmethodstub
17. EmployeeDOemp=newEmployeeDO();
18. emp.setId(1);
19. emp.setAge(25);
20. emp.setName("Pankaj");
21. emp.setGender("Male");
22. emp.setRole("Developer");
23. emp.setPassword("sensitive");
24. JAXBUtil<EmployeeDO>ju=newJAXBUtil<EmployeeDO>();
25. ju.marshal(emp,newFile(FILE_NAME));
26. System.out.println("generatorsuccess");
27. EmployeeDOempant=ju.unmarshal(EmployeeDO.class,newFile(FILE_NAME));
28. System.out.println("readersuccess");
29. System.out.println(empant);
30. }
32. }

we can easily use JAXBUtil to marshal Object to file.
we can also easily use JAXBUtil to unmarchal File to Object.

Java代码

1. <?xmlversion="1.0"encoding="UTF-8"standalone="yes"?>
2. <employeeDO>
3. <age>25</age>
4. <gender>Male</gender>
5. <id>1</id>
6. <name>Pankaj</name>
7. <password>sensitive</password>
8. <role>Developer</role>
9. </employeeDO>

If you review this code carefully,you will find the default root element name is the Object's name with first letter is lowercase.
the element under the root element is the attribute of the object.
Q1: can i change the Element Name,to generator Xml

Java代码

1. packageycl.learn.xml.jaxb;
3. importjavax.xml.bind.annotation.XmlElement;
4. importjavax.xml.bind.annotation.XmlRootElement;
6. @XmlRootElement(name="content")
7. publicclassEmployeeDO{
8. privateintid;
10. privateStringgender;
12. privateintage;
14. privateStringname;
16. privateStringrole;
18. privateStringpassword;
20. @XmlElement(name="pwd")
21. publicStringgetpassword(){
22. returnpassword;
23. }
25. publicvoidsetPassword(Stringpassword){
26. this.password=password;
27. }
29. publicintgetId(){
30. returnid;
31. }
33. publicvoidsetId(intid){
34. this.id=id;
35. }
37. publicintgetAge(){
38. returnage;
39. }
41. publicvoidsetAge(intage){
42. this.age=age;
43. }
45. publicStringgetName(){
46. returnname;
47. }
49. publicvoidsetName(Stringname){
50. this.name=name;
51. }
53. publicStringgetGender(){
54. returngender;
55. }
57. publicvoidsetGender(Stringgender){
58. this.gender=gender;
59. }
61. publicStringgetRole(){
62. returnrole;
63. }
65. publicvoidsetRole(Stringrole){
66. this.role=role;
67. }
69. @Override
70. publicStringtoString(){
71. return"ID="+id+"NAME="+name+"AGE="+age+"GENDER="
72. +gender+"ROLE="+role+"PASSWORD="+password;
73. }
74. }

we just need to set the @XmlRootElement or @XmlElement's name is ok.then the xml content is

Java代码

1. <?xmlversion="1.0"encoding="UTF-8"standalone="yes"?>
2. <content>
3. <age>25</age>
4. <gender>Male</gender>
5. <id>1</id>
6. <name>Pankaj</name>
7. <pwd>sensitive</pwd>
8. <role>Developer</role>
9. </content>

Q2: can i point that some attribute of Object i don't want to export

Java代码

1. packageycl.learn.xml.jaxb;
3. importjavax.xml.bind.annotation.XmlElement;
4. importjavax.xml.bind.annotation.XmlRootElement;
5. importjavax.xml.bind.annotation.XmlTransient;
7. @XmlRootElement(name="content")
8. publicclassEmployeeDO{
9. privateintid;
11. privateStringgender;
13. privateintage;
15. privateStringname;
17. privateStringrole;
19. privateStringpassword;
21. @XmlElement(name="pwd")
22. publicStringgetpassword(){
23. returnpassword;
24. }
26. publicvoidsetPassword(Stringpassword){
27. this.password=password;
28. }
30. @XmlTransient
31. publicintgetId(){
32. returnid;
33. }
35. publicvoidsetId(intid){
36. this.id=id;
37. }
39. publicintgetAge(){
40. returnage;
41. }
43. publicvoidsetAge(intage){
44. this.age=age;
45. }
47. publicStringgetName(){
48. returnname;
49. }
51. publicvoidsetName(Stringname){
52. this.name=name;
53. }
55. publicStringgetGender(){
56. returngender;
57. }
59. publicvoidsetGender(Stringgender){
60. this.gender=gender;
61. }
63. publicStringgetRole(){
64. returnrole;
65. }
67. publicvoidsetRole(Stringrole){
68. this.role=role;
69. }
71. @Override
72. publicStringtoString(){
73. return"ID="+id+"NAME="+name+"AGE="+age+"GENDER="
74. +gender+"ROLE="+role+"PASSWORD="+password;
75. }
76. }

you can add @XmlTransient before the getmethod,then this attribute won't be export.

Java代码

1. <?xmlversion="1.0"encoding="UTF-8"standalone="yes"?>
2. <content>
3. <age>25</age>
4. <gender>Male</gender>
5. <name>Pankaj</name>
6. <pwd>sensitive</pwd>
7. <role>Developer</role>
8. </content>

Q3: can i export the attribute of Object as attribute,not Element of xml,and change the attribute name

Java代码

1. @XmlAttribute(name="agefather")
2. publicintgetAge(){
3. returnage;
4. }

very easily to change sub element to attribute.

Java代码

1. <?xmlversion="1.0"encoding="UTF-8"standalone="yes"?>
2. <contentagefather="25">
3. <gender>Male</gender>
4. <name>Pankaj</name>
5. <pwd>sensitive</pwd>
6. <role>Developer</role>
7. </content>

Q4: i want to export the xml element as my order

Java代码

1. @XmlRootElement(name="content")
2. @XmlType(propOrder={"gender","age","name","role","password"})
3. publicclassEmployeeDO

Java代码

1. <?xmlversion="1.0"encoding="UTF-8"standalone="yes"?>
2. <contentagefather="25">
3. <gender>Male</gender>
4. <name>Pankaj</name>
5. <role>Developer</role>
6. <pwd>sensitive</pwd>
7. </content>

you can see this element is ordered by our defined.

Q5: i want to export list of Objects

Java代码

1. @XmlElementWrapper(name="employees")
2. @XmlElement(name="employee")
3. publicList<Employee>getEmployees(){
4. returnemployees;
5. }

Java代码

1. <employees>
2. <employee>
3. <age>25</age>
4. <gender>GGGGGG</gender>
5. <id>1</id>
6. <name>Pankaj</name>
7. <password>sensitive</password>
8. <role>Developer</role>
9. <family></family>
10. </employee>
11. <employee>
12. <age>25</age>
13. <gender>GGGGGGG</gender>
14. <id>1</id>
15. <name>Pankaj</name>
16. <password>sensitive</password>
17. <role>Developer</role>
18. <family></family>
19. </employee>
20. </employees>

Q5: i want to export list of Objects in other Object

Java代码

1. [ClassA]
2. publicFamilygetFamily(){
3. returnfamily;
4. }

Java代码

1. publicclassFamily{
3. privateList<Employee>employees;
5. @XmlElement(name="employee")
6. publicList<Employee>getEmployees(){
7. returnemployees;
8. }
10. publicvoidsetEmployees(List<Employee>employees){
11. this.employees=employees;
12. }
13. }

Java代码

1. <family>
2. <employee>
3. <age>25</age>
4. <gender>LLLLLLL</gender>
5. <id>1</id>
6. <name>Pankaj</name>
7. <password>sensitive</password>
8. <role>Developer</role>
9. <family></family>
10. </employee>
11. <employee>
12. <age>25</age>
13. <gender>Male</gender>
14. <id>1</id>
15. <name>Pankaj</name>
16. <password>sensitive</password>
17. <role>Developer</role>
18. <family></family>
19. </employee>
20. </family>

oh,you just don't to defined family,because it is the element of the object,default define is ok. the employee is multiple in family,you just define the @XmlElement empoyee is ok,and this will be auto add to list so this is you can think of the four questions,and i can't think other situations,and i think this four points can resolve all problems that we encountered,we can easily change xml Element name,Element attribute,Element order,that's cool.