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

2024-10-30 22:21:02

本文实例讲述了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=杭州市]]]

PS：这里再为大家推荐一款本站相关的JavaBean在线工具供大家参考使用：

在线JSON转Java Bean代码工具：
http://tools.jb51.net/code/json2javabean

希望本文所述对大家java程序设计有所帮助。

谈谈为JAXB和response设置编码，解决wechat4j中文乱码的问题

如果有哪一个做程序员的小伙伴说自己没有遇到中文乱码问题,我是不愿意相信的.今天在做微信订阅号的智能回复时,又一时迷乱的跳进了中文乱码这个火坑.刚解决问题时,都欢呼雀跃了,完全忘记了她曾经带给我的痛苦. 一.问题描述看到没,红色框框内的乱码赤裸裸的对我进行挑衅,而我却无可奈何,真是糟糕透顶. 二.寻求解决之道面对问题,只有拿着刀逼自己去解决啊,能怎么样呢? 首先,必须搞清楚微信智能回复的机制,画图如下: ps,工具用得不好,请见谅. 接下来,我们抓重点,看乱码重要发生在什么位置. 1.cont
java使用jaxb操作xml示例

首先定义两个示例类ClassA,ClassB,用于后续的示例演示复制代码代码如下: package cn.lzrabbit; public class ClassA { private int classAId; private String classAName; private ClassB classB; public int getClassAId() { return classAId; } public void setClassAId(i
JAXB命名空间_动力节点Java学院整理

本篇介绍下JAXB进阶使用,命名空间处理使用package-info.java添加默认命名空间在需要添加命名空间的包下面添加package-info.java文件,然后添加@XmlSchema注解,这样整个包序列化时就都会自动加上命名空间了 @XmlSchema(namespace = "http://www.lzrabbit.cn") package com.bjpowernode.test; import javax.xml.bind.annotation.XmlSchema;
JAXB简介_动力节点Java学院整理

一.jaxb是什么 JAXB是Java Architecture for XML Binding的缩写.可以将一个Java对象转变成为XML格式,反之亦然. 我们把对象与关系数据库之间的映射称为ORM,其实也可以把对象与XML之间的映射称为OXM(Object XML Mapping).原来JAXB是Java EE的一部分,在JDK1.6中,SUN将其放到了Java SE中,这也是SUN的一贯做法.JDK1.6中自带的这个JAXB版本是2.0,比起1.0(JSR 31)来,JAXB2
深入jaxb xjc编码问题的详细介绍

平时喜欢根据写一个xjc批处理命令,根据xsd批量生成java类,觉得很方便也很酷.但是有时候xsd生成的java类中含有汉字,结果总是有些问题.可是xjc命令参数又没有encoding参数之类的.在网上搜了一通,忽然发现了一个好东东:xjc是由com.sun.tools.internal.xjc.Driver实现的,因此批处理命令可以如下:java -Dfile.encoding=UTF-8 -cp D:\java\jdk1.6.0_03\lib\tools.jar com.sun.tools
Jaxb2实现JavaBean与xml互转的方法详解

本文实例讲述了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使用了JD
C#实现文件与字符串互转的方法详解

目录实现功能开发环境实现代码实现效果嗯,就是BASE64,不用多想,本来计划是要跟上一篇字符串压缩一起写的,用来实现将一个文件可以用json或者text等方式进行接口之间的传输,为了保证传输效率,所以对生成的字符串进行进一步压缩.但是由于不能上传完整源代码,所以就还是分开写了,方便展示实现效果以及功能的单独使用. 实现功能将文件与为字符串互转开发环境开发工具: Visual Studio 2013 .NET Framework版本:4.5 实现代码 //选择文件路径 privat
Python处理XML格式数据的方法详解

本文实例讲述了Python处理XML格式数据的方法.分享给大家供大家参考,具体如下: 这里的操作是基于Python3平台. 在使用Python处理XML的问题上,首先遇到的是编码问题. Python并不支持gb2312,所以面对encoding="gb2312"的XML文件会出现错误.Python读取的文件本身的编码也可能导致抛出异常,这种情况下打开文件的时候就需要指定编码.此外就是XML中节点所包含的中文. 我这里呢,处理就比较简单了,只需要修改XML的encoding头部. #!/
Android编程使用pull方式解析xml格式文件的方法详解

本文实例讲述了Android编程使用pull方式解析xml格式文件的方法.分享给大家供大家参考,具体如下: 上次已经说过使用Android sax解析xml,实际上还可以使用pull解析xml.这样的方式效率也是比较高的.pull不仅可以在Android上使用也可以用在javaee里面,需要的就是pull的jar包.这次的xml也使用上次的那个,如下所示 <?xml version="1.0" encoding="UTF-8"?> <persons
jQuery解析与处理服务器端返回xml格式数据的方法详解

本文实例讲述了jQuery解析与处理服务器端返回xml格式数据的方法.分享给大家供大家参考,具体如下: 1.php代码: <?php header("Content-Type:text/xml; charset=utf-8");//声明浏览器端返回数据的格式为xml文档格式 echo "<?xml version='1.0' encoding='utf-8'?>". "<comments>". "<c
java中四种生成和解析XML文档的方法详解（介绍+优缺点比较+示例）

众所周知,现在解析XML的方法越来越多,但主流的方法也就四种,即:DOM.SAX.JDOM和DOM4J 下面首先给出这四种方法的jar包下载地址 DOM:在现在的Java JDK里都自带了,在xml-apis.jar包里 SAX:http://sourceforge.net/projects/sax/ JDOM:http://jdom.org/downloads/index.html DOM4J:http://sourceforge.net/projects/dom4j/ 一.介绍及优缺点分析
Java解析XML格式数据的方法详解

最初,XML 语言仅仅是意图用来作为 HTML 语言的替代品而出现的,但是随着该语言的不断发展和完善,人们越来越发现它所具有的优点:例如标记语言可扩展,严格的语法规定,可使用有意义的标记,内容存储和表现分离等等优势注定了该语言从诞生之日起就会走向辉煌. XML 语言在成为 W3C 标准之后进入到了一个快速发展的时期,当然它本身所具有的一系列优点和优势也注定了各大技术厂商对它的偏爱,Java 作为软件行业的一种开发技术也迅速作出了反应,出现了多种对 XML 支持的工具,本文将会从这个角度对 Jav
Java解析XML的四种方法详解

XML现在已经成为一种通用的数据交换格式,它的平台无关性,语言无关性,系统无关性,给数据集成与交互带来了极大的方便.对于XML本身的语法知识与技术细节,需要阅读相关的技术文献,这里面包括的内容有DOM(Document Object Model),DTD(Document Type Definition),SAX(Simple API for XML),XSD(Xml Schema Definition),XSLT(Extensible Stylesheet Language Transform
Ibatis配置xml文件CDATA使用方法详解

ibatis作为一种半自动化的OR Mapping工具,其灵活性日益体现出来,越来越多的人都倾向于在项目中使用.由于Sql中经常有与xml规范相冲突的字符对xml映射文件的合法性造成影响.许多人都知道使用<![CDATA[ ]]>标记来避免冲突,但是在sql配置中有动态语句的时候,还是有一些细节需要特别注意的. 在使用ibatis时,经常需要配置待执行的sql语句.使用过ibatis的朋友都知道,无可避免的都会碰到一些不兼容.冲突的字符,多数人也都知道用<![CDATA[ ]]>标
jQ处理xml文件和xml字符串的方法(详解)

1.xml文件 <?xml version="1.0" encoding="utf-8" ?> <root> <book id="1"> <name>锋利的jQuery1</name> <author>XXX1</author> <price>250</price> </book> <book id="2&quo

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

相关推荐

随机推荐