JAXB中的@XmlRootElement注解詳解

Java代碼

@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface XmlRootElement

@Inherited
@Retention(value=RUNTIME)
@Target(value={PACKAGE,TYPE})
public @interface XmlAccessorType

XmlRootElement: 將類或枚舉類型映射到 XML 元素。JAXB中的注解，用來根據java類生成xml內容。 

當使用 @XmlRootElement 注釋對頂層類或枚舉類型進行注釋時，類型值被表示為 XML 文檔中的 XML 元素。 

JAXB Annotation 

• @XmlRootElement   // xml 文件的根元素
• @XmlElement
• @XmlAccessorType  // 控制默認情況下是否對字段或 Javabean 屬性進行系列化。
• @XmlTransient
• @XmlJavaTypeAdaptor:參考Using JAXB 2.0's XmlJavaTypeAdapter

XmlAccessorType  
默認規則： 
默認情況下，如果包中不存在 @XmlAccessorType，那么假定使用以下包級別注釋。 
@XmlAccessorType(XmlAccessType.PUBLIC_MEMBER) 
默認情況下，如果類中不存在 @XmlAccessorType，並且沒有任何超類是使用 @XmlAccessorType 注釋的，則假定在類中使用以下默認注釋： 
@XmlAccessorType(XmlAccessType.PUBLIC_MEMBER) 
可能值： 
FIELD:    JAXB 綁定類中的每個非靜態、非瞬態字段將會自動綁定到 XML，除非由 XmlTransient 注釋。 
NONE:     所有字段或屬性都不能綁定到 XML，除非使用一些 JAXB 注釋專門對它們進行注釋。 
PROPERTY: JAXB 綁定類中的每個獲取方法/設置方法對將會自動綁定到 XML，除非由 XmlTransient 注釋。 
PUBLIC_MEMBER:每個公共獲取方法/設置方法對和每個公共字段將會自動綁定到 XML，除非由 XmlTransient 注釋。 

應用參考：http://blog.sina.com.cn/s/blog_4051f5dc0100ju0a.html 

package jaxb;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlAccessType;

@XmlRootElement // 必須要標明這個元素
@XmlAccessorType(XmlAccessType.FIELD)
public class Boy {
    String name = "CY";
}

package jaxb;

import java.io.StringReader;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.bind.Unmarshaller;

public class JAXBTest {

    public static void main(String[] args) throws JAXBException {
        JAXBContext context = JAXBContext.newInstance(Boy.class);

        Marshaller marshaller = context.createMarshaller();
        Unmarshaller unmarshaller = context.createUnmarshaller();

        Boy boy = new Boy();
        marshaller.marshal(boy, System.out);
        System.out.println();

        String xml = "<boy><name>David</name></boy>";
        Boy boy2 = (Boy) unmarshaller.unmarshal(new StringReader(xml));
        System.out.println(boy2.name);
    }
}

執行結果： 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><boy><name>CY</name></boy> 
David 
（先 是marshall成 xml文件，再是把 xml 文件 unmarshal 成 java object。） 

改動一： 
修改@XmlAccessorType(XmlAccessType.FIELD)  --> @XmlAccessorType(XmlAccessType.PROPERTY) 
意思是只有 屬性 才能被轉換成 xml 中的標簽。 

所以再運行的結果是： 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><boy/> 
CY 
就是說 java object 轉換成 xml 的時候，name 不是屬性（因為沒有 get set方法），所以name不轉換成標簽。 

改動二： 
在 改動一 的基礎上，給name屬性添加 get set 方法。 再運行，結果為： 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><boy><name>CY</name></boy> 
David 
由 此 可見 @XmlAccessorType 這個annotation 的作用。 

改動三： 
在改動二 的基礎上，給Boy 再添加一個field， int age=10, 即： 

package jaxb;

import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlAccessType;

@XmlRootElement
@XmlAccessorType(XmlAccessType.PROPERTY)
public class Boy {
    String name = "CY";
    int age = 10;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

顯然，這個age 是不會被 轉化 到xml 文件中的。解決辦法是： 

import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlAccessType;

@XmlRootElement // bixude
@XmlAccessorType(XmlAccessType.PROPERTY)
public class Boy {

    String name = "CY";
    @XmlElement
    int age = 10;
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

加上 @XmlElement annotation. 運行結果為： 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><boy><age>10</age> <name>CY</name></boy> 
David 

對於根元素，可以設置屬性： 
@XmlRootElement(name="b" nameSpace="http://test") 
這樣，在生成的xml文件中，<boy> 標簽 就會變為 <b> 標簽。並且加上一個命名空間。 


下面解釋 @XmlJavaTypeAdaptor 的作用： 

@XmlRootElement
@XmlAccessorType(XmlAccessType.PROPERTY)
public class Boy {

    private String name = "CY";

    private Address address; // 是一個接口

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

在 java object 轉換成 xml 的時候，接口Address 無法被轉換。 
所以 這里要加上 @XmlJavaTypeAdapter(AddressAdapter.class) 
所以 要多寫一個AddressAdaptor 類。 
這個類會返回Address接口的一個具體實現類的對象。 

這 就是 @XmlJavaTypeAdapter 的作用。