写给急性子的人的快速入门

简介

这是让你快速上手 Spring AMQP 的五分钟教程。

先决条件：安装并运行 RabbitMQ broker (https://rabbitmq.cn/download.html)。然后获取 spring-rabbit JAR 及其所有依赖项 - 最简单的方法是在你的构建工具中声明依赖。例如，对于 Maven，你可以这样做

<dependency>
  <groupId>org.springframework.amqp</groupId>
  <artifactId>spring-rabbit</artifactId>
  <version>3.2.5</version>
</dependency>

对于 Gradle，你可以这样做

compile 'org.springframework.amqp:spring-rabbit:3.2.5'

兼容性

最低 Spring Framework 版本依赖是 6.1.0。

最低 amqp-client Java 客户端库版本是 5.18.0。

用于 stream 队列的最低 stream-client Java 客户端库版本是 0.12.0。

非常、非常快速

本节提供最快速的入门。

首先，添加以下 import 语句以使本节后面的示例生效

import org.springframework.amqp.core.AmqpAdmin;
import org.springframework.amqp.core.AmqpTemplate;
import org.springframework.amqp.core.Queue;
import org.springframework.amqp.rabbit.connection.CachingConnectionFactory;
import org.springframework.amqp.rabbit.connection.ConnectionFactory;
import org.springframework.amqp.rabbit.core.RabbitAdmin;
import org.springframework.amqp.rabbit.core.RabbitTemplate;

以下示例使用纯粹的命令式 Java 发送和接收消息

ConnectionFactory connectionFactory = new CachingConnectionFactory();
AmqpAdmin admin = new RabbitAdmin(connectionFactory);
admin.declareQueue(new Queue("myqueue"));
AmqpTemplate template = new RabbitTemplate(connectionFactory);
template.convertAndSend("myqueue", "foo");
String foo = (String) template.receiveAndConvert("myqueue");

请注意，原生 Java Rabbit 客户端中也有一个 ConnectionFactory。我们在前面的代码中使用了 Spring 的抽象。它会缓存通道（以及可选的连接）以供重用。我们依赖于 broker 中的默认交换器（因为发送时没有指定交换器），以及所有队列按其名称绑定到默认交换器的默认行为（因此，在发送时可以使用队列名称作为路由键）。这些行为在 AMQP 规范中定义。

使用 XML 配置

以下示例与前一个示例相同，但将资源配置外部化到 XML 中

ApplicationContext context =
    new GenericXmlApplicationContext("classpath:/rabbit-context.xml");
AmqpTemplate template = context.getBean(AmqpTemplate.class);
template.convertAndSend("myqueue", "foo");
String foo = (String) template.receiveAndConvert("myqueue");

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:rabbit="http://www.springframework.org/schema/rabbit"
       xsi:schemaLocation="http://www.springframework.org/schema/rabbit
           https://www.springframework.org/schema/rabbit/spring-rabbit.xsd
           http://www.springframework.org/schema/beans
           https://www.springframework.org/schema/beans/spring-beans.xsd">

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

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

    <rabbit:admin connection-factory="connectionFactory"/>

    <rabbit:queue name="myqueue"/>

</beans>

默认情况下，<rabbit:admin/> 声明会自动查找类型为 Queue、Exchange 和 Binding 的 bean，并代表用户向 broker 声明它们。因此，在简单的 Java 驱动程序中，你无需显式使用该 bean。XML schema 中有很多选项可以配置组件的属性。你可以使用 XML 编辑器的自动完成功能来探索它们并查看其文档。

使用 Java 配置

以下示例重复了前一个示例，但将外部配置定义在 Java 中

ApplicationContext context =
    new AnnotationConfigApplicationContext(RabbitConfiguration.class);
AmqpTemplate template = context.getBean(AmqpTemplate.class);
template.convertAndSend("myqueue", "foo");
String foo = (String) template.receiveAndConvert("myqueue");

........

@Configuration
public class RabbitConfiguration {

    @Bean
    public CachingConnectionFactory connectionFactory() {
        return new CachingConnectionFactory("localhost");
    }

    @Bean
    public RabbitAdmin amqpAdmin() {
        return new RabbitAdmin(connectionFactory());
    }

    @Bean
    public RabbitTemplate rabbitTemplate() {
        return new RabbitTemplate(connectionFactory());
    }

    @Bean
    public Queue myQueue() {
       return new Queue("myqueue");
    }
}

结合 Spring Boot 自动配置和异步 POJO 监听器

Spring Boot 会自动配置基础设施 bean，如下例所示

@SpringBootApplication
public class Application {

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

    @Bean
    public ApplicationRunner runner(AmqpTemplate template) {
        return args -> template.convertAndSend("myqueue", "foo");
    }

    @Bean
    public Queue myQueue() {
        return new Queue("myqueue");
    }

    @RabbitListener(queues = "myqueue")
    public void listen(String in) {
        System.out.println(in);
    }

}