XmlRootElement JAXB注解

[XmlRootElement JAXB注解]

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 注释。

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 119,492评论 16 133
  • 溪流碧水绕人家, 堤边农妇齐浣纱。 农夫锄禾艳阳下, 阡陌纵横筑篱笆。 翠竹芳草蝶恋花, 又见山间放牛娃。 炊烟袅...
    草莓说事阅读 65评论 0 1
  • 有两天没写了。无谓的日常,其实并不想写。这几天平平淡淡。进入期末考了。医学生。。苦逼。 既然已经决定。不努力怎么就...
    柠檬不柠阅读 77评论 0 0
  • 女人到了30岁,应该明白自己到底该买哪些鞋。20岁的你初出茅庐,一切都是那么新鲜,但又没什么钱,对心仪的东西容易有...
    程苏米阅读 1,080评论 0 4