JAXB基础API,注解(整理)

JAXB基础API,注解(整理)

JAXB(Java Architecture for XML Binding) 是一个业界的标准,是一项可以根据XML Schema产生Java类的技术。该过程中,JAXB也提供了将XML实例文档反向生成Java对象树的方法,并能将Java对象树的内容重新写到XML实例文档。从另一方面来讲,JAXB提供了快速而简便的方法将XML模式绑定到Java表示,从而使得Java开发者在Java应用程序中能方便地结合XML数据和处理函数。JAXB能够使用Jackson对JAXB注解的支持实现(jackson-module-jaxb-annotations),既方便生成XML,也方便生成JSON。

1.API

  • JAXBContext类,是应用的入口,通过该类创建序列化和反序列化对象,也即编组对象和解组对象。
  • Marshaller(编组)接口,将Java对象序列化为XML数据。
    可以通过其setProperty( String name,Object value )方法设置一些属性,以控制 XML 的生成。常用的有如下属性。
    Marshaller.JAXB_ENCODING:指定生成的 XML 的字符集。
    Marshaller.JAXB_FORMATTED_OUTPUT:指定是否需要对生成的 XML 进行格式化,默认是不格式化的。
    Marshaller.JAXB_FRAGMENT:指定是否需要生成文档级别的事件,指定对应的属性值为 true 可以不生成 XML的头信息。
  • Unmarshaller(解组)接口,将XML数据反序列化为Java对象。

2.注解

  • @XmlRootElement,将Java类或枚举映射成XML元素根节点,是唯一一个必须注解,name属性指定根节点名称,不指定默认为类名的小写;
  • @XmlElement,将Java类的一个属性映射为XML节点元素,name属性可自定义元素名;
  • @XmlAttribute,将Java类的一个属性映射为XML节点元素的属性,name属性可自定义属性名;
  • @XmlType,将Java类或枚举类型映射到XML模式类型,常与@XmlRootElement、@XmlAccessorType共用,propOrder属性定义字段生成的XML节点顺序;
  • @XmlAccessorType,控制字段或属性的序列化。属性XmlAccessType有4个常量值:FIELD表示JAXB将自动绑定Java类中的每个非静态的(static)、非瞬态的(由@XmlTransient标注)字段到XML;PROPERTY表示java对象中所有通过getter/setter方式绑定成属性到XML;PUBLIC_MEMBER表示Java对象中所有的public访问权限的成员变量和通过getter/setter方式访问的成员变量,该值为默认值;NONE表示Java对象的所有属性都不映射为XML的元素;
  • @XmlAccessorOrder,控制JAXB
    绑定类中属性和字段的排序,有两个属性,AccessorOrder.ALPHABETICAL——对生成的XML元素按字母书序排序,XmlAccessOrder.UNDEFINED——不排序,默认为该值;
  • @XmlJavaTypeAdapter,自定义适配器(即扩展抽象类XmlAdapter并覆盖marshal()和unmarshal()方法),解决日期(Date),数字(Number)格式化问题;
  • @XmlElementWrapper
    ,对于数组或集合(即包含多个元素的成员变量),生成一个包装该数组或集合的XML元素(称为包装器),该注解只能用在集合上;
  • @XmlTransient ,用于标示在由Java对象映射XML时,忽略此属性,在生成的XML文件中将不出现此元素。该注解与所有其他JAXB注释相互排斥,也就是说与其他注释连用就会报错。

实际应用中注意的问题

如果JavaBean中定义了有参的构造器,那么必须同时定义无参构造器,否则转XML会抛无默认构造函数的异常
  
  成员变量值为NULL时,将不会映射成对应的XML元素——由于基本数据类型默认值不为空,所以基本数据类型不设值也会映射成XML元素,值为默认值,所以如果模型需要基本数据,在属性定义的时候尽量使用包装类型

@XmlAccessorType 注解中如果属性值为XmlAccessType.FIELD,则表示通过成员变量来映射,set/get方法上的映射注解就是多余的,所以如果此时set/get方法上再标注元素或者属性映射注解,将抛属性重复性异常;属性值为XmlAccessType.NONE不映射为XML元素的前提是Java字段或set/get方法上都没有映射注解

@XmlType propOrder属性能够自定义字段的排序,该属性如果设置,要么写成{}的形式,否则在就必须将所有@XmlElement标注或者没有@XmlElement标注的但实际上会被映射为XML节点的字段添加到排序列表,不然会抛异常;如果propOrder属性设置有值,@XmlAccessorOrder注解的元素排序规则将失效;

参考文档(精):https://www.cnblogs.com/chenbenbuyi/p/8283657.html

  • 2
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值