对于最新的稳定版本，请使用 Spring Boot 3.4.0！spring-doc.cadn.net.cn

AMQP

高级消息队列协议（AMQP）是一种平台中立的有线级协议，适用于面向消息的中间件。 Spring AMQP 项目将核心 Spring 概念应用于基于 AMQP 的消息传递解决方案的开发。 Spring Boot 为通过 RabbitMQ 使用 AMQP 提供了多种便利，包括spring-boot-starter-amqp起动机。spring-doc.cadn.net.cn

RabbitMQ 支持

RabbitMQ 是基于 AMQP 协议的轻量级、可靠、可扩展且可移植的消息代理。 Spring 使用 RabbitMQ 通过 AMQP 协议进行通信。spring-doc.cadn.net.cn

RabbitMQ 配置由spring.rabbitmq.*. 例如，您可以在application.properties:spring-doc.cadn.net.cn

Propertiesspring-doc.cadn.net.cn
YAMLspring-doc.cadn.net.cn

spring.rabbitmq.host=localhost
spring.rabbitmq.port=5672
spring.rabbitmq.username=admin
spring.rabbitmq.password=secret

spring:
  rabbitmq:
    host: "localhost"
    port: 5672
    username: "admin"
    password: "secret"

或者，您可以使用addresses属性：spring-doc.cadn.net.cn

Propertiesspring-doc.cadn.net.cn
YAMLspring-doc.cadn.net.cn

spring.rabbitmq.addresses=amqp://admin:secret@localhost

spring:
  rabbitmq:
    addresses: "amqp://admin:secret@localhost"

以这种方式指定地址时，host和portproperties 将被忽略。如果地址使用amqps协议，则会自动启用 SSL 支持。

看RabbitProperties，了解更多受支持的基于属性的配置选项。配置 RabbitMQ 的较低级别详细信息ConnectionFactory，定义一个ConnectionFactoryCustomizer豆。spring-doc.cadn.net.cn

如果ConnectionNameStrategybean 存在于上下文中，它将自动用于命名由自动配置的CachingConnectionFactory.spring-doc.cadn.net.cn

要对RabbitTemplate，请使用RabbitTemplateCustomizer豆。spring-doc.cadn.net.cn

有关更多详细信息，请参阅了解 RabbitMQ 使用的协议 AMQP。

发送消息

Spring的AmqpTemplate和AmqpAdmin是自动配置的，你可以将它们直接自动连接到你自己的 bean 中，如以下示例所示：spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

import org.springframework.amqp.core.AmqpAdmin;
import org.springframework.amqp.core.AmqpTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

	private final AmqpAdmin amqpAdmin;

	private final AmqpTemplate amqpTemplate;

	public MyBean(AmqpAdmin amqpAdmin, AmqpTemplate amqpTemplate) {
		this.amqpAdmin = amqpAdmin;
		this.amqpTemplate = amqpTemplate;
	}

	// ...

	public void someMethod() {
		this.amqpAdmin.getQueueInfo("someQueue");
	}

	public void someOtherMethod() {
		this.amqpTemplate.convertAndSend("hello");
	}

}

import org.springframework.amqp.core.AmqpAdmin
import org.springframework.amqp.core.AmqpTemplate
import org.springframework.stereotype.Component

@Component
class MyBean(private val amqpAdmin: AmqpAdmin, private val amqpTemplate: AmqpTemplate) {

	// ...

	fun someMethod() {
		amqpAdmin.getQueueInfo("someQueue")
	}

	fun someOtherMethod() {
		amqpTemplate.convertAndSend("hello")
	}

}

RabbitMessagingTemplate可以以类似的方式注射。如果MessageConverterbean 时，它会自动关联到自动配置的AmqpTemplate.

如有必要，任何Queue定义为 bean 时，它会自动用于在 RabbitMQ 实例上声明相应的队列。spring-doc.cadn.net.cn

要重试作，您可以在AmqpTemplate（例如，如果代理连接丢失）：spring-doc.cadn.net.cn

Propertiesspring-doc.cadn.net.cn
YAMLspring-doc.cadn.net.cn

spring.rabbitmq.template.retry.enabled=true
spring.rabbitmq.template.retry.initial-interval=2s

spring:
  rabbitmq:
    template:
      retry:
        enabled: true
        initial-interval: "2s"

默认情况下，重试处于禁用状态。您还可以自定义RetryTemplate通过声明RabbitRetryTemplateCustomizer豆。spring-doc.cadn.net.cn

如果您需要创建更多RabbitTemplate实例，或者如果您想覆盖默认值，Spring Boot 会提供RabbitTemplateConfigurerBean，可用于初始化RabbitTemplate使用与 auto-configuration 使用的工厂相同的设置。spring-doc.cadn.net.cn

向流发送消息

要向特定流发送消息，请指定流的名称，如以下示例所示：spring-doc.cadn.net.cn

Propertiesspring-doc.cadn.net.cn
YAMLspring-doc.cadn.net.cn

spring.rabbitmq.stream.name=my-stream

spring:
  rabbitmq:
    stream:
      name: "my-stream"

如果MessageConverter,StreamMessageConverter或ProducerCustomizerbean 时，它会自动关联到自动配置的RabbitStreamTemplate.spring-doc.cadn.net.cn

如果您需要创建更多RabbitStreamTemplate实例，或者如果您想覆盖默认值，Spring Boot 会提供RabbitStreamTemplateConfigurerBean，可用于初始化RabbitStreamTemplate使用与 auto-configuration 使用的工厂相同的设置。spring-doc.cadn.net.cn

接收消息

当 Rabbit 基础结构存在时，任何 bean 都可以使用@RabbitListener以创建侦听器终端节点。如果没有RabbitListenerContainerFactory，则默认的SimpleRabbitListenerContainerFactory会自动配置，您可以使用spring.rabbitmq.listener.type财产。如果MessageConverter或MessageRecovererbean，它会自动与默认工厂相关联。spring-doc.cadn.net.cn

以下示例组件在someQueue队列：spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

import org.springframework.amqp.rabbit.annotation.RabbitListener;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

	@RabbitListener(queues = "someQueue")
	public void processMessage(String content) {
		// ...
	}

}

import org.springframework.amqp.rabbit.annotation.RabbitListener
import org.springframework.stereotype.Component

@Component
class MyBean {

	@RabbitListener(queues = ["someQueue"])
	fun processMessage(content: String?) {
		// ...
	}

}

看@EnableRabbit了解更多详情。

如果您需要创建更多RabbitListenerContainerFactory实例，或者如果您想覆盖默认值，Spring Boot 会提供SimpleRabbitListenerContainerFactoryConfigurer以及DirectRabbitListenerContainerFactoryConfigurer，可用于初始化SimpleRabbitListenerContainerFactory以及DirectRabbitListenerContainerFactory使用与 auto-configuration 使用的工厂相同的设置。spring-doc.cadn.net.cn

选择哪种容器类型并不重要。这两个 bean 由自动配置公开。

例如，下面的配置类公开了另一个使用特定MessageConverter:spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

import org.springframework.amqp.rabbit.config.SimpleRabbitListenerContainerFactory;
import org.springframework.amqp.rabbit.connection.ConnectionFactory;
import org.springframework.boot.autoconfigure.amqp.SimpleRabbitListenerContainerFactoryConfigurer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyRabbitConfiguration {

	@Bean
	public SimpleRabbitListenerContainerFactory myFactory(SimpleRabbitListenerContainerFactoryConfigurer configurer) {
		SimpleRabbitListenerContainerFactory factory = new SimpleRabbitListenerContainerFactory();
		ConnectionFactory connectionFactory = getCustomConnectionFactory();
		configurer.configure(factory, connectionFactory);
		factory.setMessageConverter(new MyMessageConverter());
		return factory;
	}

	private ConnectionFactory getCustomConnectionFactory() {
		return ...
	}

}

import org.springframework.amqp.rabbit.config.SimpleRabbitListenerContainerFactory
import org.springframework.amqp.rabbit.connection.ConnectionFactory
import org.springframework.boot.autoconfigure.amqp.SimpleRabbitListenerContainerFactoryConfigurer
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration

@Configuration(proxyBeanMethods = false)
class MyRabbitConfiguration {

	@Bean
	fun myFactory(configurer: SimpleRabbitListenerContainerFactoryConfigurer): SimpleRabbitListenerContainerFactory {
		val factory = SimpleRabbitListenerContainerFactory()
		val connectionFactory = getCustomConnectionFactory()
		configurer.configure(factory, connectionFactory)
		factory.setMessageConverter(MyMessageConverter())
		return factory
	}

	fun getCustomConnectionFactory() : ConnectionFactory? {
		return ...
	}

}

然后，您可以在任何@RabbitListener-annotated 方法，如下所示：spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

import org.springframework.amqp.rabbit.annotation.RabbitListener;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

	@RabbitListener(queues = "someQueue", containerFactory = "myFactory")
	public void processMessage(String content) {
		// ...
	}

}

import org.springframework.amqp.rabbit.annotation.RabbitListener
import org.springframework.stereotype.Component

@Component
class MyBean {

	@RabbitListener(queues = ["someQueue"], containerFactory = "myFactory")
	fun processMessage(content: String?) {
		// ...
	}

}

您可以启用重试来处理侦听器引发异常的情况。默认情况下，RejectAndDontRequeueRecoverer，但您可以定义MessageRecoverer你自己的。当重试次数用尽时，消息将被拒绝，并被丢弃或路由到死信交换（如果代理配置为这样做）。默认情况下，重试处于禁用状态。您还可以自定义RetryTemplate通过声明RabbitRetryTemplateCustomizer豆。spring-doc.cadn.net.cn

默认情况下，如果禁用重试并且侦听器引发异常，则会无限期地重试投放。您可以通过两种方式修改此行为：将defaultRequeueRejectedproperty 设置为false，以便尝试零重新投递，或者抛出AmqpRejectAndDontRequeueException来表示消息应该被拒绝。后者是启用重试并达到最大投放尝试次数时使用的机制。