AMQP

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

RabbitMQ 支持

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

RabbitMQ 配置由中的外部配置属性控制。例如，您可以在：spring.rabbitmq.*application.propertiesspring-doc.cn

Propertiesspring-doc.cn
YAMLspring-doc.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"

或者，您可以使用以下属性配置相同的连接：addressesspring-doc.cn

Propertiesspring-doc.cn
YAMLspring-doc.cn

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

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

以这种方式指定地址时，将忽略 and 属性。如果地址使用该协议，则会自动启用 SSL 支持。hostportamqps

有关更多受支持的基于属性的配置选项，请参见 RabbitProperties。要配置 Spring AMQP 使用的 RabbitMQ ConnectionFactory 的较低级别详细信息，请定义ConnectionFactoryCustomizer Bean。spring-doc.cn

如果上下文中存在ConnectionNameStrategy bean，它将自动用于命名由自动配置的CachingConnectionFactory创建的连接。spring-doc.cn

要对RabbitTemplate进行应用程序范围的附加定制，请使用RabbitTemplateCustomizer Bean。spring-doc.cn

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

发送消息

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

Javaspring-doc.cn
Kotlinspring-doc.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可以以类似的方式注入。如果定义了MessageConverter bean，则它将自动与自动配置的AmqpTemplate相关联。

如有必要，任何定义为 Bean 的 Queue 都将自动用于在 RabbitMQ 实例上声明相应的队列。spring-doc.cn

要重试操作，你可以在 AmqpTemplate 上启用重试（例如，在代理连接丢失的情况下）：spring-doc.cn

Propertiesspring-doc.cn
YAMLspring-doc.cn

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

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

默认情况下，重试处于禁用状态。你还可以通过声明RabbitRetryTemplateCustomizer Bean 以编程方式自定义RetryTemplate。spring-doc.cn

如果你需要创建更多的RabbitTemplate实例，或者想要覆盖默认值， Spring Boot 提供了一个RabbitTemplateConfigurer bean，你可以使用它来初始化RabbitTemplate，其设置与自动配置使用的工厂相同。spring-doc.cn

向流发送消息

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

Propertiesspring-doc.cn
YAMLspring-doc.cn

spring.rabbitmq.stream.name=my-stream

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

如果定义了MessageConverter、StreamMessageConverter或ProducerCustomizer Bean，则它将自动与自动配置的RabbitStreamTemplate相关联。spring-doc.cn

如果你需要创建更多的RabbitStreamTemplate实例，或者想要覆盖默认值， Spring Boot 提供了一个RabbitStreamTemplateConfigurer bean，你可以使用它来初始化RabbitStreamTemplate，其设置与自动配置使用的工厂相同。spring-doc.cn

接收消息

当存在 Rabbit 基础结构时，任何 bean 都可以使用 @RabbitListener 进行注释以创建侦听器端点。如果未定义RabbitListenerContainerFactory，则会自动配置默认的SimpleRabbitListenerContainerFactory，并且你可以使用该属性切换到直接容器。如果定义了MessageConverter或MessageRecoverer bean，则它将自动与默认工厂相关联。spring.rabbitmq.listener.typespring-doc.cn

以下示例组件在队列上创建一个侦听器终端节点：someQueuespring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.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.cn

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

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

Javaspring-doc.cn
Kotlinspring-doc.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注释的方法中使用工厂，如下所示：spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.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。当重试次数用尽时，消息将被拒绝，并被丢弃或路由到死信交换（如果代理配置为这样做）。默认情况下，重试处于禁用状态。你还可以通过声明RabbitRetryTemplateCustomizer Bean 以编程方式自定义RetryTemplate。spring-doc.cn

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