|
如需获取最新稳定版本，请使用 Spring Boot 4.0.4！ |
JMS
ConnectionFactory 接口提供了一种标准方法，用于创建 Connection 以与 JMS 代理进行交互。
尽管 Spring 需要 ConnectionFactory 才能使用 JMS，但您通常无需直接使用它，而是可以依赖更高级别的消息抽象。
（详细信息请参阅 Spring Framework 参考文档的相关部分。）
Spring Boot 还会自动配置发送和接收消息所需的基础设施。
ActiveMQ “Classic” 支持
当 ActiveMQ "Classic" 在类路径上可用时，Spring Boot 可以配置一个 ConnectionFactory。
如果代理存在，则会自动启动并配置嵌入式代理（前提是没有通过配置指定代理 URL，并且配置中未禁用嵌入式代理）。
如果您使用 spring-boot-starter-activemq，则会提供连接到 ActiveMQ "Classic" 实例所需的依赖项，以及用于与 JMS 集成的 Spring 基础设施。
在应用程序中添加 org.apache.activemq:activemq-broker 可让您使用嵌入式代理。 |
ActiveMQ "Classic" 的配置由 spring.activemq.* 中的外部配置属性控制。
如果 activemq-broker 在类路径上，ActiveMQ "Classic" 会自动配置为使用 VM 传输，这会在同一 JVM 实例中启动一个代理。
您可以通过配置 spring.activemq.embedded.enabled 属性来禁用嵌入式代理，如下例所示：
-
Properties
-
YAML
spring.activemq.embedded.enabled=falsespring:
activemq:
embedded:
enabled: false如果您配置了代理 URL，嵌入式代理也将被禁用，如下例所示：
-
Properties
-
YAML
spring.activemq.broker-url=tcp://192.168.1.210:9876
spring.activemq.user=admin
spring.activemq.password=secretspring:
activemq:
broker-url: "tcp://192.168.1.210:9876"
user: "admin"
password: "secret"如果您想完全控制嵌入式代理，请参阅 ActiveMQ "Classic" 文档 以获取更多信息。
默认情况下，CachingConnectionFactory 会使用合理的设置包装原生 ConnectionFactory，你可以通过 spring.jms.* 中的外部配置属性来控制这些设置：
-
Properties
-
YAML
spring.jms.cache.session-cache-size=5spring:
jms:
cache:
session-cache-size: 5如果您更愿意使用原生连接池，可以通过添加对 org.messaginghub:pooled-jms 的依赖并相应地配置 JmsPoolConnectionFactory 来实现，如下例所示：
-
Properties
-
YAML
spring.activemq.pool.enabled=true
spring.activemq.pool.max-connections=50spring:
activemq:
pool:
enabled: true
max-connections: 50请参阅 ActiveMQProperties 以了解更多支持的选项。
您还可以注册任意数量的实现 ActiveMQConnectionFactoryCustomizer 的 bean，以实现更高级的自定义。 |
默认情况下，ActiveMQ “Classic” 会在目标尚不存在时创建它，以便根据提供的名称解析目标。
ActiveMQ Artemis 支持
Spring Boot 在检测到类路径上存在 ActiveMQ Artemis 时可以自动配置一个 ConnectionFactory。
如果代理程序存在，会自动启动并配置一个嵌入式代理（除非已明确设置模式属性）。
支持的模式包括 embedded（显式表示需要嵌入式代理，并且如果类路径上不可用代理程序则会报错）和 native（使用 netty 传输协议连接到代理程序）。
当配置后一种模式时，Spring Boot 会配置一个 ConnectionFactory，该代理程序使用默认设置连接到本地计算机上运行的代理程序。
如果您使用 spring-boot-starter-artemis，则会提供连接到现有 ActiveMQ Artemis 实例所需的依赖项，以及用于与 JMS 集成的 Spring 基础架构。
向您的应用程序添加 org.apache.activemq:artemis-jakarta-server 即可使用嵌入模式。 |
ActiveMQ Artemis 配置由 spring.artemis.* 中的外部配置属性控制。
例如，您可以在 application.properties 中声明以下部分：
-
Properties
-
YAML
spring.artemis.mode=native
spring.artemis.broker-url=tcp://192.168.1.210:9876
spring.artemis.user=admin
spring.artemis.password=secretspring:
artemis:
mode: native
broker-url: "tcp://192.168.1.210:9876"
user: "admin"
password: "secret"嵌入代理时，您可以选择是否启用持久性，并列出应可用的目标。
这些目标可以指定为逗号分隔的列表，以使用默认选项创建它们，或者您可以定义类型为 JMSQueueConfiguration 或 TopicConfiguration 的一个或多个 bean，分别用于高级队列和主题配置。
默认情况下，CachingConnectionFactory 会使用合理的设置包装原生 ConnectionFactory，你可以通过 spring.jms.* 中的外部配置属性来控制这些设置：
-
Properties
-
YAML
spring.jms.cache.session-cache-size=5spring:
jms:
cache:
session-cache-size: 5如果您更愿意使用原生连接池，可以通过添加对 org.messaginghub:pooled-jms 的依赖并相应地配置 JmsPoolConnectionFactory 来实现，如下例所示：
-
Properties
-
YAML
spring.artemis.pool.enabled=true
spring.artemis.pool.max-connections=50spring:
artemis:
pool:
enabled: true
max-connections: 50有关更多支持的选项，请参见 ArtemisProperties。
不涉及 JNDI 查找，目标地址是根据其名称解析的，使用的是 ActiveMQ Artemis 配置中的 name 属性或通过配置提供的名称。
使用 JNDI ConnectionFactory
如果您在应用服务器中运行应用程序，Spring Boot 会尝试通过 JNDI 查找 JMS ConnectionFactory。
默认情况下，会检查 java:/JmsXA 和 java:/XAConnectionFactory 位置。
如果需要指定备用位置，可以使用 spring.jms.jndi-name 属性，如下例所示：
-
Properties
-
YAML
spring.jms.jndi-name=java:/MyConnectionFactoryspring:
jms:
jndi-name: "java:/MyConnectionFactory"发送消息
Spring 的 JmsTemplate 是自动配置的，您可以直接将其自动装配到您自己的 Bean 中，如下例所示：
-
Java
-
Kotlin
import org.springframework.jms.core.JmsTemplate;
import org.springframework.stereotype.Component;
@Component
public class MyBean {
private final JmsTemplate jmsTemplate;
public MyBean(JmsTemplate jmsTemplate) {
this.jmsTemplate = jmsTemplate;
}
// ...
public void someMethod() {
this.jmsTemplate.convertAndSend("hello");
}
}import org.springframework.jms.core.JmsTemplate
import org.springframework.stereotype.Component
@Component
class MyBean(private val jmsTemplate: JmsTemplate) {
// ...
fun someMethod() {
jmsTemplate.convertAndSend("hello")
}
}JmsMessagingTemplate 可以以类似的方式注入。
如果定义了 DestinationResolver 或 MessageConverter bean，它会自动关联到自动配置的 JmsTemplate。 |
接收消息
当 JMS 基础设施存在时，任何 bean 都可以使用 @JmsListener 进行注解以创建监听器端点。
如果未定义 JmsListenerContainerFactory，则会自动配置一个默认的。
如果定义了 DestinationResolver、MessageConverter 或 ExceptionListener bean，它们将自动与默认工厂关联。
在大多数场景下，消息监听器容器应针对原生 ConnectionFactory 进行配置。
这样，每个监听器容器都拥有自己的连接，从而使其能够完全负责本地恢复。
自动配置使用 ConnectionFactoryUnwrapper 从自动配置的工厂中解包出原生的连接工厂。
自动配置仅解包 CachedConnectionFactory。 |
默认情况下，默认工厂是事务性的。
如果在存在 JtaTransactionManager 的基础设施中运行，则默认情况下它会与监听器容器关联。
否则，将启用 sessionTransacted 标志。
在后一种场景中，您可以通过在监听器方法（或其委托方法）上添加 @Transactional，将本地数据存储事务与传入消息的处理关联起来。
这确保了在本地事务完成后，才会确认传入消息。
这也包括在同一 JMS 会话上执行的响应消息的发送。
以下组件在 someQueue 目标上创建一个监听器端点：
-
Java
-
Kotlin
import org.springframework.jms.annotation.JmsListener;
import org.springframework.stereotype.Component;
@Component
public class MyBean {
@JmsListener(destination = "someQueue")
public void processMessage(String content) {
// ...
}
}import org.springframework.jms.annotation.JmsListener
import org.springframework.stereotype.Component
@Component
class MyBean {
@JmsListener(destination = "someQueue")
fun processMessage(content: String?) {
// ...
}
}请参阅 @EnableJms API 文档以获取更多详细信息。 |
如果您需要创建更多 JmsListenerContainerFactory 实例，或者想要覆盖默认设置，Spring Boot 提供了一个 DefaultJmsListenerContainerFactoryConfigurer，您可以使用它来初始化一个 DefaultJmsListenerContainerFactory，其设置与自动配置的实例相同。
例如，以下示例公开了另一个使用特定 MessageConverter 的工厂：
-
Java
-
Kotlin
import jakarta.jms.ConnectionFactory;
import org.springframework.boot.autoconfigure.jms.DefaultJmsListenerContainerFactoryConfigurer;
import org.springframework.boot.jms.ConnectionFactoryUnwrapper;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jms.config.DefaultJmsListenerContainerFactory;
@Configuration(proxyBeanMethods = false)
public class MyJmsConfiguration {
@Bean
public DefaultJmsListenerContainerFactory myFactory(DefaultJmsListenerContainerFactoryConfigurer configurer,
ConnectionFactory connectionFactory) {
DefaultJmsListenerContainerFactory factory = new DefaultJmsListenerContainerFactory();
configurer.configure(factory, ConnectionFactoryUnwrapper.unwrapCaching(connectionFactory));
factory.setMessageConverter(new MyMessageConverter());
return factory;
}
}import jakarta.jms.ConnectionFactory
import org.springframework.boot.autoconfigure.jms.DefaultJmsListenerContainerFactoryConfigurer
import org.springframework.boot.jms.ConnectionFactoryUnwrapper
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import org.springframework.jms.config.DefaultJmsListenerContainerFactory
@Configuration(proxyBeanMethods = false)
class MyJmsConfiguration {
@Bean
fun myFactory(configurer: DefaultJmsListenerContainerFactoryConfigurer,
connectionFactory: ConnectionFactory): DefaultJmsListenerContainerFactory {
val factory = DefaultJmsListenerContainerFactory()
configurer.configure(factory, ConnectionFactoryUnwrapper.unwrapCaching(connectionFactory))
factory.setMessageConverter(MyMessageConverter())
return factory
}
}在上面的示例中，自定义使用 ConnectionFactoryUnwrapper 以与自动配置的工厂相同的方式将原生连接工厂关联到消息监听器容器。 |
然后，您可以在任何带有 @JmsListener 注解的方法中使用该工厂，如下所示：
-
Java
-
Kotlin
import org.springframework.jms.annotation.JmsListener;
import org.springframework.stereotype.Component;
@Component
public class MyBean {
@JmsListener(destination = "someQueue", containerFactory = "myFactory")
public void processMessage(String content) {
// ...
}
}import org.springframework.jms.annotation.JmsListener
import org.springframework.stereotype.Component
@Component
class MyBean {
@JmsListener(destination = "someQueue", containerFactory = "myFactory")
fun processMessage(content: String?) {
// ...
}
}