此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Boot 3.4.0! |
JMS 公司
ConnectionFactory
接口提供了一种创建Connection
的标准方法,以便与 JMS 代理进行交互。
尽管 Spring 需要一个ConnectionFactory
来与 JMS 一起工作,但你通常不需要自己直接使用它,而是可以依赖更高级别的消息传递抽象。
(有关详细信息,请参阅 Spring Framework 参考文档的相关部分。
Spring Boot 还自动配置了发送和接收消息所需的基础设施。
ActiveMQ “Classic” 支持
当 ActiveMQ “Classic” 在 Classpath 上可用时, Spring Boot 可以配置ConnectionFactory
。
如果您使用 ,则提供了连接到 ActiveMQ “Classic” 实例所需的依赖项,以及与 JMS 集成的 Spring 基础架构。spring-boot-starter-activemq |
ActiveMQ “Classic” 配置由 中的外部配置属性控制。
默认情况下,ActiveMQ “Classic” 自动配置为使用 TCP 传输,默认情况下连接到 .以下示例显示如何更改默认代理 URL:spring.activemq.*
tcp://localhost:61616
-
Properties
-
YAML
spring.activemq.broker-url=tcp://192.168.1.210:9876
spring.activemq.user=admin
spring.activemq.password=secret
spring:
activemq:
broker-url: "tcp://192.168.1.210:9876"
user: "admin"
password: "secret"
默认情况下,CachingConnectionFactory
使用合理的设置包装本机 ConnectionFactory
,您可以通过外部配置属性控制这些设置:spring.jms.*
-
Properties
-
YAML
spring.jms.cache.session-cache-size=5
spring:
jms:
cache:
session-cache-size: 5
如果你更愿意使用原生池,你可以通过向JmsPoolConnectionFactory
添加依赖项并相应地配置来实现,如以下示例所示:org.messaginghub:pooled-jms
-
Properties
-
YAML
spring.activemq.pool.enabled=true
spring.activemq.pool.max-connections=50
spring:
activemq:
pool:
enabled: true
max-connections: 50
有关更多支持的选项,请参阅 ActiveMQProperties 。
您还可以注册任意数量的 Bean 来实现 ActiveMQConnectionFactoryCustomizer ,以进行更高级的自定义。 |
默认情况下,ActiveMQ “Classic” 会创建一个目标(如果尚不存在),以便根据提供的名称解析目标。
ActiveMQ Artemis 支持
Spring Boot 可以在检测到 ActiveMQ Artemis 在 Classpath 上可用时自动配置ConnectionFactory
。
如果存在代理,则会自动启动并配置嵌入式代理(除非已明确设置 mode 属性)。
支持的模式是(明确表示需要嵌入式代理,如果代理在 Classpath 上不可用,则应该发生错误)和(使用传输协议连接到代理)。
配置后者后, Spring Boot 会配置一个ConnectionFactory,该ConnectionFactory
使用默认设置连接到在本地计算机上运行的代理。embedded
native
netty
如果您使用 ,则提供了连接到现有 ActiveMQ Artemis 实例所需的依赖项,以及与 JMS 集成的 Spring 基础架构。
通过添加到应用程序,可以使用嵌入式模式。spring-boot-starter-artemis 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=secret
spring:
artemis:
mode: native
broker-url: "tcp://192.168.1.210:9876"
user: "admin"
password: "secret"
在嵌入代理时,您可以选择是否要启用持久性并列出应可用的目标。
可以将这些 bean 指定为逗号分隔的列表,以便使用默认选项创建它们,或者您可以定义 JMSQueueConfiguration
或 TopicConfiguration
类型的 bean,分别用于高级队列和主题配置。
默认情况下,CachingConnectionFactory
使用合理的设置包装本机 ConnectionFactory
,您可以通过外部配置属性控制这些设置:spring.jms.*
-
Properties
-
YAML
spring.jms.cache.session-cache-size=5
spring:
jms:
cache:
session-cache-size: 5
如果你更愿意使用原生池,你可以通过添加对JmsPoolConnectionFactory
的依赖并相应地配置来实现,如以下示例所示:org.messaginghub:pooled-jms
-
Properties
-
YAML
spring.artemis.pool.enabled=true
spring.artemis.pool.max-connections=50
spring:
artemis:
pool:
enabled: true
max-connections: 50
有关更多支持的选项,请参阅 ArtemisProperties
。
不涉及 JNDI 查找,并且使用 ActiveMQ Artemis 配置中的属性或通过配置提供的名称根据其名称解析目标。name
使用 JNDI ConnectionFactory
如果你在应用程序服务器中运行应用程序,Spring Boot 会尝试使用 JNDI 来定位 JMS ConnectionFactory
。
默认情况下,将选中 和 location。
如果需要指定备用位置,则可以使用该属性,如以下示例所示:java:/JmsXA
java:/XAConnectionFactory
spring.jms.jndi-name
-
Properties
-
YAML
spring.jms.jndi-name=java:/MyConnectionFactory
spring:
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,则它们将自动与默认工厂相关联。
默认情况下,默认工厂是事务性的。
如果你在存在JtaTransactionManager
的基础设施中运行,则默认情况下它与侦听器容器相关联。
否则,将启用该标志。
在后一种情况下,您可以通过在 listener 方法(或其委托)上添加 @Transactional
将本地数据存储事务与传入消息的处理相关联。
这可确保在本地事务完成后确认传入消息。
这还包括发送已在同一 JMS 会话上执行的响应消息。sessionTransacted
以下组件在目标上创建一个侦听器终端节点: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.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) {
DefaultJmsListenerContainerFactory factory = new DefaultJmsListenerContainerFactory();
ConnectionFactory connectionFactory = getCustomConnectionFactory();
configurer.configure(factory, connectionFactory);
factory.setMessageConverter(new MyMessageConverter());
return factory;
}
private ConnectionFactory getCustomConnectionFactory() {
return ...
}
}
import jakarta.jms.ConnectionFactory
import org.springframework.boot.autoconfigure.jms.DefaultJmsListenerContainerFactoryConfigurer
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): DefaultJmsListenerContainerFactory {
val factory = DefaultJmsListenerContainerFactory()
val connectionFactory = getCustomConnectionFactory()
configurer.configure(factory, connectionFactory)
factory.setMessageConverter(MyMessageConverter())
return factory
}
fun getCustomConnectionFactory() : ConnectionFactory? {
return ...
}
}
然后,您可以在任何@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?) {
// ...
}
}