转换 XML 载荷

本节介绍如何转换 XML 载荷

将 Transformer 配置为 Bean

本节将解释以下转换器的工作原理以及如何将它们配置为 Bean

所有 XML 转换器都扩展了 AbstractTransformer 或 AbstractPayloadTransformer，因此实现了 Transformer。在 Spring Integration 中将 XML 转换器配置为 Bean 时，通常会结合 MessageTransformingHandler 配置 Transformer。这使得转换器可以用作端点。最后，我们将讨论命名空间支持，它允许将转换器配置为 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 使用 Extensible Stylesheet Language Transformations (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。

有关更多信息和示例，请参阅命名空间配置和 Result Transformer。

XML 转换器的命名空间支持

Spring Integration XML 命名空间中提供了所有 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"/>

如果提供的结果类型不满足需求，您可以使用 result-factory 属性提供对 ResultFactory 自定义实现的引用，作为设置 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 属性来指定转换器工厂类名。

命名空间配置和 Result Transformer

我们在使用 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，它会被使用，并且生成的 Message 载荷类型为 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-and-<xsl:output-method=-text-/>]] === 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 属性时可用。