【Java】JABX实现对象与XML互转

JABX简介

　　JAXB能够使用Jackson对JAXB注解的支持实现(jackson-module-jaxb-annotations)，既方便生成XML，也方便生成JSON，这样一来可以更好的标志可以转换为JSON对象的JAVA类。JAXB允许JAVA人员将JAVA类映射为XML表示方式，常用的注解包括：@XmlRootElement,@XmlElement等等。

　　JAXB（Java Architecture for XML Binding) 是一个业界的标准，是一项可以根据XML Schema产生Java类的技术。该过程中，JAXB也提供了将XML实例文档反向生成Java对象树的方法，并能将Java对象树的内容重新写到XML实例文档。从另一方面来讲，JAXB提供了快速而简便的方法将XML模式绑定到Java表示，从而使得Java开发者在Java应用程序中能方便地结合XML数据和处理函数。

JDK中JAXB相关的重要Class和Interface：

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

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

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

JDK中JAXB相关的重要Annotation：

　　@XmlType，将Java类或枚举类型映射到XML模式类型

　　@XmlAccessorType(XmlAccessType.FIELD) ，控制字段或属性的序列化。FIELD表示JAXB将自动绑定Java类中的每个非静态的（static）、非瞬态的（由@XmlTransient标注）字段到XML。其他值还有XmlAccessType.PROPERTY和XmlAccessType.NONE。

　　@XmlAccessorOrder，控制JAXB 绑定类中属性和字段的排序。

　　@XmlJavaTypeAdapter，使用定制的适配器（即扩展抽象类XmlAdapter并覆盖marshal()和unmarshal()方法），以序列化Java类为XML。

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

　　@XmlRootElement，将Java类或枚举类型映射到XML元素。

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

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

Marshaller接口和Unmarshaller接口

　　下面举例说明，将Java对象序列化为XML数据，以及将XML数据反序列化为Java对象

• pojo对象

   package test.hd.pojo;
   
   import javax.xml.bind.annotation.XmlAccessType;
   import javax.xml.bind.annotation.XmlAccessorType;
   import javax.xml.bind.annotation.XmlRootElement;
   import javax.xml.bind.annotation.XmlType;
   
   @XmlRootElement
   @XmlAccessorType(XmlAccessType.FIELD)
   //控制JAXB 绑定类中属性和字段的排序
   @XmlType(propOrder = {
        "age",
        "name"
   })
   public class Person {
   
       private String name;
   
       private Integer age;
   
       public String getName() {
           return name;
       }
   
       public void setName(String name) {
           this.name = name;
       }
   
       public Integer getAge() {
           return age;
       }
   
       public void setAge(Integer age) {
           this.age = age;
       }
   
   }

  　　

• 测试类 

   package test.hd.test_jaxb;
   
   import java.io.IOException;
   import java.io.StringReader;
   import java.io.Writer;
   
   import javax.xml.bind.JAXBContext;
   import javax.xml.bind.JAXBException;
   import javax.xml.bind.Marshaller;
   import javax.xml.bind.Unmarshaller;
   
   import com.sun.xml.internal.bind.marshaller.CharacterEscapeHandler;
   
   import test.hd.pojo.Person;
   
   public class Test {
   
       public static void main(String[] args) throws JAXBException {
   
           marshall();//对象转xml
           unMarshal();//xml转对象
       }
   
       /**
        * 对象转xml
        *
        * @throws JAXBException
        */
       public static void marshall() throws JAXBException {
           Person person = new Person();
           person.setName("H__D");
           person.setAge(11);
   
           JAXBContext context = JAXBContext.newInstance(Person.class);
           Marshaller marshaller = context.createMarshaller();
           marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");
           // xml格式
           marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
           // 去掉生成xml的默认报文头
           // marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true);
           // 不进行转义字符的处理
           marshaller.setProperty(CharacterEscapeHandler.class.getName(), new CharacterEscapeHandler() {
               public void escape(char[] ch, int start, int length, boolean isAttVal, Writer writer) throws IOException {
                   writer.write(ch, start, length);
               }
           });
           // 将XML打印到控制台
           marshaller.marshal(person, System.out);
   
       }
   
       /**
        * xml转对象
        *
        * @throws JAXBException
        */
       public static void unMarshal() throws JAXBException {
   
           JAXBContext context = JAXBContext.newInstance(Person.class);
           Unmarshaller unmarshaller = context.createUnmarshaller();
   
           Person p = (Person) unmarshaller.unmarshal(new StringReader("<person><name><![CDATA[H__D]]></name><age>11</age></person>"));
   
           System.out.println("person = " + p.getName() + "------" + p.getAge());
       }
   
   }

• 控制台输出
  

  JABX注解使用

• @XmlType 定义映射的一些相关规则
  参数：
   propOrder        指定映射XML时的节点顺序
   factoryClass     指定UnMarshal时生成映射类实例所需的工厂类，默认为这个类本身
   factoryMethod  指定工厂类的工厂方法
   name               定义XML Schema中type的名称
   namespace      指定Schema中的命名空间

• @XmlAccessorType  定义映射这个类中的何种类型需要映射到XML。可接收四个参数，分别是：

  XmlAccessType.FIELD：映射这个类中的所有字段到XML
   XmlAccessType.PROPERTY：映射这个类中的属性（get/set方法）到XML
   XmlAccessType.PUBLIC_MEMBER：将这个类中的所有public的field或property同时映射到XML（默认）
   XmlAccessType.NONE：不映射

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

  XmlAccessorOrder.ALPHABETICAL：对生成的xml元素按字母顺序排序；
       XmlAccessorOrder.UNDEFINED：不排序。

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

  XmlAdapter如下：
   @XmlElementWrapper注解表示生成一个包装 XML 表示形式的包装器元素。 此元素主要用于生成一个包装集合的包装器 XML 元素。

  例如需要输出CDATA格式的数据时，编写一个CDataAdapter类，然后使用XmlJavaTypeAdapter注解：

   package test.hd.util;
   
   import javax.xml.bind.annotation.adapters.XmlAdapter;
   
   /**
    * 有时候 Java 类不能自然映射到自己所需的 XML 形式，
    * 这时需要编写自己的适配器类，通过注解绑定到javabean的成员变量上，
    * 在运行的时候jaxb框架自动会适配你所编写的适配器类的方法，
    * CDataAdapter.marshal(String str)，将javabean的成员变量的value值
    * 转变成你想要的形式。
    * @author H__D
    * @date 2017年6月19日 下午4:32:00
    *
    */
   public class CDataAdapter extends XmlAdapter<String, String> {
   
       // 从javabean到xml的适配方法
       @Override
       public String marshal(String str) throws Exception {
           return "<![CDATA[" + str + "]]>";
       }
   
       // 从xml到javabean的适配方法
       @Override
       public String unmarshal(String str) throws Exception {
           return str;
       }
   
   }

   package test.hd.pojo;
   
   import java.io.Serializable;
   
   import javax.xml.bind.annotation.XmlAccessOrder;
   import javax.xml.bind.annotation.XmlAccessType;
   import javax.xml.bind.annotation.XmlAccessorOrder;
   import javax.xml.bind.annotation.XmlAccessorType;
   import javax.xml.bind.annotation.XmlRootElement;
   import javax.xml.bind.annotation.XmlType;
   import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
   
   import test.hd.util.CDataAdapter;
   
   @XmlRootElement
   @XmlAccessorType(XmlAccessType.FIELD)
   //控制JAXB 绑定类中属性和字段的排序
   @XmlType(propOrder = {
        "age",
        "name"
   })
   @XmlAccessorOrder(XmlAccessOrder.ALPHABETICAL)
   public class Person {
   
       @XmlJavaTypeAdapter(CDataAdapter.class)
       private String name;
   
       private Integer age;
   
       public String getName() {
           return name;
       }
   
       public void setName(String name) {
           this.name = name;
       }
   
       public Integer getAge() {
           return age;
       }
   
       public void setAge(Integer age) {
           this.age = age;
       }
   
   }

  输出如下
  

• @XmlElementWrapper  为数组元素或集合元素定义一个父节点。如，类中有一元素为List items，若不加此注解，该元素将被映射为

  <items>...</items>
      <items>...</items>

  这种形式，此注解可将这个元素进行包装，如：

  @XmlElementWrapper(name="items")
      @XmlElement(name="item")
      public List items;

  将会生成这样的XML样式：

  <items>
          <item>...</item>
          <item>...</item>
      </items>

• @XmlRootElement   将一个Java类映射为一段XML的根节点

  参数：
   name            定义这个根节点的名称
   namespace   定义这个根节点命名空间

• @XmlElement  指定一个字段或get/set方法映射到XML的节点。如，当一个类的XmlAccessorType 被标注为PROPERTY时，在某一个没有get/set方法的字段上标注此注解，即可将该字段映射到XML。
  参数：
           defaultValue 指定节点默认值
           name  指定节点名称
           namespace     指定节点命名空间
           required 是否必须（默认为false）
           nillable 该字段是否包含 nillable="true" 属性（默认为false）
           type  定义该字段或属性的关联类型
• @XmlAttribute  指定一个字段或get/set方法映射到XML的属性。
  参数：
   name  指定属性名称
   namespace     指定属性命名空间
   required 是否必须（默认为false）