A generic JAXB marshal/unmarshal XmlType

引子

xsd中的complexType在JAXB中对应XmlType，element在JAXB中对应XmlRootElement。而xml序列化(marshal)和反序列化(unmarshal)的对象是element而不是type，所以在JAXB中XmlType无法被直接序列化，只能通过xsd定义element或者如通过Annotation声明XmlRootElement来完成。

 

比如，我们的xsd中定义为

 

<complexType name="Admin"> <sequence> <element name="id" type="long"/> <element name="companyId" type="long"/> <element name="email" type="string"/> <element name="password" type="string"/> </sequence> </complexType> 

 

要想序列化上面的Admin

• 一种方式是定义xml element

<element name=”admin” type=”ns:Admin”> 

• 另外一种方式是使用Annotaion。比如声明一个Wrapper类AdminElement

@XmlRootElement(name = "adminElement") static class AdminElement { @XmlElement(name = "admin") Admin admin; } 

 

假如我们的类很有多，除了Admin,还有Company, Employee, User, Device, Job, Event,...而且在XSD中都只定义了xml type而没有定义xml element。这时序列化这些对象，为每个类都声明一个wrapper类，显得很繁琐。

 

 

解决这类问题,进行 代码去重的一般思路是

1. 泛型和模板
2. 反射
3. 代码生成器(cglib, asm)，自动生成code

 

解决

我们采用的第一种：泛型和模板。代码如下：

 

marshal

 

利用非Annotation的JAXBElement来声明element(javadoc: JAXB representation of an Xml Element)，然后序列化此JAXBElement对象。

@SuppressWarnings("unchecked") public static <T> void marshallXmlType(T value, OutputStream os) { try { Class<T> clzz = (Class<T>) value.getClass(); JAXBContext context = JAXBContext.newInstance(clzz); Marshaller m = context.createMarshaller(); m.setProperty("jaxb.formatted.output", true); QName name = new QName(clzz.getSimpleName()); JAXBElement<T> element = new JAXBElement<T>(name, clzz, value); m.marshal(element, os); } catch (JAXBException e) { e.printStackTrace(); } } 

 

unmarshal

同样是需要使用JAXBElement.所以使用的方法是带有declaredType的unmarshall

public static <T> T unmarshallXmlType(Class<T> clzz, InputStream input) { try { JAXBContext context = JAXBContext.newInstance(clzz); Unmarshaller u = context.createUnmarshaller(); JAXBElement<T> element = u.unmarshal(new StreamSource(input), clzz); return element.getValue(); } catch (JAXBException e) { e.printStackTrace(); } return null; } 

 

Test

成对的API是比较好测试的，测试如下：

• 创建一个实例
• 将其序列化为xml
• 将xml反序列化成实例对象
• 比较两个实例

 

@Test public void testMarshalAndUnmarshal() throws IOException { long now = System.currentTimeMillis(); Admin admin = new Admin(); admin.setId(now); admin.setCompanyId(now); admin.setEmail(String.valueOf(now)); PipedOutputStream out = new PipedOutputStream(); PipedInputStream input = new PipedInputStream(out); ObjectFactory.marshallXmlType(admin, out); out.close(); Admin adminFromXml = ObjectFactory .unmarshallXmlType(Admin.class, input); Assert.assertEquals(admin.getEmail(), adminFromXml.getEmail()); } 

 

 

参考

http://jaxb.java.net/guide/_XmlRootElement_and_unmarshalling.html