基于注解的监听器端点

异步接收消息最简单的方法是使用基于注解的监听器端点基础设施。简而言之，它允许您将托管 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 类之一，如下例所示

@Configuration
@EnableJms
public class AppConfig {

	@Bean
	public DefaultJmsListenerContainerFactory jmsListenerContainerFactory() {
		DefaultJmsListenerContainerFactory factory = new DefaultJmsListenerContainerFactory();
		factory.setConnectionFactory(connectionFactory());
		factory.setDestinationResolver(destinationResolver());
		factory.setSessionTransacted(true);
		factory.setConcurrency("3-10");
		return factory;
	}
}

默认情况下，基础设施会查找名为 jmsListenerContainerFactory 的 bean 作为用于创建消息监听器容器的工厂的来源。在这种情况下（忽略 JMS 基础设施设置），您可以使用三个线程的核心轮询大小和十个线程的最大池大小来调用 processOrder 方法。

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

如果您更喜欢 XML 配置，您可以使用 <jms:annotation-driven> 元素，如下例所示

<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>

编程端点注册

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带注解的方法参数，用于提取特定标头值，包括标准 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;
	}
}