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

作者 | RocketMQ 官微
來源|[阿里巴巴雲原生公眾號](https://mp.weixin.qq.com/s/RaC4R02fYoqvPJHopqCoaA)

2019 年 1 月，孵化 6 個月的 RocketMQ-Spring 作為 Apache RocketMQ 的子專案正式畢業，釋出了第一個 Release 版本 2.0.1。該專案是把 RocketMQ 的客戶端使用 Spring Boot 的方式進行了封裝，可以讓使用者透過簡單的 annotation 和標準的 Spring Messaging API 編寫程式碼來進行訊息的傳送和消費。當時 RocketMQ 社群同學請 Spring 社群的同學對 RocketMQ-Spring 程式碼進行 review，引出一段[羅美琪（RocketMQ）和春波特（Spring Boot）的故事](https://mp.weixin.qq.com/s?__biz=MzIxODM2NTQ3OQ==&mid=2247483907&idx=2&sn=10970974cd335896782ed6eb1096c5b3&scene=21#wechat_redirect)。

時隔兩年，RocketMQ-Spring 正式釋出 2.2.0。在這期間，RocketMQ-Spring 迭代了數個版本，以 RocketMQ-Spring 為基礎實現的 Spring Cloud Stream RocketMQ Binder、Spring Cloud Bus RocketMQ 登上了 [Spring 的官網](https://spring.io/projects/spring-cloud-alibaba)，Spring 佈道師 baeldung 向國外同學介紹[如何使用 RocketMQ-Spring](https://www.baeldung.com/apache-rocketmq-spring-boot)，越來越多國內外的同學開始使用 RocketMQ-Spring 收發訊息，RocketMQ-Spring 倉庫的 star 數也在短短兩年時間內超越了 Spring-Kafka 和 Spring-AMQP（注：兩者均由 Spring 社群維護），成為 Apache RocketMQ 最受歡迎的生態專案之一。

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

RocketMQ-Spring 的受歡迎一方面得益於支援豐富業務場景的 RocketMQ 與微服務生態 Spring 的完美契合，另一方面也與 RocketMQ-Spring 本身嚴格遵循 Spring Messaging API 規範，支援豐富的訊息型別分不開。

# 遵循 Spring Messaging API 規範

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

## 1. 傳送端

RocketMQ-Spring 在遵循 Spring Messaging API 規範的基礎上結合 RocketMQ 自身的功能特點提供了相應的 API。在訊息的傳送端，RocketMQ-Spring 透過實現 RocketMQTemplate 完成訊息的傳送。如下圖所示，RocketMQTemplate 繼承 AbstractMessageSendingTemplate 抽象類，來支援 Spring Messaging API 標準的訊息轉換和傳送方法，這些方法最終會代理給 doSend 方法，doSend 方法會最終呼叫 syncSend，由 DefaultMQProducer 實現。

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

除 Spring Messaging API 規範中的方法，RocketMQTemplate 還實現了 RocketMQ 原生客戶端的一些方法，來支援更加豐富的訊息型別。值得注意的是，相比於原生客戶端需要自己去構建 RocketMQ Message（比如將物件序列化成 byte 陣列放入 Message 物件），RocketMQTemplate 可以直接將物件、字串或者 byte 陣列作為引數傳送出去（物件序列化操作由 RocketMQ-Spring 內建完成），在消費端約定好對應的 Schema 即可正常收發。

```
RocketMQTemplate Send API：
	SendResult syncSend(String destination, Object payload) 
	SendResult syncSend(String destination, Message> message）
    void asyncSend(String destination, Message> message, SendCallback sendCallback)
    void asyncSend(String destination, Message> message, SendCallback sendCallback)
	……
```

## 2. 消費端

在消費端，需要實現一個包含 @RocketMQMessageListener 註解的類（需要實現 RocketMQListener 介面，並實現 onMessage 方法，在註解中進行 topic、consumerGroup 等屬性配置），這個 Listener 會一對一的被放置到 DefaultRocketMQListenerContainer 容器物件中，容器物件會根據消費的方式(併發或順序)，將 RocketMQListener 封裝到具體的 RocketMQ 內部的併發或者順序介面實現。在容器中建立 RocketMQ DefaultPushConsumer 物件，啟動並監聽定製的 Topic 訊息，完成約定 Schema 物件的轉換，回撥到 Listener 的 onMessage 方法。

```
@Service
@RocketMQMessageListener(topic = "${demo.rocketmq.topic}", consumerGroup = "string_consumer", selectorExpression = "${demo.rocketmq.tag}")
public class StringConsumer implements RocketMQListener<string> {
    @Override
    public void onMessage(String message) {
        System.out.printf("------- StringConsumer received: %s \n", message);
    }
}
```

除此 Push 介面之外，**在最新的 2.2.0 版本中，RocketMQ-Spring 實現了 RocketMQ Lite Pull Consumer**。透過在配置檔案中進行 consumer 的配置，利用 RocketMQTemplate 的 Recevie 方法即可主動 Pull 訊息。

```
配置檔案resource/application.properties：

rocketmq.name-server=localhost:9876
rocketmq.consumer.group=my-group1
rocketmq.consumer.topic=test

Pull Consumer程式碼：

while(!isStop) {
	List<string> messages = rocketMQTemplate.receive(String.class);
    System.out.println(messages);
}
```

# 豐富的訊息型別

RocketMQ Spring 訊息型別支援方面與 RocketMQ 原生客戶端完全對齊，包括同步/非同步/one-way、順序、延遲、批次、事務以及 Request-Reply 訊息。在這裡，主要介紹較為特殊的事務訊息和 request-reply 訊息。

## 1. 事務訊息

RocketMQ 的事務訊息不同於 Spring Messaging 中的事務訊息，依然採用 RocketMQ 原生事務訊息的方案。如下所示，傳送事務訊息時需要實現一個包含 @RocketMQTransactionListener 註解的類，並實現 executeLocalTransaction 和 checkLocalTransaction 方法，從而來完成執行本地事務以及檢查本地事務執行結果。

```
// Build a SpringMessage for sending in transaction
Message msg = MessageBuilder.withPayload(..)...;
// In sendMessageInTransaction(), the first parameter transaction name ("test")
// must be same with the @RocketMQTransactionListener's member field 'transName'
rocketMQTemplate.sendMessageInTransaction("test-topic", msg, null);

// Define transaction listener with the annotation @RocketMQTransactionListener
@RocketMQTransactionListener
class TransactionListenerImpl implements RocketMQLocalTransactionListener {
    @Override
    public RocketMQLocalTransactionState executeLocalTransaction(Message msg, Object arg) {
        // ... local transaction process, return bollback, commit or unknown
        return RocketMQLocalTransactionState.UNKNOWN;
    }

@Override
    public RocketMQLocalTransactionState checkLocalTransaction(Message msg) {
        // ... check transaction status and return bollback, commit or unknown
        return RocketMQLocalTransactionState.COMMIT;
    }
}
```

在 2.1.0 版本中，RocketMQ-Spring 重構了事務訊息的實現，如下圖所示，舊版本中每一個 group 對應一個 TransactionProducer，而在新版本中改為每一個 RocketMQTemplate 對應一個 TransationProducer，從而解決了併發使用多個事務訊息的問題。當使用者需要在單程式使用多個事務訊息時，可以使用 ExtRocketMQTemplate 來完成（一般情況下，推薦一個程式使用一個 RocketMQTemplate，ExtRocketMQTemplate 可以使用在同程式中需要使用多個 Producer / LitePullConsumer 的場景，可以為 ExtRocketMQTemplate 指定與標準模版 RocketMQTemplate 不同的 nameserver、group 等配置），並在對應的 RocketMQTransactionListener 註解中指定 rocketMQTemplateBeanName 為 ExtRocketMQTemplate 的 BeanName。

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

## 2. Request-Reply 訊息

在 2.1.0 版本中，RocketMQ-Spring 開始支援 Request-Reply 訊息。Request-Reply 訊息指的是上游服務投遞訊息後進入等待被通知的狀態，直到消費端返回結果並返回給傳送端。在 RocketMQ-Spring 中，傳送端透過 RocketMQTemplate 的 sendAndReceivce 方法進行傳送，如下所示，主要有同步和非同步兩種方式。非同步方式中透過實現 RocketMQLocalRequestCallback 進行回撥。

```
// 同步傳送request並且等待String型別的返回值
String replyString = rocketMQTemplate.sendAndReceive("stringRequestTopic", "request string", String.class);

// 非同步傳送request並且等待User型別的返回值
rocketMQTemplate.sendAndReceive("objectRequestTopic", new User("requestUserName",(byte) 9), new RocketMQLocalRequestCallback<user>() {
    @Override public void onSuccess(User message) {
    	……
    }

@Override public void onException(Throwable e) {
    	……
    }
});
```

在消費端，仍然需要實現一個包含 @RocketMQMessageListener 註解的類，但需要實現的介面是 RocketMQReplyListener<t r=""> 介面（普通訊息為 RocketMQListener<t> 介面），其中 T 表示接收值的型別，R 表示返回值的型別，介面需要實現帶返回值的 onMessage 方法，返回值的內容返回給對應的 Producer。

```
@Service
@RocketMQMessageListener(topic = "stringRequestTopic", consumerGroup = "stringRequestConsumer")
public class StringConsumerWithReplyString implements RocketMQReplyListener<string string=""> {
    @Override
    public String onMessage(String message) {
        ……
        return "reply string";
    }
}
```

RocketMQ-Spring 遵循 Spring 約定大於配置（Convention over configuration）的理念，透過啟動器（Spring Boot Starter）的方式，在 pom 檔案引入依賴（groupId：org.apache.rocketmq，artifactId：rocketmq-spring-boot-starter）便可以在 Spring Boot 中整合所有 RocketMQ 客戶端的所有功能，透過簡單的註解使用即可完成訊息的收發。在 [RocketMQ-Spring Github Wiki](https://github.com/apache/rocketmq-spring/wiki) 中有更加詳細的用法和常見問題解答。

據統計，從 RocketMQ-Spring 釋出第一個正式版本以來，RocketMQ-Spring 完成 16 個 bug 修復，37 個 imporvement，其中包括事務訊息重構，訊息過濾、訊息序列化、多例項 RocketMQTemplate 最佳化等重要最佳化，歡迎更多的小夥伴能參與到 RocketMQ 社群的建設中來，羅美琪（RocketMQ）和春波特（Spring Boot）的故事還在繼續...釘釘搜尋群號：21982288，即可進群和眾多開發者交流！</string></t></t></user></string></string>

RocketMQ-Spring 為什麼能成為 Spring 生態中最受歡迎的 messaging 實現？

相關文章