技術文章 » Spring Boot中使用RabbitMQ

Spring Boot中使用RabbitMQ

2020-08-08 08:42:55

很久沒有寫Spring Boot的內容了，正好最近在寫Spring Cloud Bus的內容，因爲內容會有一些相關性，所以先補一篇關於AMQP的整合。

Message Broker與AMQP簡介

Message Broker是一種訊息驗證、傳輸、路由的架構模式，其設計目標主要應用於下面 下麪這些場景：

  • 訊息路由到一個或多個目的地
  • 訊息轉化爲其他的表現方式
  • 執行訊息的聚集、訊息的分解，並將結果發送到他們的目的地，然後重新組合相應返回給訊息使用者
  • 呼叫Web服務來檢索數據
  • 響應事件或錯誤
  • 使用發佈-訂閱模式來提供內容或基於主題的訊息路由

AMQP是Advanced Message Queuing Protocol的簡稱，它是一個訊息導向中介軟體的開放式標準應用層協定。AMQP定義了這些特性：

  • 訊息方向
  • 訊息佇列
  • 訊息路由（包括：點到點和發佈-訂閱模式）
  • 可靠性
  • 安全性

RabbitMQ

本文要介紹的RabbitMQ就是以AMQP協定實現的一種中介軟體產品，它可以支援多種操作系統，多種程式語言，幾乎可以覆蓋所有主流的企業級技術平臺。

安裝

在RabbitMQ官網的下載頁面https://www.rabbitmq.com/download.html中，我們可以獲取到針對各種不同操作系統的安裝包和說明文件。這裏，我們將對幾個常用的平臺一一說明。

下面 下麪我們採用的Erlang和RabbitMQ Server版本說明：

  • Erlang/OTP 19.1
  • RabbitMQ Server 3.6.5

Windows安裝

  1. 安裝Erland，通過官方下載頁面http://www.erlang.org/downloads獲取exe安裝包，直接開啓並完成安裝。
  2. 安裝RabbitMQ，通過官方下載頁面https://www.rabbitmq.com/download.html獲取exe安裝包。
  3. 下載完成後，直接執行安裝程式。
  4. RabbitMQ Server安裝完成之後，會自動的註冊爲服務，並以預設設定啓動起來。

Mac OS X安裝

在Mac OS X中使用brew工具，可以很容易的安裝RabbitMQ的伺服器端，只需要按如下命令操作即可：

  1. brew更新到最新版本，執行：brew update
  2. 安裝Erlang，執行：brew install erlang
  3. 安裝RabbitMQ Server，執行：brew install rabbitmq

通過上面的命令，RabbitMQ Server的命令會被安裝到/usr/local/sbin，並不會自動加到使用者的環境變數中去，所以我們需要在.bash_profile或.profile檔案中增加下面 下麪內容：

PATH=$PATH:/usr/local/sbin

這樣，我們就可以通過rabbitmq-server命令來啓動RabbitMQ的伺服器端了。

Ubuntu安裝

在Ubuntu中，我們可以使用APT倉庫來進行安裝

  1. 安裝Erlang，執行：apt-get install erlang

  2. 執行下面 下麪的命令，新增APT倉庫到/etc/apt/sources.list.d

    echo 'deb http://www.rabbitmq.com/debian/ testing main' |
            sudo tee /etc/apt/sources.list.d/rabbitmq.list

  3. 更新APT倉庫的package list，執行sudo apt-get update命令

  4. 安裝Rabbit Server，執行sudo apt-get install rabbitmq-server命令

Rabbit管理

我們可以直接通過組態檔的存取進行管理，也可以通過Web的存取進行管理。下面 下麪我們將介紹如何通過Web進行管理。

  • 執行rabbitmq-plugins enable rabbitmq_management命令，開啓Web管理外掛，這樣我們就可以通過瀏覽器來進行管理了。
> rabbitmq-plugins enable rabbitmq_management
The following plugins have been enabled:
  mochiweb
  webmachine
  rabbitmq_web_dispatch
  amqp_client
  rabbitmq_management_agent
  rabbitmq_management

Applying plugin configuration to rabbit@PC-201602152056... started 6 plugins.
  • 開啓瀏覽器並存取：http://localhost:15672/，並使用預設使用者guest登錄，密碼也爲guest。我們可以看到如下圖的管理頁面：

從圖中，我們可以看到之前章節中提到的一些基本概念，比如：Connections、Channels、Exchanges、Queue等。第一次使用的讀者，可以都點開看看都有些什麼內容，熟悉一下RabbitMQ Server的伺服器端。

  • 點選Admin標籤，在這裏可以進行使用者的管理。

Spring Boot整合

下面 下麪，我們通過在Spring Boot應用中整合RabbitMQ，並實現一個簡單的發送、接收訊息的例子來對RabbitMQ有一個直觀的感受和理解。

在Spring Boot中整合RabbitMQ是一件非常容易的事，因爲之前我們已經介紹過Starter POMs，其中的AMQP模組就可以很好的支援RabbitMQ，下面 下麪我們就來詳細說說整合過程：

  • 新建一個Spring Boot工程，命名爲：「rabbitmq-hello」。
  • 在pom.xml中引入如下依賴內容，其中spring-boot-starter-amqp用於支援RabbitMQ。
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.3.7.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-amqp</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>
  • 在application.properties中設定關於RabbitMQ的連線和使用者資訊，使用者可以回到上面的安裝內容，在管理頁面中建立使用者。
spring.application.name=rabbitmq-hello

spring.rabbitmq.host=localhost
spring.rabbitmq.port=5672
spring.rabbitmq.username=spring
spring.rabbitmq.password=123456
  • 建立訊息生產者Sender。通過注入AmqpTemplate介面的範例來實現訊息的發送，AmqpTemplate介面定義了一套針對AMQP協定的基礎操作。在Spring Boot中會根據設定來注入其具體實現。在該生產者，我們會產生一個字串，併發送到名爲hello的佇列中。
@Component
public class Sender {

    @Autowired
    private AmqpTemplate rabbitTemplate;

    public void send() {
        String context = "hello " + new Date();
        System.out.println("Sender : " + context);
        this.rabbitTemplate.convertAndSend("hello", context);
    }

}
  • 建立訊息消費者Receiver。通過@RabbitListener註解定義該類對hello佇列的監聽，並用@RabbitHandler註解來指定對訊息的處理方法。所以，該消費者實現了對hello佇列的消費，消費操作爲輸出訊息的字串內容。
@Component
@RabbitListener(queues = "hello")
public class Receiver {

    @RabbitHandler
    public void process(String hello) {
        System.out.println("Receiver : " + hello);
    }

}
  • 建立RabbitMQ的設定類RabbitConfig，用來設定佇列、交換器、路由等高階資訊。這裏我們以入門爲主，先以最小化的設定來定義，以完成一個基本的生產和消費過程。
@Configuration
public class RabbitConfig {

    @Bean
    public Queue helloQueue() {
        return new Queue("hello");
    }

}
  • 建立應用主類：
@SpringBootApplication
public class HelloApplication {

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

}
  • 建立單元測試類，用來呼叫訊息生產：
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = HelloApplication.class)
public class HelloApplicationTests {

    @Autowired
    private Sender sender;

    @Test
    public void hello() throws Exception {
        sender.send();
    }

}

完成程式編寫之後，下面 下麪開始嘗試執行。首先確保RabbitMQ Server已經開始，然後進行下面 下麪的操作：

  • 啓動應用主類，從控制檯中，我們看到如下內容，程式建立了一個存取127.0.0.1:5672中springcloud的連線。
o.s.a.r.c.CachingConnectionFactory       : Created new connection: SimpleConnection@29836d32 [delegate=amqp://[email protected]:5672/]

同時，我們通過RabbitMQ的控制面板，可以看到Connection和Channels中包含當前連線的條目。

  • 執行單元測試類，我們可以看到控制檯中輸出下面 下麪的內容，訊息被髮送到了RabbitMQ Server的hello佇列中。
Sender : hello Sun Sep 25 11:06:11 CST 2016
  • 切換到應用主類的控制檯，我們可以看到類似如下輸出，消費者對hello佇列的監聽程式執行了，並輸出了接受到的訊息資訊。
Receiver : hello Sun Sep 25 11:06:11 CST 2016

通過上面的範例，我們在Spring Boot應用中引入spring-boot-starter-amqp模組，進行簡單設定就完成了對RabbitMQ的訊息生產和消費的開發內容。然而在實際應用中，我們還有很多內容沒有演示，這裏不做更多的講解，讀者可以自行查閱RabbitMQ的官方教學，有更全面的瞭解。

程式碼範例

本文的相關例子可以檢視下面 下麪倉庫中的chapter5-2-1目錄：

如果您覺得本文不錯，歡迎Star支援，您的關注是我堅持的動力！

money.jpg