![頭圖.png](https://ucc.alicdn.com/pic/developer-ecology/10ffe867cfa24fce98338fced30195e1.png)

作者 | 遼天
來源 | [阿里巴巴雲原生公眾號](https://mp.weixin.qq.com/s/MlAd_4ia6cGMRoFqZO93JQ)

**導讀**：本文將 rocktmq-spring-boot 的設計實現做一個簡單的介紹，讀者可以透過本文了解將 RocketMQ Client 端整合為 spring-boot-starter 框架的開發細節，然後透過一個簡單的示例來一步一步的講解如何使用這個 spring-boot-starter 工具包來配置，傳送和消費 RocketMQ 訊息。

在 Spring 生態中玩轉 RocketMQ 系列文章：

- [《如何在 Spring 生態中玩轉 RocketMQ？》](http://mp.weixin.qq.com/s?__biz=MzUzNzYxNjAzMg==&mid=2247502546&idx=1&sn=ed1bc0ef63fb3c6ef17e2db43b532671&chksm=fae6c11dcd91480b20cd87473aab17df87a39577cc001751e948ad061982256a85556bd8cecf&scene=21#wechat_redirect)
- [《羅美琪和春波特的故事...》](http://mp.weixin.qq.com/s?__biz=MzUzNzYxNjAzMg==&mid=2247504338&idx=1&sn=1953910b4ce73bc5de63ee469f825e29&chksm=fae6da1dcd91530b335e04d6ba263d054a440f861615d9435aa9332c327721d69d7c87e4687a&scene=21#wechat_redirect)
- [《RocketMQ-Spring 畢業兩週年，為什麼能成為 Spring 生態中最受歡迎的 messaging 實現？》](http://mp.weixin.qq.com/s?__biz=MzUzNzYxNjAzMg==&mid=2247500442&idx=1&sn=277a29dab2c75fc97e6726bf23355f71&chksm=fae6c955cd914043940059a0c7c700893cca4e56eed098e9cfb7e956bd8827856ee7a85c5427&scene=21#wechat_redirect)

本文配套可互動教程已登入阿里雲知行動手實驗室，PC 端登入[ start.aliyun.com]( start.aliyun.com) 在瀏覽器中立即體驗。

![1.png](https://ucc.alicdn.com/pic/developer-ecology/02f03e9f9c8d44a6a8938a49e7291028.png)

透過本文，您將瞭解到：

- Spring 的訊息框架介紹
- rocketmq-spring-boot 具體實現
- 使用示例

# 前言
上世紀 90 年代末，隨著 Java EE(Enterprise Edition) 的出現，特別是 Enterprise Java Beans 的使用需要複雜的描述符配置和死板複雜的程式碼實現，增加了廣大開發者的學習曲線和開發成本，由此基於簡單的 XML 配置和普通 Java 物件（Plain Old Java Objects）的 Spring 技術應運而生，依賴注入（Dependency Injection）, 控制反轉（Inversion of Control）和麵向切面程式設計（AOP）的技術更加敏捷地解決了傳統 Java 企業及版本的不足。

隨著 Spring 的持續演進，基於註解（Annotation）的配置逐漸取代了 XML 檔案配置，2014 年 4 月 1 日，Spring Boot 1.0.0 正式釋出，它基於“約定大於配置”（Convention over configuration）這一理念來快速地開發、測試、執行和部署 Spring 應用，並能透過簡單地與各種啟動器（如 spring-boot-web-starter）結合，讓應用直接以命令列的方式執行，不需再部署到獨立容器中。這種簡便直接快速構建和開發應用的過程，可以使用約定的配置並且簡化部署，受到越來越多的開發者的歡迎。

Apache RocketMQ 是業界知名的分散式訊息和流處理中介軟體，簡單地理解，它由 Broker 伺服器和客戶端兩部分組成：

其中客戶端一個是訊息釋出者客戶端（Producer），它負責向 Broker 伺服器傳送訊息；另外一個是訊息的消費者客戶端（Consumer），多個消費者可以組成一個消費組，來訂閱和拉取消費 Broker 伺服器上儲存的訊息。

為了利用 Spring Boot 的快速開發和讓使用者能夠更靈活地使用 RocketMQ 訊息客戶端，Apache RocketMQ 社群推出了 spring-boot-starter 實現。隨著分散式事務訊息功能在 RocketMQ 4.3.0 版本的釋出，近期升級了相關的 spring-boot 程式碼，透過註解方式支援分散式事務的回查和事務訊息的傳送。

本文將對當前的設計實現做一個簡單的介紹，讀者可以透過本文了解將 RocketMQ Client 端整合為 spring-boot-starter 框架的開發細節，然後透過一個簡單的示例來一步一步的講解如何使用這個 spring-boot-starter 工具包來配置，傳送和消費 RocketMQ 訊息。

# Spring 中的訊息框架
順便在這裡討論一下在 Spring 中關於訊息的兩個主要的框架，即 Spring Messaging 和 Spring Cloud Stream。它們都能夠與 Spring Boot 整合並提供了一些參考的實現。和所有的實現框架一樣，訊息框架的目的是實現輕量級的訊息驅動的微服務，可以有效地簡化開發人員對訊息中介軟體的使用複雜度，讓系統開發人員可以有更多的精力關注於核心業務邏輯的處理。

## 1. Spring Messaging
Spring Messaging 是 Spring Framework 4 中新增的模組，是 Spring 與訊息系統整合的一個擴充套件性的支援。它實現了從基於 JmsTemplate 的簡單的使用 JMS 介面到非同步接收訊息的一整套完整的基礎架構，Spring AMQP 提供了該協議所要求的類似的功能集。在與 Spring Boot 的整合後，它擁有了自動配置能力，能夠在測試和執行時與相應的訊息傳遞系統進行整合。

單純對於客戶端而言，Spring Messaging 提供了一套抽象的 API 或者說是約定的標準，對訊息傳送端和訊息接收端的模式進行規定，不同的訊息中介軟體提供商可以在這個模式下提供自己的 Spring 實現：在訊息傳送端需要實現的是一個 XXXTemplate 形式的 Java Bean，結合 Spring Boot 的自動化配置選項提供多個不同的傳送訊息方法；在訊息的消費端是一個 XXXMessageListener 介面（實現方式通常會使用一個註解來宣告一個訊息驅動的 POJO），提供回撥方法來監聽和消費訊息，這個介面同樣可以使用 Spring Boot 的自動化選項和一些定製化的屬性。

如果有興趣深入的瞭解 Spring Messaging 及針對不同的訊息產品的使用，推薦閱讀這個檔案。參考 Spring Messaging 的既有實現，RocketMQ 的 spring-boot-starter 中遵循了相關的設計模式並結合 RocketMQ 自身的功能特點提供了相應的 API（如順序、非同步和事務半訊息等)。

## 2. Spring Cloud Stream
Spring Cloud Stream 結合了 Spring Integration 的註解和功能，它的應用模型如下：

![2.jpeg](https://ucc.alicdn.com/pic/developer-ecology/47c11caab73f43efa0910cb92391b0a6.jpeg)
該圖片引自 spring cloud stream

Spring Cloud Stream 框架中提供一個獨立的應用核心，它透過輸入（@Input）和輸出（@Output）通道與外部世界進行通訊，訊息源端（Source）透過輸入通道傳送訊息，消費目標端（Sink）透過監聽輸出通道來獲取消費的訊息。這些通道透過專用的 Binder 實現與外部代理連線。開發人員的程式碼只需要針對應用核心提供的固定的介面和註解方式進行程式設計，而不需要關心執行時具體的 Binder 繫結的訊息中介軟體。在執行時，Spring Cloud Stream 能夠自動探測並使用在 classpath 下找到的Binder。

這樣開發人員可以輕鬆地在相同的程式碼中使用不同型別的中介軟體：僅僅需要在構建時包含進不同的 Binder。在更加複雜的使用場景中，也可以在應用中打包多個 Binder 並讓它自己選擇 Binder，甚至在執行時為不同的通道使用不同的 Binder。

Binder 抽象使得 Spring Cloud Stream 應用可以靈活的連線到中介軟體，加之 Spring Cloud Stream 使用利用了 Spring Boot 的靈活配置配置能力，這樣的配置可以透過外部配置的屬性和 Spring Boot 支援的任何形式來提供（包括應用啟動引數、環境變數和 application.yml 或者 application.properties 檔案），部署人員可以在執行時動態選擇通道連線 destination（例如，Kafka 的 topic 或者 RabbitMQ 的 exchange）。

Binder SPI 的方式來讓訊息中介軟體產品使用可擴充套件的 API 來編寫相應的 Binder，並整合到 Spring Cloud Steam 環境，目前 RocketMQ 還沒有提供相關的 Binder，我們計劃在下一步將完善這一功能，也希望社群裡有這方面經驗的同學積極嘗試，貢獻 PR 或建議。

# spring-boot-starter的實現
在開始的時候我們已經知道，spring boot starter 構造的啟動器對於使用者是非常方便的，使用者只要在 pom.xml引入starter 的依賴定義，相應的編譯，執行和部署功能就全部自動引入。因此常用的開源元件都會為 Spring 的使用者提供一個 spring-boot-starter 封裝給開發者，讓開發者非常方便整合和使用，這裡我們詳細的介紹一下 RocketMQ（客戶端）的 starter 實現過程。

## 1. spring-boot-starter 的實現步驟
對於一個 spring-boot-starter 實現需要包含如下幾個部分：

### **1）在 pom.xml 的定義**

- 定義最終要生成的 starter 元件資訊

```
<groupid>org.apache.rocketmq</groupid>
<artifactid>spring-boot-starter-rocketmq</artifactid>
<version>1.0.0-SNAPSHOT</version>
```

- 定義依賴包

它分為兩個部分：Spring 自身的依賴包和 RocketMQ 的依賴包。

![3.png](https://ucc.alicdn.com/pic/developer-ecology/ac2a4ff1cd39438191cb6171242c3844.png)

### **2）配置檔案類**
定義應用屬性配置檔案類 RocketMQProperties，這個 Bean 定義一組預設的屬性值。使用者在使用最終的 starter 時，可以根據這個類定義的屬性來修改取值，當然不是直接修改這個類的配置，而是 spring-boot 應用中對應的配置檔案：src/main/resources/application.properties。

### **3）定義自動載入類**
定義 src/resources/META-INF/spring.factories 檔案中的自動載入類， 其目的是讓 spring boot 更具文中中所指定的自動化配置類來自動初始化相關的 Bean、Component 或 Service，它的內容如下：

```
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.apache.rocketmq.spring.starter.RocketMQAutoConfiguration
```

在 RocketMQAutoConfiguration 類的具體實現中，定義開放給使用者直接使用的 Bean 物件包括：

- RocketMQProperties 載入應用屬性配置檔案的處理類；
- RocketMQTemplate 傳送端使用者傳送訊息的傳送模板類；
- ListenerContainerConfiguration 容器 Bean 負責發現和註冊消費端消費實現介面類，這個類要求：由 @RocketMQMessageListener 註解標註；實現 RocketMQListener 泛化介面。

### **4）最後具體地進行 RpcketMQ 相關的封裝**
在傳送端（producer）和消費端（consumer）客戶端分別進行封裝，在當前的實現版本提供了對 Spring Messaging 介面的相容方式。

## 2. 訊息傳送端實現
### **1）普通傳送端**
傳送端的程式碼封裝在 RocketMQTemplate POJO 中，下圖是傳送端的相關程式碼的呼叫關係圖：

![4.png](https://ucc.alicdn.com/pic/developer-ecology/5f259e61c1f64eb090ec1edc461679c2.png)

為了與 Spring Messaging 的傳送模板相容，在 RocketMQTemplate 整合了 AbstractMessageSendingTemplate 抽象類，來支援相關的訊息轉換和傳送方法，這些方法最終會代理給 doSend() 方法、doSend() 以及 RocoketMQ 所特有的一些方法如非同步，單向和順序等方法直接新增到 RoketMQTempalte 中，這些方法直接代理呼叫到 RocketMQ 的 Producer API 來進行訊息的傳送。

### **2）事務訊息傳送端**
對於事務訊息的處理，在訊息傳送端進行了部分的擴充套件，參考上面的呼叫關係類圖。

RocketMQTemplate 里加入了一個傳送事務訊息的方法 sendMessageInTransaction()，並且最終這個方法會代理到 RocketMQ 的 TransactionProducer 進行呼叫，在這個 Producer 上會註冊其關聯的 TransactionListener 實現類，以便在傳送訊息後能夠對 TransactionListener 裡的方法實現進行呼叫。

## 3. 訊息消費端實現
![5.png](https://ucc.alicdn.com/pic/developer-ecology/09cc6004971b47e5858111375e52db26.png)

在消費端 Spring-Boot 應用啟動後，會掃描所有包含 @RocketMQMessageListener 註解的類（這些類需要整合 RocketMQListener 介面，並實現 onMessage()方法），這個 Listener 會一對一的被放置到。

DefaultRocketMQListenerContainer 容器物件中，容器物件會根據消費的方式（併發或順序），將 RocketMQListener 封裝到具體的 RocketMQ 內部的併發或者順序介面實現。在容器中建立 RocketMQ Consumer 物件，啟動並監聽定製的 Topic 訊息，如果有消費訊息，則回撥到 Listener 的 onMessage() 方法。

# 使用示例
上面的一章介紹了 RocketMQ 在 spring-boot-starter 方式的實現，這裡透過一個最簡單的訊息傳送和消費的例子來介紹如何使這個 rocketmq-spring-boot-starter。

## 1. RocketMQ 服務端的準備
### **1）啟動 NameServer 和 Broker**
要驗證 RocketMQ 的 Spring-Boot 客戶端，首先要確保 RocketMQ 服務正確的下載並啟動。可以參考 RocketMQ 主站的快速開始來進行操作。確保啟動 NameServer 和 Broker 已經正確啟動。

### **2）建立例項中所需要的 Topics**
在執行啟動命令的目錄下執行下面的命令列操作：

```
bash bin/mqadmin updateTopic -c DefaultCluster -t string-topic
```

## 2. 編譯 rocketmq-spring-boot-starter
目前的 spring-boot-starter 依賴還沒有提交的 Maven 的中心庫，使用者使用前需要自行下載 git 原始碼，然後執行 mvn clean install 安裝到本地倉庫。

```
git clone https://github.com/apache/rocketmq-externals.git
cd rocketmq-spring-boot-starter
mvn clean install
```

## 3. 編寫客戶端程式碼
使用者如果使用它，需要在訊息的釋出和消費客戶端的 maven 配置檔案 pom.xml 中新增如下的依賴：

![6.png](https://ucc.alicdn.com/pic/developer-ecology/857c2ccdd62f4e2b932143624612cd66.png)

屬性 spring-boot-starter-rocketmq-version 的取值為：1.0.0-SNAPSHOT， 這與上一步驟中執行安裝到本地倉庫的版本一致。

### **1）訊息傳送端的程式碼**
傳送端的配置檔案 application.properties：

![7.png](https://ucc.alicdn.com/pic/developer-ecology/59335cc460644c88aed70f03b2fe2c1d.png)

傳送端的 Java 程式碼：

![8.png](https://ucc.alicdn.com/pic/developer-ecology/5d00e37eb6f9410aa4d62fb418b425e1.png)

### **2）訊息消費端程式碼**
消費端的配置檔案 application.properties：

![9.png](https://ucc.alicdn.com/pic/developer-ecology/585972ba1ddb48c18fcc5aac206bbff0.png)

消費端的 Java 程式碼：

![10.png](https://ucc.alicdn.com/pic/developer-ecology/dc700e3b85d64665ab64b1c5512c6e0c.png)

這裡只是簡單的介紹了使用 spring-boot 來編寫最基本的訊息傳送和接收的程式碼，如果需要了解更多的呼叫方式，如: 非同步傳送，物件訊息體，指定 tag 標籤以及指定事務訊息，請參看 github 的說明文件和詳細的程式碼。我們後續還會對這些高階功能進行陸續的介紹。

### **作者簡介**
**遼天**，阿里巴巴技術專家，Apache RocketMQ 核心控，擁有多年分散式系統研發經驗，對 Microservice、Messaging 和 Storage 等領域有深刻理解， 目前專注 RocketMQ 核心最佳化以及 Messaging 生態建設。

使用 rocketmq-spring-boot-starter 來配置、傳送和消費 RocketMQ 訊息

相關文章