`

Jaxb2 实现JavaBean与xml互转

 
阅读更多

一、简介

      JAXB（Java Architecture for XML Binding) 是一个业界的标准，是一项可以根据XML Schema产生Java类的技术。该过程中，JAXB也提供了将XML实例文档反向生成Java对象树的方法，并能将Java对象树的内容重新写到 XML实例文档。

      Jaxb 2.0是JDK 1.6的组成部分。我们不需要下载第三方jar包 即可做到轻松转换。Jaxb2使用了JDK的新特性，如：Annotation、GenericType等，需要在即将转换的JavaBean中添加annotation注解。

 

二、重要概念

  • JAXBContext类，是应用的入口，用于管理XML/Java绑定信息。
  • Marshaller接口，将Java对象序列化为XML数据。
  • Unmarshaller接口，将XML数据反序列化为Java对象。

 

  • @XmlType，将Java类或枚举类型映射到XML模式类型
  • @XmlAccessorType(XmlAccessType.FIELD) ，控制字段或属性的序列化。FIELD表示JAXB将自动绑定Java类中的每个非静态的（static）、非瞬态的（由@XmlTransient标 注）字段到XML。其他值还有XmlAccessType.PROPERTY和XmlAccessType.NONE。
  • @XmlAccessorOrder，控制JAXB 绑定类中属性和字段的排序。
  • @XmlJavaTypeAdapter，使用定制的适配器（即扩展抽象类XmlAdapter并覆盖marshal()和unmarshal()方法），以序列化Java类为XML。
  • @XmlElementWrapper ，对于数组或集合（即包含多个元素的成员变量），生成一个包装该数组或集合的XML元素（称为包装器）。
  • @XmlRootElement，将Java类或枚举类型映射到XML元素。
  • @XmlElement，将Java类的一个属性映射到与属性同名的一个XML元素。
  • @XmlAttribute，将Java类的一个属性映射到与属性同名的一个XML属性。

 

 三、示例

 

1、准备工作

 

package utils;

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

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

/**
 * Jaxb2工具类
 * @author		zhuc
 * @create		2013-3-29 下午2:40:14
 */
public class JaxbUtil {

	/**
	 * JavaBean转换成xml
	 * 默认编码UTF-8
	 * @param obj
	 * @param writer
	 * @return 
	 */
	public static String convertToXml(Object obj) {
		return convertToXml(obj, "UTF-8");
	}

	/**
	 * JavaBean转换成xml
	 * @param obj
	 * @param encoding 
	 * @return 
	 */
	public static String convertToXml(Object obj, String encoding) {
		String result = null;
		try {
			JAXBContext context = JAXBContext.newInstance(obj.getClass());
			Marshaller marshaller = context.createMarshaller();
			marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
			marshaller.setProperty(Marshaller.JAXB_ENCODING, encoding);

			StringWriter writer = new StringWriter();
			marshaller.marshal(obj, writer);
			result = writer.toString();
		} catch (Exception e) {
			e.printStackTrace();
		}

		return result;
	}

	/**
	 * xml转换成JavaBean
	 * @param xml
	 * @param c
	 * @return
	 */
	@SuppressWarnings("unchecked")
	public static <T> T converyToJavaBean(String xml, Class<T> c) {
		T t = null;
		try {
			JAXBContext context = JAXBContext.newInstance(c);
			Unmarshaller unmarshaller = context.createUnmarshaller();
			t = (T) unmarshaller.unmarshal(new StringReader(xml));
		} catch (Exception e) {
			e.printStackTrace();
		}

		return t;
	}
}

 非常简单易懂，需要注意的是

 

marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
marshaller.setProperty(Marshaller.JAXB_ENCODING, encoding);

 

 

Marshaller.JAXB_FORMATTED_OUTPUT 决定是否在转换成xml时同时进行格式化（即按标签自动换行，否则即是一行的xml）

Marshaller.JAXB_ENCODING xml的编码方式

 

另外，Marshaller 还有其他Property可以设置，可以去查阅api。

 

 

2、最简单转换

package t1;

import java.util.Date;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

/**
 * @author		zhuc
 * @create		2013-3-29 下午2:49:48
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement
@XmlType(name = "book", propOrder = { "author", "calendar", "price", "id" })
public class Book {

	@XmlElement(required = true)
	private String author;

	@XmlElement(name = "price_1", required = true)
	private float price;

	@XmlElement
	private Date calendar;

	@XmlAttribute
	private Integer id;

	/**
	 * @return the author
	 */
	public String getAuthor() {
		return author;
	}

	/**
	 * @return the price
	 */
	public float getPrice() {
		return price;
	}

	/**
	 * @return the calendar
	 */
	public Date getCalendar() {
		return calendar;
	}

	/**
	 * @return the id
	 */
	public Integer getId() {
		return id;
	}

	/**
	 * @param author the author to set
	 */
	public void setAuthor(String author) {
		this.author = author;
	}

	/**
	 * @param price the price to set
	 */
	public void setPrice(float price) {
		this.price = price;
	}

	/**
	 * @param calendar the calendar to set
	 */
	public void setCalendar(Date calendar) {
		this.calendar = calendar;
	}

	/**
	 * @param id the id to set
	 */
	public void setId(Integer id) {
		this.id = id;
	}

	/* (non-Javadoc)
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString() {
		return "Book [author=" + author + ", price=" + price + ", calendar=" + calendar + ", id=" + id + "]";
	}

}

 

 

 

package t1;

import java.util.Date;

import javax.xml.bind.JAXBException;

import org.junit.Test;

import utils.JaxbUtil;

/**
 * @author		zhuc
 * @create		2013-3-29 下午2:50:00
 */
public class JaxbTest1 {

	/**
	 * @throws JAXBException
	 */
	@Test
	public void showMarshaller()  {
		Book book = new Book();
		book.setId(100);
		book.setAuthor("James");
		book.setCalendar(new Date());
		book.setPrice(23.45f);	 //默认是0.0
		
		String str = JaxbUtil.convertToXml(book);
		System.out.println(str);
	}

	/**
	 * @throws JAXBException
	 */
	@Test
	public void showUnMarshaller() {
		String str = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>" +
			"<book id=\"100\">" +
			"    <author>James</author>" +
			 "   <calendar>2013-03-29T09:25:56.004+08:00</calendar>" +
			  "  <price_1>23.45</price_1>" +
			"</book>";
		
		Book book = JaxbUtil.converyToJavaBean(str, Book.class);
		System.out.println(book);
	}
}

 

 

输出结果分别为：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<book id="100">
    <author>James</author>
    <calendar>2013-03-29T14:50:58.974+08:00</calendar>
    <price_1>23.45</price_1>
</book>


Book [author=James, price=23.45, calendar=Fri Mar 29 09:25:56 CST 2013, id=100]

 

3、类中包含复杂对象的转换

package t2;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

/**
 * @author		zhuc
 * @create		2013-3-29 下午2:51:44
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "student")
@XmlType(propOrder = {})
public class Student {

	@XmlAttribute
	private Integer id;

	@XmlElement
	private String name;

	@XmlElement(name = "role")
	private Role role;

	/**
	 * @return the id
	 */
	public Integer getId() {
		return id;
	}

	/**
	 * @return the name
	 */
	public String getName() {
		return name;
	}

	/**
	 * @return the role
	 */
	public Role getRole() {
		return role;
	}

	/**
	 * @param id the id to set
	 */
	public void setId(Integer id) {
		this.id = id;
	}

	/**
	 * @param name the name to set
	 */
	public void setName(String name) {
		this.name = name;
	}

	/**
	 * @param role the role to set
	 */
	public void setRole(Role role) {
		this.role = role;
	}

	/* (non-Javadoc)
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString() {
		return "Student [id=" + id + ", name=" + name + ", role=" + role + "]";
	}

}

 

 

package t2;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;

/**
 * @author		zhuc
 * @create		2013-3-29 下午2:51:52
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(propOrder = { "name", "desc" })
public class Role {

	@XmlElement
	private String name;

	@XmlElement
	private String desc;

	/**
	 * @return the name
	 */
	public String getName() {
		return name;
	}

	/**
	 * @return the desc
	 */
	public String getDesc() {
		return desc;
	}

	/**
	 * @param name the name to set
	 */
	public void setName(String name) {
		this.name = name;
	}

	/**
	 * @param desc the desc to set
	 */
	public void setDesc(String desc) {
		this.desc = desc;
	}

	/* (non-Javadoc)
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString() {
		return "Role [name=" + name + ", desc=" + desc + "]";
	}

}

 

 

package t2;

import org.junit.Test;

import utils.JaxbUtil;

/**
 * @author		zhuc
 * @create		2013-3-29 下午2:52:00
 */
public class JaxbTest2 {

	@Test
	public void showMarshaller() {

		Student student = new Student();
		student.setId(12);
		student.setName("test");

		Role role = new Role();
		role.setDesc("管理");
		role.setName("班长");

		student.setRole(role);

		String str = JaxbUtil.convertToXml(student);
		System.out.println(str);
	}

	@Test
	public void showUnMarshaller() {
		String str = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>"+
			"<student id=\"12\">"+
			"    <name>test</name>"+
			 "   <role>"+
			  "      <name>班长</name>"+
			   "     <desc>管理</desc>"+
			    "</role>"+
			"</student>";
		Student student = JaxbUtil.converyToJavaBean(str, Student.class);
		System.out.println(student);
	}
	
}

 

 

输出结果分别为：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<student id="12">
    <name>test</name>
    <role>
        <name>班长</name>
        <desc>管理</desc>
    </role>
</student>

Student [id=12, name=test, role=Role [name=班长, desc=管理]]

 

4、集合对象的转换（同样适用于Set）

package t3;

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;
import javax.xml.bind.annotation.XmlType;

/**
 * @author		zhuc
 * @create		2013-3-29 下午2:55:56
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "country")
@XmlType(propOrder = { "name", "provinceList" })
public class Country {

	@XmlElement(name = "country_name")
	private String name;

	@XmlElementWrapper(name = "provinces")
	@XmlElement(name = "province")
	private List<Province> provinceList;

	/**
	 * @return the name
	 */
	public String getName() {
		return name;
	}

	/**
	 * @return the provinceList
	 */
	public List<Province> getProvinceList() {
		return provinceList;
	}

	/**
	 * @param name the name to set
	 */
	public void setName(String name) {
		this.name = name;
	}

	/**
	 * @param provinceList the provinceList to set
	 */
	public void setProvinceList(List<Province> provinceList) {
		this.provinceList = provinceList;
	}

	/* (non-Javadoc)
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString() {
		return "Country [name=" + name + ", provinceList=" + provinceList + "]";
	}

}

 

package t3;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;

/**
 * @author		zhuc
 * @create		2013-3-29 下午2:56:03
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(propOrder = { "name", "provCity" })
public class Province {

	@XmlElement(name = "province_name")
	private String name;

	@XmlElement(name = "prov_city")
	private String provCity;

	/**
	 * @return the provCity
	 */
	public String getProvCity() {
		return provCity;
	}

	/**
	 * @param provCity the provCity to set
	 */
	public void setProvCity(String provCity) {
		this.provCity = provCity;
	}

	/**
	 * @return the name
	 */
	public String getName() {
		return name;
	}

	/**
	 * @param name the name to set
	 */
	public void setName(String name) {
		this.name = name;
	}

	/* (non-Javadoc)
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString() {
		return "Province [name=" + name + ", provCity=" + provCity + "]";
	}

}

package t3;

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

import org.junit.Test;

import utils.JaxbUtil;

/**
 * @author		zhuc
 * @create		2013-3-29 下午2:56:11
 */
public class JaxbTest3 {

	/**
	 * @throws JAXBException
	 */
	@Test
	public void showMarshaller() {
		Country country = new Country();
		country.setName("中国");

		List<Province> list = new ArrayList<Province>();
		Province province = new Province();
		province.setName("江苏省");
		province.setProvCity("南京市");
		Province province2 = new Province();
		province2.setName("浙江省");
		province2.setProvCity("杭州市");
		list.add(province);
		list.add(province2);

		country.setProvinceList(list);

		String str = JaxbUtil.convertToXml(country);
		System.out.println(str);
	}

	/**
	 * 
	 */
	@Test
	public void showUnMarshaller() {
		String str = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>"+
			"<country>"+
			"    <country_name>中国</country_name>"+
			"    <provinces>"+
			"        <province>"+
			"            <province_name>江苏省</province_name>"+
			 "           <prov_city>南京市</prov_city>"+
			"        </province>"+
			 "       <province>"+
			 "           <province_name>浙江省</province_name>"+
			 "           <prov_city>杭州市</prov_city>"+
			 "       </province>"+
			"    </provinces>"+
			"</country>";
		Country country = JaxbUtil.converyToJavaBean(str, Country.class);
		System.out.println(country);
	}
	
}

  

 

输出结果分别为：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<country>
    <country_name>中国</country_name>
    <provinces>
        <province>
            <province_name>江苏省</province_name>
            <prov_city>南京市</prov_city>
        </province>
        <province>
            <province_name>浙江省</province_name>
            <prov_city>杭州市</prov_city>
        </province>
    </provinces>
</country>

Country [name=中国, provinceList=[Province [name=江苏省, provCity=南京市], Province [name=浙江省, provCity=杭州市]]]

分享到：
| 淘宝开源监控Tsar系统
评论
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

    Jaxb2实现JavaBean与xml互转的方法详解

    JAXB (Java Architecture for XML Binding) 是Java平台上的一个标准，它允许开发人员将XML文档与Java对象之间进行绑定，从而实现XML数据的序列化和反序列化。Jaxb2是JAXB的一个版本，从JDK 1.6开始成为其内置组件，...

    使用JAXB完成JAVAbean与xml互转

    在本文中，我们将深入探讨如何使用JAXB实现JavaBean到XML的转换以及XML到JavaBean的反向转换。 首先，JAXB的核心组件包括`@XmlRootElement`、`@XmlElement`、`@XmlAttribute`等注解，它们用于标记Java类和类的属性...

    利用JAXB进行xml和javabean之间转换

    而JAXB（Java Architecture for XML Binding）是Java提供的一种标准API，它允许我们轻松地在Java对象（javabean）和XML文档之间进行转换。通过JAXB，开发者可以避免手动编写XML解析和序列化代码，极大地提高了开发...

    javaBean 与 xml 互转

    总结来说，JavaBean和XML的互转是通过Java的标准库JAXB实现的。通过定义符合JavaBean规范的类，并利用JAXB的序列化和反序列化功能，我们可以方便地在Java对象和XML文档之间进行数据转换。这在处理Web服务、配置文件...

    xml转javaBean,javaBean转xml,xml标签大小写问题,以及对xml特殊符号的处理

    2. JavaBean转XML： JavaBean转XML的过程与XML转JavaBean相反。首先，创建一个JAXBContext对象，然后获取Marshaller实例。通过调用Marshaller的marshal()方法，我们可以将JavaBean对象转换为XML字符串或者写入XML...

    json、javaBean、xml互转的几种工具介绍

    对于XML转换，Jackson有一个名为`JAXB`的模块，可以处理XML与Java对象之间的转换。 3. **JAXB (Java Architecture for XML Binding)** JAXB是Java SE的一部分，用于将Java对象绑定到XML。它支持XML到JavaBean的...

    javabean 与 xml文件转换

    总结一下，JavaBean与XML之间的转换主要依赖于Java的`JAXB`框架。通过创建和解析绑定文件，我们可以轻松地将Java对象序列化为XML，或将XML反序列化为Java对象。这种转换在数据交换、配置文件存储或持久化场景中非常...

    javabean和xml互相转换工具类以及jar包

    2. **XML转JavaBean**： - **DOM解析**：解析XML文档，创建一个Document对象，然后遍历XML节点，调用JavaBean的setter方法设置属性值。 - **SAX（Simple API for XML）**：非回溯事件驱动的解析方式，根据XML事件...

    javabean到XML的转换

    在Java中，有多种方法可以实现JavaBean到XML的转换，包括使用API如JAXB（Java Architecture for XML Binding）、DOM（Document Object Model）、SAX（Simple API for XML）或者第三方库如Castor等。本篇我们将重点...

    Xml与javaBean互转.zip

    JavaBean与XML之间的互转是开发中的常见需求，这允许我们在不依赖具体实现的情况下存储和传输数据。以下是一些关于如何在Java中实现这种转换的关键知识点： 1. **JAXB（Java Architecture for XML Binding）**：...

    JavaBean和xml转换

    JavaBean和XML转换是Java开发中的一个重要主题，特别是在...通过学习和理解JAXB的工作原理以及如何在代码中应用，开发者可以有效地在Java应用程序中实现JavaBean和XML之间的无缝转换，提高开发效率和数据处理的灵活性。

    JAXB xml与对象转换

    2. **添加注解**：在Java类和字段上添加JAXB注解，这些注解告诉JAXB如何映射XML元素和属性。 3. **创建Unmarshaller和Marshaller对象**：使用`javax.xml.bind.JAXBContext`类来创建Unmarshaller和Marshaller对象，...

    javabean2xml实例与jox-1.17b3.jar

    JavaBean2XML实例与JOX-1.17b3.jar是关于在Java中将对象序列化为XML文档的一种技术的实例应用。JOX（Java Object eXchange）是一个轻量级的开源库，用于方便地在Java对象和XML之间进行转换。在Java开发中，我们经常...

    java持久化工具类：JavaBean与XML

    2. `fromXML(String xml)`: 从XML字符串创建JavaBean对象。 3. `readXMLFile(String filePath)`: 从XML文件读取数据并返回JavaBean列表。 4. `writeXMLFile(List&lt;JavaBean&gt; beans, String filePath)`: 将JavaBean...

    jaxb解析xml

    2. 使用 JAXB 的 XJC 工具，通过定义 schema 的方式实现 Java 对象与 XML 的绑定。 ### 3.2 JAXB Annotation 使用说明 #### 3.2.1 @XmlType @XmlType 定义映射的一些规则，用在 class 类的注解，常与 @...

    xml与javabean的相互转换

    XML与JavaBean的转换是Java开发中常见的任务，掌握好这一技能能帮助我们更好地利用XML的灵活性和JavaBean的面向对象特性，实现数据的高效管理。通过深入学习和实践，可以提升我们在软件开发中的能力，尤其是在构建...

Magicbox
Global site tag (gtag.js) - Google Analytics