此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Framework 6.2.0！spring-doc.cn

使用对象 XML 映射器封送 XML

介绍

本章描述了 Spring 的 Object-XML Mapping 支持。对象 XML 映射（简称 O-X 映射）是将 XML 文档相互转换的过程 一个对象。此转换过程也称为 XML 封送或 XML 序列化。本章可以互换使用这些术语。spring-doc.cn

在 O-X 映射领域中，编组器负责序列化 object （graph） 转换为 XML。以类似的方式，解组器将 XML 反序列化为 对象图。此 XML 可以采用 DOM 文档、输入或输出的形式 stream 或 SAX 处理程序。spring-doc.cn

使用 Spring 满足您的 O/X 映射需求的一些好处是：spring-doc.cn

易于配置

Spring 的 bean factory 使配置编组器变得容易，而无需 构造 JAXB 上下文、JiBX 绑定工厂等。您可以配置封送处理程序 就像您在应用程序上下文中的任何其他 bean 一样。此外，基于 XML 命名空间 配置可用于许多编组器，使配置均匀 简单。spring-doc.cn

一致的接口

Spring 的 O-X 映射通过两个全局接口运行：Marshaller 和 Unmarshaller。这些抽象允许您切换 O-X 映射框架 相对容易，只需对执行 编组。这种方法还有一个额外的好处，就是可以执行 XML 使用混合匹配方法进行封送（例如，使用 JAXB 执行一些封送处理 还有一些由 XStream 提供），让您使用每个 科技。spring-doc.cn

一致的异常层次结构

Spring 提供了从底层 O-X 映射工具到其 自己的异常层次结构，其中 作为根异常。 这些运行时异常包装原始异常，因此不会丢失任何信息。XmlMappingExceptionspring-doc.cn

Marshaller和Unmarshaller

如简介中所述，编组处理程序序列化对象 转换为 XML，并且解组器将 XML 流反序列化为对象。本节介绍 用于此目的的两个 Spring 接口。spring-doc.cn

理解Marshaller

Spring 抽象了接口后面的所有编组操作，其主要方法如下：org.springframework.oxm.Marshallerspring-doc.cn

public interface Marshaller {

	/**
	 * Marshal the object graph with the given root into the provided Result.
	 */
	void marshal(Object graph, Result result) throws XmlMappingException, IOException;
}

该接口有一个 main 方法，该方法将给定对象封送到 鉴于。结果是一个标记接口，基本上 表示 XML 输出抽象。具体实现包装各种 XML 表示形式，如下表所示：Marshallerjavax.xml.transform.Resultspring-doc.cn

结果实现 包装 XML 表示

DOMResultspring-doc.cn

org.w3c.dom.Nodespring-doc.cn

SAXResultspring-doc.cn

org.xml.sax.ContentHandlerspring-doc.cn

StreamResultspring-doc.cn

java.io.File或java.io.OutputStreamjava.io.Writerspring-doc.cn
尽管该方法接受普通对象作为其第一个参数，但大多数实现无法处理任意对象。相反，对象类 必须在映射文件中映射，使用注释进行标记，并使用 marshaller 或具有公共基类。请参阅本章后面的章节 来确定您的 O-X 技术如何管理这一点。marshal()Marshaller

理解Unmarshaller

与 类似，我们有 interface ，下面的清单显示了该接口：Marshallerorg.springframework.oxm.Unmarshallerspring-doc.cn

public interface Unmarshaller {

	/**
	 * Unmarshal the given provided Source into an object graph.
	 */
	Object unmarshal(Source source) throws XmlMappingException, IOException;
}

此接口还有一个方法，该方法从给定的（XML 输入抽象）中读取并返回读取的对象。如 其中 ，是一个具有三个具体实现的标记接口。每 包装不同的 XML 表示形式，如下表所示：javax.xml.transform.SourceResultSourcespring-doc.cn

源实现 包装 XML 表示

DOMSourcespring-doc.cn

org.w3c.dom.Nodespring-doc.cn

SAXSourcespring-doc.cn

org.xml.sax.InputSource和org.xml.sax.XMLReaderspring-doc.cn

StreamSourcespring-doc.cn

java.io.File或java.io.InputStreamjava.io.Readerspring-doc.cn

即使有两个单独的编组接口（ 和 ），Spring-WS 中的所有实现都在一个类中实现。 这意味着您可以连接一个 marshaller 类，并将其同时称为 编组程序和解组程序 .MarshallerUnmarshallerapplicationContext.xmlspring-doc.cn

理解XmlMappingException

Spring 将来自底层 O-X 映射工具的异常转换为它自己的异常 层次结构，其中 作为根例外。 这些运行时异常会包装原始异常，因此不会丢失任何信息。XmlMappingExceptionspring-doc.cn

此外，和 提供了封送操作和解组操作之间的区别，即使 底层 O-X 映射工具不这样做。MarshallingFailureExceptionUnmarshallingFailureExceptionspring-doc.cn

O-X 映射异常层次结构如下图所示：spring-doc.cn

OXM 异常

使用 和MarshallerUnmarshaller

您可以将 Spring 的 OXM 用于各种情况。在下面的示例中，我们 使用它来将 Spring Management 的应用程序的设置编组为 XML 文件。在下面的示例中，我们 使用一个简单的 JavaBean 来表示设置：spring-doc.cn

public class Settings {

	private boolean fooEnabled;

	public boolean isFooEnabled() {
		return fooEnabled;
	}

	public void setFooEnabled(boolean fooEnabled) {
		this.fooEnabled = fooEnabled;
	}
}
class Settings {
	var isFooEnabled: Boolean = false
}

application 类使用此 bean 来存储其设置。除了 main 方法之外， 类有两种方法：将设置 Bean 保存到名为 的文件中，然后再次加载这些设置。以下方法 构造一个 Spring 应用程序上下文并调用以下两个方法：saveSettings()settings.xmlloadSettings()main()spring-doc.cn

import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.oxm.Marshaller;
import org.springframework.oxm.Unmarshaller;

public class Application {

	private static final String FILE_NAME = "settings.xml";
	private Settings settings = new Settings();
	private Marshaller marshaller;
	private Unmarshaller unmarshaller;

	public void setMarshaller(Marshaller marshaller) {
		this.marshaller = marshaller;
	}

	public void setUnmarshaller(Unmarshaller unmarshaller) {
		this.unmarshaller = unmarshaller;
	}

	public void saveSettings() throws IOException {
		try (FileOutputStream os = new FileOutputStream(FILE_NAME)) {
			this.marshaller.marshal(settings, new StreamResult(os));
		}
	}

	public void loadSettings() throws IOException {
		try (FileInputStream is = new FileInputStream(FILE_NAME)) {
			this.settings = (Settings) this.unmarshaller.unmarshal(new StreamSource(is));
		}
	}

	public static void main(String[] args) throws IOException {
		ApplicationContext appContext =
				new ClassPathXmlApplicationContext("applicationContext.xml");
		Application application = (Application) appContext.getBean("application");
		application.saveSettings();
		application.loadSettings();
	}
}
class Application {

	lateinit var marshaller: Marshaller

	lateinit var unmarshaller: Unmarshaller

	fun saveSettings() {
		FileOutputStream(FILE_NAME).use { outputStream -> marshaller.marshal(settings, StreamResult(outputStream)) }
	}

	fun loadSettings() {
		FileInputStream(FILE_NAME).use { inputStream -> settings = unmarshaller.unmarshal(StreamSource(inputStream)) as Settings }
	}
}

private const val FILE_NAME = "settings.xml"

fun main(args: Array<String>) {
	val appContext = ClassPathXmlApplicationContext("applicationContext.xml")
	val application = appContext.getBean("application") as Application
	application.saveSettings()
	application.loadSettings()
}

这需要同时设置 a 和 an 属性。我们 可以使用以下方法执行此操作：ApplicationmarshallerunmarshallerapplicationContext.xmlspring-doc.cn

<beans>
	<bean id="application" class="Application">
		<property name="marshaller" ref="xstreamMarshaller" />
		<property name="unmarshaller" ref="xstreamMarshaller" />
	</bean>
	<bean id="xstreamMarshaller" class="org.springframework.oxm.xstream.XStreamMarshaller"/>
</beans>

此应用程序上下文使用 XStream，但我们可以使用任何其他编组处理程序 实例。请注意，默认情况下，XStream 不需要 任何进一步的配置，因此 bean 定义相当简单。还要注意，这两个 都实现了 和 ，因此我们可以在 应用。XStreamMarshallerMarshallerUnmarshallerxstreamMarshallermarshallerunmarshallerspring-doc.cn

此示例应用程序生成以下文件：settings.xmlspring-doc.cn

<?xml version="1.0" encoding="UTF-8"?>
<settings foo-enabled="false"/>

XML 配置命名空间

您可以使用 OXM 命名空间中的标记更简洁地配置编组器。 要使这些标记可用，您必须首先在 XML 配置文件的序言。以下示例显示了如何执行此操作：spring-doc.cn

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:oxm="http://www.springframework.org/schema/oxm" (1)
	xsi:schemaLocation="http://www.springframework.org/schema/beans
		https://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/oxm
		https://www.springframework.org/schema/oxm/spring-oxm.xsd"> (2)
1 引用架构。oxm
2 指定架构位置。oxm

该架构使以下元素可用：spring-doc.cn

每个标记在其各自的 marshaller's 部分中都有说明。不过，举个例子， JAXB2 编组器的配置可能类似于以下内容：spring-doc.cn

<oxm:jaxb2-marshaller id="marshaller" contextPath="org.springframework.ws.samples.airline.schema"/>

JAXB

JAXB 绑定编译器将 W3C XML 模式转换为一个或多个 Java 类、一个文件，可能还有一些资源文件。JAXB 还提供了一种 从带注释的 Java 类生成架构。jaxb.propertiesspring-doc.cn

Spring 支持 JAXB 2.0 API 作为 XML 编组策略，遵循 Marshaller 和 Unmarshaller 中描述的 and 接口。 相应的集成类位于包中。MarshallerUnmarshallerorg.springframework.oxm.jaxbspring-doc.cn

用Jaxb2Marshaller

该类实现了 Spring 的 和 interfaces。它需要一个上下文路径才能运行。您可以通过设置属性来设置上下文路径。上下文路径是以冒号分隔的 Java 包的列表 包含架构派生类的名称。它还提供了一个属性， 它允许您设置编组器要支持的类数组。图式 通过向 Bean 指定一个或多个模式资源来执行验证，如下例所示：Jaxb2MarshallerMarshallerUnmarshallercontextPathclassesToBeBoundspring-doc.cn

<beans>
	<bean id="jaxb2Marshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
		<property name="classesToBeBound">
			<list>
				<value>org.springframework.oxm.jaxb.Flight</value>
				<value>org.springframework.oxm.jaxb.Flights</value>
			</list>
		</property>
		<property name="schema" value="classpath:org/springframework/oxm/schema.xsd"/>
	</bean>

	...

</beans>

XML 配置命名空间

该元素配置一个 ， 如下例所示：jaxb2-marshallerorg.springframework.oxm.jaxb.Jaxb2Marshallerspring-doc.cn

<oxm:jaxb2-marshaller id="marshaller" contextPath="org.springframework.ws.samples.airline.schema"/>

或者，可以使用 child 元素提供要绑定到编组处理程序的类列表：class-to-be-boundspring-doc.cn

<oxm:jaxb2-marshaller id="marshaller">
	<oxm:class-to-be-bound name="org.springframework.ws.samples.airline.schema.Airport"/>
	<oxm:class-to-be-bound name="org.springframework.ws.samples.airline.schema.Flight"/>
	...
</oxm:jaxb2-marshaller>

下表描述了可用属性：spring-doc.cn

属性 描述 必填

idspring-doc.cn

封送处理程序的 IDspring-doc.cn

不spring-doc.cn

contextPathspring-doc.cn

JAXB 上下文路径spring-doc.cn

不spring-doc.cn

吉BX

JiBX 框架提供了一个类似于 Hibernate 为 ORM 提供的解决方案：一个 binding 定义定义如何将 Java 对象转换为此对象或从中转换的规则 在准备绑定并编译类之后，JiBX 绑定编译器 增强了类文件并添加了代码以处理类实例的转换 from 或 to XML。spring-doc.cn

有关 JiBX 的更多信息，请参阅 JiBX Web 站点。Spring 集成类驻留在包中。org.springframework.oxm.jibxspring-doc.cn

用JibxMarshaller

该类同时实现 and 接口。要进行操作，它需要要封送的类的名称，您可以 set 使用属性。（可选）您可以通过设置属性来设置绑定名称。在下面的示例中，我们绑定了类：JibxMarshallerMarshallerUnmarshallertargetClassbindingNameFlightsspring-doc.cn

<beans>
	<bean id="jibxFlightsMarshaller" class="org.springframework.oxm.jibx.JibxMarshaller">
		<property name="targetClass">org.springframework.oxm.jibx.Flights</property>
	</bean>
	...
</beans>

A 配置为单个类。如果要封送多个 类，则必须配置具有不同属性值的多个实例。JibxMarshallerJibxMarshallertargetClassspring-doc.cn

XML 配置命名空间

该标签配置了一个 、 如下例所示：jibx-marshallerorg.springframework.oxm.jibx.JibxMarshallerspring-doc.cn

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

下表描述了可用属性：spring-doc.cn

属性 描述 必填

idspring-doc.cn

封送处理程序的 IDspring-doc.cn

不spring-doc.cn

target-classspring-doc.cn

此封送处理程序的目标类spring-doc.cn

是的spring-doc.cn

bindingNamespring-doc.cn

此封送处理程序使用的绑定名称spring-doc.cn

不spring-doc.cn

XStream

XStream 是一个简单的库，用于将对象序列化为 XML，然后再序列化回来。它没有 需要任何映射并生成干净的 XML。spring-doc.cn

有关 XStream 的更多信息，请参阅 XStream 网站。Spring 集成类驻留在包中。org.springframework.oxm.xstreamspring-doc.cn

用XStreamMarshaller

不需要任何配置，可以在 application context 直接访问。要进一步自定义 XML，您可以设置别名映射 由映射到类的字符串别名组成，如下例所示：XStreamMarshallerspring-doc.cn

<beans>
	<bean id="xstreamMarshaller" class="org.springframework.oxm.xstream.XStreamMarshaller">
		<property name="aliases">
			<props>
				<prop key="Flight">org.springframework.oxm.xstream.Flight</prop>
			</props>
		</property>
	</bean>
	...
</beans>

默认情况下，XStream 允许对任意类进行解组，这可能导致 不安全的 Java 序列化效果。因此，我们不建议使用 the 从外部源（即 Web）解组 XML，因为这样做可能会 导致安全漏洞。XStreamMarshallerspring-doc.cn

如果您选择使用从外部源解组 XML， 在 上设置 属性，如下例所示：XStreamMarshallersupportedClassesXStreamMarshallerspring-doc.cn

<bean id="xstreamMarshaller" class="org.springframework.oxm.xstream.XStreamMarshaller">
	<property name="supportedClasses" value="org.springframework.oxm.xstream.Flight"/>
	...
</bean>

这样做可以确保只有已注册的类才有资格进行 unmarshalling。spring-doc.cn

此外，您还可以注册自定义 converters 来确保只有您支持的类可以解组。你可以 想要添加 a 作为列表中的最后一个转换器，除了 显式支持应支持的 Domain 类的转换器。作为 结果，默认 XStream 转换器具有较低的优先级和可能的安全性 漏洞不会被调用。CatchAllConverterspring-doc.cn
请注意，XStream 是一个 XML 序列化库，而不是一个数据绑定库。 因此，它对命名空间的支持有限。因此，它相当不适合使用 在 Web 服务中。