基于注解的监听器端点

异步接收消息最简单的方法是使用基于注解的监听器端点基础设施。简而言之，它允许您将托管 Bean 的方法公开为 Rabbit 监听器端点。以下示例演示了如何使用 @RabbitListener 注解

@Component
public class MyService {

    @RabbitListener(queues = "myQueue")
    public void processOrder(String data) {
        ...
    }

}

上述示例的思想是，每当在名为 myQueue 的队列上可用消息时，processOrder 方法就会相应地被调用（在本例中，使用消息的有效负载）。

基于注解的端点基础设施在幕后为每个带注解的方法创建一个消息监听器容器，方法是使用 RabbitListenerContainerFactory。

在前面的示例中，myQueue 必须已经存在并绑定到某个交换机。只要应用程序上下文中存在 RabbitAdmin，就可以自动声明并绑定队列。

可以为注解属性（queues 等）指定属性占位符（${some.property}）或 SpEL 表达式（#{someExpression}）。有关可能使用 SpEL 而不是属性占位符的原因的示例，请参阅监听多个队列。以下列表显示了声明 Rabbit 监听器的三个示例

@Component
public class MyService {

  @RabbitListener(bindings = @QueueBinding(
        value = @Queue(value = "myQueue", durable = "true"),
        exchange = @Exchange(value = "auto.exch", ignoreDeclarationExceptions = "true"),
        key = "orderRoutingKey")
  )
  public void processOrder(Order order) {
    ...
  }

  @RabbitListener(bindings = @QueueBinding(
        value = @Queue,
        exchange = @Exchange(value = "auto.exch"),
        key = "invoiceRoutingKey")
  )
  public void processInvoice(Invoice invoice) {
    ...
  }

  @RabbitListener(queuesToDeclare = @Queue(name = "${my.queue}", durable = "true"))
  public String handleWithSimpleDeclare(String data) {
      ...
  }

}

在第一个示例中，如果需要，将自动声明队列 myQueue（持久）以及交换机，并使用路由键将其绑定到交换机。在第二个示例中，声明并绑定匿名（独占、自动删除）队列；框架使用 Base64UrlNamingStrategy 创建队列名称。您不能使用此技术声明代理命名队列；它们需要声明为 Bean 定义；请参阅容器和代理命名队列。可以提供多个 QueueBinding 条目，让监听器监听多个队列。在第三个示例中，如果需要，将声明从属性 my.queue 中检索名称的队列，并使用队列名称作为路由键将其默认绑定到默认交换机。

从 2.0 版本开始，@Exchange 注解支持任何交换机类型，包括自定义类型。有关更多信息，请参阅 AMQP 概念。

当您需要更高级的配置时，可以使用普通的 @Bean 定义。

请注意第一个示例中交换机上的 ignoreDeclarationExceptions。例如，这允许绑定到可能具有不同设置（例如 internal）的现有交换机。默认情况下，现有交换机的属性必须匹配。

从 2.0 版本开始，您现在可以将队列绑定到具有多个路由键的交换机，如下例所示

...
    key = { "red", "yellow" }
...

您还可以为 @QueueBinding 注解中的队列、交换机和绑定指定参数，如下例所示

@RabbitListener(bindings = @QueueBinding(
        value = @Queue(value = "auto.headers", autoDelete = "true",
                        arguments = @Argument(name = "x-message-ttl", value = "10000",
                                                type = "java.lang.Integer")),
        exchange = @Exchange(value = "auto.headers", type = ExchangeTypes.HEADERS, autoDelete = "true"),
        arguments = {
                @Argument(name = "x-match", value = "all"),
                @Argument(name = "thing1", value = "somevalue"),
                @Argument(name = "thing2")
        })
)
public String handleWithHeadersExchange(String foo) {
    ...
}

请注意，队列的 x-message-ttl 参数设置为 10 秒。由于参数类型不是 String，因此我们必须指定其类型——在本例中为 Integer。与所有此类声明一样，如果队列已存在，则参数必须与队列上的参数匹配。对于标头交换机，我们将绑定参数设置为匹配具有 thing1 标头设置为 somevalue 的消息，并且 thing2 标头必须存在且具有任何值。x-match 参数表示必须满足这两个条件。

参数名称、值和类型可以是属性占位符（${…}）或 SpEL 表达式（#{…}）。name 必须解析为 String。type 的表达式必须解析为 Class 或类的完全限定名称。value 必须解析为可以通过 DefaultConversionService 转换为该类型的内容（例如前面的示例中的 x-message-ttl）。

如果名称解析为 null 或空 String，则忽略该 @Argument。