Spring 对象XML映射

ゞ浴缸里的玫瑰 2022-07-12 04:46 251阅读 0赞

## OXM简介 ##

我们都知道对象关系映射（ORM），用来将Java对象和关系型数据库的数据进行映射。Spring也提供了一套类似的映射机制，用来将Java对象和XML文件进行映射。这就是Spring的对象XML映射功能，有时候也成为XML的序列化和反序列化。

这套功能的最基本的两个接口就是`org.springframework.oxm.Marshaller`和`org.springframework.oxm.Unmarshaller`，前者用于将Java对象转换成XML文件，后者用于将XML文件转换成Java对象。

Marshaller接口如下，它有一个marshal方法，包含要序列化的对象，结果会返回到Result参数上。Result也是一个接口，相应的有几个实现DOMResult、SAXResult和StreamResult，代表几种不同的XML技术。

public interface Marshaller {
    
        void marshal(Object graph, Result result) throws XmlMappingException, IOException;
    }

`Unmarshaller`接口也是类似的，它有一个unmarshal方法，将传入的Source反序列化Java对象。相应的Source也有三个实现DOMSource、SAXSource和StreamSource，代表这几种技术。

public interface Unmarshaller {
    
        Object unmarshal(Source source) throws XmlMappingException, IOException;
    }

## 基本使用 ##

要使用Spring的OXM功能，需要添加它的依赖。如果使用Gradle，添加下面的依赖项。

compile group: 'org.springframework', name: 'spring-oxm', version: '4.3.6.RELEASE'

Spring提供了几个Marshaller和Unmarshaller接口的实现，用来进行各种转换操作。我们来使用最简单的一个转换器CastorMarshaller，它同时实现了Marshaller和Unmarshaller接口，因此我们可以使用它同时进行序列化和反序列化。同时它不需要其他额外配置。在配置文件中，声明如下一个Bean。

我们来定义一个实体类来进行XML序列化和反序列化，方法已省略，只列出字段。

public class User {
        private int id;
        private String name;
        private int age;
    }

然后我们使用一个方法来测试

public class OXMTest {
    
        private static ApplicationContext context;
        private static User user;
    
        @BeforeClass
        public static void init() {
            context = new ClassPathXmlApplicationContext("classpath:oxm.xml");
            user = new User();
            user.setName("yitian");
            user.setAge(24);
            user.setId(1);
        }
    
        @Test
        public void test() throws IOException {
            Marshaller marshaller = context.getBean("castorMarshaller", CastorMarshaller.class);
            Unmarshaller unmarshaller = context.getBean("castorMarshaller", CastorMarshaller.class);
            //直接输出到标准输出流
            Result result = new StreamResult(System.out);
            marshaller.marshal(user, result);
            System.out.println();
    
        }
    }

我们可以在控制台上得到类似下面的输出。我们可以看到CastorMarshaller默认情况下会将简单类型处理为属性，引用类型处理为子元素。

<?xml version="1.0" encoding="UTF-8"?>
    <user age="24" id="1"><name>yitian</name></user>

## 各种序列化器 ##

下面来介绍一下Spring实现的一些XML序列化器和反序列化器

### JAXB ###

[JAXB][]全称是Java Architecture for XML Binding，为XML表和Java对象之间提供了快速而简单的绑定。`org.springframework.oxm.jaxb.Jaxb2Marshaller`同时实现了Marshaller和Unmarshaller，所以我们只需要配置一个Jaxb2Marshaller即可。使用JAXB，我们需要设置其classesToBeBound属性指定要绑定哪些类，还可以设置schema属性提供XML的验证。JAXB的详细使用方法请参见其文档。

也可以使用oxm命名空间简化配置。

<oxm:jaxb2-marshaller id="marshaller">
        <oxm:class-to-be-bound name="foo.bar.Bean1"/>
        <oxm:class-to-be-bound name="foo.bar.Bean2"/>
        ...
    </oxm:jaxb2-marshaller>

### Castor ###

[*Castor*][Castor]是一个开源的XML绑定框架。详细使用方法请参见其文档。该类库是一个第三方类库，所以为了使用它还需要引用其类库。CastorMarshaller同时实现了Marshaller和Unmarshaller。

默认情况下不需要配置即可使用。如果需要配置XML绑定，我们可以添加一个绑定文件，绑定文件如何编写参见[Castor XML Mapping][]。

当然也可以使用oxm命名空间简化。

<oxm:castor-marshaller id="marshaller" mapping-location="classpath:org/springframework/oxm/castor/mapping.xml"/>

### XMLBeans（已过时） ###

[*XMLBeans*][XMLBeans]也是一个XML绑定工具，但是它的绑定功能需要Java类继承XmlObject基类。

XmlBeansMarshaller同时实现了Marshaller和Unmarshaller。我们需要添加如下的Bean配置。

或者使用oxm命名空间。

<oxm:xmlbeans-marshaller id="marshaller"/>

由于XMLBeans项目已过时，因此Spring相应的XMLBeans类也过时了。

### JiBX ###

[*JiBX*][JiBX].也是一个XML映射类库，它提供和JDO的对象关系映射类似的功能。

JibxMarshaller同时实现了Marshaller和Unmarshaller。

它的Bean配置文件如下。我们使用targetClass属性向其添加要映射的类。

或者使用oxm命名空间简化。

<oxm:jibx-marshaller id="marshaller" target-class="org.springframework.ws.samples.airline.schema.Flight"/>

JibxMarshaller设计为只为一个类进行序列化和反序列化。因此如果要序列化多个类，就需要配置多个JibxMarshaller。

### XStream ###

[*XStream*][XStream]是一个简单的XML序列化库。

默认情况下XStream不需要任何配置即可使用。如果需要配置的话，可以使用aliases属性自定义生成的XML文件。

XStream可以反序列化匿名类，可能会造成安全隐患。所以最好不要使用XStream来反序列化外部加载的XML（例如网络上的XML）。我们还可以使用supportedClasses属性注册类，这样会确保我们只反序列化注册的类。

另外需要注意XStream只是一个XML序列化库，而不是数据绑定库。也就是说它的功能不如前面几个库完善，有些命名空间不支持。因此你无法用XStream来完成类似Web服务的功能。

[JAXB]: https://docs.oracle.com/javase/tutorial/jaxb/intro/index.html
[Castor]: https://castor-data-binding.github.io/castor
[Castor XML Mapping]: https://castor-data-binding.github.io/castor/reference-guides/1.3.3/html-single/index.html#xml.mapping
[XMLBeans]: https://xmlbeans.apache.org/
[JiBX]: http://jibx.sourceforge.net/
[XStream]: https://x-stream.github.io/