`
liyuandong
  • 浏览: 332083 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

JAXB常用注解

    博客分类:
  • JAVA
 
阅读更多

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 的过程。我用的是 JAXB2_20101209.jar ,可以到http://jaxb.java.net/ 下载最新版本。



首先看个小例子:



定义一个java类

Java代码
package com.why.jaxb;  
 
import javax.xml.bind.annotation.XmlRootElement;  
 
@XmlRootElement 
public class People {  
    public String id = "001";  
    public String name = "灰太狼";  
    public int age = 26;  


package com.why.jaxb;

import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class People {
        public String id = "001";
        public String name = "灰太狼";
        public int age = 26;
}Java To XML(Marshal)

Java代码
package com.why.jaxb;  
 
import javax.xml.bind.JAXBContext;  
import javax.xml.bind.JAXBException;  
import javax.xml.bind.Marshaller;  
 
public class Java2XML {  
 
    /** 
     * @param args 
     * @throws JAXBException  
     */ 
    public static void main(String[] args) throws JAXBException {  
        JAXBContext context = JAXBContext.newInstance(People.class);  
          
        Marshaller marshaller = context.createMarshaller();  
        marshaller.setProperty(Marshaller.JAXB_ENCODING,"gb2312");//编码格式  
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);//是否格式化生成的xml串  
        marshaller.setProperty(Marshaller.JAXB_FRAGMENT, false);//是否省略xml头信息(<?xml version="1.0" encoding="gb2312" standalone="yes"?>)  
          
        People people = new People();  
        marshaller.marshal(people, System.out);  
    }  
 


package com.why.jaxb;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;

public class Java2XML {

        /**
         * @param args
         * @throws JAXBException
         */
        public static void main(String[] args) throws JAXBException {
                JAXBContext context = JAXBContext.newInstance(People.class);
              
                Marshaller marshaller = context.createMarshaller();
                marshaller.setProperty(Marshaller.JAXB_ENCODING,"gb2312");//编码格式
                marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);//是否格式化生成的xml串
                marshaller.setProperty(Marshaller.JAXB_FRAGMENT, false);//是否省略xml头信息(<?xml version="1.0" encoding="gb2312" standalone="yes"?>)
              
                People people = new People();
                marshaller.marshal(people, System.out);
        }

}
XML To Java(UnMarshal)

Java代码
package com.why.jaxb;  
 
import java.io.File;  
import javax.xml.bind.JAXBContext;  
import javax.xml.bind.JAXBException;  
import javax.xml.bind.Unmarshaller;  
import org.xml.sax.SAXException;  
 
public class XML2Java {  
    /** 
     * @param args 
     * @throws JAXBException  
     * @throws JAXBException  
     * @throws SAXException  
     */ 
    public static void main(String[] args) throws JAXBException {  
        JAXBContext context = JAXBContext.newInstance(People.class);  
        Unmarshaller unmarshaller = context.createUnmarshaller();  
        File file = new File("src/people.xml");  
        People people = (People)unmarshaller.unmarshal(file);  
        System.out.println(people.id);  
        System.out.println(people.name);  
        System.out.println(people.age);  
    }  


package com.why.jaxb;

import java.io.File;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Unmarshaller;
import org.xml.sax.SAXException;

public class XML2Java {
        /**
         * @param args
         * @throws JAXBException
         * @throws JAXBException
         * @throws SAXException
         */
        public static void main(String[] args) throws JAXBException {
                JAXBContext context = JAXBContext.newInstance(People.class);
                Unmarshaller unmarshaller = context.createUnmarshaller();
                File file = new File("src/people.xml");
                People people = (People)unmarshaller.unmarshal(file);
                System.out.println(people.id);
                System.out.println(people.name);
                System.out.println(people.age);
        }
}
 
    其实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文件中。

分享到:
评论

相关推荐

    JAXB注解相关技术

    #### 一、JAXB 处理 Java 对象和 XML 之间转换常用的注解 1. **`@XmlRootElement`** - 作用:指定该类是 JAXB 上下文中的根元素。通常用于表示 XML 文档的根节点。 - 使用场景:当需要将整个 Java 类实例序列化为...

    cxf接口常用注解doc

    ### CXF接口常用注解详解 #### 一、概述 CXF是一个强大的开源框架,用于构建和服务SOA架构中的各种Web服务。它提供了多种方式来创建Web服务客户端和服务端,其中包括利用注解来简化开发过程。本文档将详细介绍CXF...

    stax+jaxb进行xml解析

    在Java中,有多种方法可以解析XML,其中StAX(Streaming API for XML)和JAXB(Java Architecture for XML Binding)是两种常用的技术。本篇文章将详细探讨如何结合StAX和JAXB进行高效的XML解析。 StAX是一种事件...

    Jaxb简单例子

    以下是一些常用的注解: - `@XmlRootElement`: 用于标记一个Java类作为XML文档的根元素。 - `@XmlElement`: 标记类中的字段成为XML元素。 - `@XmlAttribute`: 标记字段成为XML属性。 - `@XmlAccessorType`: 控制...

    jaxb-libs.jar.zip

    jaxb-libs.jar 下载 JAXB能够使用Jackson对JAXB注解的支持实现(jackson-module-jaxb-annotations),既方便生成XML...JAXB允许JAVA人员将JAVA类映射为XML表示方式,常用的注解包括:@XmlRootElement,@XmlElement等等。

    jaxb-api-2.2.jar.zip

    jaxb-api-2.2.jar 下载 JAXB能够使用Jackson对JAXB注解的支持实现(jackson-module-jaxb-annotations),既方便生成...JAXB允许JAVA人员将JAVA类映射为XML表示方式,常用的注解包括:@XmlRootElement,@XmlElement等等。

    jaxb解析xml

    JAXB 解析 XML JAXB (Java Architecture for XML Binding) 是一种基于 Java 的 XML 绑定技术,主要功能是根据 DTD 或者 XML Schema 将 XML Element 转化为 Java 类。JAXB 将 XML 文本流转化为 Java Object,把 XML ...

    maven-jaxb2-plugin-0.14.0.jar

    maven-jaxb2-plugin-0.14.0 下载 maven包 JAXB能够使用Jackson对JAXB注解的支持实现(jackson-module-jaxb-...JAXB允许JAVA人员将JAVA类映射为XML表示方式,常用的注解包括:@XmlRootElement,@XmlElement等等。

    Java XML绑定技术 (Castor JAXB XMLBeans)

    本文将详细介绍Java XML绑定技术的基本概念,并重点介绍三种常用的实现框架:JAXB、XMLBeans和Castor。 #### 二、Java XML绑定技术概述 Java XML绑定技术(简称XML Binding)是一种能够自动将XML文档映射到Java...

    使用jaxb将XML转化为JAVA BEAN

    JAXB基于Java反射机制,通过在Java类上使用特定的注解(如@XmlRootElement、@XmlElement等),JAXB可以自动地将这些类实例序列化为XML文档,或者将XML文档反序列化为Java对象。这个过程分为两个主要步骤: ...

    spring3 mvc系列二:方法返回值的学习(注解版)

    我们将结合实际示例来理解这一机制,并了解一些常用的工具来辅助开发。 首先,Spring MVC中的方法返回值不仅仅是简单的字符串,它可以是一个模型对象、视图名、甚至可以是一个`ModelAndView`对象。这些返回值会根据...

    JAXBContext 解析xml

    JAXB(Java Architecture for XML Binding)是Java提供的一种标准API,它允许我们将XML文档与Java对象进行绑定,使得我们可以方便地在XML和Java对象之间进行转换。在处理嵌套列表时,JAXBContext扮演了关键角色。...

    java源码生成-mb2g-jaxb:使用Maven从xsd文件生成Java源代码

    最常用的插件是`maven-jaxb2-plugin`,它基于XJC(XSD到Java编译器),是JAXB RI的一部分。通过在pom.xml文件中配置该插件,开发者可以指定XSD文件的位置以及生成的Java源码应放置的目录。例如: ```xml ...

    Webservice笔记含使用cxf和jaxws两种方式开发webservice【源代码+笔记】

    第一天: 什么是webservice?... 常用注解 测试jaxws传输复杂对象类型 CXF开发webservice: CXF入门程序 Spring+cxf整合(重点) CXF发布rest的webservice。(重点) 综合案例: 实现便民查询网站

    JavaXml及Bean互转

    本篇将详细介绍两种常用的Java XML与Bean互转方法:XStream库和JAXB(Java Architecture for XML Binding)框架。 一、XStream库 1. **XStream简介**: XStream是一个用于Java的轻量级库,它提供了一种简单的API来...

    jackson相关jar

    通过此模块,Jackson可以识别并利用JAXB注解,使得已经使用JAXB注解的类可以无缝地与Jackson一起工作,无需额外的配置。 总的来说,Jackson是一个强大的工具,广泛应用于Web服务、RESTful API、数据序列化等多个...

    java开发常用jar包之webservice.rar

    本压缩包文件“java开发常用jar包之webservice.rar”很可能包含了与这两种技术相关的库文件,用于简化Java开发者创建和消费Web服务的过程。 JAX-WS是Sun Microsystems推出的用于构建SOAP(Simple Object Access ...

    rest-api:jaxb xml,json,杰克逊,杰特森

    在Java世界里,JAXB(Java Architecture for XML Binding)和Jackson库被广泛用于处理这些数据格式。 首先,让我们详细了解一下JAXB。JAXB是Java标准,它提供了在Java对象和XML之间进行自动转换的功能。通过JAXB,...

    Java解析和生成XML.pdf

    2. 常用注解的具体使用方法和属性: - `@XmlType`:拥有name、propOrder和namespace三个属性。name用于指定XML Schema中的名字,propOrder用于定义属性的顺序,namespace用于定义XML命名空间。 - `@XmlElement`:...

    jdk1.6扩展类与属性.txt

    - **注解标准化**:为常用的注解提供了一套标准化的API,简化了Java EE应用的开发。 - **跨框架兼容性**:Common Annotations提供了更好的跨框架兼容性,使得注解在不同框架间更加通用。 综上所述,JDK 1.6在多个...

Global site tag (gtag.js) - Google Analytics