JAXB學習筆記(一)—— 常用註解

JAXB學習筆記(一)—— 常用註解

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 ,可以到[url]http://jaxb.java.net/[/url] 下載最新版本。



首先看個小例子:



定義一個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文件中。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章