天天看點

JAXB輕松轉換xml對象和java對象

實體類如下:

package com.cn.entity;

import java.util.List;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement(name = "person")
@XmlAccessorType(XmlAccessType.NONE)
public class Person {

	//姓名
	@XmlElement(name = "newName")
	private String name;
	
	//性别
	@XmlElement(name = "sex_1")
	private String sex;
	
	//年齡
	@XmlElement
	private int age;
	
	//位址
	@XmlElementWrapper(name = "Address")
	@XmlElement(name = "address")
	private List<Address> Address;
	
	get...
	set...
}
           
package com.cn.entity;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlType;
@XmlAccessorType(XmlAccessType.PROPERTY)
@XmlType(propOrder={"country","province","city","county","town"})
public class Address {

	//國
	//@XmlElement(name = "country000")
	private String country;
	//省
	//@XmlElement
	private String province;
	//市
	//@XmlElement
	private String city;
	//縣
	//@XmlElement
	private String county;
	//鎮
	//@XmlElement(required = true)
	private String town; 
	
	get...
	set...
}
           

JAXB工具類:

package com.cn.util;

import java.io.StringReader;
import java.io.StringWriter;

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

import org.apache.log4j.Logger;

/**
 * JAXB工具類
 * @author sun.kai
 * 2016年8月18日
 */
public class JaxbUtil {    
    private static Logger logger = Logger.getLogger(JaxbUtil.class);
	private static JAXBContext jaxbContext;
	
	//xml轉java對象
	@SuppressWarnings("unchecked")
	public static <T> T xmlToBean(String xml,Class<T> c){
		T t = null;
		try {
			jaxbContext = JAXBContext.newInstance(c);
			Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
			t = (T) unmarshaller.unmarshal(new StringReader(xml));
		} catch (JAXBException e) {
			logger.info(e.getMessage());
		}
		return t;
	}
	
	//java對象轉xml
	public static String beanToXml(Object obj){
		StringWriter writer = null;
		try {
			jaxbContext=JAXBContext.newInstance(obj.getClass());
			Marshaller marshaller = jaxbContext.createMarshaller();
			//Marshaller.JAXB_FRAGMENT:是否省略xml頭資訊,true省略,false不省略
			marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true);
			//Marshaller.JAXB_FORMATTED_OUTPUT:決定是否在轉換成xml時同時進行格式化(即按标簽自動換行,否則即是一行的xml)
			marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
			//Marshaller.JAXB_ENCODING:xml的編碼方式
            marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");
			writer = new StringWriter();
			marshaller.marshal(obj, writer);
		} catch (JAXBException e) {
			logger.info(e.getMessage());
		}
		return "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" + writer.toString();
	}
}
           

測試用例:

package com.test.test;

import java.util.ArrayList;
import java.util.List;

import com.cn.entity.Address;
import com.cn.entity.Person;
import com.cn.util.JaxbUtil;

public class TestJaxb {

	public static void main(String[] args) {
		long time1  = System.currentTimeMillis();
		//測試java對象轉xml,java對象中包含集合對象
		Person person = new Person();
		person.setName("admin管理者");
		person.setSex("男");
		person.setAge(25);
		List<Address> adds = new ArrayList<Address>();
		Address address1 = new Address();
		address1.setCountry("中國");
		address1.setProvince("安徽");
		address1.setCity("宿州");
		address1.setCounty("蕭縣");
		Address address2 = new Address();
		address2.setCountry("中國");
		address2.setProvince("上海");
		address2.setCity(null);
		address2.setCounty("");
		adds.add(address1);
		adds.add(address2);
		person.setAddress(adds);
		String xml = JaxbUtil.beanToXml(person);
		System.out.println(xml);
		
		//測試xml轉java對象
		Person person2 = JaxbUtil.xmlToBean(xml,Person.class);
		System.out.println(person2.getAddress().get(0).getCountry());
		System.out.println(person2.getAddress().get(1).getProvince());
		
		long time2 = System.currentTimeMillis();
		System.out.println((time2-time1)+"ms");
	}
}
           

執行後控制台列印:

<?xml version="1.0" encoding="UTF-8"?>
<person>
    <newName>admin管理者</newName>
    <sex_1>男</sex_1>
    <age>25</age>
    <Address>
        <address>
            <country>中國</country>
            <province>安徽</province>
            <city>宿州</city>
            <county>蕭縣</county>
        </address>
        <address>
            <country>中國</country>
            <province>上海</province>
            <county></county>
        </address>
    </Address>
</person>
中國
上海
531ms
           

總結:

(1) @XmlRootElement:根節點,且可以增加屬性(name="NewRootElementName"),那麼生成的xml串的标簽别名是NewRootElementName。

(2) @XmlAttribute:該屬性作為xml的屬性,且可以增加屬性(name="NewAttributeName"),那麼生成的xml串的标簽别名是NewAttributeName。

(3) @XmlElement:該屬性作為xml的元素,且可以增加屬性(name="NewElementName"),那麼生成的xml串的标簽别名是NewElementName。

(4) @XmlElementWrapper:對于數組或集合(即包含多個元素的成員變量),生成一個包裝該數組或集合的XML元素(稱為包裝器。如果不加該注解,集合中的每個對象的父節點不是List了,而是Class。

(5) @XmlType,将Java類或枚舉類型映射到XML模式類型。

(6) @XmlAccessorType(XmlAccessType.FIELD) ,控制字段或屬性的序列化。

        XmlAccessType.FIELD表示JAXB将自動綁定Java類中的每個非靜态的(static)、非瞬态的(由@XmlTransient标 注)字段到XML,即使在java對象中的屬性上不加注解@XmlElement等也可以轉成XML對象。

        XmlAccessType.NONE表示JAXB不自動綁定屬性字段到XML,是以需要在需要轉換的屬性上加上注解@XmlElement才能轉成XML對象。

        XmlAccessType.PROPERTY表示隻有屬性(有get/set方法)才能被轉換成XML中的标簽,并且屬性上不許有注解@XmlElement等,除非用@XmlTransient注釋。

        XmlAccessType.PUBLIC_MEMBER表示每個公共(public)擷取(get)方法/設定(set)方法對和每個公共字段将會自動綁定到 XML,除非由@XmlTransient注釋。

(7) @XmlAccessorOrder,控制JAXB 綁定類中屬性和字段的排序。

(8) @XmlJavaTypeAdapter,使用定制的擴充卡(即擴充抽象類XmlAdapter并覆寫marshal()和unmarshal()方法),以序列化Java類為XML

(9) 對于根節點中的對象,在該對象類上用@XmlRootElement設定别名沒有作用。