码迷,mamicode.com
首页 > 编程语言 > 详细

JAVA开发Webservice——JAXB

时间:2016-01-19 17:20:31      阅读:213      评论:0      收藏:0      [点我收藏+]

标签:

   JAXB(Java API for XML Binding),提供了一个快速便捷的方式将Java对象与XML进行转换。在JAX-WS(Java的WebService规范之一)中,JDK1.6 自带的版本JAX-WS2.1,其底层支持就是JAXB。

   JAXB 可以实现Java对象与XML的相互转换,在JAXB中,将一个Java对象转换为XML的过程称之为Marshal,将XML转换为Java对象的过程称之为UnMarshal。我们可以通过在 Java 类中标注注解的方式将一个Java对象绑定到一段XML,也就是说,在Java类中标注一些注解,这些注解定义了如何将这个类转换为XML,怎么转换,以及一段XML如何被解析成这个类所定义的对象;也可以使用JAXB的XJC工具,通过定义schema的方式实现Java对象与XML的绑定。

   下面来了解一下如何通过标注注解来完成 Marshal 和 UnMarshal 的过程。

首先看个小例子:

定义一个java类

 1 package jaxb;
 2 
 3 import javax.xml.bind.annotation.XmlElement;
 4 import javax.xml.bind.annotation.XmlRootElement;
 5 import javax.xml.bind.annotation.XmlType;
 6 
 7 @XmlType(name = "", propOrder = {
 8   "name",
 9    "age",
10    "id"
11   })
12 @XmlRootElement(name="Student")
13 public class Student
14 {
15     @XmlElement(name="ID")
16     public int id = 1;
17     @XmlElement(name="Name")
18     public String name = "ldd";
19     @XmlElement(name="Age")
20     public int age = 18;
21     @Override
22     public String toString()
23     {
24         return "Student [id=" + id + ", name=" + name + ", age=" + age + "]";
25     }
26 }

Java To XML(Marshal)

 1 package jaxb;
 2 
 3 import javax.xml.bind.JAXBContext;
 4 import javax.xml.bind.JAXBException;
 5 import javax.xml.bind.Marshaller;
 6 
 7 public class JavaToXML
 8 {
 9     public static void main(String[] args) throws JAXBException
10     {
11         JAXBContext context = JAXBContext.newInstance(Student.class);
12         Marshaller marshaller = context.createMarshaller();
13         marshaller.setProperty(Marshaller.JAXB_ENCODING, "utf-8");//编码格式 
14         marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);//是否格式化生成的xml串  
15         marshaller.setProperty(Marshaller.JAXB_FRAGMENT, false);//是否省略xml头信息(<?xml version="1.0" encoding="gb2312" standalone="yes"?>)  
16         Student student = new Student();
17         marshaller.marshal(student, System.out);
18     }
19 }

输出结果如下:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<Student>
    <Name>ldd</Name>
    <Age>18</Age>
    <ID>1</ID>
</Student>

XML To Java(UnMarshal)

 1 package jaxb;
 2 
 3 import java.io.File;
 4 
 5 import javax.xml.bind.JAXBContext;
 6 import javax.xml.bind.JAXBException;
 7 import javax.xml.bind.Unmarshaller;
 8 
 9 
10 public class XmlToJava
11 {
12     public static void main(String[] args) throws JAXBException
13     {
14         JAXBContext context = JAXBContext.newInstance(Student.class);
15         Unmarshaller unmarshaller = context.createUnmarshaller();
16         File file = new File("src/main/java/student.xml");
17         Student student = (Student) unmarshaller.unmarshal(file);
18         System.out.println(student);
19     }
20 }

 

  其实Marshal 和 UnMarshal的过程并不复杂,只需要从JAXBContext中获得Marshaller或Unmarshaller对象,就可以让JAXB帮我们来进行转换了。我们需要操作的主要内容是定义一个规则,告诉JAXB如何将一个类、按照什么样的格式转换为XML,下面是JAXB中主要的一些注解。
     
@XmlRootElement  将一个Java类映射为一段XML的根节点

name            定义这个根节点的名称

namespace   定义这个根节点命名空间

@XmlAccessorType 定义映射这个类中的何种类型需要映射到XML。

XmlAccessType.FIELD:映射这个类中的所有字段到XML

XmlAccessType.PROPERTY:映射这个类中的属性(get/set方法)到XML

XmlAccessType.PUBLIC_MEMBER:将这个类中的所有public的field或property同时映射到XML(默认)

XmlAccessType.NONE:不映射

 @XmlElement 

指定一个字段或get/set方法映射到XML的节点。

如,当一个类的XmlAccessorType 被标注为PROPERTY时,在某一个没有get/set方法的字段上标注此注解,即可将该字段映射到XML。

 

defaultValue  指定节点默认值

name             指定节点名称

namespace    指定节点命名空间

required         是否必须(默认为false)

 nillable  该字段是否包含 nillable="true" 属性(默认为false)

   type               定义该字段或属性的关联类型

 @XmlAttribute   指定一个字段或get/set方法映射到XML的属性。  

name             指定属性名称

namespace    指定属性命名空间

required         是否必须(默认为false)

 @XmlTransient 

定义某一字段或属性不需要被映射为XML。

如,当一个类的XmlAccessorType 被标注为PROPERTY时,在某一get/set方法的字段上标注此注解,那么该属性则不会被映射。

 
 @XmlType  定义映射的一些相关规则  

propOrder        指定映射XML时的节点顺序

factoryClass     指定UnMarshal时生成映射类实例所需的工厂类,默认为这个类本身

factoryMethod  指定工厂类的工厂方法

name               定义XML Schema中type的名称

namespace      指定Schema中的命名空间

 @XmlElementWrapper   

为数组元素或集合元素定义一个父节点。如,类中有一元素为List items,若不加此注解,该元素将被映射为

    <items>...</items>

    <items>...</items>

这种形式,此注解可将这个元素进行包装,如:

    @XmlElementWrapper(name="items")
    @XmlElement(name="item")
    public List items;

将会生成这样的XML样式:

    <items>

        <item>...</item>

        <item>...</item>

    </items>

 
 @XmlJavaTypeAdapter

自定义某一字段或属性映射到XML的适配器。

如,类中包含一个接口,我们可以定义一个适配器(继承自javax.xml.bind.annotation.adapters.XmlAdapter类),指定这个接口如何映射到XML。

 
 @XmlSchema 配置整个包的namespace,这个注解需放在package-info.java文件中。  

 

JAVA开发Webservice——JAXB

标签:

原文地址:http://www.cnblogs.com/ld-swust/p/5142576.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!