JAXB

本文部分转自http://blog.csdn.net/czplplp_900725/article/details/7888896

在JDK1.6开始，SUN将JAXB放到了JDK中，配合JDK5的特性Annotation可以很方便的与jax-rs、jax-ws集成，极大的简化了web service接口的开发工作量。 

就因为如此，在webservice实现中为避免遇到这样那样的问题，对JAXB的API的熟悉是非常有必要的：

　　1.@XmlRootElement

　　用于类级别的注解，对应xml的根元素，常与 @XmlType 和 @XmlAccessorType一起使用。属性：name，用于为根元素节点取名。默认为类名。如：

@XmlRootElement(name = "REQUEST")　　// 根节点为REQUEST，
生成的XML:<?xml version="1.0" encoding="UTF-8" standalone="yes"?><REQUEST id="1"><NAME>李四</NAME><AGE>20</AGE></REQUEST>

　　2.@XmlAccessorType

　　用于指定由java对象生成xml文件时对java对象属性的访问方式。常与@XmlRootElement、@XmlType一起使用。它的属性值是XmlAccessType的4个枚举值，分别为：

　　XmlAccessType.FIELD:java对象中的所有成员变量

　　XmlAccessType.PROPERTY：java对象中所有通过getter/setter方式访问的成员变量

　　XmlAccessType.PUBLIC_MEMBER：java对象中所有的public访问权限的成员变量和通过getter/setter方式访问的成员变量

　　XmlAccessType.NONE:java对象的所有属性都不映射为xml的元素

　　注意：

　　a.@XmlAccessorType的默认访问级别是XmlAccessType.PUBLIC_MEMBER，因此，如果java对象中的private成员变量设置了public权限的getter/setter方法，就不要在private变量上使用@XmlElement和@XmlAttribute注解，否则在由java对象生成xml时会报同一个属性在java类里存在两次的错误。

　　b.如果@XmlAccessorType的访问权限为XmlAccessType.NONE，如果在java的成员变量上使用了@XmlElement或@XmlAttribute注解，这些成员变量依然可以映射到xml文件。

　　c.用了@XmlAccessorType(XmlAccessType.FIELD)，所以没有使用注解@XmlElement，xml中依然会生成这些元素。

　　3.@XmlAccessorOrder

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

　　XmlAccessorOrder.ALPHABETICAL：对生成的xml元素按字母书序排序

　　XmlAccessOrder.UNDEFINED:不排序

　　4.@XmlType

　　用在class类的注解，常与@XmlRootElement，@XmlAccessorType一起使用。它有三个属性：name、propOrder、namespace，经常使用的只有propOrder一个属性。

　　注意：

　　a.对于@XmlElementWrapper标注的属性，不能出现在@XmlType的propOrder列表中。

　　 b.对于所有@XmlElement标注过的属性，必须出现在@XmlType的propOrder列表中。

　　5.@XmlAttribute

　　用于把java对象的属性映射为xml的属性,并可通过name属性为生成的xml属性指定别名。如：

    @XmlAttribute
    public int ID;

　　6.@XmlElement

　　将java对象的属性映射为xml的节点，在使用@XmlElement时，可通过name属性改变java对象属性在xml中显示的名称。如：

　　@XmlElement(name = "REAL_NAME")
　　public String NAME;

　　7.@XmlTransient

　　@XmlTransient用于标示在由java对象映射xml时，忽略此属性。即，在生成的xml文件中不出现此元素。

　　8.@XmlJavaTypeAdapter

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

　　@XmlJavaTypeAdapter(value=xxx.class)，value为自己定义的adapter类。

　　9.@XmlElementWrapper  

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

<WORKER id="1">
　　<REAL_NAME>工人1</REAL_NAME>
　　<AGE>0</AGE>
</WORKER>
<WORKER id="2">
　　<REAL_NAME>工人2</REAL_NAME>
　　<AGE>0</AGE>
</WORKER>

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

　　@XmlElementWrapper(name="WORKERS")
　　@XmlElement(name="WORKER")
　　public List<Worker> WORKER;

将会生成这样的XML样式：

<WORKERS>
  　<WORKER id="1">
  　　　 <REAL_NAME>工人1</REAL_NAME>
  　　　 <AGE>0</AGE>
  　</WORKER>
  　<WORKER id="2">
  　　　 <REAL_NAME>工人2</REAL_NAME>
        <AGE>0</AGE>
    </WORKER>
</WORKERS>

　　10.@XmlSeeAlso

指示JAXB，包装此类的同时，包装子类。也就是让子类继承父类的xml包装逻辑。该注解写在父类里。如：

@XmlSeeAlso({ Employee.class,Boss.class })

用例代码如下：

• java类

实体类 - 基类：Person.java

package model;
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.XmlSeeAlso;
import javax.xml.bind.annotation.XmlTransient;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import adapter.DateTimeAdapter;
 
@XmlAccessorType(XmlAccessType.FIELD)
@XmlSeeAlso({Employee.class,Boss.class})
@XmlType(propOrder = {
        "ID",
        "NAME",
        "AGE",
        "BIRTH",
        "EMAIL",
        "ZIP",
        "ADDRESS"
})
public class Person {
    @XmlAttribute
    public int ID;
    @XmlElement(name = "REAL_NAME")
    public String NAME;
    @XmlElement
    public int AGE;
    @XmlElement
    @XmlJavaTypeAdapter(value = DateTimeAdapter.class)
    public Date BIRTH;
    @XmlTransient
    public String JOB;
    public String EMAIL;
    public String ZIP;
    public String ADDRESS;
    
    public int getID() {
        return ID;
    }
    public void setID(int iD) {
        ID = iD;
    }
    public String getNAME() {
        return NAME;
    }
    public void setNAME(String nAME) {
        NAME = nAME;
    }
    public int getAGE() {
        return AGE;
    }
    public void setAGE(int aGE) {
        AGE = aGE;
    }
    public Date getBIRTH() {
        return BIRTH;
    }
    public void setBIRTH(Date bIRTH) {
        BIRTH = bIRTH;
    }
    public String getEMAIL() {
        return EMAIL;
    }
    public void setEMAIL(String eMAIL) {
        EMAIL = eMAIL;
    }
    public String getZIP() {
        return ZIP;
    }
    public void setZIP(String zIP) {
        ZIP = zIP;
    }
    public String getADDRESS() {
        return ADDRESS;
    }
    public void setADDRESS(String aDDRESS) {
        ADDRESS = aDDRESS;
    }
    public String getJOB() {
        return JOB;
    }
    public void setJOB(String jOB) {
        JOB = jOB;
    }
}

子类：Boss.java

package model;
import java.util.List;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
import javax.xml.bind.annotation.XmlRootElement;
 
@XmlRootElement(name = "REQUEST")
public class Boss extends Person{
    @XmlElementWrapper(name="WORKERS")  
    @XmlElement(name="WORKER")  
    public List<Worker> WORKER;
    
    public List<Worker> getWORKER() {
        return WORKER;
    }
    public void setWORKER(List<Worker> wORKER) {
        WORKER = wORKER;
    }    
}

子类：Worker.java

package model;

public class Worker extends Person{

}

适配器类：DateTimeAdapter.java

package adapter;
import java.text.SimpleDateFormat;
import java.util.Date;
import javax.xml.bind.annotation.adapters.XmlAdapter;

public class DateTimeAdapter extends XmlAdapter<String, Date> {

    private SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

    @Override
    public String marshal(Date v) throws Exception {
        return dateFormat.format(v);
    }

    @Override
    public Date unmarshal(String v) throws Exception {
        return dateFormat.parse(v);
    }
}

main：JaxbTest1.java

package jaxb;
import java.io.StringReader;
import java.io.StringWriter;
import java.io.Writer;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.List;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBElement;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.bind.Unmarshaller;
import javax.xml.transform.stream.StreamSource;
import model.Boss;
import model.Worker;

public class JaxbTest1 {
    public static void main(String[] args) throws JAXBException, ParseException {
        
        Boss boss = new Boss();
        boss.setID(1);
        boss.setNAME("李四");
        boss.setAGE(20);
        
        boss.setEMAIL("abc@163.com");
        boss.setZIP("000000");
        boss.setADDRESS("中华人民共和国");
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        boss.setBIRTH(dateFormat.parse("1990-09-09 09:09:09"));
        boss.setJOB("教师");

        Worker worker1 = new Worker();
        worker1.setID(1);
        worker1.setNAME("工人1");

        Worker worker2 = new Worker();
        worker2.setID(2);
        worker2.setNAME("工人2");
        
        List<Worker> workers = new ArrayList<Worker>();
        workers.add(worker1);
        workers.add(worker2);
        boss.setWORKER(workers); 
        
        JAXBContext context = JAXBContext.newInstance(Boss.class);
        Marshaller marsheller = context.createMarshaller();
        Unmarshaller unmarsheller = context.createUnmarshaller();
        
        // marshal
        System.err.println("marshal:");
        Writer writer = new StringWriter();
        marsheller.marshal(boss, writer);
        String xml = writer.toString();
        System.out.println(xml);
        System.out.println();
        
        // unmarshal
        // String xml = "<REQUEST><REAL_NAME>zhangsan</REAL_NAME></REQUEST>";
        JAXBElement<Boss> root = unmarsheller.unmarshal(new StreamSource(new StringReader(xml)),Boss.class);
        Boss boss2 = root.getValue();
        System.err.println("unmarshal:");
        System.out.println(boss2.getNAME());
    }
}

输出：

marshal:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<REQUEST id="1">
　　<REAL_NAME>李四</REAL_NAME>
　　<AGE>20</AGE>
　　<BIRTH>1990-09-09 09:09:09</BIRTH>
　　<EMAIL>abc@163.com</EMAIL>
　　<ZIP>000000</ZIP>
　　<ADDRESS>中华人民共和国</ADDRESS>
　　<WORKERS>
　　　　<WORKER id="1">
　　　　　　<REAL_NAME>工人1</REAL_NAME>
　　　　　　<AGE>0</AGE>
　　　　</WORKER>
　　　　<WORKER id="2">
　　　　　　<REAL_NAME>工人2</REAL_NAME>
　　　　　　<AGE>0</AGE>
　　　　</WORKER>
　　</WORKERS>
</REQUEST>

unmarshal:
李四

有纰漏之处，欢迎大家的指正建议。

环境：JDK1.6，MAVEN，eclipse

源码地址：http://files.cnblogs.com/files/xiluhua/JAXB.rar

JDK地址：http://pan.baidu.com/s/1i3L6hal