java JAXB注解
来源:互联网 发布:淘宝网皮衣加厚的 编辑:程序博客网 时间:2024/05/22 19:57
说明:今天学习微信公众平台接口的时候遇到了JAXB,这个东西将xml转化成javeBean简直是神器,注解我是参考下面的参考文档写的,感谢大神的分享,这里自己也总结一下小分享。
一、简介
JAXB能够使用Jackson对JAXB注解的支持实现(jackson-module-jaxb-annotations),既方便生成XML,也方便生成JSON,这样一来可以更好的标志可以转换为JSON对象的JAVA类。JAXB允许JAVA人员将JAVA类映射为XML表示方式,常用的注解包括:@XmlRootElement,@XmlElement等等。
JAXB(Java Architecture for XML Binding) 是一个业界的标准,是一项可以根据XML Schema产生Java类的技术。该过程中,JAXB也提供了将XML实例文档反向生成Java对象树的方法,并能将Java对象树的内容重新写到XML实例文档。从另一方面来讲,JAXB提供了快速而简便的方法将XML模式绑定到Java表示,从而使得Java开发者在Java应用程序中能方便地结合XML数据和处理函数。
注:摘抄自百度 https://baike.baidu.com/item/JAXB/479341?fr=aladdin
二、注解介绍
1 常用注解
@XmlType
@XmlElement
@XmlRootElement
@XmlAttribute
@XmlAccessorType
@XmlAccessorOrder
@XmlTransient
@XmlJavaTypeAdapter
2 注解说明
1:@XmlType
@XmlType用在class类的注解,常与@XmlRootElement,@XmlAccessorType一起使用。它有三个属性:name、propOrder、namespace,经常使用的只有前两个属性。如:同时使用了@XmlType(propOrder={})和@XmlAccessorOrder(XmlAccessOrder.ALPHABETICAL)的时候,生成的xml只按照propOrder定义的顺序生成元素。
@XmlType(name = "basicStruct", propOrder = { "intValue", "stringArray", "stringValue")
在使用@XmlType的propOrder 属性时,必须列出JavaBean对象中的所有属性,否则会报错。
2:@XmlRootElement
@XmlRootElement用于类级别的注解,对应xml的跟元素,常与 @XmlType 和 @XmlAccessorType一起使用。如:
@XmlType@XmlAccessorType(XmlAccessType.FIELD)@XmlRootElementpublic class Address {}
3:@XmlAccessorType
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的元素。
@XmlAccessorType(XmlAccessType.FIELD)
4:@XmlElement
@XmlElement将Java对象的属性映射为xml的节点,在使用@XmlElement时,可通过name属性改变java对象属性在xml中显示的名称。如:
@XmlElement(name="Address") private String yourAddress;
5:@XmlAttribute
@XmlAttribute用于把java对象的属性映射为xml的属性,并可通过name属性为生成的xml属性指定别名。如:
@XmlAttribute(name="Country")private String state;
6:@XmlAccessorOrder
@XmlAccessorOrder用于对java对象生成的xml元素进行排序。它有两个属性值:
AccessorOrder.ALPHABETICAL:对生成的xml元素按字母书序排序
XmlAccessOrder.UNDEFINED:不排序
7:@XmlTransient
@XmlTransient用于标示在由java对象映射xml时,忽略此属性。即,在生成的xml文件中不出现此元素。
8:@XmlJavaTypeAdapter
使用定制的适配器(即扩展抽象类XmlAdapter并覆盖marshal()和unmarshal()方法),以序列化Java类为XML。
@XmlJavaTypeAdapter常用在转换比较复杂的对象时,如map类型或者格式化日期等。使用此注解时,需要自己写一个adapter类继承XmlAdapter抽象类,并实现里面的方法。
@XmlJavaTypeAdapter(value=xxx.class),value为自己定义的XmlAdapter类
XmlAdapter如下:
public abstract class XmlAdapter<ValueType,BoundType> { // Do-nothing constructor for the derived classes. protected XmlAdapter() {} // Convert a value type to a bound type. public abstract BoundType unmarshal(ValueType v); // Convert a bound type to a value type. public abstract ValueType marshal(BoundType v); }
API文档:XmlJavaTypeAdapter
三、参考实例
import javax.xml.bind.annotation.XmlAccessType;import javax.xml.bind.annotation.XmlAccessorType;import javax.xml.bind.annotation.XmlElement;import javax.xml.bind.annotation.XmlRootElement;import javax.xml.bind.annotation.XmlType;@XmlAccessorType(XmlAccessType.FIELD)@XmlType(name = "", propOrder = { "toUserName", "fromUserName", "createTime", "msgType", "msgId"})@XmlRootElement(name = "xml")/* * <ToUserName><![CDATA[toUser]]></ToUserName> * <FromUserName><![CDATA[fromUser]]></FromUserName> * <CreateTime>1348831860</CreateTime> * <MsgType><![CDATA[text]]></MsgType> * <Content><![CDATA[this is a test]]></Content> * <MsgId>1234567890123456</MsgId> */public class PostMessageRequest { @XmlElement(name="ToUserName") private String toUserName; @XmlElement(name="FromUserName") private String fromUserName; @XmlElement(name="CreateTime") private long createTime; @XmlElement(name="MsgType") private String msgType; @XmlElement(name="MsgId") private long msgId; public String getToUserName() { return toUserName; } public void setToUserName(String toUserName) { this.toUserName = toUserName; } public String getFromUserName() { return fromUserName; } public void setFromUserName(String fromUserName) { this.fromUserName = fromUserName; } public long getCreateTime() { return createTime; } public void setCreateTime(long createTime) { this.createTime = createTime; } public String getMsgType() { return msgType; } public void setMsgType(String msgType) { this.msgType = msgType; } public long getMsgId() { return msgId; } public void setMsgId(long msgId) { this.msgId = msgId; }}
参考文章:
JAXB注解使用
JAXB注解的使用详解
- java JAXB注解
- JAXB注解
- jaxb注解
- JAXB注解
- jaxb注解
- JAXB注解
- JAXB注解
- JAXB注解
- JAXB 注解
- jaxb注解
- JAXB注解
- JAXB(Java API for XML Binding)注解
- Jaxb中java类的相关注解详解描述
- 通过JAXB注解,根据java类生成xml内容
- JAXB(Java API for XML Binding)注解
- JAXB(Java API for XML Binding)注解(续)
- JAXB注解使用
- XmlRootElement JAXB注解
- 工类下载
- SpringBoot学习(六)SpringSecurity学习
- 日常纪要
- android中动态给EditText获得焦点并弹起软键盘的方法详解
- PHP类中static 和self的使用区别
- java JAXB注解
- 医学全面云转型大势已定
- Html中CSS之去除li前面的小黑点,和ul、LI部分属性方法
- Web开发之常见端口
- Pixhawk之姿态控制篇(1)_源码算法分析
- 计算机网络 之 数据链路层
- 细数你不得不知的容器安全工具
- Toolkit 理解、单例设计理解
- 刊登知识