此版本仍在开发中,目前尚不稳定。如需最新稳定版本,请使用 Spring AMQP 4.0.2spring-doc.cadn.net.cn

给急躁者的快速入门

介绍

这是快速入门 Spring AMQP 的五分钟指南。spring-doc.cadn.net.cn

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

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

对于 Gradle,您可以执行类似以下的操作:spring-doc.cadn.net.cn

implementation 'org.springframework.amqp:spring-rabbit:4.1.0-SNAPSHOT'

兼容性

Spring Framework 的最低版本依赖要求为 7.0.0。spring-doc.cadn.net.cn

最低 Java 客户端库版本为 amqp-client 5.28.0。spring-doc.cadn.net.cn

最低版本的 Java 客户端库(用于流队列)为 1.5.0。spring-doc.cadn.net.cn

非常、非常快速

本部分提供最快捷的入门介绍。spring-doc.cadn.net.cn

首先,添加以下 import 语句,以确保本节后续示例能够正常运行:spring-doc.cadn.net.cn

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 代码发送和接收消息:spring-doc.cadn.net.cn

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 客户端中也存在一个 ConnectionFactoryspring-doc.cadn.net.cn

spring-doc.cadn.net.cn

我们在前面的代码中使用了 Spring 抽象层。spring-doc.cadn.net.cn

它会缓存通道(并可选地缓存连接)以供重用。spring-doc.cadn.net.cn

我们依赖代理服务器中的默认交换机(由于发送时未指定交换机),以及所有队列默认通过其名称绑定到默认交换机的规则(因此,我们可以在发送时将队列名称用作路由键)。spring-doc.cadn.net.cn

这些行为由 AMQP 规范定义。spring-doc.cadn.net.cn

spring-doc.cadn.net.cn

使用 XML 配置

以下示例与前面的示例相同,但将资源配置外部化为 XML:spring-doc.cadn.net.cn

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/> 声明会自动查找类型为 QueueExchangeBinding 的 Bean,并代表用户向代理(broker)注册这些 Bean。因此,您无需在简单的 Java 驱动程序中显式使用该 Bean。在 XML 架构中,有多种选项可用于配置组件的属性。您可以利用 XML 编辑器的自动完成功能来探索这些选项,并查阅其相关文档。spring-doc.cadn.net.cn

使用 Java 配置

以下示例重复了前面示例中的相同示例,但外部配置是通过 Java 定义的:spring-doc.cadn.net.cn

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,如下例所示:spring-doc.cadn.net.cn

@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);
    }

}