使用 Spring JMS
本节描述如何使用 Spring 的 JMS 组件。
使用 JmsTemplate
JmsTemplate
类是 JMS 核心包中的中心类。它简化了 JMS 的使用,因为它在发送或同步接收消息时处理资源的创建和释放。
使用 JmsTemplate
的代码只需实现回调接口,这些接口为它们提供了明确定义的高级契约。MessageCreator
回调接口在给定 JmsTemplate
中调用代码提供的 Session
时创建消息。为了允许更复杂的 JMS API 用法,SessionCallback
提供 JMS 会话,而 ProducerCallback
则暴露 Session
和 MessageProducer
对。
JMS API 暴露了两种发送方法,一种将传输模式、优先级和生存时间作为服务质量 (QOS) 参数,另一种不带 QOS 参数并使用默认值。由于 JmsTemplate
有许多发送方法,因此设置 QOS 参数已作为 bean 属性暴露,以避免发送方法数量的重复。类似地,同步接收调用的超时值通过使用 setReceiveTimeout
属性设置。
一些 JMS 提供者允许通过 ConnectionFactory
的配置以管理方式设置默认 QOS 值。这导致对 MessageProducer
实例的 send
方法 (send(Destination destination, Message message)
) 的调用使用与 JMS 规范中指定的不同的 QOS 默认值。为了提供 QOS 值的一致管理,JmsTemplate
因此必须通过将布尔属性 isExplicitQosEnabled
设置为 true
来专门启用使用其自己的 QOS 值。
为方便起见,JmsTemplate
还暴露了一个基本的请求-回复操作,允许发送消息并等待在作为操作一部分创建的临时队列上的回复。
JmsTemplate
类的实例一旦配置,就是线程安全的。这很重要,因为它意味着您可以配置 JmsTemplate
的单个实例,然后安全地将此共享引用注入到多个协作器中。需要明确的是,JmsTemplate
是有状态的,因为它维护对 ConnectionFactory
的引用,但此状态不是会话状态。
从 Spring Framework 4.1 开始,JmsMessagingTemplate
构建在 JmsTemplate
之上,并提供与消息抽象(即 org.springframework.messaging.Message
)的集成。这使您能够以通用方式创建要发送的消息。
连接
JmsTemplate
需要引用 ConnectionFactory
。ConnectionFactory
是 JMS 规范的一部分,并作为使用 JMS 的入口点。它被客户端应用程序用作与 JMS 提供者创建连接的工厂,并封装了各种配置参数,其中许多是供应商特定的,例如 SSL 配置选项。
在 EJB 中使用 JMS 时,供应商提供 JMS 接口的实现,以便它们可以参与声明式事务管理并执行连接和会话的池化。为了在 EJB 中将此实现与 JmsTemplate
一起使用,Jakarta EE 容器通常要求您在 EJB 或 servlet 部署描述符中将 JMS 连接工厂声明为 resource-ref
。为了确保 JmsTemplate
在 EJB 中使用这些功能,客户端应用程序应确保它引用 ConnectionFactory
的托管实现。
缓存消息资源
标准 API 涉及创建许多中间对象。要发送消息,执行以下“API”遍历:
ConnectionFactory->Connection->Session->MessageProducer->send
在 ConnectionFactory
和 Send
操作之间,创建和销毁了三个中间对象。为了优化资源使用并提高性能,Spring 提供了 ConnectionFactory
的两种实现。
使用 SingleConnectionFactory
Spring 提供了 ConnectionFactory
接口的实现 SingleConnectionFactory
,它在所有 createConnection()
调用上返回相同的 Connection
,并忽略对 close()
的调用。这对于测试和独立环境很有用,以便相同的连接可用于可能跨越任意数量事务的多个 JmsTemplate
调用。SingleConnectionFactory
引用一个通常来自 JNDI 的标准 ConnectionFactory
。
使用 CachingConnectionFactory
CachingConnectionFactory
扩展了 SingleConnectionFactory
的功能,并添加了 Session
、MessageProducer
和 MessageConsumer
实例的缓存。初始缓存大小设置为 1
。您可以使用 sessionCacheSize
属性来增加缓存会话的数量。请注意,实际缓存会话的数量多于该数量,因为会话是根据其确认模式缓存的,因此当 sessionCacheSize
设置为 1 时,最多可以有四个缓存会话实例(每种确认模式一个)。MessageProducer
和 MessageConsumer
实例在其所属会话中缓存,并在缓存时也考虑生产者和消费者的独特属性。MessageProducers 根据其目标进行缓存。MessageConsumers 根据由目标、选择器、noLocal 传输标志和持久订阅名称(如果创建持久消费者)组成的键进行缓存。
临时队列和主题 (TemporaryQueue/TemporaryTopic) 的 MessageProducers 和 MessageConsumers 永远不会被缓存。不幸的是,WebLogic JMS 碰巧在其常规目标实现上实现了临时队列/主题接口,错误地指示其所有目标都不能被缓存。请在 WebLogic 上使用不同的连接池/缓存,或为 WebLogic 目的自定义 |
目标管理
目标,作为 ConnectionFactory
实例,是 JMS 管理对象,您可以将其存储和检索在 JNDI 中。配置 Spring 应用程序上下文时,可以使用 JNDI JndiObjectFactoryBean
工厂类或 <jee:jndi-lookup>
对对象的 JMS 目标引用执行依赖注入。然而,如果应用程序中有大量目标,或者 JMS 提供者具有独特的先进目标管理功能,则此策略通常很麻烦。此类先进目标管理的示例包括创建动态目标或支持分层目标命名空间。JmsTemplate
将目标名称的解析委托给实现 DestinationResolver
接口的 JMS 目标对象。DynamicDestinationResolver
是 JmsTemplate
使用的默认实现,并适应解析动态目标。还提供了 JndiDestinationResolver
作为 JNDI 中包含的目标的服务定位器,并可选地回退到 DynamicDestinationResolver
中包含的行为。
通常,JMS 应用程序中使用的目标仅在运行时已知,因此在部署应用程序时无法以管理方式创建。这通常是因为交互系统组件之间存在共享应用程序逻辑,这些组件根据众所周知的命名约定在运行时创建目标。尽管创建动态目标不是 JMS 规范的一部分,但大多数供应商都提供了此功能。动态目标使用用户定义名称创建,这使其与临时目标区分开来,并且通常未在 JNDI 中注册。用于创建动态目标的 API 因提供者而异,因为与目标关联的属性是供应商特定的。然而,供应商有时做出的一个简单实现选择是忽略 JMS 规范中的警告,并使用 TopicSession
createTopic(String topicName)
方法或 QueueSession
createQueue(String queueName)
方法创建具有默认目标属性的新目标。根据供应商实现,DynamicDestinationResolver
此时也可以创建物理目标,而不仅仅是解析一个。
布尔属性 pubSubDomain
用于配置 JmsTemplate
,使其了解正在使用的 JMS 域。默认情况下,此属性的值为 false,表示将使用点对点域 Queues
。此属性(由 JmsTemplate
使用)通过 DestinationResolver
接口的实现确定动态目标解析的行为。
您还可以通过属性 defaultDestination
为 JmsTemplate
配置默认目标。默认目标用于不引用特定目标的发送和接收操作。
消息监听器容器
在 EJB 世界中使用 JMS 消息最常见的用途之一是驱动消息驱动 bean (MDB)。Spring 提供了一种创建消息驱动 POJO (MDP) 的解决方案,其方式不会将用户绑定到 EJB 容器。(请参阅 异步接收:消息驱动 POJO 以获取 Spring MDP 支持的详细介绍。)端点方法可以用 @JmsListener
注解——有关详细信息,请参阅 注解驱动的监听器端点。
消息监听器容器用于从 JMS 消息队列接收消息并驱动注入其中的 MessageListener
。监听器容器负责所有消息接收的线程化并将消息分派到监听器进行处理。消息监听器容器是 MDP 和消息提供者之间的中介,负责注册接收消息、参与事务、资源获取和释放、异常转换等。这使您可以编写与接收消息(并可能对其进行响应)相关的(可能复杂的)业务逻辑,并将样板 JMS 基础设施问题委托给框架。
Spring 提供了两种标准 JMS 消息监听器容器,每种都具有其专门的功能集。
使用 SimpleMessageListenerContainer
此消息监听器容器是两种标准类型中较简单的一种。它在启动时创建固定数量的 JMS 会话和消费者,使用标准 JMS MessageConsumer.setMessageListener()
方法注册监听器,并将其留给 JMS 提供者执行监听器回调。此变体不允许动态适应运行时需求或参与外部管理事务。在兼容性方面,它非常接近独立 JMS 规范的精神,但通常与 Jakarta EE 的 JMS 限制不兼容。
虽然 |
默认的 AUTO_ACKNOWLEDGE
模式不提供适当的可靠性保证。当监听器执行失败(因为提供者在监听器调用后自动确认每条消息,没有异常传播到提供者)或当监听器容器关闭(您可以通过设置 acceptMessagesWhileStopping
标志来配置此项)时,消息可能会丢失。在需要可靠性(例如,用于可靠的队列处理和持久主题订阅)的情况下,请务必使用事务性会话。
使用 DefaultMessageListenerContainer
此消息监听器容器在大多数情况下使用。与 SimpleMessageListenerContainer
不同,此容器变体允许动态适应运行时需求,并且能够参与外部管理事务。每个接收到的消息在配置 JtaTransactionManager
时都会注册到 XA 事务中。因此,处理可以利用 XA 事务语义。此监听器容器在 JMS 提供者的低要求、高级功能(例如参与外部管理事务)以及与 Jakarta EE 环境的兼容性之间取得了良好的平衡。
您可以自定义容器的缓存级别。请注意,当未启用缓存时,每次消息接收都会创建新的连接和新会话。将其与高负载的非持久订阅结合使用可能会导致消息丢失。在这种情况下,请务必使用适当的缓存级别。
当代理宕机时,此容器还具有可恢复功能。默认情况下,一个简单的 BackOff
实现每五秒重试一次。您可以指定自定义 BackOff
实现以获得更精细的恢复选项。请参阅 ExponentialBackOff
以获取示例。
与其兄弟( |
默认的 AUTO_ACKNOWLEDGE
模式不提供适当的可靠性保证。当监听器执行失败(因为提供者在监听器调用后自动确认每条消息,没有异常传播到提供者)或当监听器容器关闭(您可以通过设置 acceptMessagesWhileStopping
标志来配置此项)时,消息可能会丢失。在需要可靠性(例如,用于可靠的队列处理和持久主题订阅)的情况下,请务必使用事务性会话。
事务管理
Spring 提供了一个 JmsTransactionManager
,用于管理单个 JMS ConnectionFactory
的事务。这使得 JMS 应用程序能够利用 Spring 的托管事务功能,如 数据访问章节的事务管理部分 所述。JmsTransactionManager
执行本地资源事务,将指定 ConnectionFactory
的 JMS Connection/Session 对绑定到线程。JmsTemplate
自动检测此类事务性资源并相应地操作它们。
在 Jakarta EE 环境中,ConnectionFactory
池化 Connection 和 Session 实例,因此这些资源在事务之间得到高效重用。在独立环境中,使用 Spring 的 SingleConnectionFactory
会导致共享的 JMS Connection
,每个事务都有自己的独立 Session
。或者,考虑使用提供者特定的池适配器,例如 ActiveMQ 的 PooledConnectionFactory
类。
您还可以将 JmsTemplate
与 JtaTransactionManager
和支持 XA 的 JMS ConnectionFactory
一起使用,以执行分布式事务。请注意,这需要使用 JTA 事务管理器以及正确配置 XA 的 ConnectionFactory。(请查阅您的 Jakarta EE 服务器或 JMS 提供者的文档。)
在使用 JMS API 从 Connection
创建 Session
时,在托管和非托管事务环境之间重用代码可能会令人困惑。这是因为 JMS API 只有一个工厂方法来创建 Session
,并且它需要事务和确认模式的值。在托管环境中,设置这些值是环境事务基础设施的责任,因此这些值被供应商对 JMS Connection 的包装器忽略。当您在非托管环境中使用 JmsTemplate
时,可以通过使用属性 sessionTransacted
和 sessionAcknowledgeMode
来指定这些值。当您将 PlatformTransactionManager
与 JmsTemplate
一起使用时,模板始终会获得一个事务性 JMS Session
。