JAVA 和 XML --- JAXB 那些事情

来源：互联网发布：淘宝返现机器人编辑：程序博客网时间：2024/05/29 10:18

序言

我们的一个合作伙伴，正在使用Java技术开发专业领域内的CAD二维图像应用软件。随着Java技术的不断发展，其虚拟机的速度不断的提高，越来越多的厂商使用Java语言作为他们图形软件跨平台的解决方案。特别是JDK1.4推出以后，对图形图像的操作，性能有了显著的提高。在某些二维图形图像的类（如VolatileImage）中，能够直接操纵硬件加速的图像缓存，甚至使得Java成为图形游戏的开发平台成为可能。

为了加快开发的速度，我们的合作伙伴选择了Java本身的对象序列化（serialization）技术来作为应用数据的存储。换句话说，应用程序中的所有图形图像，不管是“按钮”还是“线条”，都以对象序列化方式存储到文件系统中；在使用的时候，从文件中读出数据，恢复成内存中的Java对象。这样做的好处是简单，所有对象数据的存储和恢复都由Java平台内部的序列化机制来完成，数据保存的格式（二进制）也由Java来制定；并且在性能上，这种方法也是不错的，特别是在JDK1.4上，对象序列化的速度有了很大的提高，使得序列化技术应用得越来越广泛，不仅仅用于对象数据的存储，还大量的应用于各种分布式网络计算模型中。

但是，我们的合作伙伴在产品开发和版本升级过程中遇到了一些问题。

l 数据的兼容性差
在升级的版本中，如果对Java类的改动超出了对象序列化兼容性的范围，如：改变了类图结构中的继承关系和层次结构，改变或增减了类成员变量数量和类型等等，都会造成新老版本的数据不一致性。很有可能新版本的系统不能兼容和使用老版本系统产生的数据。

l 对数据的操作性差。
由于序列化所产生的数据是由JVM内部机制生成的二进制数据，对其进行修改和转换有一定的困难和风险。而且二进制数据的可读性比较差。而对这些图形数据的操作是此系统不可缺少的一部分。例如，不同版本之间的数据转换，不同格式之间的转换以及系统数据的导入和导出，都需要对系统数据进行不同程度的操作。

l 数据的保存量大。
用序列化保存的数据通常包含了大量无用的信息。例如，保存一个简单的"Button"，序列化会保存它所有父类对象的所有实例的成员变量，还会保存这个对象所有缺省的其他属性。而实际上，我们只要关心这个"Button"上面的文本，加上它在图面中的坐标就行了。要控制序列化保存数据量的大小需要较复杂和繁琐的设置，例如使用“transit”修饰符等等（详见参考资料）。

l JDK版本的影响。
不同的JDK的序列化实现有可能会有差异，保存数据的格式也有所不同，这就使得系统有可能被绑定在某个版本的JDK，而不能使用高版本的JDK所带来的性能上和功能上的好处！

一. XML数据表示和JAXB的解决方案

由于存在以上的问题，需要考虑采用其他的解决方案，以保证即能够保证数据操作的灵活性，又能够使用现有的数据格式和成熟的开发工具包，减轻系统开发和维护的负担。

“XML”成为被考虑的目标之一。显然，具有“通用数据表示”之称的XML能够带来很大的灵活性，使得数据在各个平台之间的交换，各个版本之间的升级变得非常方便；而且，在XML的开发中，Java平台已经拥有很多成熟的软件开发工具和解决方案。一般来说，使用XML作为系统数据存储的格式有以下两种解决方案：

l 直接使用Java对象序列化的内部对XML的支持功能：XmlEncoder和XMLDecoder两个类。这个功能其实是对象序列化功能本身的一部分，通过使用XmlEncoder和XMLDecoder这两个类，可以使序列化的数据以XML的格式保存和恢复，而不是二进制格式。这种方式增加了对数据的可读性和可操作性。但是仍然不能灵活地按照自己的意愿和需求对数据进行保存和恢复。

l 自己定义XML的数据格式。这个方案使系统拥有了最大的灵活程度。一旦使用自己定义的XML格式，那么对此XML格式的文件进行解析、效验以及反向解析（XML文件的生成）都需要自己去开发了！一旦版本发生更新，XML的数据格式也有可能随着改变，这些解析和效验程序都有可能需要做出相应的改动。这样会大大增加了系统开发的负担和周期！

JAXB正是为解决这些问题而提出来的。在允许你自己灵活定义自己的 XML文件格式的基础上，由JAXB替你生成操作XML文件的源代码，使你的应用程序将重点放到Java对象上，而不用直接面对XML操作。这正是JAXB的目的所在。

二. 什么是JAXB？

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

这意味着你不需要处理甚至不需要知道XML编程技巧就能在Java应用程序中利用平台核心XML数据的灵活性。而且，可以充分利用XML的优势而不用依赖于复杂的XML处理模型如SAX或DOM。JAXB 隐藏了细节并且取消了SAX和DOM中没用的关系——生成的JAXB类仅描述原始模型中定义的关系。其结果是结合了高度可移植Java代码和高度可移植的XML数据。其中这些代码可用来创建灵活、轻便的应用程序和Web服务。 JAXB（Java Architecture for XML Binding) 是一个业界的标准，是一项可以根据XML Schema产生Java类的技术。该过程中，JAXB也提供了将XML实例文档反向生成Java对象树的方法，并能将Java对象树的内容重新写到 XML实例文档。 Jaxb 2.0是JDK 1.6的组成部分。我们不需要下载第三方jar包即可做到轻松转换。Jaxb2使用了JDK的新特性，如：Annotation、GenericType等，需要在即将转换的JavaBean中添加annotation注解。

三、重要概念

JAXBContext类，是应用的入口，用于管理XML/Java绑定信息。
Marshaller接口，将Java对象序列化为XML数据。
Unmarshaller接口，将XML数据反序列化为Java对象。

@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属性。

四、示例

1、准备工作

Java代码  
package utils;  
  
import java.io.StringReader;  
import java.io.StringWriter;  
  
import javax.xml.bind.JAXBContext;  
import javax.xml.bind.Marshaller;  
import javax.xml.bind.Unmarshaller;  
  
/** 
 * Jaxb2工具类 
 * @author      zhuc 
 * @create      2013-3-29 下午2:40:14 
 */  
public class JaxbUtil {  
  
    /** 
     * JavaBean转换成xml 
     * 默认编码UTF-8 
     * @param obj 
     * @param writer 
     * @return  
     */  
    public static String convertToXml(Object obj) {  
        return convertToXml(obj, "UTF-8");  
    }  
  
    /** 
     * 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);  
  
            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;  
    }  
}  

非常简单易懂，需要注意的是

Java代码  
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);  
marshaller.setProperty(Marshaller.JAXB_ENCODING, encoding);  

Marshaller.JAXB_FORMATTED_OUTPUT 决定是否在转换成xml时同时进行格式化（即按标签自动换行，否则即是一行的xml）

Marshaller.JAXB_ENCODING xml的编码方式

另外，Marshaller 还有其他Property可以设置，可以去查阅api。

2、最简单转换

Java代码  
package t1;  
  
import java.util.Date;  
  
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;  
  
/** 
 * @author      zhuc 
 * @create      2013-3-29 下午2:49:48 
 */  
@XmlAccessorType(XmlAccessType.FIELD)  
@XmlRootElement  
@XmlType(name = "book", propOrder = { "author", "calendar", "price", "id" })  
public class Book {  
  
    @XmlElement(required = true)  
    private String author;  
  
    @XmlElement(name = "price_1", required = true)  
    private float price;  
  
    @XmlElement  
    private Date calendar;  
  
    @XmlAttribute  
    private Integer id;  
  
    /** 
     * @return the author 
     */  
    public String getAuthor() {  
        return author;  
    }  
  
    /** 
     * @return the price 
     */  
    public float getPrice() {  
        return price;  
    }  
  
    /** 
     * @return the calendar 
     */  
    public Date getCalendar() {  
        return calendar;  
    }  
  
    /** 
     * @return the id 
     */  
    public Integer getId() {  
        return id;  
    }  
  
    /** 
     * @param author the author to set 
     */  
    public void setAuthor(String author) {  
        this.author = author;  
    }  
  
    /** 
     * @param price the price to set 
     */  
    public void setPrice(float price) {  
        this.price = price;  
    }  
  
    /** 
     * @param calendar the calendar to set 
     */  
    public void setCalendar(Date calendar) {  
        this.calendar = calendar;  
    }  
  
    /** 
     * @param id the id to set 
     */  
    public void setId(Integer id) {  
        this.id = id;  
    }  
  
    /* (non-Javadoc) 
     * @see java.lang.Object#toString() 
     */  
    @Override  
    public String toString() {  
        return "Book [author=" + author + ", price=" + price + ", calendar=" + calendar + ", id=" + id + "]";  
    }  
  
}  

Java代码  
package t1;  
  
import java.util.Date;  
  
import javax.xml.bind.JAXBException;  
  
import org.junit.Test;  
  
import utils.JaxbUtil;  
  
/** 
 * @author      zhuc 
 * @create      2013-3-29 下午2:50:00 
 */  
public class JaxbTest1 {  
  
    /** 
     * @throws JAXBException 
     */  
    @Test  
    public void showMarshaller()  {  
        Book book = new Book();  
        book.setId(100);  
        book.setAuthor("James");  
        book.setCalendar(new Date());  
        book.setPrice(23.45f);   //默认是0.0  
          
        String str = JaxbUtil.convertToXml(book);  
        System.out.println(str);  
    }  
  
    /** 
     * @throws JAXBException 
     */  
    @Test  
    public void showUnMarshaller() {  
        String str = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>" +  
            "<book id=\"100\">" +  
            "    <author>James</author>" +  
             "   <calendar>2013-03-29T09:25:56.004+08:00</calendar>" +  
              "  <price_1>23.45</price_1>" +  
            "</book>";  
          
        Book book = JaxbUtil.converyToJavaBean(str, Book.class);  
        System.out.println(book);  
    }  
}  

输出结果分别为：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<book id="100">
    <author>James</author>
    <calendar>2013-03-29T14:50:58.974+08:00</calendar>
    <price_1>23.45</price_1>
</book>

Book [author=James, price=23.45, calendar=Fri Mar 29 09:25:56 CST 2013, id=100]

3、类中包含复杂对象的转换

Java代码  
package t2;  
  
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;  
  
/** 
 * @author      zhuc 
 * @create      2013-3-29 下午2:51:44 
 */  
@XmlAccessorType(XmlAccessType.FIELD)  
@XmlRootElement(name = "student")  
@XmlType(propOrder = {})  
public class Student {  
  
    @XmlAttribute  
    private Integer id;  
  
    @XmlElement  
    private String name;  
  
    @XmlElement(name = "role")  
    private Role role;  
  
    /** 
     * @return the id 
     */  
    public Integer getId() {  
        return id;  
    }  
  
    /** 
     * @return the name 
     */  
    public String getName() {  
        return name;  
    }  
  
    /** 
     * @return the role 
     */  
    public Role getRole() {  
        return role;  
    }  
  
    /** 
     * @param id the id to set 
     */  
    public void setId(Integer id) {  
        this.id = id;  
    }  
  
    /** 
     * @param name the name to set 
     */  
    public void setName(String name) {  
        this.name = name;  
    }  
  
    /** 
     * @param role the role to set 
     */  
    public void setRole(Role role) {  
        this.role = role;  
    }  
  
    /* (non-Javadoc) 
     * @see java.lang.Object#toString() 
     */  
    @Override  
    public String toString() {  
        return "Student [id=" + id + ", name=" + name + ", role=" + role + "]";  
    }  
  
}  

Java代码  
package t2;  
  
import javax.xml.bind.annotation.XmlAccessType;  
import javax.xml.bind.annotation.XmlAccessorType;  
import javax.xml.bind.annotation.XmlElement;  
import javax.xml.bind.annotation.XmlType;  
  
/** 
 * @author      zhuc 
 * @create      2013-3-29 下午2:51:52 
 */  
@XmlAccessorType(XmlAccessType.FIELD)  
@XmlType(propOrder = { "name", "desc" })  
public class Role {  
  
    @XmlElement  
    private String name;  
  
    @XmlElement  
    private String desc;  
  
    /** 
     * @return the name 
     */  
    public String getName() {  
        return name;  
    }  
  
    /** 
     * @return the desc 
     */  
    public String getDesc() {  
        return desc;  
    }  
  
    /** 
     * @param name the name to set 
     */  
    public void setName(String name) {  
        this.name = name;  
    }  
  
    /** 
     * @param desc the desc to set 
     */  
    public void setDesc(String desc) {  
        this.desc = desc;  
    }  
  
    /* (non-Javadoc) 
     * @see java.lang.Object#toString() 
     */  
    @Override  
    public String toString() {  
        return "Role [name=" + name + ", desc=" + desc + "]";  
    }  
  
}  

Java代码  
package t2;  
  
import org.junit.Test;  
  
import utils.JaxbUtil;  
  
/** 
 * @author      zhuc 
 * @create      2013-3-29 下午2:52:00 
 */  
public class JaxbTest2 {  
  
    @Test  
    public void showMarshaller() {  
  
        Student student = new Student();  
        student.setId(12);  
        student.setName("test");  
  
        Role role = new Role();  
        role.setDesc("管理");  
        role.setName("班长");  
  
        student.setRole(role);  
  
        String str = JaxbUtil.convertToXml(student);  
        System.out.println(str);  
    }  
  
    @Test  
    public void showUnMarshaller() {  
        String str = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>"+  
            "<student id=\"12\">"+  
            "    <name>test</name>"+  
             "   <role>"+  
              "      <name>班长</name>"+  
               "     <desc>管理</desc>"+  
                "</role>"+  
            "</student>";  
        Student student = JaxbUtil.converyToJavaBean(str, Student.class);  
        System.out.println(student);  
    }  
      
}  

输出结果分别为：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<student id="12">
    <name>test</name>
    <role>
        <name>班长</name>
        <desc>管理</desc>
    </role>
</student>

Student [id=12, name=test, role=Role [name=班长, desc=管理]]

4、集合对象的转换（同样适用于Set）

Java代码  
package t3;  
  
import java.util.List;  
  
import javax.xml.bind.annotation.XmlAccessType;  
import javax.xml.bind.annotation.XmlAccessorType;  
import javax.xml.bind.annotation.XmlElement;  
import javax.xml.bind.annotation.XmlElementWrapper;  
import javax.xml.bind.annotation.XmlRootElement;  
import javax.xml.bind.annotation.XmlType;  
  
/** 
 * @author      zhuc 
 * @create      2013-3-29 下午2:55:56 
 */  
@XmlAccessorType(XmlAccessType.FIELD)  
@XmlRootElement(name = "country")  
@XmlType(propOrder = { "name", "provinceList" })  
public class Country {  
  
    @XmlElement(name = "country_name")  
    private String name;  
  
    @XmlElementWrapper(name = "provinces")  
    @XmlElement(name = "province")  
    private List<Province> provinceList;  
  
    /** 
     * @return the name 
     */  
    public String getName() {  
        return name;  
    }  
  
    /** 
     * @return the provinceList 
     */  
    public List<Province> getProvinceList() {  
        return provinceList;  
    }  
  
    /** 
     * @param name the name to set 
     */  
    public void setName(String name) {  
        this.name = name;  
    }  
  
    /** 
     * @param provinceList the provinceList to set 
     */  
    public void setProvinceList(List<Province> provinceList) {  
        this.provinceList = provinceList;  
    }  
  
    /* (non-Javadoc) 
     * @see java.lang.Object#toString() 
     */  
    @Override  
    public String toString() {  
        return "Country [name=" + name + ", provinceList=" + provinceList + "]";  
    }  
  
}  

Java代码  
package t3;  
  
import javax.xml.bind.annotation.XmlAccessType;  
import javax.xml.bind.annotation.XmlAccessorType;  
import javax.xml.bind.annotation.XmlElement;  
import javax.xml.bind.annotation.XmlType;  
  
/** 
 * @author      zhuc 
 * @create      2013-3-29 下午2:56:03 
 */  
@XmlAccessorType(XmlAccessType.FIELD)  
@XmlType(propOrder = { "name", "provCity" })  
public class Province {  
  
    @XmlElement(name = "province_name")  
    private String name;  
  
    @XmlElement(name = "prov_city")  
    private String provCity;  
  
    /** 
     * @return the provCity 
     */  
    public String getProvCity() {  
        return provCity;  
    }  
  
    /** 
     * @param provCity the provCity to set 
     */  
    public void setProvCity(String provCity) {  
        this.provCity = provCity;  
    }  
  
    /** 
     * @return the name 
     */  
    public String getName() {  
        return name;  
    }  
  
    /** 
     * @param name the name to set 
     */  
    public void setName(String name) {  
        this.name = name;  
    }  
  
    /* (non-Javadoc) 
     * @see java.lang.Object#toString() 
     */  
    @Override  
    public String toString() {  
        return "Province [name=" + name + ", provCity=" + provCity + "]";  
    }  
  
}  

Java代码  
package t3;  
  
import java.util.ArrayList;  
import java.util.List;  
  
import org.junit.Test;  
  
import utils.JaxbUtil;  
  
/** 
 * @author      zhuc 
 * @create      2013-3-29 下午2:56:11 
 */  
public class JaxbTest3 {  
  
    /** 
     * @throws JAXBException 
     */  
    @Test  
    public void showMarshaller() {  
        Country country = new Country();  
        country.setName("中国");  
  
        List<Province> list = new ArrayList<Province>();  
        Province province = new Province();  
        province.setName("江苏省");  
        province.setProvCity("南京市");  
        Province province2 = new Province();  
        province2.setName("浙江省");  
        province2.setProvCity("杭州市");  
        list.add(province);  
        list.add(province2);  
  
        country.setProvinceList(list);  
  
        String str = JaxbUtil.convertToXml(country);  
        System.out.println(str);  
    }  
  
    /** 
     *  
     */  
    @Test  
    public void showUnMarshaller() {  
        String str = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>"+  
            "<country>"+  
            "    <country_name>中国</country_name>"+  
            "    <provinces>"+  
            "        <province>"+  
            "            <province_name>江苏省</province_name>"+  
             "           <prov_city>南京市</prov_city>"+  
            "        </province>"+  
             "       <province>"+  
             "           <province_name>浙江省</province_name>"+  
             "           <prov_city>杭州市</prov_city>"+  
             "       </province>"+  
            "    </provinces>"+  
            "</country>";  
        Country country = JaxbUtil.converyToJavaBean(str, Country.class);  
        System.out.println(country);  
    }  
      
}  

输出结果分别为：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<country>
    <country_name>中国</country_name>
    <provinces>
        <province>
            <province_name>江苏省</province_name>
            <prov_city>南京市</prov_city>
        </province>
        <province>
            <province_name>浙江省</province_name>
            <prov_city>杭州市</prov_city>
        </province>
    </provinces>
</country>

Country [name=中国, provinceList=[Province [name=江苏省, provCity=南京市], Province [name=浙江省, provCity=杭州市]]]

0 0