JAXB介绍以及简单用法

记录开发日常的点滴,成为更棒的程序员
引用 https://blog.csdn.net/wn084/article/details/80853587

使用场景

编写webservice接口的时候,使用JAXB使代码量大大减少,增加工作效率

JAXB

Java Architecture for XML Binding 将XML模式绑定到Java,可以把一个Java对象快速转成XML格式,或者将一个XML格式快速转为Java对象

基础注解介绍

@XmlAccessorType

决定哪些字段或哪些get/set方法对应的字段会被映射为xml元素,需要注意的是字段或get/set方法的访问权限(public/private)会影响字段是否被映射为xml元素
包和类级别的注解
属性
value:XmlAccessType的枚举类型里的值

  • XmlAccessType.PROPERTY
    对应字段只要有get/set方法(缺一不可)就可以自动映射成XML
    没有get/set方法,在字段上使用@XmlElement注解,不可同时存在
  • XmlAccessType.FIELD
    每个非静态字段都会被映射成XML元素,就算没有get/set和@XmlElement注解
  • XmlAccessType.PUBLIC_MEMBER (该值为默认值)
    每个public字段或者public的get/set方法对,都会被映射成XML元素,不可同时存在
  • XmlAccessType.NONE:
    任何字段都不发生映射
@XmlRootElement

将类映射为xml全局元素,也就是根元素
类级别的注解
属性
name:指定生成元素的名字,若不指定则默认使用类名小写作为元素名
nameSpace:指定生成的元素所属的命名空间

实例

java代码

@XmlAccessorType(XmlAccessType.PROPERTY)
@XmlRootElement(name = "response")
public class ZyDataIcdResVo extends ResponseVo {
    public static final String ERROR="-1";
    public static final String SUCCESS="1";

    private String code=SUCCESS;
    private String msg="成功";

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }
}

生成结果

<response>
    <code>-1</code>
    <msg>请检查入参格式</msg>
</response>
@XmlElement

该注解可以将被注解的字段(非静态),或者被注解的get/set方法对应的字段映射为本地元素,也就是子元素
字段,方法,参数级别的注解
属性
name:指定生成元素的名字,默认使用字段名或get/set方法去掉前缀剩下部分小写作为元素名
namespace:指定该元素所属的命名空间
nillable:指定元素的文本值是否可以为空,默认为false
required:指定该元素是否必须出现,默认为false
defaultValue:指定该元素默认的文本值

@XmlElementWrapper

围绕被映射的xml元素生成包装元素。主要用在集合对象映射后生成包装映射结果的xml元素。
\color{red}{仅允许出现在集合属性上 }
字段和方法级别的注解
属性
name、nillable、namespace、required 用法同上

实例

java代码

    private List<ZyDataIcdInfo> data;

    public List<ZyDataIcdInfo> getData() {
        return data;
    }

    @XmlElementWrapper(name = "data")
    @XmlElement(name="result")
    public void setData(List<ZyDataIcdInfo> data) {
        this.data = data;
    }

生成结果

<data>
   <result>
      <backup1></backup1>  
      <backup2></backup2>  
      <backup3></backup3>  
      <backup4></backup4>  
      <backup5></backup5> 
    </result> 

</response>
@XmlType

指定生成元素的顺序
类级别的注解
属性
propOrder:生成的xml元素必须按照propOrder指定的顺序出现,也就间接实现了排序

实例

java代码

@XmlAccessorType(XmlAccessType.PROPERTY)
@XmlType(name = "", propOrder = {
        "backup1",
        "backup2",
        "backup3",
        "backup4",
        "backup5"
})
public class ZyDataIcdInfo implements Serializable {

}
@XmlJavaTypeAdapter

解决日期,数字等格式化的问题
包、类、字段,方法、参数级别的注解
属性
XXX.class:自定义一个适配器,继承XmlAdapter类,实现里面的marshal和unmarshal方法,并在该注解上引用
\color{red}{ marshal()是把java对象转化为xml对象的一个过程 }
\color{red}{ nmarshal()是把xml对象转化为我们需要的java对象的方法 }

public class TimestampAdapter extends XmlAdapter<Date, Timestamp> {
 
   public Date marshal(Timestamp t) {
     return new Date(t.getTime());
   }
 
   public Timestamp unmarshal(Date d) {
     return new Timestamp (d.getTime());
   }
 }

public class InfoDTO {
  private Timestamp createTime;
  ...
  @XmlJavaTypeAdapter(Timestamp.class)
  public Timestamp getCreateTime() {
    return this.createTime;
  }
 }

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,457评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,837评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,696评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,183评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,057评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,105评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,520评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,211评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,482评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,574评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,353评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,897评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,489评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,683评论 2 335

推荐阅读更多精彩内容