寫給急性子的人的快速入門

簡介

這是讓你快速上手 Spring AMQP 的五分鐘教程。

先決條件：安裝並執行 RabbitMQ broker (https://www.rabbitmq.com/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);
    }

}