【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对象 
     1 package test.hd.pojo;
 2 
 3 
 4 import javax.xml.bind.annotation.XmlAccessType;
 5 import javax.xml.bind.annotation.XmlAccessorType;
 6 import javax.xml.bind.annotation.XmlRootElement;
 7 import javax.xml.bind.annotation.XmlType;
 8 
 9 
10 @XmlRootElement
11 @XmlAccessorType(XmlAccessType.FIELD)
12 //控制JAXB 绑定类中属性和字段的排序  
13 @XmlType(propOrder = {   
14      "age",   
15      "name" 
16 })  
17 public class Person {
18 
19     private String name;
20     
21     private Integer age;
22 
23     public String getName() {
24         return name;
25     }
26 
27     public void setName(String name) {
28         this.name = name;
29     }
30 
31     public Integer getAge() {
32         return age;
33     }
34 
35     public void setAge(Integer age) {
36         this.age = age;
37     }
38     
39 }
    　　
  • 测试类  
     1 package test.hd.test_jaxb;
 2 
 3 import java.io.IOException;
 4 import java.io.StringReader;
 5 import java.io.Writer;
 6 
 7 import javax.xml.bind.JAXBContext;
 8 import javax.xml.bind.JAXBException;
 9 import javax.xml.bind.Marshaller;
10 import javax.xml.bind.Unmarshaller;
11 
12 import com.sun.xml.internal.bind.marshaller.CharacterEscapeHandler;
13 
14 import test.hd.pojo.Person;
15 
16 public class Test {
17 
18     public static void main(String[] args) throws JAXBException {
19 
20         marshall();//对象转xml
21         unMarshal();//xml转对象
22     }
23 
24     /**
25      * 对象转xml
26      * 
27      * @throws JAXBException
28      */
29     public static void marshall() throws JAXBException {
30         Person person = new Person();
31         person.setName("H__D");
32         person.setAge(11);
33 
34         JAXBContext context = JAXBContext.newInstance(Person.class);
35         Marshaller marshaller = context.createMarshaller();
36         marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");
37         // xml格式
38         marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
39         // 去掉生成xml的默认报文头
40         // marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true);
41         // 不进行转义字符的处理
42         marshaller.setProperty(CharacterEscapeHandler.class.getName(), new CharacterEscapeHandler() {
43             public void escape(char[] ch, int start, int length, boolean isAttVal, Writer writer) throws IOException {
44                 writer.write(ch, start, length);
45             }
46         });
47         // 将XML打印到控制台
48         marshaller.marshal(person, System.out);
49 
50     }
51 
52     /**
53      * xml转对象
54      * 
55      * @throws JAXBException
56      */
57     public static void unMarshal() throws JAXBException {
58 
59         JAXBContext context = JAXBContext.newInstance(Person.class);
60         Unmarshaller unmarshaller = context.createUnmarshaller();
61 
62         Person p = (Person) unmarshaller.unmarshal(new StringReader("<person><name><![CDATA[H__D]]></name><age>11</age></person>"));
63 
64         System.out.println("person = " + p.getName() + "------" + p.getAge());
65     }
66 
67 }

  • 控制台输出


    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注解：

     1 package test.hd.util;
 2 
 3 import javax.xml.bind.annotation.adapters.XmlAdapter;
 4 
 5 /**
 6  * 有时候 Java 类不能自然映射到自己所需的 XML 形式，
 7  * 这时需要编写自己的适配器类，通过注解绑定到javabean的成员变量上，
 8  * 在运行的时候jaxb框架自动会适配你所编写的适配器类的方法，
 9  * CDataAdapter.marshal(String str)，将javabean的成员变量的value值
10  * 转变成你想要的形式。
11  * @author H__D
12  * @date 2017年6月19日 下午4:32:00
13  *
14  */
15 public class CDataAdapter extends XmlAdapter<String, String> {
16 
17     // 从javabean到xml的适配方法
18     @Override
19     public String marshal(String str) throws Exception {
20         return "<![CDATA[" + str + "]]>";
21     }
22 
23     // 从xml到javabean的适配方法
24     @Override
25     public String unmarshal(String str) throws Exception {
26         return str;
27     }
28 
29 }
     1 package test.hd.pojo;
 2 
 3 import java.io.Serializable;
 4 
 5 import javax.xml.bind.annotation.XmlAccessOrder;
 6 import javax.xml.bind.annotation.XmlAccessType;
 7 import javax.xml.bind.annotation.XmlAccessorOrder;
 8 import javax.xml.bind.annotation.XmlAccessorType;
 9 import javax.xml.bind.annotation.XmlRootElement;
10 import javax.xml.bind.annotation.XmlType;
11 import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
12 
13 import test.hd.util.CDataAdapter;
14 
15 @XmlRootElement
16 @XmlAccessorType(XmlAccessType.FIELD)
17 //控制JAXB 绑定类中属性和字段的排序  
18 @XmlType(propOrder = {   
19      "age",   
20      "name" 
21 })  
22 @XmlAccessorOrder(XmlAccessOrder.ALPHABETICAL)
23 public class Person {
24 
25     @XmlJavaTypeAdapter(CDataAdapter.class)
26     private String name;
27     
28     private Integer age;
29 
30     public String getName() {
31         return name;
32     }
33 
34     public void setName(String name) {
35         this.name = name;
36     }
37 
38     public Integer getAge() {
39         return age;
40     }
41 
42     public void setAge(Integer age) {
43         this.age = age;
44     }
45     
46     
47     
48 }

    输出如下


  • @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）
【推广】 免费学中医，健康全家人
原文地址：https://www.cnblogs.com/h--d/p/7050099.html