注解驱动的监听器端点

接收消息最简单的方法是异步地使用带注解的监听器端点基础设施。简而言之，它允许您将受管 Bean 的方法公开为 JMS 监听器端点。以下示例演示了如何使用它

@Component
public class MyService {

	@JmsListener(destination = "myDestination")
	public void processOrder(String data) { ... }
}

前面示例的思想是，只要jakarta.jms.Destination myDestination 上有可用消息，就会相应地调用processOrder 方法（在本例中，使用 JMS 消息的内容，类似于MessageListenerAdapter 提供的内容）。

带注解的端点基础设施在后台为每个带注解的方法创建一个消息侦听器容器，方法是使用JmsListenerContainerFactory。此类容器未在应用程序上下文中注册，但可以通过使用JmsListenerEndpointRegistry Bean轻松地找到它以进行管理。

@JmsListener 是 Java 8 上的可重复注解，因此您可以通过向其中添加其他@JmsListener 声明将多个 JMS 目标与相同方法关联。

启用监听器端点注解

要启用对@JmsListener 注解的支持，您可以将@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 的 Bean 作为要用于创建消息侦听器容器的工厂的来源。在这种情况下（并忽略 JMS 基础设施设置），您可以使用三个线程的核心池大小和十个线程的最大池大小来调用processOrder 方法。

您可以自定义要用于每个注解的侦听器容器工厂，也可以通过实现JmsListenerConfigurer 接口来配置显式默认值。仅当至少注册了一个没有特定容器工厂的端点时，才需要默认值。有关详细信息和示例，请参阅实现JmsListenerConfigurer 的类的 javadoc。

编程端点注册

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 或其任何子类（前提是它与传入的消息类型匹配）。

  • 用于可选访问本机 JMS API 的jakarta.jms.Session（例如，用于发送自定义回复）。

  • 表示传入 JMS 消息的org.springframework.messaging.Message。请注意，此消息同时包含自定义标头和标准标头（由JmsHeaders 定义）。

  • @Header 注解的方法参数，用于提取特定标头值，包括标准 JMS 标头。

  • @Headers 注解的参数，该参数也必须可分配给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 中现有的支持已经允许您的方法具有非void 返回类型。在这种情况下，调用的结果将封装在jakarta.jms.Message 中，发送到原始消息的JMSReplyTo 标头中指定的目的地或侦听器上配置的默认目的地。您现在可以使用消息传递抽象的@SendTo 注解设置该默认目的地。

假设我们的processOrder 方法现在应该返回OrderStatus，我们可以编写它来自动发送响应，如下例所示

@JmsListener(destination = "myDestination")
@SendTo("status")
public OrderStatus processOrder(Order order) {
	// order processing
	return status;
}
如果您有多个@JmsListener 注解的方法，您也可以将@SendTo 注解放在类级别以共享默认回复目标。

如果您需要以独立于传输的方式设置其他标头，您可以返回一个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;
	}
}