使用 XPath 路由 XML 消息

与基于 SpEL 的路由器类似,Spring Integration 支持基于 XPath 表达式的消息路由,这允许您创建一个带有输入通道但没有输出通道的消息端点。相反,一个或多个输出通道是动态确定的。以下示例展示了如何创建此类路由器

<int-xml:xpath-router id="orderTypeRouter" input-channel="orderChannel">
    <int-xml:xpath-expression expression="/order/type"/>
</int-xml:xpath-router>
有关路由器共有的属性的概览,请参阅常用路由器参数

在内部,XPath 表达式被评估为 NODESET 类型,并转换为表示通道名称的 List<String>。通常,此类列表包含单个通道名称。但是,基于 XPath 表达式的结果,如果 XPath 表达式返回多个值,XPath 路由器也可以具备收件人列表路由器的特征。在这种情况下,List<String> 包含多个通道名称。因此,消息会发送到列表中的所有通道。

因此,假设传递给以下路由器配置的 XML 文件包含许多表示通道名称的 responder 子元素,消息将发送到所有这些通道

<!-- route the order to all responders-->
<int-xml:xpath-router id="responderRouter" input-channel="orderChannel">
    <int-xml:xpath-expression expression="/request/responders"/>
</int-xml:xpath-router>

如果返回的值不直接代表通道名称,您可以指定额外的映射参数将这些返回的值映射到实际的通道名称。例如,如果 /request/responders 表达式产生两个值(responderAresponderB),但您不想将响应者名称与通道名称耦合,您可以提供额外的映射配置,例如以下内容

<!-- route the order to all responders-->
<int-xml:xpath-router id="responderRouter" input-channel="orderChannel">
    <int-xml:xpath-expression expression="/request/responders"/>
    <int-xml:mapping value="responderA" channel="channelA"/>
    <int-xml:mapping value="responderB" channel="channelB"/>
</int-xml:xpath-router>

如前所述,XPath 表达式的默认评估类型是 NODESET,它被转换为通道名称的 List<String>,这可以处理单通道场景和多通道场景。

然而,某些 XPath 表达式可能从一开始就评估为 String 类型。例如,考虑以下 XPath 表达式

name(./node())

此表达式返回根节点的名称。如果使用默认的评估类型 NODESET,则会导致异常。

对于这些场景,您可以使用 evaluate-as-string 属性,它允许您管理评估类型。默认值为 FALSE。但是,如果将其设置为 TRUE,则使用 String 评估类型。

XPath 1.0 规定了 4 种数据类型

  • 节点集

  • 字符串

  • 数字

  • 布尔值

当 XPath 路由器使用可选的 evaluate-as-string 属性评估表达式时,返回值由 XPath 规范中定义的 string() 函数确定。这意味着,如果表达式选择了多个节点,它将返回第一个节点的字符串值。

欲了解更多信息,请参阅

例如,如果我们要基于根节点的名称进行路由,可以使用以下配置

<int-xml:xpath-router id="xpathRouterAsString"
        input-channel="xpathStringChannel"
        evaluate-as-string="true">
    <int-xml:xpath-expression expression="name(./node())"/>
</int-xml:xpath-router>

XML Payload 转换器

对于 XPath 路由器,您还可以指定在进行 XPath 评估之前转换 Payload 时使用的 Converter。因此,XPath 路由器支持 XmlPayloadConverter 策略的自定义实现,并且在 XML 中配置 xpath-router 元素时,可以通过 converter 属性提供对此类实现的引用。

如果未明确提供此引用,则使用 DefaultXmlPayloadConverter。在大多数情况下,这应该足够了,因为它能够转换 Node、Document、Source、File 和 String 类型的 Payload。如果您需要超出该默认实现的能力,那么在大多数情况下,上游 Transformer 是更好的选择,而不是在此处提供自定义实现引用的引用。