前言

上世紀90年代末，隨著Java EE(Enterprise Edition)的出現(xiàn)，特別是Enterprise Java Beans的使用需要復(fù)雜的描述符配置和死板復(fù)雜的代碼實現(xiàn)，增加了廣大開發(fā)者的學(xué)習(xí)曲線和開發(fā)成本，由此基于簡單的XML配置和普通Java對象(Plain Old Java Objects)的Spring技術(shù)應(yīng)運而生，依賴注入(Dependency Injection), 控制反轉(zhuǎn)(Inversion of Control)和面向切面編程(AOP)的技術(shù)更加敏捷地解決了傳統(tǒng)Java企業(yè)及版本的不足。

隨著Spring的持續(xù)演進，基于注解(Annotation)的配置逐漸取代了XML文件配置， 2014年4月1日，Spring Boot 1.0.0正式發(fā)布，它基于“約定大于配置”（Convention over configuration)這一理念來快速地開發(fā)、測試、運行和部署Spring應(yīng)用，并能通過簡單地與各種啟動器(如 spring-boot-web-starter)結(jié)合，讓應(yīng)用直接以命令行的方式運行，不需再部署到獨立容器中。這種簡便直接快速構(gòu)建和開發(fā)應(yīng)用的過程，可以使用約定的配置并且簡化部署，受到越來越多的開發(fā)者的歡迎。

Apache RocketMQ是業(yè)界知名的分布式消息和流處理中間件，簡單地理解，它由Broker服務(wù)器和客戶端兩部分組成：

其中客戶端一個是消息發(fā)布者客戶端(Producer)，它負責(zé)向Broker服務(wù)器發(fā)送消息；

另外一個是消息的消費者客戶端(Consumer)，多個消費者可以組成一個消費組，來訂閱和拉取消費Broker服務(wù)器上存儲的消息。

為了利用Spring Boot的快速開發(fā)和讓用戶能夠更靈活地使用RocketMQ消息客戶端，Apache RocketMQ社區(qū)推出了spring-boot-starter實現(xiàn)。隨著分布式事務(wù)消息功能在RocketMQ 4.3.0版本的發(fā)布，近期升級了相關(guān)的spring-boot代碼，通過注解方式支持分布式事務(wù)的回查和事務(wù)消息的發(fā)送。

本文將對當前的設(shè)計實現(xiàn)做一個簡單的介紹，讀者可以通過本文了解將RocketMQ Client端集成為spring-boot-starter框架的開發(fā)細節(jié)，然后通過一個簡單的示例來一步一步的講解如何使用這個spring-boot-starter工具包來配置，發(fā)送和消費RocketMQ消息。

Spring 中的消息框架

順便在這里討論一下在Spring中關(guān)于消息的兩個主要的框架，即Spring Messaging和Spring Cloud Stream。它們都能夠與Spring Boot整合并提供了一些參考的實現(xiàn)。和所有的實現(xiàn)框架一樣，消息框架的目的是實現(xiàn)輕量級的消息驅(qū)動的微服務(wù)，可以有效地簡化開發(fā)人員對消息中間件的使用復(fù)雜度，讓系統(tǒng)開發(fā)人員可以有更多的精力關(guān)注于核心業(yè)務(wù)邏輯的處理。

2.1 Spring Messaging

Spring Messaging是Spring Framework 4中添加的模塊，是Spring與消息系統(tǒng)集成的一個擴展性的支持。它實現(xiàn)了從基于JmsTemplate的簡單的使用JMS接口到異步接收消息的一整套完整的基礎(chǔ)架構(gòu)，Spring AMQP提供了該協(xié)議所要求的類似的功能集。 在與Spring Boot的集成后，它擁有了自動配置能力，能夠在測試和運行時與相應(yīng)的消息傳遞系統(tǒng)進行集成。

單純對于客戶端而言，Spring Messaging提供了一套抽象的API或者說是約定的標準，對消息發(fā)送端和消息接收端的模式進行規(guī)定，不同的消息中間件提供商可以在這個模式下提供自己的Spring實現(xiàn)：在消息發(fā)送端需要實現(xiàn)的是一個XXXTemplate形式的Java Bean，結(jié)合Spring Boot的自動化配置選項提供多個不同的發(fā)送消息方法；在消息的消費端是一個XXXMessageListener接口（實現(xiàn)方式通常會使用一個注解來聲明一個消息驅(qū)動的POJO），提供回調(diào)方法來監(jiān)聽和消費消息，這個接口同樣可以使用Spring Boot的自動化選項和一些定制化的屬性。

如果有興趣深入的了解Spring Messaging及針對不同的消息產(chǎn)品的使用，推薦閱讀這個文件。參考Spring Messaging的既有實現(xiàn)，RocketMQ的spring-boot-starter中遵循了相關(guān)的設(shè)計模式并結(jié)合RocketMQ自身的功能特點提供了相應(yīng)的API(如，順序，異步和事務(wù)半消息等)。

2.2 Spring Cloud Stream

Spring Cloud Stream結(jié)合了Spring Integration的注解和功能，它的應(yīng)用模型如下：

該圖片引自spring cloud stream

Spring Cloud Stream框架中提供一個獨立的應(yīng)用內(nèi)核，它通過輸入(@Input)和輸出(@Output)通道與外部世界進行通信，消息源端(Source)通過輸入通道發(fā)送消息，消費目標端(Sink)通過監(jiān)聽輸出通道來獲取消費的消息。這些通道通過專用的Binder實現(xiàn)與外部代理連接。開發(fā)人員的代碼只需要針對應(yīng)用內(nèi)核提供的固定的接口和注解方式進行編程，而不需要關(guān)心運行時具體的Binder綁定的消息中間件。在運行時，Spring Cloud Stream能夠自動探測并使用在classpath下找到的Binder。

這樣開發(fā)人員可以輕松地在相同的代碼中使用不同類型的中間件：僅僅需要在構(gòu)建時包含進不同的Binder。在更加復(fù)雜的使用場景中，也可以在應(yīng)用中打包多個Binder并讓它自己選擇Binder，甚至在運行時為不同的通道使用不同的Binder。

Binder抽象使得Spring Cloud Stream應(yīng)用可以靈活的連接到中間件，加之Spring Cloud Stream使用利用了Spring Boot的靈活配置配置能力，這樣的配置可以通過外部配置的屬性和Spring Boo支持的任何形式來提供（包括應(yīng)用啟動參數(shù)、環(huán)境變量和application.yml或者application.properties文件），部署人員可以在運行時動態(tài)選擇通道連接destination（例如，Kafka的topic或者RabbitMQ的exchange）。

Binder SPI的方式來讓消息中間件產(chǎn)品使用可擴展的API來編寫相應(yīng)的Binder，并集成到Spring Cloud Steam環(huán)境，目前RocketMQ還沒有提供相關(guān)的Binder，我們計劃在下一步將完善這一功能，也希望社區(qū)里有這方面經(jīng)驗的同學(xué)積極嘗試，貢獻PR或建議。

spring-boot-starter的實現(xiàn)

在開始的時候我們已經(jīng)知道，spring boot starter構(gòu)造的啟動器對于使用者是非常方便的，使用者只要在pom.xml引入starter的依賴定義，相應(yīng)的編譯，運行和部署功能就全部自動引入。因此常用的開源組件都會為Spring的用戶提供一個spring-boot-starter封裝給開發(fā)者，讓開發(fā)者非常方便集成和使用，這里我們詳細的介紹一下RocketMQ（客戶端）的starter實現(xiàn)過程。

3.1. spring-boot-starter的實現(xiàn)步驟

對于一個spring-boot-starter實現(xiàn)需要包含如下幾個部分：

   1.  在pom.xml的定義

•  定義最終要生成的starter組件信息 

<groupId>org.apache.rocketmq</groupId>  
<artifactId>spring-boot-starter-rocketmq</artifactId>  
<version>1.0.0-SNAPSHOT</version> 

•  定義依賴包，

它分為兩個部分: A、Spring自身的依賴包； B、RocketMQ的依賴包 

<dependencies>  
    <!-- spring-boot-start internal depdencies -->  
    <dependency>  
        <groupId>org.springframework.boot</groupId>  
        <artifactId>spring-boot-starter</artifactId>  
    </dependency>           
    <dependency>  
        <groupId>org.springframework.boot</groupId>  
        <artifactId>spring-boot-starter-test</artifactId>  
        <scope>test</scope>  
    </dependency> 
    <!-- rocketmq dependencies -->  
    <dependency> 
         <groupId>org.apache.rocketmq</groupId>  
        <artifactId>rocketmq-client</artifactId>  
        <version>${rocketmq-version}</version>  
    </dependency>  
</dependencies>      
    <dependencyManagement>  
    <dependencies> 
         <!-- spring-boot-start parent depdency definition -->   
        <dependency>  
            <groupId>org.springframework.boot</groupId>  
            <artifactId>spring-boot-starter-parent</artifactId>  
            <version>${spring.boot.version}</version>  
            <type>pom</type>  
            <scope>import</scope>  
        </dependency>  
    </dependencies>  
</dependencyManagement> 

    2.  配置文件類

定義應(yīng)用屬性配置文件類RocketMQProperties,這個Bean定義一組默認的屬性值。用戶在使用最終的starter時，可以根據(jù)這個類定義的屬性來修改取值，當然不是直接修改這個類的配置，而是spring-boot應(yīng)用中對應(yīng)的配置文件：src/main/resources/application.properties.

    3.  定義自動加載類

定義 src/resources/META-INF/spring.factories文件中的自動加載類， 其目的是讓spring boot更具文中中所指定的自動化配置類來自動初始化相關(guān)的Bean，Component或Service，它的內(nèi)容如下： 

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

在RocketMQAutoConfiguration類的具體實現(xiàn)中，定義開放給用戶直接使用的Bean對象. 包括：

•  RocketMQProperties 加載應(yīng)用屬性配置文件的處理類；
•  RocketMQTemplate 發(fā)送端用戶發(fā)送消息的發(fā)送模板類；
•  ListenerContainerConfiguration 容器Bean負責(zé)發(fā)現(xiàn)和注冊消費端消費實現(xiàn)接口類，這個類要求：由@RocketMQMessageListener注解標注；實現(xiàn)RocketMQListener泛化接口。

    4.  最后具體的RocketMQ相關(guān)的封裝

在發(fā)送端（producer）和消費端(consumer)客戶端分別進行封裝，在當前的實現(xiàn)版本提供了對Spring Messaging接口的兼容方式。

3.2. 消息發(fā)送端實現(xiàn)

    1.  普通發(fā)送端

發(fā)送端的代碼封裝在RocketMQTemplate POJO中，下圖是發(fā)送端的相關(guān)代碼的調(diào)用關(guān)系圖：

為了與Spring Messaging的發(fā)送模板兼容，在RocketMQTemplate集成了AbstractMessageSendingTemplate抽象類，來支持相關(guān)的消息轉(zhuǎn)換和發(fā)送方法，這些方法最終會代理給doSend()方法；doSend()以及RocoketMQ所特有的一些方法如異步，單向和順序等方法直接添加到RoketMQTempalte中，這些方法直接代理調(diào)用到RocketMQ的Producer API來進行消息的發(fā)送。

    2.  事務(wù)消息發(fā)送端

對于事務(wù)消息的處理，在消息發(fā)送端進行了部分的擴展，參考下圖的調(diào)用關(guān)系類圖：

RocketMQTemplate里加入了一個發(fā)送事務(wù)消息的方法sendMessageInTransaction(), 并且最終這個方法會代理到RocketMQ的TransactionProducer進行調(diào)用，在這個Producer上會注冊其關(guān)聯(lián)的TransactionListener實現(xiàn)類，以便在發(fā)送消息后能夠?qū)ransactionListener里的方法實現(xiàn)進行調(diào)用。

3.3. 消息消費端實現(xiàn)

在消費端Spring-Boot應(yīng)用啟動后，會掃描所有包含@RocketMQMessageListener注解的類(這些類需要集成RocketMQListener接口，并實現(xiàn)onMessage()方法)，這個Listener會一對一的被放置到DefaultRocketMQListenerContainer容器對象中，容器對象會根據(jù)消費的方式(并發(fā)或順序)，將RocketMQListener封裝到具體的RocketMQ內(nèi)部的并發(fā)或者順序接口實現(xiàn)。在容器中創(chuàng)建RocketMQ Consumer對象，啟動并監(jiān)聽定制的Topic消息，如果有消費消息，則回調(diào)到Listener的onMessage()方法。

使用示例

上面的一章介紹了RocketMQ在spring-boot-starter方式的實現(xiàn)，這里通過一個最簡單的消息發(fā)送和消費的例子來介紹如何使這個rocketmq-spring-boot-starter。

4.1 RocketMQ服務(wù)端的準備

1.  啟動NameServer和Broker

要驗證RocketMQ的Spring-Boot客戶端，首先要確保RocketMQ服務(wù)正確的下載并啟動。可以參考RocketMQ主站的快速開始來進行操作。確保啟動NameServer和Broker已經(jīng)正確啟動。

      2.  創(chuàng)建實例中所需要的Topics

在執(zhí)行啟動命令的目錄下執(zhí)行下面的命令行操作 

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

4.2. 編譯rocketmq-spring-boot-starter

目前的spring-boot-starter依賴還沒有提交的Maven的中心庫，用戶使用前需要自行下載git源碼，然后執(zhí)行mvn clean install 安裝到本地倉庫。 

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

4.3. 編寫客戶端代碼

用戶如果使用它，需要在消息的發(fā)布和消費客戶端的maven配置文件pom.xml中添加如下的依賴： 

<properties>   <spring-boot-starter-rocketmq-version>1.0.0-SNAPSHOT</spring-boot-starter-rocketmq-version>  
</properties>  
<dependency>  
   <groupId>org.apache.rocketmq</groupId>  
   <artifactId>spring-boot-starter-rocketmq</artifactId>  
   <version>${spring-boot-starter-rocketmq-version}</version>  
</dependency> 

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

1.  消息發(fā)送端的代碼

發(fā)送端的配置文件application.properties 

# 定義name-server地址  
spring.rocketmq.name-server=localhost:9876  
# 定義發(fā)布者組名  
spring.rocketmq.producer.group=my-group1  
# 定義要發(fā)送的topic  
spring.rocketmq.topic=string-topic 

發(fā)送端的Java代碼 

import org.apache.rocketmq.spring.starter.core.RocketMQTemplate;  
...  
@SpringBootApplication  
public class ProducerApplication implements CommandLineRunner {  
    // 聲明并引用RocketMQTemplate  
    @Resource  
    private RocketMQTemplate rocketMQTemplate;  
    // 使用application.properties里定義的topic屬性  
    @Value("${spring.rocketmq.springTopic}")  
    private String springTopic;  
    public static void main(String[] args){  
        SpringApplication.run(ProducerApplication.class, args);  
    }  
    public void run(String... args) throws Exception {  
        // 以同步的方式發(fā)送字符串消息給指定的topic  
        SendResult sendResult = rocketMQTemplate.syncSend(springTopic, "Hello, World!");  
        // 打印發(fā)送結(jié)果信息  
        System.out.printf("string-topic syncSend1 sendResult=%s %n", sendResult);  
    }  
} 

     2.   消息消費端代碼

消費端的配置文件application.properties 

# 定義name-server地址  
spring.rocketmq.name-server=localhost:9876  
# 定義發(fā)布者組名  
spring.rocketmq.consumer.group=my-customer-group1  
# 定義要發(fā)送的topic  
spring.rocketmq.topic=string-topic 

消費端的Java代碼 

@SpringBootApplication  
public class ConsumerApplication {  
    public static void main(String[] args) {  
        SpringApplication.run(ConsumerApplication.class, args);  
    } 
}  
// 聲明消費消息的類，并在注解中指定，相關(guān)的消費信息  
@Service  
@RocketMQMessageListener(topic = "${spring.rocketmq.topic}", consumerGroup = "${spring.rocketmq.consumer.group}")  
class StringConsumer implements RocketMQListener{  
    @Override  
    public void onMessage(String message) {  
        System.out.printf("------- StringConsumer received: %s %f", message);  
    }  
} 

這里只是簡單的介紹了使用spring-boot來編寫最基本的消息發(fā)送和接收的代碼，如果需要了解更多的調(diào)用方式，如: 異步發(fā)送，對象消息體，指定tag標簽以及指定事務(wù)消息，請參看github的說明文檔和詳細的代碼。我們后續(xù)還會對這些高級功能進行陸續(xù)的介紹。