之前整理了对JAXB的初步学习,其实JAXB是一个简单实用的OX binding工具。说了如何在xml和java对象直接的转换,说说java对象如何注解吧。
JDK中JAXB一些的重要Annotation:
先上代码
package com.yonyou.studio.iweb.tools.entity;
import java.io.Serializable;
import java.util.List;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
import javax.xml.bind.annotation.XmlRootElement;
@XmlRootElement(name="Temp")
public class PageTempObj implements Serializable,Cloneable{
private String id;
private String name;
private int pageCount;
private String type;
private List<PageInfo> pages;
public PageTempObj() {
super();
}
public PageTempObj(String id,String name,int pageCount,String type){
this.id = id;
this.name = name;
this.pageCount = pageCount;
this.type = type;
}
@XmlElement
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
@XmlElement
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
@XmlElement
public int getPageCount() {
return pageCount;
}
public void setPageCount(int pageCount) {
this.pageCount = pageCount;
}
@XmlElement
public String getType() {
return type;
}
public void setType(String type) {
this.type = type;
}
@XmlElementWrapper(name="pages")
@XmlElement(name="page")
public List<PageInfo> getPages() {
return pages;
}
public void setPages(List<PageInfo> pages) {
this.pages = pages;
}
public void addPage(PageInfo page){
pages.add(page);
}
public void removePage(String id){
if(pages!=null&&pages.size()>0){
for(PageInfo page:pages){
if(page.getId().equals(id)){
pages.remove(page);
break;
}
}
}
}
}
package com.yonyou.studio.iweb.tools.entity;
import java.util.List;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
@XmlRootElement(name="Templates")
public class TemplatesObj {
private List<PageTempObj> templates;
@XmlElement(name="Temp")
public List<PageTempObj> getTemplates() {
return templates;
}
public void setTemplates(List<PageTempObj> templates) {
this.templates = templates;
}
public void addTemplate(PageTempObj temp){
templates.add(temp);
}
public void removeTemplate(String tempId){
if(templates!=null&&templates.size()>0){
for(PageTempObj obj:templates){
if(obj.getId().equals(tempId)){
templates.remove(obj);
break;
}
}
}
}
}
这里我用到的三个:@XmlRootElement、@XmlElement、@XmlElementWrapper
———-分割线—————————————–
Jaxb处理java对象和xml之间转换常用的annotation有:
@XmlType
@XmlElement
@XmlRootElement
@XmlAttribute
@XmlAccessorType
@XmlAccessorOrder
@XmlTransient
@XmlJavaTypeAdapter
常用annotation使用说明
@XmlType
@XmlType用在class类的注解,常与@XmlRootElement,@XmlAccessorType一起使用。它有三个属性:name、propOrder、namespace,经常使用的只有前两个属性。如:
@XmlType(name = “basicStruct”, propOrder = {
“intValue”,
“stringArray”,
“stringValue”
)
在使用@XmlType的propOrder 属性时,必须列出JavaBean对象中的所有属性,否则会报错。
2.@XmlElement
@XmlElement将java对象的属性映射为xml的节点,在使用@XmlElement时,可通过name属性改变java对象属性在xml中显示的名称。如:
@XmlElement(name=”Address”)
private String yourAddress;
3.@XmlRootElement
@XmlRootElement用于类级别的注解,对应xml的跟元素,常与 @XmlType 和 @XmlAccessorType一起使用。如:
@XmlType
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement
public class Address {}
4.@XmlAttribute
@XmlAttribute用于把java对象的属性映射为xml的属性,并可通过name属性为生成的xml属性指定别名。如:
@XmlAttribute(name=”Country”)
private String state;
5.@XmlAccessorType
@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的元素
注意:@XmlAccessorType的默认访问级别是XmlAccessType.PUBLIC_MEMBER,因此,如果java对象中的private成员变量设置了public权限的getter/setter方法,就不要在 private变量上使用@XmlElement和@XmlAttribute注解,否则在由java对象生成xml时会报同一个属性在java类里存在两次的错误。同理,如果@XmlAccessorType的访问权限 为XmlAccessType.NONE,如果在java的成员变量上使用了@XmlElement或@XmlAttribute注解,这些成员变量依然可以映射到xml文件。
6.@XmlAccessorOrder
@XmlAccessorOrder用于对java对象生成的xml元素进行排序。它有两个属性值:
AccessorOrder.ALPHABETICAL:对生成的xml元素按字母书序排序
XmlAccessOrder.UNDEFINED:不排序
7.@XmlTransient
@XmlTransient用于标示在由java对象映射xml时,忽略此属性。即,在生成的xml文件中不出现此元素。
8.@XmlJavaTypeAdapter
@XmlJavaTypeAdapter常用在转换比较复杂的对象时,如map类型或者格式化日期等。使用此注解时,需要自己写一个adapter类继承XmlAdapter抽象类,并实现里面的方法。
特地说明,注解元素时,不像XStream一样直接放到成员变量上面,JAXB一般放到get方法上面。(我亲历过失败的,放到set方法上面没试过)
对于要序列化(marshal)为XML的Java类,绝不能把成员变量声明为public,否则运行将抛出异常(这个我也亲历过失败)
xjc”工具可以用来将XML模式或其他类型模式文件(Java 1.6试验性地支持RELAX NG,DTD以及WSDL)转换为Java类。Java类使用javax.xml.bind.annotation包下的Java 标注,例如@XmlRootElement和@XmlElement。XML列表序列表示为java.util.List类型的属性, 通过JAXBContext可以创建Marshallers(将Java对象转换成XML)和Unmarshallers(将XML解析为Java对象)。
此外,JAXB包括了一个“schemagen”工具,能够执行“xjc”的反向操作,通过一组标注的Java类创建一个XML模式。