XmlRootElement JAXB注解_xml


1. @Retention(value=RUNTIME)  
2. @Target(value=TYPE)  
3. public @interface
4.   
5. @Inherited
6. @Retention(value=RUNTIME)  
7. @Target(value={PACKAGE,TYPE})  
8. public @interface


XmlRootElement: 将类或枚举类型映射到 XML 元素。JAXB中的注解,用来根据java类生成xml内容。 

当使用 @XmlRootElement 注释对顶层类或枚举类型进行注释时,类型值被表示为 XML 文档中的 XML 元素。 

JAXB Annotation 

  • @XmlRootElement   // xml 文件的根元素
  • @XmlElement
  • @XmlAccessorType  // 控制默认情况下是否对字段或 Javabean 属性进行系列化。
  • @XmlTransient
  • @XmlJavaTypeAdaptor

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



XmlRootElement JAXB注解_xml



    1. package
    2. import
    3. import
    4. import
    5.   
    6. @XmlRootElement // 必须要标明这个元素
    7. @XmlAccessorType(XmlAccessType.FIELD)  
    8. public class
    9. "CY";  
    10. }  
    11.   
    12. package
    13.   
    14. import
    15. import
    16. import
    17. import
    18. import
    19.   
    20. public class
    21.   
    22. public static void main(String[] args) throws
    23. class);  
    24.          
    25.         Marshaller marshaller = context.createMarshaller();  
    26.         Unmarshaller unmarshaller = context.createUnmarshaller();  
    27.          
    28. new
    29.         marshaller.marshal(boy, System.out);  
    30.         System.out.println();  
    31.          
    32. "<boy><name>David</name></boy>";  
    33. new
    34.         System.out.println(boy2.name);  
    35.     }  
    36. }



    执行结果: 
    <?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, 即: 



    XmlRootElement JAXB注解_xml

    1. package
    2.   
    3. import
    4. import
    5. import
    6.   
    7. @XmlRootElement
    8. @XmlAccessorType(XmlAccessType.PROPERTY)  
    9. public class
    10. "CY";  
    11. int age = 10;  
    12. public
    13. return
    14.     }  
    15. public void
    16. this.name = name;  
    17.     }  
    18. }

    显然,这个age 是不会被 转化 到xml 文件中的。解决办法是: 



    XmlRootElement JAXB注解_xml


    1. import
    2. import
    3. import
    4. import
    5.   
    6. @XmlRootElement // bixude
    7. @XmlAccessorType(XmlAccessType.PROPERTY)  
    8. public class
    9.      
    10. "CY";  
    11. @XmlElement
    12. int age = 10;  
    13. public
    14. return
    15.     }  
    16.   
    17. public void
    18. this.name = name;  
    19.     }  
    20.   
    21. }


    加上 @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 JAXB注解_xml


    1. @XmlRootElement
    2. @XmlAccessorType(XmlAccessType.PROPERTY)  
    3. public class
    4.      
    5. private String name = "CY";  
    6.   
    7. private Address address; // 是一个接口
    8.      
    9. public
    10. return
    11.     }  
    12.   
    13. public void
    14. this.name = name;  
    15.     }  
    16.   
    17. }


    在 java object 转换成 xml 的时候,接口Address 无法被转换。 
    所以 这里要加上 @XmlJavaTypeAdapter(AddressAdapter.class) 
    所以 要多写一个AddressAdaptor 类。 
    这个类会返回Address接口的一个具体实现类的对象。 

    这 就是 @XmlJavaTypeAdapter 的作用。