启用 Listener 端点注解

要启用对 @RabbitListener 注解的支持，您可以在其中一个 @Configuration 类中添加 @EnableRabbit。以下示例演示了如何执行此操作。

@Configuration
@EnableRabbit
public class AppConfig {

    @Bean
    public SimpleRabbitListenerContainerFactory rabbitListenerContainerFactory() {
        SimpleRabbitListenerContainerFactory factory = new SimpleRabbitListenerContainerFactory();
        factory.setConnectionFactory(connectionFactory());
        factory.setConcurrentConsumers(3);
        factory.setMaxConcurrentConsumers(10);
        factory.setContainerCustomizer(container -> /* customize the container */);
        return factory;
    }
}

从 2.0 版本开始，还提供了 DirectMessageListenerContainerFactory。它创建 DirectMessageListenerContainer 实例。

有关帮助您在 SimpleRabbitListenerContainerFactory 和 DirectRabbitListenerContainerFactory 之间进行选择的相关信息，请参阅 选择容器。

从 2.2.2 版本开始，您可以提供 ContainerCustomizer 实现（如上所示）。这可用于在创建和配置容器后进一步配置容器；例如，您可以使用它来设置容器工厂未公开的属性。

2.4.8 版本提供了 CompositeContainerCustomizer，用于您希望应用多个自定义程序的情况。

默认情况下，基础结构查找名为 rabbitListenerContainerFactory 的 bean 作为用于创建消息监听器容器的工厂的来源。在这种情况下，并忽略 RabbitMQ 基础结构设置，可以使用核心轮询大小为三个线程和最大池大小为十个线程来调用 processOrder 方法。

您可以自定义每个注解要使用的监听器容器工厂，或者您可以通过实现 RabbitListenerConfigurer 接口来配置显式默认值。仅当至少注册了一个没有特定容器工厂的端点时，才需要默认值。有关完整详细信息和示例，请参阅 Javadoc。

容器工厂提供用于添加 MessagePostProcessor 实例的方法，这些实例在接收消息（在调用监听器之前）和发送回复之前应用。

有关回复的信息，请参阅 回复管理。

从 2.0.6 版本开始，您可以向监听器容器工厂添加 RetryTemplate 和 RecoveryCallback。它用于发送回复时。当重试次数用尽时，将调用 RecoveryCallback。您可以使用 SendRetryContextAccessor 从上下文中获取信息。以下示例演示了如何执行此操作。

factory.setRetryTemplate(retryTemplate);
factory.setReplyRecoveryCallback(ctx -> {
    Message failed = SendRetryContextAccessor.getMessage(ctx);
    Address replyTo = SendRetryContextAccessor.getAddress(ctx);
    Throwable t = ctx.getLastThrowable();
    ...
    return null;
});

如果您更喜欢 XML 配置，则可以使用 <rabbit:annotation-driven> 元素。将检测任何使用 @RabbitListener 注解的 bean。

对于 SimpleRabbitListenerContainer 实例，您可以使用类似于以下内容的 XML

<rabbit:annotation-driven/>

<bean id="rabbitListenerContainerFactory"
      class="org.springframework.amqp.rabbit.config.SimpleRabbitListenerContainerFactory">
    <property name="connectionFactory" ref="connectionFactory"/>
    <property name="concurrentConsumers" value="3"/>
    <property name="maxConcurrentConsumers" value="10"/>
</bean>

对于 DirectMessageListenerContainer 实例，您可以使用类似于以下内容的 XML

<rabbit:annotation-driven/>

<bean id="rabbitListenerContainerFactory"
      class="org.springframework.amqp.rabbit.config.DirectRabbitListenerContainerFactory">
    <property name="connectionFactory" ref="connectionFactory"/>
    <property name="consumersPerQueue" value="3"/>
</bean>

从 2.0 版本开始，@RabbitListener 注解具有 concurrency 属性。它支持 SpEL 表达式 (#{…​}) 和属性占位符 (${…​})。其含义和允许的值取决于容器类型，如下所示

  • 对于 DirectMessageListenerContainer，该值必须是单个整数值，它设置容器上的 consumersPerQueue 属性。

  • 对于 SimpleRabbitListenerContainer，该值可以是单个整数值，它设置容器上的 concurrentConsumers 属性，或者可以具有 m-n 形式，其中 m 是 concurrentConsumers 属性，n 是 maxConcurrentConsumers 属性。

在这两种情况下，此设置都会覆盖工厂上的设置。以前，如果您有需要不同并发的监听器，则必须定义不同的容器工厂。

该注解还允许通过 autoStartup 和 executor（从 2.2 开始）注解属性覆盖工厂的 autoStartup 和 taskExecutor 属性。为每个监听器使用不同的执行器可能有助于在日志和线程转储中识别与每个监听器关联的线程。

2.2 版本还添加了 ackMode 属性，它允许您覆盖容器工厂的 acknowledgeMode 属性。

@RabbitListener(id = "manual.acks.1", queues = "manual.acks.1", ackMode = "MANUAL")
public void manual1(String in, Channel channel,
    @Header(AmqpHeaders.DELIVERY_TAG) long tag) throws IOException {

    ...
    channel.basicAck(tag, false);
}