使用JAXB类库实现XML与JAVA对象的互转

第一章 前言

   ​       XML是开发中常用的配置文件类型，在常用的组件包里也能时常看到它的踪影，如Spring中的applicationContext.xml、Hibernate中的hbm.xml，都是用的XML来配置相关的参数信息。可见其使用是十分广泛的。

        JAXB是Java Architecture for XML Binding的缩写，用于在Java类与XML之间建立映射，能够帮助开发者很方便的將XML和Java对象进行相互转换。 本文以一个简单的例子介绍JAXB的使用，首先我们需要了解一下JAXB常用的API。

•         JAXBContext类，是应用的入口，用于管理XML/Java绑定信息。

•         Marshaller接口，将Java对象序列化为XML数据。

•         Unmarshaller接口，将XML数据反序列化为Java对象。

• 第二章 基础学习

•       ​   JAXB实现转换是依赖于Annotation的，那么咱们应该如何使用呢，可以看下面各个Annotation的作用：

         a)、@XmlRootElement

         用来定义一个XML的根节点信息，其参数有name和namespace。

         其中name用来定义根节点的名称，非必填。

         namespace用来定义XML的命名空间，非必填。

      b)、@XmlAccessorType

      控制字段或属性的序列化。常用的有XmlAccessType.FIELD、XmlAccessType.PROPERTY和XmlAccessType.NONE。

      如果定义的是FIELD（全自动），则表明JAXB 绑定类中的每个非静态（static）、非瞬态（transient）字段将会自动绑定到 XML，除非由 XmlTransient 注释。

      如果定义的是PROPERTY（半自动），则表明JAXB 绑定类中的每个获取方法（get）/设置方法（set）对将会自动绑定到 XML，除非由 XmlTransient 注释。需要注意的是要实现get/set方法。

      如果定义的是NONE（手动），则表所有字段或属性都不能绑定到 XML，除非使用一些 JAXB 注释专门对它们进行注释。如果使用了这个属性，咱们就需要对每个要映射的成员变量做设置才可以。

      c)、@XmlElement​

      将Java类的一个属性映射到与属性同名的一个XML元素。

      d)、@XmlAttribute

      将Java类的一个属性映射到与属性同名的一个XML属性。

      e)、@XmlElementWrapper

      对于数组或集合（即包含多个元素的成员变量），生成一个包装该数组或集合的XML元素（称为包装器）。

      f)、@XmlTransient

      阻止将 JavaBean 属性映射到 XML 表示形式。主要用来解决映射冲突的情况。

第三章 使用

     1.Java对象-->XML​​

​        a)首先，我们要有Java对象类，编写一个Student类和一个Group类，将Student作为子对象放在Group中。

package jxab;import java.util.List;import javax.xml.bind.annotation.XmlAccessType;import javax.xml.bind.annotation.XmlAccessorType;import javax.xml.bind.annotation.XmlAttribute;import javax.xml.bind.annotation.XmlElement;import javax.xml.bind.annotation.XmlElementWrapper;import javax.xml.bind.annotation.XmlRootElement; @XmlRootElement(name = "Message")@XmlAccessorType(XmlAccessType.FIELD)public class Group {@XmlElement(name = "groupName", required = true)private String groupName;  //小组名@XmlElementWrapper(name = "Group")  @XmlElement(name = "Student", required = true)    private List<Student> list;public String getGroupName() {return groupName;}public void setGroupName(String groupName) {this.groupName = groupName;}public List<Student> getList() {return list;}public void setList(List<Student> list) {this.list = list;}     }

Group.class

package jxab;import javax.xml.bind.annotation.XmlAccessType;import javax.xml.bind.annotation.XmlAccessorType;import javax.xml.bind.annotation.XmlAttribute;import javax.xml.bind.annotation.XmlElement;import javax.xml.bind.annotation.XmlRootElement;import javax.xml.bind.annotation.XmlType;   @XmlAccessorType(XmlAccessType.FIELD)@XmlType(propOrder = { "name", "age", "id","gender"})public class Student {@XmlElement(name = "name")private String name; //学生姓名@XmlElement(name = "age")private int age;     //学生年级@XmlElement(name = "id")private int id;      //学生学号@XmlElement(name = "gender")private String gender; //学生性别public String getName() {return name;}public void setName(String name) {this.name = name;}public int getAge() {return age;}public void setAge(int age) {this.age = age;}public int getId() {return id;}public void setId(int id) {this.id = id;}public String getGender() {return gender;}public void setGender(String gender) {this.gender = gender;}}

Student.class

​      b)有了这两个类之后，介绍一下我们的进行两种转换的工具类。

package jxab;import java.io.StringReader;import java.io.StringWriter;import javax.xml.bind.JAXBContext;import javax.xml.bind.Marshaller;import javax.xml.bind.Unmarshaller;public class JaxbUtil { /**      * JavaBean转换成xml      * @param obj      * @param encoding       * @return       */      public static String convertToXml(Object obj, String encoding) {          String result = null;          try {              JAXBContext context = JAXBContext.newInstance(obj.getClass());              Marshaller marshaller = context.createMarshaller();              marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);              marshaller.setProperty(Marshaller.JAXB_ENCODING, encoding);              marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true);                StringWriter writer = new StringWriter();              marshaller.marshal(obj, writer);              result = writer.toString();          } catch (Exception e) {          e.printStackTrace();        }            return result;      }        /**      * xml转换成JavaBean      * @param xml      * @param c      * @return      */      @SuppressWarnings("unchecked")public static <T> T converyToJavaBean(String xml, Class<T> c) {          T t = null;          try {              JAXBContext context = JAXBContext.newInstance(c);              Unmarshaller unmarshaller = context.createUnmarshaller();              t = (T) unmarshaller.unmarshal(new StringReader(xml));          } catch (Exception e) {          e.printStackTrace();        }            return t;      }  }

JaxbUtil工具类

​      c)最后编写一个调用上面方法的测试类。

package jxab;import java.io.IOException;import java.util.ArrayList;import java.util.List;import javax.xml.bind.JAXBContext;import javax.xml.bind.JAXBException;public class testJTX extends JaxbUtil{public static void main(String[] args){   String encoding = "";   Group group = new Group();   group.setGroupName("JavaGroup");   Student a = new Student();   a.setAge(18);   a.setName("LiMing");   a.setId(1);   a.setGender("Man");   Student b = new Student();   b.setAge(19);   b.setName("XiaoHong");   b.setId(2);   b.setGender("Woman");   Student c = new Student();   c.setId(3);   c.setName("Messi");   c.setGender("Man");   c.setAge(28);   List<Student> list = new ArrayList<Student>();   list.add(a);   list.add(b);   list.add(c);   group.setList(list);   String result;   result = convertToXml(group ,encoding);   System.out.print(result);}}

测试类

​​        c)运行一下，可以看到Java对象转换成XML。

<Message xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">    <groupName>JavaGroup</groupName>    <Group>        <Student>            <name>LiMing</name>            <age>18</age>            <id>1</id>            <gender>Man</gender>        </Student>        <Student>            <name>XiaoHong</name>            <age>19</age>            <id>2</id>            <gender>Woman</gender>        </Student>        <Student>            <name>Messi</name>            <age>28</age>            <id>3</id>            <gender>Man</gender>        </Student>    </Group></Message>

最终结果

​​        TIP：如果想要在XML文件中，第二行显示<Message xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">这句话需要添加下面一个Class。

@XmlSchema( xmlns = { @XmlNs(namespaceURI = "http://www.w3.org/2001/XMLSchema-instance", prefix = "xsi"),   @XmlNs(namespaceURI = "http://www.w3.org/2001/XMLSchema", prefix = "xsd")})package jxab;import javax.xml.bind.annotation.XmlNs;import javax.xml.bind.annotation.XmlSchema;

 package-infor.java

​​​

​  2.XML-->JAVA对象

    a)依据上面编写的Student类、Group类和工具类，我们编写一个调用方法的测试类。

package jxab;import java.io.IOException;import java.util.ArrayList;import java.util.List;import javax.xml.bind.JAXBContext;import javax.xml.bind.JAXBException;public class testJTX extends JaxbUtil{public static void main(String[] args){String xml ="<Message>"    + "<groupName>JavaGroup</groupName>"    + "<Group>" + "<Student>"+"<name>LiMing</name>"    + "<age>18</age>" + "<id>1</id>" + "<gender>Man</gender>"    + "</Student>" + "<Student>" + "<name>XiaoHong</name>"    + "<age>19</age>" + "<id>2</id>" + "<gender>Woman</gender>"    + "</Student>" + "<Student>" + "<name>Messi</name>" + "<age>28</age>"    + "<id>3</id>" + "<gender>Man</gender>" + "</Student>" + "</Group>" + "</Message>";Group group = new Group();Student a = new Student();Student b = new Student();Student c = new Student();group = converyToJavaBean(xml, Group.class);List<Student> list = new ArrayList<Student>();list = group.getList();System.out.println(group.getGroupName());a = list.get(0);b = list.get(1);c = list.get(2);System.out.println(a.getId()+"  "+a.getName()+"  "+a.getAge()+"  "+a.getGender());System.out.println(b.getId()+"  "+b.getName()+"  "+b.getAge()+"  "+b.getGender());System.out.println(c.getId()+"  "+c.getName()+"  "+c.getAge()+"  "+c.getGender());}}

测试类

​         b)运行一下，得到下列结果。

JavaGroup1  LiMing  18  Man2  XiaoHong  19  Woman3  Messi  28  Man

运行结果

第四章 小结

     ​以上是对JAXB做了一个粗略的介绍,如果有不足之处，希望大家指出，我会努力改进。