Spring Integration联合监测系统支持

Spring 集成提供了用于接收和发送 JMS 消息的通道适配器。

您需要将此依赖项包含在项目中：

<dependency> <groupId>org.springframework.integration</groupId> <artifactId>spring-integration-jms</artifactId> <version>6.0.0</version></dependency>

必须通过一些JMS供应商特定的实现显式添加，例如Apache ActiveMQ。​​jakarta.jms:jakarta.jms-api​​

实际上有两个基于 JMS 的入站通道适配器。 第一个使用Spring的基于轮询周期接收。 第二个是“消息驱动”，依赖于Spring容器。 出站通道适配器使用 按需转换和发送 JMS 消息。​​JmsTemplate​​​​MessageListener​​​​JmsTemplate​​

通过使用和容器，Spring 集成依赖于 Spring 的 JMS 支持。 了解这一点很重要，因为这些适配器上公开的大多数属性都配置基础和容器。 有关容器和容器的更多详细信息，请参阅 Spring JMS 文档。​​JmsTemplate​​​​MessageListener​​​​JmsTemplate​​​​MessageListener​​​​JmsTemplate​​​​MessageListener​​

虽然JMS通道适配器用于单向消息传递（仅发送或仅接收），但Spring Integration还为请求和回复操作提供了入站和出站JMS网关。 入站网关依赖于 Spring 的容器实现之一来实现消息驱动的接收。 它还能够将返回值发送到目标，如收到的消息所提供的那样。 出站网关将 JMS 消息发送到 （或 或 ），然后接收回复消息。 可以显式配置引用（或或）。 否则，出站网关将使用 JMS 临时队列。​​MessageListener​​​​reply-to​​​​request-destination​​​​request-destination-name​​​​request-destination-expression​​​​reply-destination​​​​reply-destination-name​​​​reply-destination-expression​​

在 Spring Integration 2.2 之前，如有必要，为每个请求或回复创建（并删除）一个。 从 Spring Integration 2.2 开始，您可以将出站网关配置为使用容器来接收回复，而不是直接使用新的（或缓存的）来接收每个请求的回复。 如此配置且未提供显式回复目标时，每个网关使用一个，而不是每个请求使用一个。​​TemporaryQueue​​​​MessageListener​​​​Consumer​​​​TemporaryQueue​​

从版本 6.0 开始，出站网关将创建 而不是 if 选项设置为 。 一些 JMS 供应商以不同的方式处理这些目标。​​TemporaryTopic​​​​TemporaryQueue​​​​replyPubSubDomain​​​​true​​

入站通道适配器

入站通道适配器需要对单个实例或同时引用 a 和 a（您可以提供“destinationName”来代替“目标”引用）。 以下示例定义带有引用的入站通道适配器：​​JmsTemplate​​​​ConnectionFactory​​​​Destination​​​​Destination​​

@Beanpublic IntegrationFlow jmsInbound(ConnectionFactory connectionFactory) { return IntegrationFlow.from( Jms.inboundAdapter(connectionFactory) .destination("inQueue"), e -> e.poller(poller -> poller.fixedRate(30000))) .handle(m -> System.out.println(m.getPayload())) .get();}

请注意，从前面的配置中，是轮询使用者。 这意味着它在触发时调用。 您应该仅在轮询相对不频繁且及时性不重要的情况下使用它。 对于所有其他情况（绝大多数基于 JMS 的用例），（稍后描述​）是更好的选择。​​inbound-channel-adapter​​​​receive()​​​​message-driven-channel-adapter​​

缺省情况下，所有需要引用 的 JMS 适配器都会自动查找名为 的 Bean。 这就是为什么在许多示例中看不到属性的原因。 但是，如果您的 JMS 具有不同的 Bean 名称，则需要提供该属性。​​ConnectionFactory​​​​jmsConnectionFactory​​​​connection-factory​​​​ConnectionFactory​​

如果设置为 （缺省值），则接收到的 JMS 消息将通过 . 当依赖默认值时，这意味着生成的 Spring 集成消息将 JMS 消息的正文作为其有效负载。 JMS 生成基于字符串的有效负载，JMS 生成字节数组有效负载，JMS 的可序列化实例成为 Spring 集成消息的有效负载。 如果您希望将原始 JMS 消息作为 Spring 集成消息的有效负载，请将该选项设置为 。​​extract-payload​​​​true​​​​MessageConverter​​​​SimpleMessageConverter​​​​TextMessage​​​​BytesMessage​​​​ObjectMessage​​​​extractPayload​​​​false​​

从版本 5.0.8 开始，和的默认值为 （不等待），否则为 1 秒。 JMS 入站通道适配器根据提供的 和 选项创建 。 如果需要外部（例如在 Spring 引导环境中），或者没有缓存，或者没有，建议设置是否预期非阻塞消耗：​​receive-timeout​​​​-1​​​​org.springframework.jms.connection.CachingConnectionFactory​​​​cacheConsumers​​​​DynamicJmsTemplate​​​​ConnectionFactory​​​​JmsTemplate​​​​ConnectionFactory​​​​cacheConsumers​​​​jmsTemplate.receiveTimeout(-1)​​

Jms.inboundAdapter(connectionFactory) .destination(queueName) .configureJmsTemplate(template -> template.receiveTimeout(-1))

交易

从版本 4.0 开始，入站通道适配器支持该属性。 在早期版本中，您必须注入设置为 . （适配器确实允许您将属性设置为 ，但这不正确且不起作用）。​​session-transacted​​​​JmsTemplate​​​​sessionTransacted​​​​true​​​​acknowledge​​​​transacted​​

但请注意，该设置几乎没有价值，因为事务已提交 在操作之后和将消息发送到 之前。​​session-transacted​​​​true​​​​receive()​​​​channel​​

如果希望整个流是事务性的（例如，如果存在下游出站通道适配器），则必须使用带有 . 或者，考虑使用 with 设置为 （默认值）。​​transactional​​​​JmsTransactionManager​​​​jms-message-driven-channel-adapter​​​​acknowledge​​​​transacted​​

消息驱动的通道适配器

这需要对 Spring 容器的实例（） 的任何子类或两者的引用（可以提供“destinationName”代替“destination”引用）。 以下示例使用引用定义消息驱动的通道适配器：​​message-driven-channel-adapter​​​​MessageListener​​​​AbstractMessageListenerContainer​​​​ConnectionFactory​​​​Destination​​​​Destination​​

@Beanpublic IntegrationFlow jmsMessageDrivenRedeliveryFlow() { return IntegrationFlow .from(Jms.messageDrivenChannelAdapter(jmsConnectionFactory()) .destination("inQueue")) .channel("exampleChannel") .get();}

消息驱动的适配器还接受与容器相关的多个属性。 仅当您不提供参考时，才会考虑这些值。 在这种情况下，将根据这些属性创建和配置 的实例。 例如，可以指定引用、值以及几个其他属性引用和值。 有关更多详细信息，请参阅 Javadoc​ 和 Spring Integration 的 JMS 模式 （）。​​MessageListener​​​​container​​​​DefaultMessageListenerContainer​​​​transaction-manager​​​​concurrent-consumers​​​​spring-integration-jms.xsd​​

如果您有自定义侦听器容器实现（通常是 的子类），则可以使用该属性提供对其实例的引用，也可以使用该属性提供其完全限定的类名。 在这种情况下，适配器上的属性将传输到自定义容器的实例。​​DefaultMessageListenerContainer​​​​container​​​​container-class​​

您不能使用 Spring JMS 命名空间元素来为 配置容器引用，因为该元素实际上并不引用容器。 每个子元素都有自己的子元素（在父元素上定义了共享属性）。 您可以为每个侦听器子元素提供一个 ，并使用它来注入到通道适配器中，但是，命名空间需要一个真正的侦听器。​​<jms:listener-container/>​​​​<int-jms:message-driven-channel-adapter>​​​​<jms:listener/>​​​​DefaultMessageListenerContainer​​​​<jms:listener-container/>​​​​id​​​​<jms:/>​​

建议为 配置常规，并将其用作通道适配器中的参考。​​<bean>​​​​DefaultMessageListenerContainer​​

从版本 4.2 开始，默认模式为 ，除非您提供外部容器。 在这种情况下，应根据需要配置容器。 我们建议与 一起使用以避免消息丢失。​​acknowledge​​​​transacted​​​​transacted​​​​DefaultMessageListenerContainer​​

“提取有效负载”属性具有相同的效果，其默认值为“true”。 该元素不适用于消息驱动的通道适配器，因为它是主动调用的。 在大多数情况下，消息驱动的方法更好，因为消息在从底层 JMS 使用者收到消息后立即传递到 。​​poller​​​​MessageChannel​​

最后，该元素还接受“错误通道”属性。 这提供了相同的基本功能，如输入 GatewayProxyFactoryBean 中所述。 下面的示例演示如何在消息驱动的通道适配器上设置错误通道：​​<message-driven-channel-adapter>​​

<int-jms:message-driven-channel-adapter id="jmsIn" destination="inQueue" channel="exampleChannel" error-channel="exampleErrorChannel"/>

将前面的示例与通用网关配置或我们稍后讨论的 JMS“入站网关”进行比较时，关键区别在于我们处于单向流中，因为这是一个“通道适配器”，而不是网关。 因此，从“误差通道”下游的流动也应该是单向的。 例如，它可以发送到日志记录处理程序，也可以连接到不同的 JMS 元素。​​<outbound-channel-adapter>​​

从主题使用时，请将属性设置为 true。 设置为持久预订或共享预订（需要 JMS 2.0 代理，并且自 4.2 版起可用）。 用于命名订阅。​​pub-sub-domain​​​​subscription-durable​​​​true​​​​subscription-shared​​​​subscription-name​​

从版本 5.1 开始，当端点在应用程序保持运行状态时停止时，底层侦听器容器将关闭，关闭其共享连接和使用者。 以前，连接和消费者保持开放。 要恢复到以前的行为，请将 上的 设置为 。​​shutdownContainerOnStop​​​​JmsMessageDrivenEndpoint​​​​false​​

入站转换错误

从版本 4.2 开始，“错误通道”也用于转换错误。 以前，如果 JMS 或由于转换错误而无法传递消息，则会将异常抛回容器。 如果将容器配置为使用事务，则会重复回滚并重新传递消息。 转换过程发生在消息构造之前和期间，因此此类错误不会发送到“错误通道”。 现在，此类转换异常会导致被发送到“错误通道”，例外为 . 如果您希望事务回滚，并且定义了“错误通道”，那么“错误通道”上的集成流必须重新抛出异常（或其他异常）。 如果错误流未引发异常，则提交事务并删除消息。 如果未定义“错误通道”，则异常将像以前一样抛回容器。​​<message-driven-channel-adapter/>​​​​<inbound-gateway/>​​​​ErrorMessage​​​​payload​​

出站通道适配器

该接口实现了该接口，并且能够将 Spring 集成转换为 JMS 消息，然后发送到 JMS 目标。 它需要引用或两者兼而有之，并且引用（可以代替 提供）。 与入站通道适配器一样，配置此适配器的最简单方法是使用命名空间支持。 以下配置生成一个适配器，该适配器从 接收 Spring 集成消息，将这些消息转换为 JMS 消息，并将它们发送到 Bean 名称为 的 JMS 目标引用：​​JmsSendingMessageHandler​​​​MessageHandler​​​​Messages​​​​jmsTemplate​​​​jmsConnectionFactory​​​​destination​​​​destinationName​​​​destination​​​​exampleChannel​​​​outQueue​​

@Beanpublic IntegrationFlow jmsOutboundFlow() { return f -> f .handle(Jms.outboundAdapter(cachingConnectionFactory()) .destinationExpression("headers." + SimpMessageHeaderAccessor.DESTINATION_HEADER) .configureJmsTemplate(t -> t.id("jmsOutboundFlowTemplate")));}

与入站通道适配器一样，有一个“提取有效负载”属性。 但是，出站适配器的含义是相反的。 布尔属性不是应用于 JMS 消息，而是应用于 Spring 集成消息负载。 换句话说，决定是将 Spring 集成消息本身作为 JMS 消息正文传递，还是将 Spring 集成消息负载作为 JMS 消息正文传递。 默认值为“true”。 因此，如果您传递有效负载为 的 Spring 集成消息，则会创建一个 JMS。 另一方面，如果你想通过JMS将实际的Spring Integration消息发送到另一个系统，请将其设置为“false”。​​String​​​​TextMessage​​

无论有效负载提取的布尔值如何，只要您依赖默认转换器或提供对另一个实例的引用，Spring 集成都会映射到 JMS 属性。 （对于“入站”适配器也是如此，只是在这些情况下，JMS 属性映射到 Spring 集成）。​​MessageHeaders​​​​MessageConverter​​​​MessageHeaders​​

从版本 5.1 开始，可以使用 and 属性配置 （），以评估 JMS 消息的适当 QoS 值，以便在运行时针对请求 Spring 发送。 的新功能和选项可能有助于作为动态和来自消息头的信息源：​​<int-jms:outbound-channel-adapter>​​​​JmsSendingMessageHandler​​​​deliveryModeExpression​​​​timeToLiveExpression​​​​Message​​​​setMapInboundDeliveryMode(true)​​​​setMapInboundExpiration(true)​​​​DefaultJmsHeaderMapper​​​​deliveryMode​​​​timeToLive​​

<int-jms:outbound-channel-adapter delivery-mode-expression="headers.jms_deliveryMode" time-to-live-expression="headers.jms_expiration - T(System).currentTimeMillis()"/>

交易

从版本 4.0 开始，出站通道适配器支持该属性。 在早期版本中，您必须注入设置为 . 该属性现在在内置默认值 上设置属性。 如果事务存在（可能来自上游），则发送操作在同一事务中执行。 否则，将启动新事务。​​session-transacted​​​​JmsTemplate​​​​sessionTransacted​​​​true​​​​JmsTemplate​​​​message-driven-channel-adapter​​

入站网关

Spring 集成的消息驱动的 JMS 入站网关委托给容器，支持动态调整并发消费者，还可以处理回复。 入站网关需要引用 和请求（或“请求目的地名称”）。 以下示例定义了一个 JMS，该 JMS 从 bean id 引用的 JMS 队列接收，并发送到名为 的 Spring 集成通道：​​MessageListener​​​​ConnectionFactory​​​​Destination​​​​inbound-gateway​​​​inQueue​​​​exampleChannel​​

<int-jms:inbound-gateway id="jmsInGateway" request-destination="inQueue" request-channel="exampleChannel"/>

由于网关提供请求-答复行为，而不是单向发送或接收行为，因此它们还具有两个不同的“有效负载提取”属性（如前面对通道适配器的“提取有效负载”设置的讨论）。 对于入站网关，“提取-请求-有效负载”属性确定是否提取收到的 JMS 消息正文。 如果为“false”，则 JMS 消息本身将成为 Spring 集成消息有效负载。 默认值为“true”。

同样，对于入站网关，“extract-reply-payload”属性适用于要转换为回复 JMS 消息的 Spring 集成消息。 如果要传递整个 Spring 集成消息（作为 JMS 对象消息的正文），请将值设置为 'false'。 默认情况下，将 Spring 集成消息有效负载转换为 JMS 消息（例如，有效负载变为 JMS 文本消息）也是“true”的。​​String​​

与其他任何内容一样，网关调用可能会导致错误。 默认情况下，生产者不会收到使用者端可能发生的错误通知，并且等待回复超时。 但是，有时您可能希望将错误条件传达回使用者（换句话说，您可能希望通过将异常映射到消息来将其视为有效回复）。 为此，JMS 入站网关提供了对消息通道的支持，错误可以发送到该通道进行处理，这可能会导致回复消息有效负载符合某些协定，该协定定义了调用方可能期望的“错误”应答。 可以使用错误通道属性来配置此类通道，如以下示例所示：

<int-jms:inbound-gateway request-destination="requestQueue" request-channel="jmsInputChannel" error-channel="errorTransformationChannel"/><int:transformer input-channel="exceptionTransformationChannel" ref="exceptionTransformer" method="createErrorResponse"/>

您可能会注意到，此示例看起来与 Enter the GatewayProxyFactoryBean 中包含的示例非常相似。 同样的想法也适用于这里：可以是创建错误响应对象的 POJO，您可以引用 来抑制错误，或者您可以省略“错误通道”以让异常传播。​​exceptionTransformer​​​​nullChannel​​

请参阅入站转换错误。

从主题使用时，请将属性设置为 true。 设置为持久预订或共享预订（需要 JMS 2.0 代理，并且自 V4.2 起可用）。 用于命名订阅。​​pub-sub-domain​​​​subscription-durable​​​​true​​​​subscription-shared​​​​subscription-name​​

从版本 4.2 开始，默认模式为 ，除非提供了外部容器。 在这种情况下，应根据需要配置容器。 我们建议您与 一起使用以避免消息丢失。​​acknowledge​​​​transacted​​​​transacted​​​​DefaultMessageListenerContainer​​

从版本 5.1 开始，当端点在应用程序保持运行状态时停止时，底层侦听器容器将关闭，关闭其共享连接和使用者。 以前，连接和消费者保持开放。 要恢复到以前的行为，请将 上的 设置为 。​​shutdownContainerOnStop​​​​JmsInboundGateway​​​​false​​

出站网关

出站网关从 Spring 集成消息创建 JMS 消息，并将它们发送到“请求目标”。 然后，它通过使用选择器从您配置的“回复目标”接收，或者，如果未提供“回复目标”，则通过创建 JMS（或 if ）实例来处理 JMS 回复消息。​​TemporaryQueue​​​​TemporaryTopic​​​​replyPubSubDomain= true​​

将 （或 ） 与 一起使用 cacheConsumer，可能会导致内存不足的情况。 这是因为每个请求都会获得一个具有新选择器的新使用者（选择值或当没有值时，在发送的 JMSMessageID 上）。 鉴于这些选择器是唯一的，则在当前请求完成后，它们仍保留在缓存中（未使用）。​​reply-destination​​​​reply-destination-name​​​​CachingConnectionFactory​​​​true​​​​correlation-key​​​​correlation-key​​

如果指定回复目的地，建议不要使用缓存的使用者。 或者，考虑使用如下所述的​ 。​​<reply-listener/>​​

以下示例演示如何配置出站网关：

<int-jms:outbound-gateway id="jmsOutGateway" request-destination="outQueue" request-channel="outboundJmsRequests" reply-channel="jmsReplies"/>

“出站网关”有效负载提取属性与“入站网关”的属性成反比（请参阅前面的讨论）。 这意味着“extract-request-payload”属性值适用于将 Spring 集成消息转换为要作为请求发送的 JMS 消息。 “extract-reply-payload”属性值适用于作为回复接收的 JMS 消息，然后转换为 Spring 集成消息，随后发送到“回复通道”，如前面的配置示例所示。

使用​​<reply-listener/>​​

Spring Integration 2.2引入了一种处理回复的替代技术。 如果将子元素添加到网关，而不是为每个回复创建使用者，则使用容器接收回复并将其移交给请求线程。 这提供了许多性能优势，并缓解了前面警告中所述的缓存使用者内存利用率问题。​​<reply-listener/>​​​​MessageListener​​

将 与没有 的出站网关一起使用时，不会为每个请求创建 ，而是使用单个请求。 （如果与代理的连接丢失并恢复，网关会根据需要创建一个附加的 ）。 如果设置为 ，则从版本 6.0 开始，将改为创建 。​​<reply-listener/>​​​​reply-destination​​​​TemporaryQueue​​​​TemporaryQueue​​​​TemporaryQueue​​​​replyPubSubDomain​​​​true​​​​TemporaryTopic​​

使用 时，多个网关可以共享相同的回复目标，因为侦听器容器使用每个网关唯一的选择器。​​correlation-key​​

如果指定回复侦听器并指定回复目标（或回复目标名称），但未提供相关键，网关将记录警告并回退到 2.2 版之前的行为。 这是因为在这种情况下无法配置选择器。 因此，无法避免回复转到可能配置了相同回复目标的其他网关。

请注意，在这种情况下，每个请求都会使用一个新的使用者，使用者可以按照上述警告中所述在内存中建立;因此，在这种情况下不应使用缓存的使用者。

以下示例显示了具有默认属性的回复侦听器：

<int-jms:outbound-gateway id="jmsOutGateway" request-destination="outQueue" request-channel="outboundJmsRequests" reply-channel="jmsReplies"> <int-jms:reply-listener /></int-jms-outbound-gateway>

侦听器非常轻量级，我们预计在大多数情况下，您只需要一个使用者。 但是，您可以添加属性，例如 、 和其他属性。 有关受支持属性的完整列表，请参阅模式，以及 Spring JMS 文档以了解其含义。​​concurrent-consumers​​​​max-concurrent-consumers​​

空闲回复侦听器

从版本 4.2 开始，您可以根据需要启动回复侦听器（并在空闲时间后停止它），而不是在网关生命周期内运行。 如果在应用程序上下文中有许多网关，而这些网关大多处于空闲状态，则这可能很有用。 其中一种情况是使用Spring Integration和JMS进行分区分发的许多（非活动）分区Spring Batch作业的上下文。 如果所有回复侦听器都处于活动状态，那么 JMS 代理的每个网关都有一个活动使用者。 通过启用空闲超时，每个使用者仅在相应的批处理作业运行时存在（并且在完成后的短时间内存在）。

请参阅属性引用。​​idle-reply-listener-timeout​​

网关回复关联

本节介绍用于回复关联的机制（确保源网关仅接收对其请求的回复），具体取决于网关的配置方式。 有关此处讨论的属性的完整说明，请参阅属性参考。

以下列表描述了各种方案（数字用于识别 - 顺序无关紧要）：

无属性和无reply-destination*<reply-listener>为每个请求创建 A，并在请求完成（成功或其他）时删除。 无关紧要。TemporaryQueuecorrelation-key

提供属性，但既不提供 a 也不提供 areply-destination*<reply-listener/>correlation-key等于传出消息用作使用者的消息选择器：JMSCorrelationID​messageSelector = "JMSCorrelationID = '" + messageId + "'"​响应系统应在回复中返回入站。 这是一种常见的模式，由 Spring 集成入站网关以及 Spring 的用于消息驱动的 POJO 实现。JMSMessageIDJMSCorrelationIDMessageListenerAdapter

使用此配置时，不应使用主题进行答复。 回复可能会丢失。

提供属性，不提供属性，并且reply-destination*<reply-listener/>correlation-key="JMSCorrelationID"网关生成唯一的关联 IS 并将其插入标头中。 消息选择器为：JMSCorrelationID​​messageSelector = "JMSCorrelationID = '" + uniqueId + "'"​​响应系统应在回复中返回入站。 这是一种常见的模式，由 Spring 集成入站网关以及 Spring 的用于消息驱动的 POJO 实现。JMSCorrelationIDJMSCorrelationIDMessageListenerAdapter

提供属性，不提供属性，并且reply-destination*<reply-listener/>correlation-key="myCorrelationHeader"网关生成唯一的相关 ID 并将其插入消息属性中。 可以是任何用户定义的值。 消息选择器为：myCorrelationHeadercorrelation-key​​messageSelector = "myCorrelationHeader = '" + uniqueId + "'"​​响应系统应在回复中返回入站。myCorrelationHeadermyCorrelationHeader

提供属性，未提供属性，以及（请注意相关键中的 。reply-destination*<reply-listener/>correlation-key="JMSCorrelationID*"*网关使用请求消息中的标头（如果存在）中的值，并将其插入标头中。 消息选择器为：jms_correlationIdJMSCorrelationID​​messageSelector = "JMSCorrelationID = '" + headers['jms_correlationId'] + "'"​​用户必须确保此值是唯一的。如果标头不存在，网关的行为将如 .3响应系统应在回复中返回入站。 这是一种常见的模式，由 Spring 集成入站网关以及 Spring 的用于消息驱动的 POJO 实现。JMSCorrelationIDJMSCorrelationIDMessageListenerAdapter

未提供任何属性，但提供了reply-destination*<reply-listener>将创建一个临时队列，并用于来自此网关实例的所有回复。 消息中不需要相关数据，但传出在网关内部使用，以将回复定向到正确的请求线程。JMSMessageID

提供属性、提供属性和不提供属性reply-destination*<reply-listener>correlation-key不允许。配置将被忽略，网关的行为如 。 将写入警告日志消息以指示此情况。<reply-listener/>2

提供属性，提供属性，以及reply-destination*<reply-listener>correlation-key="JMSCorrelationID"网关具有唯一的相关 ID 并将其插入，并在标头 （） 中插入一个递增值。 消息选择器为：JMSCorrelationIDgatewayId + "_" + ++seq​​messageSelector = "JMSCorrelationID LIKE '" + gatewayId%'"​​响应系统应在回复中返回入站。 这是一种常见的模式，由 Spring 集成入站网关以及 Spring 的用于消息驱动的 POJO 实现。 由于每个网关都有一个唯一的 ID，因此每个实例只能获得自己的回复。 完整的关联数据用于将回复路由到正确的请求线程。JMSCorrelationIDJMSCorrelationIDMessageListenerAdapter

提供属性 a 提供，并且reply-destination*<reply-listener/>correlation-key="myCorrelationHeader"网关具有唯一的相关 ID 并将其与属性 （） 中的递增值一起插入。 可以是任何用户定义的值。 消息选择器为：myCorrelationHeadergatewayId + "_" + ++seqcorrelation-key​​messageSelector = "myCorrelationHeader LIKE '" + gatewayId%'"​​响应系统应在回复中返回入站。 由于每个网关都有一个唯一的 ID，因此每个实例只能获得自己的回复。 完整的关联数据用于将回复路由到正确的请求线程。myCorrelationHeadermyCorrelationHeader

提供属性，提供属性，以及reply-destination*<reply-listener/>correlation-key="JMSCorrelationID*"（请注意相关键中的）*不允许。用户提供的相关 ID 不允许与回复侦听器一起使用。 网关不使用此配置进行初始化。

异步网关

从版本 4.3 开始，您现在可以在配置出站网关时指定（或在 Java 中）。​​async="true"​​​​setAsync(true)​​

默认情况下，将请求发送到网关时，请求线程将挂起，直到收到回复。 然后，流在该线程上继续。 如果是，则请求线程在完成后立即释放，并在侦听器容器线程上返回回复（并且流继续）。 在轮询器线程上调用网关时，这可能很有用。 线程已释放，可用于框架中的其他任务。​​async​​​​true​​​​send()​​

这需要（或使用 Java 配置时）。 它还需要一个（通常）被指定。 如果不满足这些条件中的任何一个，则 将被忽略。​​async​​​​<reply-listener/>​​​​setUseReplyContainer(true)​​​​correlationKey​​​​JMSCorrelationID​​​​async​​

属性引用

以下清单显示了 的所有可用属性：​​outbound-gateway​​

<int-jms:outbound-gateway connection-factory="connectionFactory" correlation-key="" delivery-persistent="" destination-resolver="" explicit-qos-enabled="" extract-reply-payload="true" extract-request-payload="true" header-mapper="" message-converter="" priority="" receive-timeout="" reply-channel="" reply-destination="" reply-destination-expression="" reply-destination-name="" reply-pub-sub-domain="" reply-timeout="" request-channel="" request-destination="" request-destination-expression="" request-destination-name="" request-pub-sub-domain="" time-to-live="" requires-reply="" idle-reply-listener-timeout="" async=""> <int-jms:reply-listener /> </int-jms:outbound-gateway>

对 . 默认值 .​​jakarta.jms.ConnectionFactory​​​​jmsConnectionFactory​​

包含关联数据的属性的名称，用于将响应与答复相关联。 如果省略，网关希望响应系统返回标头中出站标头的值。 如果指定，网关将生成相关 ID 并使用该 ID 填充指定的属性。 响应系统必须在同一属性中回显该值。 它可以设置为 ，在这种情况下，将使用标准标头而不是属性来保存相关数据。 使用 时，必须指定 如果提供显式 . 从版本 4.0.1 开始，此属性还支持值 ，这意味着如果出站消息已经具有（从 映射自 ）标头，则使用它而不是生成新的标头。 请注意，使用 时不允许使用该键，因为容器需要在初始化期间设置消息选择器。​​JMSMessageID​​​​JMSCorrelationID​​​​JMSCorrelationID​​​​String​​​​<reply-container/>​​​​correlation-key​​​​reply-destination​​​​JMSCorrelationID*​​​​JMSCorrelationID​​​​jms_correlationId​​​​JMSCorrelationID*​​​​<reply-container/>​​

一个布尔值，指示传递方式应为 （） 还是 （）。 仅当 为 时，此设置才会生效。​​DeliveryMode.PERSISTENT​​​​true​​​​DeliveryMode.NON_PERSISTENT​​​​false​​​​explicit-qos-enabled​​​​true​​

一个。 默认值为 ，它将目标名称映射到该名称的队列或主题。​​DestinationResolver​​​​DynamicDestinationResolver​​

设置为 时，它允许使用服务质量属性：、 和 。​​true​​​​priority​​​​delivery-mode​​​​time-to-live​​

当设置为 （默认值） 时，Spring 集成回复消息的有效负载将从 JMS 回复消息的正文创建（通过使用 ）。 设置为 时，整个 JMS 消息将成为 Spring 集成消息的有效负载。​​true​​​​MessageConverter​​​​false​​

设置为 （默认值） 时，Spring 集成消息的有效负载将转换为 （通过使用 ）。 设置为 时，整个 Spring 集成消息将转换为 . 在这两种情况下，Spring 集成消息头都通过使用 .​​true​​​​JMSMessage​​​​MessageConverter​​​​false​​​​JMSMessage​​​​HeaderMapper​​

用于将 Spring 集成消息头映射到 JMS 消息头和属性以及从 JMS 消息头和属性映射。​​HeaderMapper​​

对 的引用，用于在 JMS 消息和 Spring 集成消息负载（如果是，则为消息）之间进行转换。 默认值为 .​​MessageConverter​​​​extract-request-payload​​​​false​​​​SimpleMessageConverter​​

请求消息的默认优先级。 由邮件优先级标头（如果存在）覆盖。 其范围是 . 仅当 为 时，此设置才会生效。​​0​​​​9​​​​explicit-qos-enabled​​​​true​​

等待答复的时间（以毫秒为单位）。 默认值为 （5 秒）。​​5000​​

回复消息发送到的通道。

对 的引用，它被设置为标头。 最多只允许 、 或 中的一个。 如果未提供任何内容，则使用 a 回复此网关。​​Destination​​​​JMSReplyTo​​​​reply-destination​​​​reply-destination-expression​​​​reply-destination-name​​​​TemporaryQueue​​

计算结果为 的 SpEL 表达式，将设置为标头。 表达式可以生成对象或 . 它由 用于解析实际的 . 最多只允许 、 或 中的一个。 如果未提供任何内容，则使用 a 回复此网关。​​Destination​​​​JMSReplyTo​​​​Destination​​​​String​​​​DestinationResolver​​​​Destination​​​​reply-destination​​​​reply-destination-expression​​​​reply-destination-name​​​​TemporaryQueue​​

设置为 JMSReplyTo 标头的目标的名称。 它由 用于解析实际的 . 最多只允许 、 或 中的一个。 如果未提供任何内容，则使用 a 回复此网关。​​DestinationResolver​​​​Destination​​​​reply-destination​​​​reply-destination-expression​​​​reply-destination-name​​​​TemporaryQueue​​

设置为 时，表示由 解析的任何回复都应为 a 而不是 。​​true​​​​Destination​​​​DestinationResolver​​​​Topic​​​​Queue​​

网关在向 发送回复消息时等待的时间。 这仅在 can 阻塞（例如容量限制当前已满）时才有效。 默认值为无穷大。​​reply-channel​​​​reply-channel​​​​QueueChannel​​

此网关接收请求消息的通道。

对向其发送请求消息的 的引用。 、 或 中的一种是必需的。 您只能使用这三个属性之一。​​Destination​​​​reply-destination​​​​reply-destination-expression​​​​reply-destination-name​​

一个 SpEL 表达式，计算结果为向其发送请求消息的 。 表达式可以生成对象或 . 它由 用于解析实际的 . 其中一个 、 或 是必需的。 您只能使用这三个属性之一。​​Destination​​​​Destination​​​​String​​​​DestinationResolver​​​​Destination​​​​reply-destination​​​​reply-destination-expression​​​​reply-destination-name​​

向其发送请求消息的目标的名称。 它由 用于解析实际的 . 、 或 中的一种是必需的。 您只能使用这三个属性之一。​​DestinationResolver​​​​Destination​​​​reply-destination​​​​reply-destination-expression​​​​reply-destination-name​​

设置为 时，表示 解析的任何请求都应是 而不是 。​​true​​​​Destination​​​​DestinationResolver​​​​Topic​​​​Queue​​

指定消息生存时间。 仅当 为 时，此设置才会生效。​​explicit-qos-enabled​​​​true​​

指定此出站网关是否必须返回非空值。 默认情况下，此值为 ，当基础服务未返回 . 请注意，如果服务永远不会返回回复，则最好使用 a 而不是 with 。 对于后者，发送线程被阻止，等待该时间段的回复。​​true​​​​MessageTimeoutException​​​​receive-timeout​​​​<int-jms:outbound-channel-adapter/>​​​​<int-jms:outbound-gateway/>​​​​requires-reply="false"​​​​receive-timeout​​

使用 时，默认情况下，其生命周期（启动和停止）与网关的生命周期匹配。 当此值大于 时，容器将按需启动（发送请求时）。 容器将继续运行，直到至少此时间过去，没有收到任何请求（并且直到没有未完成的回复）。 容器在下一个请求时再次启动。 停止时间是最小值，实际上可能高达此值的 1.5 倍。​​<reply-listener />​​​​0​​

请参阅异步网关。

包含此元素时，异步接收回复，而不是为每个回复创建使用者。 在许多情况下，这可以更有效。​​MessageListenerContainer​​

您应该了解，网关无法确保唯一性，如果提供的相关 ID 不唯一，则可能会出现意外的副作用。

将消息头映射到 JMS 消息和从 JMS 消息映射消息头

JMS 消息可以包含元信息，例如 JMS API 标头和简单属性。 您可以使用 将这些消息头映射到 Spring 集成消息头或从 Spring 集成消息头映射这些消息头。 JMS API 标头被传递给适当的资源库方法（例如），而其他标头则复制到 JMS 消息的常规属性中。 JMS 出站网关使用 的默认实现进行引导，这将映射标准 JMS API 标头以及基元或消息标头。 还可以使用入站和出站网关的属性提供自定义标头映射器。​​JmsHeaderMapper​​​​setJMSReplyTo​​​​JmsHeaderMapper​​​​String​​​​header-mapper​​

许多特定于 JMS 供应商的客户端不允许直接在已创建的 JMS 消息上设置 、 和 属性。 它们被视为 QoS 属性，因此必须传播到目标 API。 出于这个原因，不会将适当的 Spring 集成标头（或表达式结果）映射到提到的 JMS 消息属性中。 相反，a 用于将标头值从请求消息传播到 API。 若要启用此功能，必须使用属性设置为 true 的出站终结点配置出站终结点。 Spring Integration Java DSL 默认配置 ，但您仍必须设置该属性。​​deliveryMode​​​​priority​​​​timeToLive​​​​MessageProducer.send(message, deliveryMode, priority, timeToLive)​​​​DefaultJmsHeaderMapper​​​​DynamicJmsTemplate​​​​JmsSendingMessageHandler​​​​MessageProducer.send()​​​​DynamicJmsTemplate​​​​explicitQosEnabled​​​​DynamicJmsTemplate​​​​explicitQosEnabled​​

从版本 4.0 开始，标头映射到入站邮件的标准标头。 以前，标头仅用于出站消息。 要恢复到以前的行为（即不映射入站优先级），请将 的属性设置为 。​​JMSPriority​​​​priority​​​​priority​​​​mapInboundPriority​​​​DefaultJmsHeaderMapper​​​​false​​

从 4.3 版开始，通过调用其方法将标准标头映射为消息属性（ 通常是 ，JMS 不支持）。 在入站端，它被映射为 . 这与标头无关，标头映射到标头和从标头映射。 通常用于关联请求和回复，而 通常用于将相关消息合并到一个组中（例如使用聚合器或重新排序器）。​​DefaultJmsHeaderMapper​​​​correlationId​​​​toString()​​​​correlationId​​​​UUID​​​​String​​​​jms_correlationId​​​​JMSCorrelationID​​​​JMSCorrelationID​​​​correlationId​​

从版本 5.1 开始，可以配置为映射入站和属性：​​DefaultJmsHeaderMapper​​​​JMSDeliveryMode​​​​JMSExpiration​​

@Beanpublic DefaultJmsHeaderMapper jmsHeaderMapper() { DefaultJmsHeaderMapper mapper = new DefaultJmsHeaderMapper(); mapper.setMapInboundDeliveryMode(true) mapper.setMapInboundExpiration(true) return mapper;}

这些 JMS 属性分别映射到 和 Spring 消息头。​​JmsHeaders.DELIVERY_MODE​​​​JmsHeaders.EXPIRATION​​

消息转换、封送和解组

如果需要转换消息，所有 JMS 适配器和网关都允许您通过设置属性来提供 。 为此，请提供在同一应用程序上下文中可用的实例的 Bean 名称。 此外，为了提供与编组器和解组器接口的一致性，Spring 提供了 ，您可以使用自己的自定义编组器和解组器进行配置。 以下示例演示如何执行此操作​​MessageConverter​​​​message-converter​​​​MessageConverter​​​​MarshallingMessageConverter​​

<int-jms:inbound-gateway request-destination="requestQueue" request-channel="inbound-gateway-channel" message-converter="marshallingMessageConverter"/><bean id="marshallingMessageConverter" class="org.springframework.jms.support.converter.MarshallingMessageConverter"> <constructor-arg> <bean class="org.bar.SampleMarshaller"/> </constructor-arg> <constructor-arg> <bean class="org.bar.SampleUnmarshaller"/> </constructor-arg></bean>

当您提供自己的实例时，它仍包装在 . 这意味着“提取-请求-有效负载”和“提取-回复-有效负载”属性可能会影响传递给转换器的实际对象。 它本身委托给目标，同时还将 Spring 集成映射到 JMS 消息属性并再次返回。​​MessageConverter​​​​HeaderMappingMessageConverter​​​​HeaderMappingMessageConverter​​​​MessageConverter​​​​MessageHeaders​​

JMS 支持的消息通道

前面介绍的通道适配器和网关都适用于与其他外部系统集成的应用程序。 入站选项假定某个其他系统正在向 JMS 目标发送 JMS 消息，而出站选项假定某个其他系统正在从目标接收。 另一个系统可能是也可能不是 Spring 集成应用程序。 当然，当发送 Spring 集成消息实例作为 JMS 消息本身的主体时（将“提取有效负载”值设置为 ），假设另一个系统基于 Spring 集成。 但是，这绝不是必需的。 这种灵活性是使用基于消息的集成选项和“通道”（或JMS中的目的地）抽象的好处之一。​​false​​

有时，给定 JMS 目标的生产者和使用者都打算成为同一应用程序的一部分，在同一进程中运行。 可以使用一对入站和出站通道适配器来实现此目的。 这种方法的问题在于您需要两个适配器，尽管从概念上讲，目标是拥有单个消息通道。 从 Spring 集成版本 2.0 开始支持更好的选项。 现在可以在使用 JMS 命名空间时定义单个“通道”，如以下示例所示：

<int-jms:channel id="jmsChannel" queue="exampleQueue"/>

前面示例中的通道的行为与 Spring 集成主命名空间中的普通元素非常相似。 它可以由任何终结点的 和 属性引用。 不同之处在于，此通道由名为 的 JMS 队列实例提供支持。 这意味着可以在生产终结点和使用终结点之间进行异步消息传递。 但是，与通过在非 JMS 元素中添加元素创建的更简单的异步消息通道不同，消息不存储在内存中队列中。 相反，这些消息在 JMS 消息正文中传递，然后底层 JMS 提供程序的全部功能可用于该通道。 使用此替代方法的最常见理由可能是利用 JMS 消息传递的存储转发方法提供的持久性。​​<channel/>​​​​input-channel​​​​output-channel​​​​exampleQueue​​​​<queue/>​​​​<channel/>​​

如果配置正确，JMS 支持的消息通道还支持事务。 换句话说，如果生产者的发送操作是回滚事务的一部分，则生产者实际上不会写入事务 JMS 支持的通道。 同样，如果接收 JMS 消息是回滚事务的一部分，则使用者不会从通道中物理删除该消息。 请注意，在这种情况下，生产者和使用者事务是分开的。 这与在没有子元素的简单同步元素之间传播事务上下文有很大不同。​​<channel/>​​​​<queue/>​​

由于前面的示例引用了 JMS 队列实例，因此它充当点对点通道。 另一方面，如果您需要发布-订阅行为，则可以使用单独的元素并改用 JMS 主题。 以下示例演示如何执行此操作：

<int-jms:publish-subscribe-channel id="jmsChannel" topic="exampleTopic"/>

对于任一类型的 JMS 支持的通道，都可以提供目标的名称而不是引用，如以下示例所示：

<int-jms:channel id="jmsQueueChannel" queue-name="exampleQueueName"/><jms:publish-subscribe-channel id="jmsTopicChannel" topic-name="exampleTopicName"/>

在前面的示例中，目标名称由 Spring 的默认实现解析，但您可以提供接口的任何实现。 此外，JMS 是通道的必需属性，但默认情况下，预期的 Bean 名称为 。 以下示例提供了用于解析 JMS 目标名称的定制实例，并为 提供了不同的名称：​​DynamicDestinationResolver​​​​DestinationResolver​​​​ConnectionFactory​​​​jmsConnectionFactory​​​​ConnectionFactory​​

<int-jms:channel id="jmsChannel" queue-name="exampleQueueName" destination-resolver="customDestinationResolver" connection-factory="customConnectionFactory"/>

对于 ，将持久预订或共享预订的属性设置为 （需要 JMS 2.0 代理，并且自 V4.2 起已可用）。 用于命名订阅。​​<publish-subscribe-channel />​​​​durable​​​​true​​​​subscription-shared​​​​subscription​​

使用 JMS 消息选择器

使用 JMS 消息选择器，您可以根据 JMS 标头和 JMS 属性过滤 JMS 消息。 例如，如果要侦听其自定义 JMS 标头属性 、 等于 的消息，则可以指定以下表达式：​​myHeaderProperty​​​​something​​

myHeaderProperty = 'something'

消息选择器表达式是 SQL-92 条件表达式语法的子集，定义为 Java 消息服务规范的一部分。 您可以通过使用以下 Spring 集成 JMS 组件的 XML 名称空间配置来指定 JMS 消息属性：​​selector​​

• JMS 通道
• JMS 发布订阅频道
• JMS 入站通道适配器
• JMS 入站网关
• JMS 消息驱动的通道适配器

不能使用 JMS 消息选择器引用消息正文值。

JMS 示例

要试验这些 JMS 适配器，请查看 Spring Integration Samples Git 存储库中提供的 JMS 示例 https://github.com/spring-projects/spring-integration-samples/tree/master/basic/jms。

该存储库包含两个示例。 一个提供入站和出站通道适配器，另一个提供入站和出站网关。 它们配置为使用嵌入式 ActiveMQ 进程运行，但您可以修改每个示例的通用.xml Spring 应用程序上下文文件，以支持不同的 JMS 提供程序或独立的 ActiveMQ 进程。

换句话说，您可以拆分配置，以便入站和出站适配器在单独的 JVM 中运行。 如果安装了 ActiveMQ，请修改文件中要使用的属性（而不是 ）。 这两个样本都接受来自 stdin 的输入并回显到 stdout。 查看配置以了解这些消息如何通过 JMS 路由。​​brokerURL​​​​common.xml​​​​tcp://localhost:61616​​​​vm://localhost​​