JAXB注解 @XmlRootElement 及XML文件解析详解

Posted 2020-12-10 javahh

【转-整理】 JAXB注解 @XmlRootElement 及XML文件解析详解
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
Java代码

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);  
}  

}

执行结果：

CY

David
（先 是marshall成 xml文件，再是把 xml 文件 unmarshal 成 java object。）

改动一：
修改@XmlAccessorType(XmlAccessType.FIELD) --> @XmlAccessorType(XmlAccessType.PROPERTY)
意思是只有 属性 才能被转换成 xml 中的标签。

所以再运行的结果是：

CY
就是说 java object 转换成 xml 的时候，name 不是属性（因为没有 get set方法），所以name不转换成标签。

改动二：
在 改动一 的基础上，给name属性添加 get set 方法。 再运行，结果为：

CY

David
由 此 可见 @XmlAccessorType 这个annotation 的作用。

改动三：
在改动二 的基础上，给Boy 再添加一个field， int age=10, 即：
Java代码

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 文件中的。解决办法是：
Java代码

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. 运行结果为：

10 CY

David

对于根元素，可以设置属性：
@XmlRootElement(name="b" nameSpace="http://test")
这样，在生成的xml文件中， 标签 就会变为 标签。并且加上一个命名空间。

下面解释 @XmlJavaTypeAdaptor 的作用：
Java代码

@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 的作用。