JAXB 的注解

- 日理万妓 2022-05-12 10:52 217阅读 0赞

JAXB框架使得通过JAVA访问xml变得非常简单.JAXB（Java Architecture for XML Binding）是JSE和JEE平台的一部分，让开发者能够快速完成java类和XML的互相映射。常用的地方就是对象类和xml之间的映射，能够让bo自动生成节点，节点自动转成实体bo。

JAXB封装在jdk中，jdk1.7及以上都不需要引入多于的jar包就可以完成JAXB代码开发了。下面结合具体常用实例来看特性~

> 1.新建一个java工程，结构也比较简单，bo包下一个Student类， util包下是工具类JAXBUtils.java,test包下是测试类。   
> ![这里写图片描述][SouthEast]

1.  bo类简单给上三个属性。关于注解引入的是javax.xml.bind.annotation下的类，类上注解对应xml的根节点，用@XmlRootElement注解。

例子：（下边例子中，根节点是response）

import java.io.Serializable;
    import javax.xml.bind.annotation.XmlAccessType;
    import javax.xml.bind.annotation.XmlAccessorType;
    import javax.xml.bind.annotation.XmlRootElement;
    
    @XmlRootElement(name="responese")  //根节点是 response
    @XmlAccessorType(XmlAccessType.FIELD)
    public class theResponse implements Serializable{ 
    
    	private static final long serialVersionUID = 1L; 
    	
    	private String RefNo;  //节点1：编号
    
    	private String mykey;  //节点2 ：key
    
    	public String getRefNo() {
    		return RefNo;
    	}
    
    	public void setRefNo(String orderRefNo) {
    		this.RefNo = RefNo;
    	}
    
    	public String getMyKey() {
    		return mykey;
    	}
    
    	public void setMyKey(String mykey) {
    		this.mykey= mykey;
    	}
    
    }

bo类注解注意点：

@1. 类上的注解 @XmlRootElement 是必不可少的。注解的name属性是可选的，不给节点默认生成为和类名一样，不过全是小写的<student></student>。指定name="studentBean"这生成指定的节点名称,且和指定的大小写一致，有空格的话空格也会出现在标签中。<studentBean></studentBean>

@2. 成员变量/属性上的注解 @XmlElement 可选的注解。不加或者只是加上@XmlElement,没有指定生成节点的名称，默认是和每个属性的名称一致，就是全变成小写。以age为例,<age></age>,如果给上name属性指定生成节点名称，则生成完全和name属性一致的节点出来，和类上的name属性一样。

假设测试类：

public class JAXBTest{
    
      public static void main(String[] args){
        JAXBContent context = JAXBContent.newInstance(Boy.class);
        Marsheller marsheller = context.createMarsheller();
        UnMarsheller unmarsheller = context.createUnMarsheller();
       
    
        theResponse res = new theResponse();
        marsheller.marshel(res,System.out);
        System.out.println();
    
        String xml=”<boy><name>David</name></boy>”;
        Boy boy2 = (Boy)unmarsheller.unmarshel(new StringReader(xml));
        System.out.println(boy2.name);
      }
    }

下面是运行结果：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><responese><RefNo></RefNo><mykey></mykey></responese>  
David  
先是marshall成 xml文件，

再是把 xml 文件 unmarshal 成 java object。

**改动一：**

@XmlAccessorType(XmlAccessType.FIELD)  --> @XmlAccessorType(XmlAccessType.PROPERTY)

意思是 只有 属性 才能被转换成 xml 中的标签。

就是说 java object 转换成 xml 的时候，假设不是属性（因为没有 get set方法），所以其不转换成标签。

\-----------------------------------------------------

改动二：

在 **改动一** 的基础上，给其属性添加 get set 方法。 再运行，则可以显示。  
由此 可见 @XmlAccessorType 这个annotation 的作用。

@XmlRootElement 
    @XmlAccessorType(XmlAccessType.PROPERTY)
    public class Boy {    
        String name = "CY";
         int age = 10;
        public String getName() {
            return name;
        }
        public void setName(String name) {
            this.name = name;
        }
    }

显然，这个age 是不会被 转化 到xml 文件中的。解决办法是：

@XmlRootElement // bixude 
    @XmlAccessorType(XmlAccessType.PROPERTY)
    public class Boy {
        String name = "CY";
        @XmlElement
         int age = 10;
        public String getName() {
            return name;
        }
        public void setName(String name) {
            this.name = name;
        }
    }

加上 @XmlElement annotation. 运行结果为：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><boy>**<age>10</age>**<name>CY</name></boy>  
David

\--------------------------------------

对于根元素，可以设置属性：

@XmlRootElement(name="b" nameSpace="http://test")

这样，在生成的xml文件中，<boy> 标签 就会变为 <b> 标签。并且加上一个命名空间。

\----------------------------------------

下面解释 @XmlJavaTypeAdaptor 的作用。

@XmlRootElement
    @XmlAccessorType(XmlAccessType.PROPERTY)
    public class Boy {
        private String name = "CY";
    
        private Address address; // 是一个接口
        public String getName() {
            return name;
        }
        public void setName(String name) {
            this.name = name;
        }
    }

在 java object 转换成 xml 的时候，接口Address 无法被转换。

所以 这里要加上 @XmlJavaTypeAdapter(AddressAdapter.class)

所以 要多写一个AddressAdaptor 类。

这个类会返回Address接口的一个具体实现类的对象。

这 就是 @XmlJavaTypeAdapter 的作用

参考网址：

[https://blog.csdn.net/terry7/article/details/46683377][https_blog.csdn.net_terry7_article_details_46683377]

[https://blog.csdn.net/gaoqiao1988/article/details/50481578][https_blog.csdn.net_gaoqiao1988_article_details_50481578]

[SouthEast]: /images/20220512/cc43fa4c51d84aa9b461f060cecadd70.png
[https_blog.csdn.net_terry7_article_details_46683377]: https://blog.csdn.net/terry7/article/details/46683377
[https_blog.csdn.net_gaoqiao1988_article_details_50481578]: https://blog.csdn.net/gaoqiao1988/article/details/50481578