基于注解的监听器端点

使用带注释的监听器端点基础设施接收消息的最简单方法是异步的。简而言之,它允许您将托管 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必须解析为Stringtype的表达式必须解析为Class或类的完全限定名称。value必须解析为可以通过DefaultConversionService转换为该类型的内容(例如,前面的示例中的x-message-ttl)。

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