【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）