AMQP

高级消息队列协议 (AMQP) 是一种与平台无关的、用于面向消息的中间件的线级协议。Spring AMQP 项目将核心 Spring 概念应用于基于 AMQP 的消息传递解决方案的开发。Spring Boot 通过 RabbitMQ 提供了若干用于处理 AMQP 的便利功能，包括 `spring-boot-starter-amqp` 启动器。

RabbitMQ 支持

RabbitMQ 是一个基于 AMQP 协议的轻量级、可靠、可扩展和可移植的消息代理。Spring 使用 RabbitMQ 通过 AMQP 协议进行通信。

RabbitMQ 配置由spring.rabbitmq.*中的外部配置属性控制。例如，您可以在application.properties中声明以下部分

  • 属性

  • YAML

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属性配置相同的连接

  • 属性

  • YAML

spring.rabbitmq.addresses=amqp://admin:secret@localhost
spring:
  rabbitmq:
    addresses: "amqp://admin:secret@localhost"
以这种方式指定地址时，将忽略host和port属性。如果地址使用amqps协议，则会自动启用 SSL 支持。

有关支持的基于属性的配置选项的更多信息，请参阅RabbitProperties。要配置 Spring AMQP 使用的 RabbitMQ ConnectionFactory 的更低级细节，请定义一个ConnectionFactoryCustomizer bean。

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

要对RabbitTemplate进行应用程序范围的增量自定义，请使用RabbitTemplateCustomizer bean。

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

发送消息

Spring 的AmqpTemplate和AmqpAdmin是自动配置的，您可以将它们直接自动装配到您自己的 bean 中，如下例所示

  • Java

  • Kotlin

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 的org.springframework.amqp.core.Queue都会自动用于在 RabbitMQ 实例上声明相应的队列。

要重试操作，您可以在AmqpTemplate上启用重试（例如，在代理连接丢失的情况下）

  • 属性

  • YAML

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。

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

发送消息到流

要将消息发送到特定流，请指定流的名称，如下例所示

  • 属性

  • YAML

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

如果定义了MessageConverter、StreamMessageConverter或ProducerCustomizer bean，则会将其自动关联到自动配置的RabbitStreamTemplate。

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

接收消息

当 Rabbit 基础设施存在时，任何 bean 都可以使用@RabbitListener进行注释以创建侦听器端点。如果未定义RabbitListenerContainerFactory，则会自动配置一个默认的SimpleRabbitListenerContainerFactory，您可以使用spring.rabbitmq.listener.type属性切换到直接容器。如果定义了MessageConverter或MessageRecoverer bean，则会将其自动关联到默认工厂。

以下示例组件在someQueue队列上创建了一个侦听器端点

  • Java

  • Kotlin

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，其设置与自动配置使用的工厂相同。

您选择哪种容器类型都没有关系。这两个 bean 由自动配置公开。

例如，以下配置类公开了另一个使用特定MessageConverter的工厂

  • Java

  • Kotlin

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注释的方法中使用该工厂，如下所示

  • Java

  • Kotlin

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。

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