此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Framework 6.2.0! |
注释驱动的侦听器端点
异步接收消息的最简单方法是使用带 Comments 的侦听器 端点基础设施。简而言之,它允许您公开托管 bean 作为 JMS 侦听器端点。以下示例演示如何使用它:
@Component
public class MyService {
@JmsListener(destination = "myDestination")
public void processOrder(String data) { ... }
}
前面示例的思路是,每当消息在jakarta.jms.Destination
myDestination
这processOrder
method 被调用
因此(在本例中,使用 JMS 消息的内容,类似于
什么MessageListenerAdapter
提供)。
带注释的终端节点基础设施会创建一个消息侦听器容器
每个带注释方法的幕后,通过使用JmsListenerContainerFactory
.
这样的容器不是针对应用程序上下文注册的,但可以很容易地
使用JmsListenerEndpointRegistry
豆。
@JmsListener 是 Java 8 上的可重复注释,因此您可以将
多个 JMS 目标,方法是添加额外的@JmsListener 声明。 |
启用 Listener Endpoint Annotations
要启用对@JmsListener
annotations 中,您可以添加@EnableJms
到其中一个
你@Configuration
类,如下例所示:
-
Java
-
Kotlin
-
Xml
@Configuration
@EnableJms
public class JmsConfiguration {
@Bean
public DefaultJmsListenerContainerFactory jmsListenerContainerFactory(ConnectionFactory connectionFactory,
DestinationResolver destinationResolver) {
DefaultJmsListenerContainerFactory factory = new DefaultJmsListenerContainerFactory();
factory.setConnectionFactory(connectionFactory);
factory.setDestinationResolver(destinationResolver);
factory.setSessionTransacted(true);
factory.setConcurrency("3-10");
return factory;
}
}
@Configuration
@EnableJms
class JmsConfiguration {
@Bean
fun jmsListenerContainerFactory(connectionFactory: ConnectionFactory, destinationResolver: DestinationResolver) =
DefaultJmsListenerContainerFactory().apply {
setConnectionFactory(connectionFactory)
setDestinationResolver(destinationResolver)
setSessionTransacted(true)
setConcurrency("3-10")
}
}
<jms:annotation-driven/>
<bean id="jmsListenerContainerFactory" class="org.springframework.jms.config.DefaultJmsListenerContainerFactory">
<property name="connectionFactory" ref="connectionFactory"/>
<property name="destinationResolver" ref="destinationResolver"/>
<property name="sessionTransacted" value="true"/>
<property name="concurrency" value="3-10"/>
</bean>
默认情况下,基础架构会查找名为jmsListenerContainerFactory
作为工厂用于创建消息侦听器容器的源。在这个
的情况下(忽略 JMS 基础设施设置),您可以调用processOrder
方法,核心池大小为 3 个线程,最大池大小为 10 个线程。
您可以自定义侦听器容器工厂以用于每个注释,也可以
通过实现JmsListenerConfigurer
接口。
仅当至少注册了一个端点而没有特定的
集装箱工厂。请参阅实现JmsListenerConfigurer
了解详细信息和示例。
编程终端节点注册
JmsListenerEndpoint
提供 JMS 终端节点的模型,并负责配置
该模型的容器。基础设施允许您以编程方式配置终端节点
除了JmsListener
注解。
以下示例显示了如何执行此作:
@Configuration
@EnableJms
public class AppConfig implements JmsListenerConfigurer {
@Override
public void configureJmsListeners(JmsListenerEndpointRegistrar registrar) {
SimpleJmsListenerEndpoint endpoint = new SimpleJmsListenerEndpoint();
endpoint.setId("myJmsEndpoint");
endpoint.setDestination("anotherQueue");
endpoint.setMessageListener(message -> {
// processing
});
registrar.registerEndpoint(endpoint);
}
}
在前面的示例中,我们使用了SimpleJmsListenerEndpoint
,它提供实际的MessageListener
调用。但是,您也可以构建自己的终端节点变体
来描述自定义调用机制。
请注意,您可以跳过使用@JmsListener
完全
并通过以下方式以编程方式仅注册您的端点JmsListenerConfigurer
.
带注释的端点方法签名
到目前为止,我们一直在注入一个简单的String
在我们的端点中,但它实际上可以
具有非常灵活的方法签名。在下面的示例中,我们重写它以注入Order
跟
自定义标头:
@Component
public class MyService {
@JmsListener(destination = "myDestination")
public void processOrder(Order order, @Header("order_type") String orderType) {
...
}
}
您可以在 JMS 侦听器终端节点中注入的主要元素如下:
-
生的
jakarta.jms.Message
或其任何子类(前提是它 匹配传入消息类型)。 -
这
jakarta.jms.Session
用于对本机 JMS API 的可选访问(例如,用于发送 自定义回复)。 -
这
org.springframework.messaging.Message
,这表示传入的 JMS 消息。 请注意,此消息同时包含自定义和标准标头(如定义 由JmsHeaders
). -
@Header
-annotated 方法参数来提取特定的标头值,包括 标准 JMS 标头。 -
一个
@Headers
-annotated 参数,该参数也必须可分配给java.util.Map
为 获取对所有标头的访问权限。 -
不是受支持类型之一的非注释元素 (
Message
或Session
) 被视为有效负载。您可以通过注释 参数与@Payload
.您还可以通过添加额外的@Valid
.
能够注入 Spring 的Message
抽象特别有用
从特定于传输的消息中存储的所有信息中,而无需依赖
特定于传输的 API。以下示例显示了如何执行此作:
@JmsListener(destination = "myDestination")
public void processOrder(Message<Order> order) { ... }
方法参数的处理由DefaultMessageHandlerMethodFactory
,您可以
进一步自定义以支持其他方法参数。您可以自定义转换和验证
那里也有支持。
例如,如果我们想确保我们的Order
有效,我们可以
使用@Valid
并配置必要的验证器,如下例所示:
@Configuration
@EnableJms
public class AppConfig implements JmsListenerConfigurer {
@Override
public void configureJmsListeners(JmsListenerEndpointRegistrar registrar) {
registrar.setMessageHandlerMethodFactory(myJmsHandlerMethodFactory());
}
@Bean
public DefaultMessageHandlerMethodFactory myHandlerMethodFactory() {
DefaultMessageHandlerMethodFactory factory = new DefaultMessageHandlerMethodFactory();
factory.setValidator(myValidator());
return factory;
}
}
响应管理
现有的支持MessageListenerAdapter
already 让你的方法有一个非 -void
return 类型。在这种情况下,将
调用封装在jakarta.jms.Message
,在指定的目标中发送
在JMSReplyTo
标头,或在
侦听器。现在,您可以使用@SendTo
注解的
消息传递抽象。
假设我们的processOrder
方法现在应该返回一个OrderStatus
,我们可以编写它
自动发送响应,如下例所示:
@JmsListener(destination = "myDestination")
@SendTo("status")
public OrderStatus processOrder(Order order) {
// order processing
return status;
}
如果您有多个@JmsListener -annotated 方法,您还可以将@SendTo annotation 共享默认回复目标。 |
如果需要以独立于传输的方式设置其他标头,则可以返回Message
而是使用类似于下面的方法:
@JmsListener(destination = "myDestination")
@SendTo("status")
public Message<OrderStatus> processOrder(Order order) {
// order processing
return MessageBuilder
.withPayload(status)
.setHeader("code", 1234)
.build();
}
如果您需要在运行时计算响应目标,则可以封装您的响应
在JmsResponse
实例,该实例还提供要在运行时使用的目标。我们可以重写之前的
示例如下:
@JmsListener(destination = "myDestination")
public JmsResponse<Message<OrderStatus>> processOrder(Order order) {
// order processing
Message<OrderStatus> response = MessageBuilder
.withPayload(status)
.setHeader("code", 1234)
.build();
return JmsResponse.forQueue(response, "status");
}
最后,如果您需要为响应指定一些 QoS 值,例如优先级或
生存时间,您可以配置JmsListenerContainerFactory
因此
如下例所示:
@Configuration
@EnableJms
public class AppConfig {
@Bean
public DefaultJmsListenerContainerFactory jmsListenerContainerFactory() {
DefaultJmsListenerContainerFactory factory = new DefaultJmsListenerContainerFactory();
factory.setConnectionFactory(connectionFactory());
QosSettings replyQosSettings = new QosSettings();
replyQosSettings.setPriority(2);
replyQosSettings.setTimeToLive(10000);
factory.setReplyQosSettings(replyQosSettings);
return factory;
}
}