转换 XML 有效负载
本节介绍如何转换XML负载
配置作为Bean的转换器
本节将解释以下转换器的工作原理以及如何将其配置为Bean
所有XML转换器都继承自 AbstractTransformer 或 AbstractPayloadTransformer，因此实现了 Transformer。在Spring Integration中将XML转换器配置为Bean时，通常会将 Transformer 与 MessageTransformingHandler 结合配置。这允许转换器用作端点。最后，我们将讨论命名空间支持，它允许将转换器配置为XML中的元素。
UnmarshallingTransformer
UnmarshallingTransformer 允许使用 Spring OXM Unmarshaller 的实现来解组XML Source。Spring的对象/XML映射支持提供了多种实现，它们支持使用 JAXB、Castor、JiBX 等进行编组和解组。解组器需要一个 Source 实例。如果消息负载不是 Source 实例，则仍会尝试转换。目前，支持 String、File、byte[] 和 org.w3c.dom.Document 负载。要创建自定义的 Source 转换，您可以注入 SourceFactory 的实现。
如果您没有显式设置 SourceFactory，则 UnmarshallingTransformer 上的属性默认设置为 DomSourceFactory。 |
从5.0版本开始，UnmarshallingTransformer 还支持 org.springframework.ws.mime.MimeMessage 作为传入负载。当通过SOAP接收带有MTOM附件的原始 WebServiceMessage 时，这可能很有用。有关更多信息，请参阅 MTOM 支持。
以下示例显示如何定义解组转换器
<bean id="unmarshallingTransformer" class="o.s.i.xml.transformer.UnmarshallingTransformer">
<constructor-arg>
<bean class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
<property name="contextPath" value="org.example" />
</bean>
</constructor-arg>
</bean>使用 MarshallingTransformer
MarshallingTransformer 允许使用Spring OXM Marshaller 将对象图转换为XML。默认情况下，MarshallingTransformer 返回 DomResult。但是，您可以通过配置替代的 ResultFactory（例如 StringResultFactory）来控制结果的类型。在许多情况下，将负载转换为替代XML格式更方便。为此，请配置一个 ResultTransformer。Spring Integration提供了两种实现，一种转换为 String，另一种转换为 Document。以下示例配置了一个转换为文档的编组转换器
<bean id="marshallingTransformer" class="o.s.i.xml.transformer.MarshallingTransformer">
<constructor-arg>
<bean class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
<property name="contextPath" value="org.example"/>
</bean>
</constructor-arg>
<constructor-arg>
<bean class="o.s.i.xml.transformer.ResultToDocumentTransformer"/>
</constructor-arg>
</bean>默认情况下，MarshallingTransformer 将负载对象传递给 Marshaller。但是，如果其布尔属性 extractPayload 设置为 false，则将整个 Message 实例传递给 Marshaller。这对于 Marshaller 接口的某些自定义实现可能很有用，但是，通常，当委托给各种 Marshaller 实现时，负载是编组的适当源对象。
XsltPayloadTransformer
XsltPayloadTransformer 使用 可扩展样式表语言转换 (XSLT) 转换XML负载。转换器的构造函数需要传入 Resource 或 Templates 的实例。传入 Templates 实例可以更灵活地配置用于创建模板实例的 TransformerFactory。
与 UnmarshallingTransformer 一样，XsltPayloadTransformer 对 Source 实例执行实际的XSLT转换。因此，如果消息负载不是 Source 实例，则仍会尝试转换。直接支持 String 和 Document 负载。
要创建自定义的 Source 转换，您可以注入 SourceFactory 的实现。
如果未显式设置 SourceFactory，则 XsltPayloadTransformer 上的属性默认设置为 DomSourceFactory。 |
默认情况下，XsltPayloadTransformer 创建一个带有 Result 负载的消息，类似于 XmlPayloadMarshallingTransformer。您可以通过提供 ResultFactory 或 ResultTransformer 来定制此行为。
以下示例配置了一个作为XSLT负载转换器工作的Bean
<bean id="xsltPayloadTransformer" class="o.s.i.xml.transformer.XsltPayloadTransformer">
<constructor-arg value="classpath:org/example/xsl/transform.xsl"/>
<constructor-arg>
<bean class="o.s.i.xml.transformer.ResultToDocumentTransformer"/>
</constructor-arg>
</bean>从Spring Integration 3.0开始，您可以使用构造函数参数指定转换器工厂类名。当您使用命名空间时，可以通过使用 transformer-factory-class 属性来实现。
使用 ResultTransformer 实现
MarshallingTransformer 和 XsltPayloadTransformer 都允许您指定 ResultTransformer。因此，如果编组或XSLT转换返回 Result，您可以选择也使用 ResultTransformer 将 Result 转换为另一种格式。Spring Integration提供了两个具体的 ResultTransformer 实现
默认情况下，MarshallingTransformer 总是返回一个 Result。通过指定 ResultTransformer，您可以自定义返回的负载类型。
对于 XsltPayloadTransformer，行为略微复杂。默认情况下，如果输入负载是 String 或 Document 的实例，则 resultTransformer 属性将被忽略。
但是，如果输入负载是 Source 或任何其他类型，则会应用 resultTransformer 属性。此外，您可以将 alwaysUseResultFactory 属性设置为 true，这也会导致使用指定的 resultTransformer。
有关更多信息和示例，请参阅 命名空间配置和结果转换器。
XML转换器的命名空间支持
所有XML转换器的命名空间支持都在Spring Integration XML命名空间中提供，其模板 之前已显示。转换器的命名空间支持根据所提供输入通道的类型创建 EventDrivenConsumer 或 PollingConsumer 实例。命名空间支持旨在通过允许使用一个元素创建端点和转换器来减少XML配置的数量。
使用 UnmarshallingTransformer
下面显示了 UnmarshallingTransformer 的命名空间支持。由于命名空间创建的是端点实例而不是转换器，您可以在元素中嵌套一个轮询器以控制输入通道的轮询。以下示例显示了如何操作
<int-xml:unmarshalling-transformer id="defaultUnmarshaller"
input-channel="input" output-channel="output"
unmarshaller="unmarshaller"/>
<int-xml:unmarshalling-transformer id="unmarshallerWithPoller"
input-channel="input" output-channel="output"
unmarshaller="unmarshaller">
<int:poller fixed-rate="2000"/>
<int-xml:unmarshalling-transformer/>使用 MarshallingTransformer
编组转换器的命名空间支持需要 input-channel、output-channel 和对 marshaller 的引用。您可以使用可选的 result-type 属性来控制创建的结果类型。有效值为 StringResult 或 DomResult（默认值）。以下示例配置了一个编组转换器
<int-xml:marshalling-transformer
input-channel="marshallingTransformerStringResultFactory"
output-channel="output"
marshaller="marshaller"
result-type="StringResult" />
<int-xml:marshalling-transformer
input-channel="marshallingTransformerWithResultTransformer"
output-channel="output"
marshaller="marshaller"
result-transformer="resultTransformer" />
<bean id="resultTransformer" class="o.s.i.xml.transformer.ResultToStringTransformer"/>如果提供的结果类型不足以满足需求，您可以提供对 ResultFactory 的自定义实现的引用，作为通过使用 result-factory 属性设置 result-type 属性的替代方案。result-type 和 result-factory 属性互斥。
在内部，StringResult 和 DomResult 结果类型分别由 ResultFactory 实现：StringResultFactory 和 DomResultFactory 表示。 |
使用 XsltPayloadTransformer
XsltPayloadTransformer 的命名空间支持允许您传入 Resource（以便创建 Templates 实例）或传入预先创建的 Templates 实例作为引用。与编组转换器一样，您可以通过指定 result-factory 或 result-type 属性来控制结果输出的类型。当您需要在发送之前转换结果时，可以使用 result-transformer 属性来引用 ResultTransformer 的实现。
如果您指定 result-factory 或 result-type 属性，则底层 XsltPayloadTransformer 上的 alwaysUseResultFactory 属性将由 XsltPayloadTransformerParser 设置为 true。 |
以下示例配置了两个XSLT转换器
<int-xml:xslt-transformer id="xsltTransformerWithResource"
input-channel="withResourceIn" output-channel="output"
xsl-resource="org/springframework/integration/xml/config/test.xsl"/>
<int-xml:xslt-transformer id="xsltTransformerWithTemplatesAndResultTransformer"
input-channel="withTemplatesAndResultTransformerIn" output-channel="output"
xsl-templates="templates"
result-transformer="resultTransformer"/>您可能需要访问 Message 数据（例如 Message 头部）以协助转换。例如，您可能需要访问某些 Message 头部并将它们作为参数传递给转换器，例如 transformer.setParameter(..)。Spring Integration提供了两种便捷的方法来完成此操作，如下例所示
<int-xml:xslt-transformer id="paramHeadersCombo"
input-channel="paramHeadersComboChannel" output-channel="output"
xsl-resource="classpath:transformer.xslt"
xslt-param-headers="testP*, *foo, bar, baz">
<int-xml:xslt-param name="helloParameter" value="hello"/>
<int-xml:xslt-param name="firstName" expression="headers.fname"/>
</int-xml:xslt-transformer>如果消息头名称与参数名称一对一匹配，您可以使用 xslt-param-headers 属性。在该属性中，您可以使用通配符进行简单的模式匹配。它支持以下简单的模式样式：xxx*、*xxx*、*xxx 和 xxx*yyy。
您还可以使用 <xslt-param/> 元素配置单个XSLT参数。在该元素上，您可以设置 expression 属性或 value 属性。expression 属性应该是任何有效的SpEL表达式，其中 Message 是表达式评估上下文的根对象。value 属性（与Spring Bean中的任何 value 一样）允许您指定简单的标量值。您还可以使用属性占位符（例如 ${some.value}）。因此，通过 expression 和 value 属性，您可以将XSLT参数映射到 Message 的任何可访问部分以及任何字面值。
从Spring Integration 3.0开始，您现在可以通过设置 transformer-factory-class 属性来指定转换器工厂类名。
命名空间配置和结果转换器
我们在 使用 ResultTransformer 实现 中介绍了结果转换器的使用。本节中的示例使用XML命名空间配置来演示几个特殊用例。首先，我们定义 ResultTransformer，如下例所示
<beans:bean id="resultToDoc" class="o.s.i.xml.transformer.ResultToDocumentTransformer"/>此 ResultTransformer 接受 StringResult 或 DOMResult 作为输入，并将输入转换为 Document。
现在我们可以声明转换器，如下所示
<int-xml:xslt-transformer input-channel="in" output-channel="fahrenheitChannel"
xsl-resource="classpath:noop.xslt" result-transformer="resultToDoc"/>如果传入消息的负载类型是 Source，则第一步是使用 ResultFactory 确定 Result。由于我们没有指定 ResultFactory，因此使用默认的 DomResultFactory，这意味着转换会生成 DomResult。
然而，由于我们指定了 ResultTransformer，它将被使用，并且生成的消息负载类型为 Document。
对于 String 或 Document 负载，指定的 ResultTransformer 将被忽略。如果传入消息的负载类型是 String，则XSLT转换后的负载是 String。类似地，如果传入消息的负载类型是 Document，则XSLT转换后的负载是 Document。 |
如果消息负载不是 Source、String 或 Document，作为备用选项，我们尝试使用默认的 SourceFactory 创建 Source。由于我们没有通过 source-factory 属性显式指定 SourceFactory，因此使用默认的 DomSourceFactory。如果成功，则执行XSLT转换，就好像负载类型是 Source 一样，如前几段所述。
DomSourceFactory 支持从 Document、File 或 String 负载创建 DOMSource。 |
下一个转换器声明添加了一个 result-type 属性，其值为 StringResult。result-type 在内部由 StringResultFactory 表示。因此，您也可以通过使用 result-factory 属性添加对 StringResultFactory 的引用，结果将是相同的。以下示例显示了该转换器声明
<int-xml:xslt-transformer input-channel="in" output-channel="fahrenheitChannel"
xsl-resource="classpath:noop.xslt" result-transformer="resultToDoc"
result-type="StringResult"/>由于我们使用了 ResultFactory，XsltPayloadTransformer 类的 alwaysUseResultFactory 属性被隐式设置为 true。因此，引用的 ResultToDocumentTransformer 将被使用。
因此，如果您转换类型为 String 的负载，则生成的负载类型为 Document。
XsltPayloadTransformer 和 <xsl:output method="text"/>
<xsl:output method="text"/> 告诉XSLT模板仅从输入源生成文本内容。在这种特殊情况下，我们没有理由使用 DomResult。因此，如果底层 javax.xml.transform.Transformer 的 输出属性 中名为 method 的属性返回 text，则 XsltPayloadTransformer 默认使用 StringResult。此强制转换与入站负载类型无关。此行为仅在为 <int-xml:xslt-transformer> 组件设置了 result-type 属性或 result-factory 属性时可用。
