快速入门指南

简介

这是一个五分钟的 Spring AMQP 快速入门指南。

前提条件：安装并运行 RabbitMQ 代理 (https://rabbitmq.cn/download.html)。然后获取 spring-rabbit JAR 及其所有依赖项 - 最简单的方法是在您的构建工具中声明一个依赖项。例如，对于 Maven，您可以执行类似以下操作

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

对于 Gradle，您可以执行类似以下操作

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

兼容性

最低 Spring Framework 版本依赖项为 6.1.0。

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

流队列的最低 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 抽象。它缓存通道（以及可选的连接）以供重用。我们依赖于代理中的默认交换机（因为发送中未指定任何交换机），以及所有队列通过其名称到默认交换机的默认绑定（因此，我们可以在发送中使用队列名称作为路由键）。这些行为在 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>

默认情况下，``声明会自动查找类型为`Queue`、`Exchange`和`Binding`的Bean，并代表用户将其声明到代理。因此，您无需在简单的 Java 驱动程序中显式使用该 Bean。XML 模式中有很多选项可以配置组件的属性。您可以使用 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);
    }

}