前面一章简单演示了JAXB的用法,这个章节主要梳理一下JAXB常见的几个注解
1.@XmlRootElement
用于类级别的注解,对应xml的跟元素,常与 @XmlType 和 @XmlAccessorType一起使用,主要的作用是映射xml的根节点
2.@XmlElement
将Java对象的属性映射为xml的节点,在使用@XmlElement时,可通过name属性改变java对象属性在xml中显示的名称。
@XmlElement(name="class")private String clz;
3.@XmlElements
当节点下面包含多个相同的子节点时,该注解可以映射成一个JavaBean的集合属性,其中注解中value的属性对应的是一个@XmlElement的集合
1 @XmlElements(value = {@XmlElement(name = "select", type = Select.class)})2 private List selects;
4.@XmlAttribute
用于把java对象的属性映射为xml的属性,并可通过name属性为生成的xml属性指定别名
@XmlAttribute(name = "id")private String id;
5.@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文件。
注意:虽然@XmlAccessorType为XmlAccessType.NONE,但是在java类的私有属性上加了@XmlAttribute和@XmlElement注解后,这些私有成员会映射生成xml的元素
6.@XmlAccessorOrder
用于对java对象生成的xml元素进行排序。它有两个属性值:
AccessorOrder.ALPHABETICAL:对生成的xml元素按字母书序排序
XmlAccessOrder.UNDEFINED:不排序
7.@XmlTransient
用于标示在由java对象映射xml时,忽略此属性。即,在生成的xml文件中不出现此元素。
8.@XmlJavaTypeAdapter
常用在转换比较复杂的对象时,如map类型或者格式化日期等。使用此注解时,需要自己写一个adapter类继承XmlAdapter抽象类,并实现里面的方法。
packageorg.lyrk.accp8.s2.chapter.xml;importjavax.xml.bind.annotation.adapters.XmlAdapter;importjava.text.DateFormat;importjava.text.SimpleDateFormat;importjava.util.Date;/*** 时间格式的转化器
* Created by niechen on 17/5/9.*/
public class DateXmlAdapter extends XmlAdapter{private static final DateFormat DATE_FORMAT =new SimpleDateFormat("yyyy-mm-dd HH:mm:ss");
@Overridepublic Date unmarshal(String v) throwsException {returnDATE_FORMAT.parse(v);
}
@Overridepublic String marshal(Date v) throwsException {returnDATE_FORMAT.format(v);
}
}
9.示例代码
9.1 扩展Bean类
packageorg.lyrk.accp8.s2.chapter.xml;import javax.xml.bind.annotation.*;importjavax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;importjava.util.Date;importjava.util.List;/*** Created by niechen on 17/5/9.*/@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
@XmlAccessorOrder(value=XmlAccessOrder.ALPHABETICAL)public classBean {
@XmlAttribute(name= "id")privateString id;//对应xml文件的id属性
@XmlAttribute(name= "class")privateString clz;//对应xml文件的class属性
@XmlJavaTypeAdapter(value= DateXmlAdapter.class)//配置转换器
@XmlElementprivateDate date;//对应xmlDate节点
@XmlElements({@XmlElement(name= "property", type = Property.class)})private Listproperties;//获取xml中所有property节点publicDate getDate() {returndate;
}public voidsetDate(Date date) {this.date =date;
}public ListgetProperties() {returnproperties;
}public void setProperties(Listproperties) {this.properties =properties;
}publicString getId() {returnid;
}public voidsetId(String id) {this.id =id;
}publicString getClz() {returnclz;
}public voidsetClz(String clz) {this.clz =clz;
}
}
@XmlAccessorType(value=XmlAccessType.FIELD)classProperty {
@XmlAttribute(name= "id")privateString id;
@XmlAttribute(name= "value")privateString value;publicString getId() {returnid;
}public voidsetId(String id) {this.id =id;
}publicString getValue() {returnvalue;
}public voidsetValue(String value) {this.value =value;
}
}
9.2 beans.xml文件
2017-05-08 11:22:33
9.3 主函数入口
1 packageorg.lyrk.accp8.s2.chapter.xml;2
3 importjavax.xml.bind.JAXBContext;4 importjavax.xml.bind.JAXBException;5 importjavax.xml.bind.Unmarshaller;6 importjava.io.InputStream;7
8 /**
9 * Created by niechen on 17/5/9.10 */
11 public classTest {12
13 public static voidmain(String[] args) {14 try{15 JAXBContext jaxbContext = JAXBContext.newInstance(Bean.class);//创建JAXBContext对象,注意一定要传@XmlRootElement的所标记的类的类型
16 Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();//拿到xml解析对象
17 InputStream inputStream = Bean.class.getClassLoader().getResourceAsStream("bean.xml");//在classpath下读取xml的文件流
18 Bean bean = (Bean) unmarshaller.unmarshal(inputStream);//将xml转换成实体对象
19 System.out.println("id:" +bean.getId());20 System.out.println("class:" +bean.getClz());21 System.out.println("date:"+bean.getDate().getTime());22 for(Property property : bean.getProperties()) {23 System.out.println("property id属性:" + property.getId() + "property value属性:" +property.getValue());24 }25 } catch(JAXBException e) {26 e.printStackTrace();27 }28 }29 }30 输出结果:31 id:student32 class:org.test.entity.Student33 date:1483845753000
34 property id属性:nameproperty value属性:张三35 property id属性:ageproperty value属性:18