AmqpTemplate

与 Spring Framework 及相关项目提供的许多其他高级抽象一样，Spring AMQP 提供了一个在其中扮演核心角色的“template”。定义主要操作的接口称为 AmqpTemplate。这些操作涵盖了发送和接收消息的通用行为。换句话说，它们并非任何实现所独有——因此名称中带有“AMQP”。另一方面，该接口的实现与 AMQP 协议的实现相关联。与作为接口级 API 的 JMS 不同，AMQP 是一种线级协议。该协议的实现提供了自己的客户端库，因此模板接口的每个实现都依赖于特定的客户端库。目前，只有一个实现：RabbitTemplate。在接下来的示例中，我们经常使用 AmqpTemplate。然而，当您查看配置示例或任何实例化模板或调用 setter 的代码片段时，您可以看到实现类型（例如 RabbitTemplate）。如前所述，AmqpTemplate 接口定义了发送和接收消息的所有基本操作。我们将在 发送消息 和 接收消息 中分别探讨消息的发送和接收。另请参阅 异步 Rabbit 模板。

添加重试功能

从 1.3 版本开始，您现在可以将 RabbitTemplate 配置为使用 RetryTemplate 来帮助处理代理连接问题。有关完整信息，请参阅 spring-retry 项目。以下只是一个示例，它使用指数退避策略和默认的 SimpleRetryPolicy，该策略在将异常抛给调用者之前尝试三次。

以下示例使用 XML 命名空间：

<rabbit:template id="template" connection-factory="connectionFactory" retry-template="retryTemplate"/>

<bean id="retryTemplate" class="org.springframework.retry.support.RetryTemplate">
    <property name="backOffPolicy">
        <bean class="org.springframework.retry.backoff.ExponentialBackOffPolicy">
            <property name="initialInterval" value="500" />
            <property name="multiplier" value="10.0" />
            <property name="maxInterval" value="10000" />
        </bean>
    </property>
</bean>

以下示例在 Java 中使用 @Configuration 注解：

@Bean
public RabbitTemplate rabbitTemplate() {
    RabbitTemplate template = new RabbitTemplate(connectionFactory());
    RetryTemplate retryTemplate = new RetryTemplate();
    ExponentialBackOffPolicy backOffPolicy = new ExponentialBackOffPolicy();
    backOffPolicy.setInitialInterval(500);
    backOffPolicy.setMultiplier(10.0);
    backOffPolicy.setMaxInterval(10000);
    retryTemplate.setBackOffPolicy(backOffPolicy);
    template.setRetryTemplate(retryTemplate);
    return template;
}

从 1.4 版本开始，除了 retryTemplate 属性之外，RabbitTemplate 还支持 recoveryCallback 选项。它用作 RetryTemplate.execute(RetryCallback<T, E> retryCallback, RecoveryCallback<T> recoveryCallback) 的第二个参数。

RecoveryCallback 有些限制，因为重试上下文只包含 lastThrowable 字段。对于更复杂的用例，您应该使用外部 RetryTemplate，以便通过上下文的属性将额外信息传递给 RecoveryCallback。以下示例展示了如何实现：

 
retryTemplate.execute(
    new RetryCallback<Object, Exception>() {

        @Override
        public Object doWithRetry(RetryContext context) throws Exception {
            context.setAttribute("message", message);
            return rabbitTemplate.convertAndSend(exchange, routingKey, message);
        }

    }, new RecoveryCallback<Object>() {

        @Override
        public Object recover(RetryContext context) throws Exception {
            Object message = context.getAttribute("message");
            Throwable t = context.getLastThrowable();
            // Do something with message
            return null;
        }
    });
}

在这种情况下，您将*不会*将 RetryTemplate 注入到 RabbitTemplate 中。

发布是异步的 — 如何检测成功和失败

发布消息是一种异步机制，默认情况下，无法路由的消息会被 RabbitMQ 丢弃。对于成功发布，您可以收到异步确认，如 关联发布者确认和返回 中所述。考虑两种失败情况：

  • 发布到交换机，但没有匹配的目标队列。

  • 发布到不存在的交换机。

第一种情况由发布者返回覆盖，如 关联发布者确认和返回 中所述。

对于第二种情况，消息被丢弃，并且不生成返回。底层通道会因异常而关闭。默认情况下，此异常会被记录，但您可以向 CachingConnectionFactory 注册 ChannelListener 以获取此类事件的通知。以下示例展示了如何添加 ConnectionListener：

this.connectionFactory.addConnectionListener(new ConnectionListener() {

    @Override
    public void onCreate(Connection connection) {
    }

    @Override
    public void onShutDown(ShutdownSignalException signal) {
        ...
    }

});

您可以检查信号的 reason 属性以确定发生的问题。

要检测发送线程上的异常，您可以在 RabbitTemplate 上 setChannelTransacted(true)，并且在 txCommit() 上检测到异常。然而，事务会显著降低性能，因此在仅为此用例启用事务之前请仔细考虑。

关联发布者确认和返回

AmqpTemplate 的 RabbitTemplate 实现支持发布者确认和返回。

对于返回的消息，模板的 mandatory 属性必须设置为 true，或者对于特定消息，mandatory-expression 必须评估为 true。此功能需要 CachingConnectionFactory 的 publisherReturns 属性设置为 true（参见 发布者确认和返回）。返回消息通过客户端调用 setReturnsCallback(ReturnsCallback callback) 注册 RabbitTemplate.ReturnsCallback 来发送。回调必须实现以下方法：

void returnedMessage(ReturnedMessage returned);

ReturnedMessage 具有以下属性：

  • message - 返回的消息本身

  • replyCode - 指示返回原因的代码

  • replyText - 返回的文本原因 - 例如 NO_ROUTE

  • exchange - 消息发送到的交换机

  • routingKey - 使用的路由键

每个 RabbitTemplate 只支持一个 ReturnsCallback。另请参阅 回复超时。

对于发布者确认（也称为发布者确认），模板需要 CachingConnectionFactory 的 publisherConfirm 属性设置为 ConfirmType.CORRELATED。确认通过客户端调用 setConfirmCallback(ConfirmCallback callback) 注册 RabbitTemplate.ConfirmCallback 来发送。回调必须实现此方法：

void confirm(CorrelationData correlationData, boolean ack, String cause);

CorrelationData 是客户端在发送原始消息时提供的对象。ack 为 true 表示 ack，为 false 表示 nack。对于 nack 实例，如果生成 nack 时可用，则 cause 可能包含 nack 的原因。一个示例是向不存在的交换机发送消息。在这种情况下，代理会关闭通道。关闭的原因包含在 cause 中。cause 是在 1.4 版本中添加的。

RabbitTemplate 只支持一个 ConfirmCallback。

当 rabbit 模板发送操作完成时，通道被关闭。当连接工厂缓存已满时（当缓存中有空间时，通道不会物理关闭，并且返回和确认正常进行），这排除了接收确认或返回。当缓存已满时，框架会将关闭延迟最多五秒，以便为接收确认和返回留出时间。当使用确认时，通道在收到最后一个确认时关闭。当只使用返回时，通道会保持打开五秒钟。我们通常建议将连接工厂的 channelCacheSize 设置为足够大的值，以便发布消息的通道返回到缓存而不是关闭。您可以使用 RabbitMQ 管理插件监控通道使用情况。如果您看到通道快速打开和关闭，您应该考虑增加缓存大小以减少服务器上的开销。

在 2.1 版本之前，启用发布者确认的通道在收到确认之前返回到缓存。其他一些进程可能会检查出通道并执行一些操作，导致通道关闭——例如向不存在的交换机发布消息。这可能导致确认丢失。2.1 及更高版本不再在确认未决时将通道返回到缓存。RabbitTemplate 在每次操作后对通道执行逻辑 close()。通常，这意味着通道上一次只有一个确认未决。

从 2.2 版本开始，回调在连接工厂的 executor 线程之一上调用。这是为了避免如果您在回调中执行 Rabbit 操作时可能发生的死锁。在以前的版本中，回调直接在 amqp-client 连接 I/O 线程上调用；如果您执行某些 RPC 操作（例如打开新通道），这会导致死锁，因为 I/O 线程阻塞等待结果，但结果需要由 I/O 线程本身处理。在这些版本中，有必要将工作（例如发送消息）传递给回调中的另一个线程。现在框架将回调调用传递给执行器，因此不再需要这样做。

只要返回回调在 60 秒或更短时间内执行，则仍然保证在确认之前收到返回消息。确认计划在返回回调退出后或 60 秒后（以先到者为准）传递。

CorrelationData 对象有一个 CompletableFuture，您可以使用它来获取结果，而不是在模板上使用 ConfirmCallback。以下示例展示了如何配置 CorrelationData 实例：

CorrelationData cd1 = new CorrelationData();
this.templateWithConfirmsEnabled.convertAndSend("exchange", queue.getName(), "foo", cd1);
assertTrue(cd1.getFuture().get(10, TimeUnit.SECONDS).isAck());
ReturnedMessage = cd1.getReturn();
...

由于它是一个 CompletableFuture<Confirm>，您可以 get() 结果准备就绪时，或使用 whenComplete() 进行异步回调。Confirm 对象是一个简单的 bean，具有 2 个属性：ack 和 reason（对于 nack 实例）。reason 不会为代理生成的 nack 实例填充。它会为框架生成的 nack 实例填充（例如，在未决 ack 实例时关闭连接）。

此外，当确认和返回都启用时，如果消息无法路由到任何队列，则 CorrelationData 的 return 属性会填充返回的消息。保证在 ack 设置之前设置返回消息属性。CorrelationData.getReturn() 返回一个 ReturnMessage，其属性包括：

  • message（返回的消息）

  • replyCode

  • replyText

  • exchange

  • routingKey

另请参阅 作用域操作，了解等待发布者确认的更简单机制。

作用域操作

通常，当使用模板时，会从缓存中取出（或创建）一个 Channel，用于操作，然后返回到缓存以供重用。在多线程环境中，无法保证下一次操作使用相同的通道。然而，有时您可能希望对通道的使用有更多控制，并确保许多操作都在同一通道上执行。

从 2.0 版本开始，提供了一个名为 invoke 的新方法，带有 OperationsCallback。在回调范围内以及在提供的 RabbitOperations 参数上执行的任何操作都使用相同的专用 Channel，该通道将在结束时关闭（不返回到缓存）。如果通道是 PublisherCallbackChannel，则在收到所有确认后（参见 关联发布者确认和返回）将其返回到缓存。

@FunctionalInterface
public interface OperationsCallback<T> {

    T doInRabbit(RabbitOperations operations);

}

您可能需要此功能的一个示例是，如果您希望在底层 Channel 上使用 waitForConfirms() 方法。此方法以前未由 Spring API 公开，因为如前所述，通道通常是缓存和共享的。RabbitTemplate 现在提供 waitForConfirms(long timeout) 和 waitForConfirmsOrDie(long timeout)，它们委托给 OperationsCallback 范围内使用的专用通道。出于显而易见的原因，这些方法不能在该范围之外使用。

请注意，提供了一个更高级别的抽象，允许您将确认与请求关联起来（参见 关联发布者确认和返回）。如果您只想等待代理确认交付，您可以使用以下示例中显示的技术：

Collection<?> messages = getMessagesToSend();
Boolean result = this.template.invoke(t -> {
    messages.forEach(m -> t.convertAndSend(ROUTE, m));
    t.waitForConfirmsOrDie(10_000);
    return true;
});

如果您希望 RabbitAdmin 操作在 OperationsCallback 范围内在同一通道上调用，则 admin 必须已使用用于 invoke 操作的同一 RabbitTemplate 构建。

如果模板操作已在现有事务范围内执行，则上述讨论无关紧要——例如，当在事务监听器容器线程上运行并对事务模板执行操作时。在这种情况下，操作在该通道上执行，并在线程返回到容器时提交。在这种情况下，不需要使用 invoke。

以这种方式使用确认时，为将确认与请求关联而设置的大部分基础设施并不是真正需要的（除非也启用了返回）。从 2.2 版本开始，连接工厂支持一个名为 publisherConfirmType 的新属性。当此属性设置为 ConfirmType.SIMPLE 时，可以避免基础设施，并且确认处理可以更高效。

此外，RabbitTemplate 在发送消息的 MessageProperties 中设置 publisherSequenceNumber 属性。如果您希望检查（或记录或以其他方式使用）特定的确认，您可以使用重载的 invoke 方法，如下例所示：

public <T> T invoke(OperationsCallback<T> action, com.rabbitmq.client.ConfirmCallback acks,
        com.rabbitmq.client.ConfirmCallback nacks);

这些 ConfirmCallback 对象（用于 ack 和 nack 实例）是 Rabbit 客户端回调，而不是模板回调。

以下示例记录 ack 和 nack 实例：

Collection<?> messages = getMessagesToSend();
Boolean result = this.template.invoke(t -> {
    messages.forEach(m -> t.convertAndSend(ROUTE, m));
    t.waitForConfirmsOrDie(10_000);
    return true;
}, (tag, multiple) -> {
        log.info("Ack: " + tag + ":" + multiple);
}, (tag, multiple) -> {
        log.info("Nack: " + tag + ":" + multiple);
}));

作用域操作绑定到线程。有关多线程环境中严格排序的讨论，请参见 多线程环境中的严格消息排序。

多线程环境中的严格消息排序

作用域操作 中的讨论仅适用于在同一线程上执行操作时。

考虑以下情况：

  • thread-1 向队列发送消息并将工作移交给 thread-2

  • thread-2 向同一队列发送消息

由于 RabbitMQ 的异步性质和缓存通道的使用；不确定是否会使用相同的通道，因此无法保证消息到达队列的顺序。（在大多数情况下，它们会按顺序到达，但乱序交付的概率不为零）。为了解决此用例，您可以使用大小为 1 的有界通道缓存（以及 channelCheckoutTimeout）来确保消息始终在同一通道上发布，并且将保证顺序。为此，如果您对连接工厂有其他用途，例如消费者，您应该使用专用的连接工厂用于模板，或者将模板配置为使用主连接工厂中嵌入的发布者连接工厂（参见 使用单独的连接）。

一个简单的 Spring Boot 应用程序最好地说明了这一点：

@SpringBootApplication
public class Application {

	private static final Logger log = LoggerFactory.getLogger(Application.class);

	public static void main(String[] args) {
		SpringApplication.run(Application.class, args);
	}

	@Bean
	TaskExecutor exec() {
		ThreadPoolTaskExecutor exec = new ThreadPoolTaskExecutor();
		exec.setCorePoolSize(10);
		return exec;
	}

	@Bean
	CachingConnectionFactory ccf() {
		CachingConnectionFactory ccf = new CachingConnectionFactory("localhost");
		CachingConnectionFactory publisherCF = (CachingConnectionFactory) ccf.getPublisherConnectionFactory();
		publisherCF.setChannelCacheSize(1);
		publisherCF.setChannelCheckoutTimeout(1000L);
		return ccf;
	}

	@RabbitListener(queues = "queue")
	void listen(String in) {
		log.info(in);
	}

	@Bean
	Queue queue() {
		return new Queue("queue");
	}


	@Bean
	public ApplicationRunner runner(Service service, TaskExecutor exec) {
		return args -> {
			exec.execute(() -> service.mainService("test"));
		};
	}

}

@Component
class Service {

	private static final Logger LOG = LoggerFactory.getLogger(Service.class);

	private final RabbitTemplate template;

	private final TaskExecutor exec;

	Service(RabbitTemplate template, TaskExecutor exec) {
		template.setUsePublisherConnection(true);
		this.template = template;
		this.exec = exec;
	}

	void mainService(String toSend) {
		LOG.info("Publishing from main service");
		this.template.convertAndSend("queue", toSend);
		this.exec.execute(() -> secondaryService(toSend.toUpperCase()));
	}

	void secondaryService(String toSend) {
		LOG.info("Publishing from secondary service");
		this.template.convertAndSend("queue", toSend);
	}

}

即使发布是在两个不同的线程上执行的，它们都将使用相同的通道，因为缓存被限制为单个通道。

从 2.3.7 版本开始，ThreadChannelConnectionFactory 支持使用 prepareContextSwitch 和 switchContext 方法将线程的通道传输到另一个线程。第一个方法返回一个上下文，该上下文传递给调用第二个方法的第二个线程。一个线程可以绑定一个非事务性通道或一个事务性通道（或两者兼有）；您不能单独传输它们，除非您使用两个连接工厂。示例如下：

@SpringBootApplication
public class Application {

	private static final Logger log = LoggerFactory.getLogger(Application.class);

	public static void main(String[] args) {
		SpringApplication.run(Application.class, args);
	}

	@Bean
	TaskExecutor exec() {
		ThreadPoolTaskExecutor exec = new ThreadPoolTaskExecutor();
		exec.setCorePoolSize(10);
		return exec;
	}

	@Bean
	ThreadChannelConnectionFactory tccf() {
		ConnectionFactory rabbitConnectionFactory = new ConnectionFactory();
		rabbitConnectionFactory.setHost("localhost");
		return new ThreadChannelConnectionFactory(rabbitConnectionFactory);
	}

	@RabbitListener(queues = "queue")
	void listen(String in) {
		log.info(in);
	}

	@Bean
	Queue queue() {
		return new Queue("queue");
	}


	@Bean
	public ApplicationRunner runner(Service service, TaskExecutor exec) {
		return args -> {
			exec.execute(() -> service.mainService("test"));
		};
	}

}

@Component
class Service {

	private static final Logger LOG = LoggerFactory.getLogger(Service.class);

	private final RabbitTemplate template;

	private final TaskExecutor exec;

	private final ThreadChannelConnectionFactory connFactory;

	Service(RabbitTemplate template, TaskExecutor exec,
			ThreadChannelConnectionFactory tccf) {

		this.template = template;
		this.exec = exec;
		this.connFactory = tccf;
	}

	void mainService(String toSend) {
		LOG.info("Publishing from main service");
		this.template.convertAndSend("queue", toSend);
		Object context = this.connFactory.prepareSwitchContext();
		this.exec.execute(() -> secondaryService(toSend.toUpperCase(), context));
	}

	void secondaryService(String toSend, Object threadContext) {
		LOG.info("Publishing from secondary service");
		this.connFactory.switchContext(threadContext);
		this.template.convertAndSend("queue", toSend);
		this.connFactory.closeThreadChannel();
	}

}

一旦调用了 prepareSwitchContext，如果当前线程执行任何其他操作，它们将在新通道上执行。不再需要时关闭线程绑定的通道非常重要。

消息集成

从 1.4 版本开始，RabbitMessagingTemplate（构建在 RabbitTemplate 之上）提供了与 Spring Framework 消息抽象的集成——即 org.springframework.messaging.Message。这允许您使用 spring-messaging Message<?> 抽象发送和接收消息。此抽象被其他 Spring 项目使用，例如 Spring Integration 和 Spring 的 STOMP 支持。涉及两个消息转换器：一个用于在 Spring 消息 Message<?> 和 Spring AMQP 的 Message 抽象之间进行转换，另一个用于在 Spring AMQP 的 Message 抽象和底层 RabbitMQ 客户端库所需的格式之间进行转换。默认情况下，消息有效负载由提供的 RabbitTemplate 实例的消息转换器转换。或者，您可以注入一个带有其他有效负载转换器的自定义 MessagingMessageConverter，如下例所示：

MessagingMessageConverter amqpMessageConverter = new MessagingMessageConverter();
amqpMessageConverter.setPayloadConverter(myPayloadConverter);
rabbitMessagingTemplate.setAmqpMessageConverter(amqpMessageConverter);

验证用户 ID

从 1.6 版本开始，模板现在支持 user-id-expression（使用 Java 配置时为 userIdExpression）。如果发送消息，则在评估此表达式后设置（如果尚未设置）用户 ID 属性。评估的根对象是要发送的消息。

以下示例展示了如何使用 user-id-expression 属性：

<rabbit:template ... user-id-expression="'guest'" />

<rabbit:template ... user-id-expression="@myConnectionFactory.username" />

第一个示例是文字表达式。第二个示例从应用程序上下文中的连接工厂 bean 获取 username 属性。

使用单独的连接

从 2.0.2 版本开始，您可以将 usePublisherConnection 属性设置为 true，以在可能的情况下使用与监听器容器使用的连接不同的连接。这是为了避免在生产者因任何原因被阻塞时消费者也被阻塞。连接工厂为此目的维护第二个内部连接工厂；默认情况下，它与主工厂类型相同，但如果您希望为发布使用不同的工厂类型，则可以明确设置。如果 rabbit 模板在监听器容器启动的事务中运行，则无论此设置如何，都使用容器的通道。

通常，您不应将 RabbitAdmin 与将此设置为 true 的模板一起使用。使用接受连接工厂的 RabbitAdmin 构造函数。如果您使用接受模板的其他构造函数，请确保模板的属性为 false。这是因为，通常，admin 用于为监听器容器声明队列。使用将属性设置为 true 的模板意味着排他队列（例如 AnonymousQueue）将在与监听器容器使用的连接不同的连接上声明。在这种情况下，容器无法使用这些队列。