动态路由器

Spring Integration 提供了许多针对常见基于内容路由用例的不同路由器配置,以及将自定义路由器实现为 POJO 的选项。例如,PayloadTypeRouter 提供了一种简单的方法来配置一个根据传入消息的有效负载类型计算通道的路由器,而 HeaderValueRouter 提供了相同便利性来配置一个通过评估特定消息头的值来计算通道的路由器。还存在基于表达式的 (SpEL) 路由器,其中通道是根据评估表达式来确定的。所有这些类型的路由器都表现出一些动态特性。

但是,这些路由器都需要静态配置。即使在基于表达式的路由器的情况下,表达式本身也是作为路由器配置的一部分定义的,这意味着对相同值的相同表达式始终导致计算相同的通道。在大多数情况下,这是可以接受的,因为此类路由定义明确,因此可预测。但有时我们需要动态更改路由器配置,以便消息流可以路由到不同的通道。

例如,您可能希望关闭系统的一部分以进行维护,并临时将消息重新路由到不同的消息流。作为另一个示例,您可能希望通过添加另一条路由来处理更具体的 java.lang.Number 类型(在 PayloadTypeRouter 的情况下)来为消息流引入更多粒度。

不幸的是,使用静态路由器配置来实现这两个目标中的任何一个,您都必须关闭整个应用程序,更改路由器的配置(更改路由),然后重新启动应用程序。这显然不是任何人都想要的解决方案。

动态路由器模式描述了无需关闭系统或单个路由器即可动态更改或配置路由器的机制。

在我们深入了解 Spring Integration 如何支持动态路由的细节之前,我们需要考虑路由器的典型流程。

  1. 计算通道标识符,这是路由器在接收到消息后计算出的值。通常,它是一个字符串或实际 MessageChannel 的实例。

  2. 将通道标识符解析为通道名称。我们将在本节后面详细介绍此过程。

  3. 将通道名称解析为实际的 MessageChannel

如果步骤 1 的结果是 MessageChannel 的实际实例,则在动态路由方面无法做太多的事情,因为 MessageChannel 是任何路由器工作的最终产物。但是,如果第一步的结果是通道标识符,而不是 MessageChannel 的实例,则您有许多可能的方法来影响派生 MessageChannel 的过程。考虑以下有效负载类型路由器的示例。

<int:payload-type-router input-channel="routingChannel">
    <int:mapping type="java.lang.String"  channel="channel1" />
    <int:mapping type="java.lang.Integer" channel="channel2" />
</int:payload-type-router>

在有效负载类型路由器的上下文中,前面提到的三个步骤将按如下方式实现。

  1. 计算通道标识符,它是有效负载类型的完全限定名称(例如,java.lang.String)。

  2. 将通道标识符解析为通道名称,其中前一步的结果用于从 mapping 元素中定义的有效负载类型映射中选择适当的值。

  3. 将通道名称解析为 MessageChannel 的实际实例,作为应用程序上下文(希望是 MessageChannel)中由前一步的结果标识的 Bean 的引用。

换句话说,每个步骤都为下一步提供输入,直到过程完成。

现在考虑一个报头值路由器的示例。

<int:header-value-router input-channel="inputChannel" header-name="testHeader">
    <int:mapping value="foo" channel="fooChannel" />
    <int:mapping value="bar" channel="barChannel" />
</int:header-value-router>

现在我们可以考虑报头值路由器的三个步骤是如何工作的。

  1. 计算通道标识符,它是 header-name 属性标识的报头的值。

  2. 将通道标识符解析为通道名称,其中前一步的结果用于从 mapping 元素中定义的通用映射中选择适当的值。

  3. 将通道名称解析为 MessageChannel 的实际实例,作为应用程序上下文(希望是 MessageChannel)中由前一步的结果标识的 Bean 的引用。

前面两种不同路由器类型的配置看起来几乎相同。但是,如果您查看 HeaderValueRouter 的替代配置,我们会清楚地看到没有 mapping 子元素,如下面的清单所示。

<int:header-value-router input-channel="inputChannel" header-name="testHeader"/>

但是,配置仍然完全有效。因此,自然的问题是第二步中的映射怎么样?

第二步现在是可选的。如果未定义 mapping,则第一步中计算的通道标识符值将自动视为 通道名称,现在将其解析为实际的 MessageChannel,如第三步所示。这也意味着第二步是为路由器提供动态特性的关键步骤之一,因为它引入了允许您更改通道标识符解析为通道名称的方式的过程,从而影响从初始通道标识符确定 MessageChannel 的最终实例的过程。

例如,在前面的配置中,假设 testHeader 值为 'kermit',它现在是一个通道标识符(第一步)。由于此路由器中没有映射,因此将此通道标识符解析为通道名称(第二步)是不可能的,并且此通道标识符现在被视为通道名称。但是,如果存在映射但针对不同的值呢?最终结果仍然相同,因为如果无法通过将通道标识符解析为通道名称的过程来确定新值,则通道标识符将成为通道名称。

剩下的就是第三步将通道名称 ('kermit') 解析为由此名称标识的 MessageChannel 的实际实例。这基本上涉及对提供的名称进行 Bean 查找。现在,所有包含报头值对作为 testHeader=kermit 的消息都将路由到 Bean 名称(其 id)为 'kermit' 的 MessageChannel

但是,如果您想将这些消息路由到 'simpson' 通道怎么办?显然,更改静态配置有效,但这样做也需要关闭系统。但是,如果您已访问通道标识符映射,则可以引入一个新的映射,其中报头值对现在为 kermit=simpson,从而允许第二步将 'kermit' 视为通道标识符,同时将其解析为 'simpson' 作为通道名称。

对于 PayloadTypeRouter,情况也是如此,您现在可以重新映射或删除特定的有效负载类型映射。实际上,它适用于所有其他路由器,包括基于表达式的路由器,因为它们的计算值现在有机会通过第二步解析为实际的 通道名称

任何是 AbstractMappingMessageRouter 的子类的路由器(包括大多数框架定义的路由器)都是动态路由器,因为 channelMappingAbstractMappingMessageRouter 级别定义。该映射的 setter 方法作为公共方法公开,以及 'setChannelMapping' 和 'removeChannelMapping' 方法。只要您有对路由器本身的引用,这些方法就可以让您在运行时更改、添加和删除路由器映射。这也意味着您可以通过 JMX(请参阅JMX 支持)或 Spring Integration 控制总线(请参阅控制总线)功能公开这些相同的配置选项。

回退到通道键作为通道名称既灵活又方便。但是,如果您不信任消息创建者,恶意行为者(了解系统)可以创建路由到意外通道的消息。例如,如果密钥设置为路由器输入通道的通道名称,则此类消息将被路由回路由器,最终导致堆栈溢出错误。因此,您可能希望禁用此功能(将 channelKeyFallback 属性设置为 false),并在需要时更改映射。

使用控制总线管理路由器映射

管理路由器映射的一种方法是通过控制总线模式,该模式公开一个控制通道,您可以向其发送控制消息以管理和监视 Spring Integration 组件,包括路由器。

有关控制总线的更多信息,请参阅控制总线

通常,您会发送一条控制消息,要求在特定托管组件(例如路由器)上调用特定操作。以下托管操作(方法)特定于更改路由器解析过程。

  • public void setChannelMapping(String key, String channelName):允许您在 通道标识符通道名称 之间添加新的或修改现有的映射。

  • public void removeChannelMapping(String key):允许您删除特定通道映射,从而断开 通道标识符通道名称 之间的关系。

请注意,这些方法可用于简单的更改(例如更新单个路由或添加或删除路由)。但是,如果您想删除一条路由并添加另一条路由,则更新不是原子的。这意味着在更新之间,路由表可能处于不确定的状态。从 4.0 版开始,您现在可以使用控制总线以原子方式更新整个路由表。以下方法允许您这样做。

  • public Map<String, String>getChannelMappings():返回当前映射。

  • public void replaceChannelMappings(Properties channelMappings):更新映射。请注意,channelMappings 参数是 Properties 对象。此安排允许控制总线命令使用内置的 StringToPropertiesConverter,如下例所示。

"@'router.handler'.replaceChannelMappings('foo=qux \n baz=bar')"

请注意,每个映射都由换行符 (\n) 分隔。对于对映射的编程更改,我们建议您使用 setChannelMappings 方法,因为存在类型安全问题。replaceChannelMappings 忽略不是 String 对象的键或值。

使用 JMX 管理路由器映射

您还可以使用 Spring 的 JMX 支持来公开路由器实例,然后使用您喜欢的 JMX 客户端(例如 JConsole)来管理这些操作(方法)以更改路由器的配置。

有关 Spring Integration 的 JMX 支持的更多信息,请参阅JMX 支持