利用JAXB将XML和Java对象开展转换

利用JAXB将XML和Java对象进行转换

JAXB 可以实现Java对象与XML的相互转换，在JAXB中，将一个Java对象转换为XML的过程称之为Marshal，将XML转换为Java对象的过程称之为UnMarshal。我们可以通过在 Java 类中标注注解的方式将一个Java对象绑定到一段XML，也就是说，在Java类中标注一些注解，这些注解定义了如何将这个类转换为XML，怎么转换，以及一段XML如何被解析成这个类所定义的对象；也可以使用JAXB的XJC工具，通过定义schema的方式实现Java对象与XML的绑定。

一、Marshal过程

定义Message.java

package com.jaxb;import javax.xml.bind.annotation.*;@SuppressWarnings("restriction")@XmlRootElement(name="GC_MSG")@XmlAccessorType(XmlAccessType.FIELD)@XmlType(name="Message", propOrder={"messageId", "message"})public class Message {@XmlElement(name="MSG_ID")private String messageId;@XmlElement(name="MESSAGE")private String message;public String getMessageId() {return messageId;}public void setMessageId(String messageId) {this.messageId = messageId;}public String getMessage() {return message;}public void setMessage(String message) {this.message = message;}}

?

利用Java类生成XML

package com.jaxb;import javax.xml.bind.JAXBContext;import javax.xml.bind.JAXBException;import javax.xml.bind.Marshaller;@SuppressWarnings("restriction")public class Java2XML {/** * @param args */public static void main(String[] args) {try {JAXBContext context = JAXBContext.newInstance(Message.class);Marshaller marshaller = context.createMarshaller();marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);Message mes = new Message();mes.setMessageId("007");mes.setMessage("Summer Test XML");marshaller.marshal(mes, System.out);} catch (JAXBException e) {e.printStackTrace();}}}

通常我们会将marshal的信息写进Document中

package com.jaxb;import java.io.ByteArrayOutputStream;import java.io.OutputStream;import javax.xml.bind.*;import javax.xml.parsers.DocumentBuilder;import javax.xml.parsers.DocumentBuilderFactory;import javax.xml.parsers.ParserConfigurationException;import javax.xml.transform.OutputKeys;import javax.xml.transform.Transformer;import javax.xml.transform.TransformerConfigurationException;import javax.xml.transform.TransformerException;import javax.xml.transform.TransformerFactory;import javax.xml.transform.dom.DOMSource;import javax.xml.transform.stream.StreamResult;import org.apache.log4j.Logger;import org.w3c.dom.Document;public class Java2XMLInDoc {/** * @param args */@SuppressWarnings("restriction")public static void main(String[] args) {Logger log = Logger.getLogger(Java2XMLInDoc.class);OutputStream os = new ByteArrayOutputStream();try {JAXBContext context = JAXBContext.newInstance(Message.class);Marshaller marshaller = context.createMarshaller();// Create an empty DOM document// DocumentBuilderFactory is not thread-safeDocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();DocumentBuilder docBuilder = dbFactory.newDocumentBuilder();Document doc = docBuilder.newDocument();// Marshall the feed object into the empty document.Message msg = new Message();msg.setMessageId("008");msg.setMessage("Summer Test XML");marshaller.marshal(msg, doc);// Transform the DOM to the output stream// TransformerFactory is not thread-safeTransformerFactory tsfFacory = TransformerFactory.newInstance();Transformer transformer = tsfFacory.newTransformer();transformer.setOutputProperty(OutputKeys.INDENT, "yes");transformer.transform(new DOMSource(doc), new StreamResult(os));log.info(os);} catch (JAXBException e) {e.printStackTrace();} catch (ParserConfigurationException e) {e.printStackTrace();}catch (TransformerConfigurationException e) {e.printStackTrace();}catch (TransformerException e) {e.printStackTrace();}}}

?

所得结果：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><GC_MSG>    <MSG_ID>007</MSG_ID>    <MESSAGE>Summer Test XML</MESSAGE></GC_MSG>

?

二、Unmarshal过程

定义message.xsd

<?xml version="1.0" encoding="UTF-8"?><xs:schema elementFormDefault="qualified"xmlns:xs="http://www.w3.org/2001/XMLSchema">    <xs:element name="GC_MSG" type="Message"></xs:element>        <xs:complexType name="Message">    <xs:sequence>    <xs:element name="MSG_ID"  type="xs:string"></xs:element>    <xs:element name="MESSAGE"  type="xs:string"></xs:element>    </xs:sequence>    </xs:complexType></xs:schema>

?

定义message.xml

<?xml version="1.0" encoding="UTF-8" standalone="no"?><GC_MSG xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="message.xsd"><MSG_ID>009</MSG_ID><MESSAGE>Summer Test XML</MESSAGE></GC_MSG>

?

利用XML转成Java对象

package com.jaxb;import java.io.FileInputStream;import java.io.IOException;import java.io.InputStream;import javax.xml.XMLConstants;import javax.xml.transform.Source;import javax.xml.transform.stream.StreamSource;import javax.xml.validation.Schema;import javax.xml.validation.SchemaFactory;import javax.xml.bind.*;import org.apache.log4j.Logger;import org.xml.sax.SAXException;public class XML2JavaObject {/** * @param args */@SuppressWarnings("restriction")public static void main(String[] args) {Logger log = Logger.getLogger(XML2JavaObject.class);XML2JavaObject xml2Java = new XML2JavaObject();String schemaFileName = "message.xsd";String fileName = "message.xml";Schema schema = xml2Java.loadSchema(schemaFileName);try {JAXBContext context = JAXBContext.newInstance(Message.class);Unmarshaller unmarshaller = context.createUnmarshaller();unmarshaller.setSchema(schema);Message message = (Message)unmarshaller.unmarshal(xml2Java.getInputStream(fileName));log.info(message.getMessage());log.info(message.getMessageId());} catch (JAXBException e) {e.printStackTrace();}}private Schema loadSchema(String fileName){SchemaFactory schemeaFactory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);InputStream inputStream = getInputStream(fileName);Source streamSource = new StreamSource(inputStream);Schema schema = null;try {schema = schemeaFactory.newSchema(streamSource);} catch (SAXException e) {e.printStackTrace();}finally{if(inputStream != null){try {inputStream.close();} catch (IOException ignored) {}}}return schema;}private InputStream getInputStream(String fileName){return XML2JavaObject.class.getResourceAsStream(fileName);}}

?

所得结果：

2014-01-10 09:57:03 INFO  (XML2JavaObject.java:35)[main]  - Summer Test XML2014-01-10 09:57:03 INFO  (XML2JavaObject.java:36)[main]  - 009

?其实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文件中。

?

最后推荐一个网页，可以验证xml对应的xsd是否正确：

http://www.xmlvalidation.com/index.php?id=1&L=0