摘要：它通過使用來連接消息代理中間件以實現消息事件驅動的微服務應用。該示例主要目標是構建一個基于的微服務應用，這個微服務應用將通過使用消息中間件來接收消息并將消息打印到日志中。下面我們通過編寫生產消息的單元測試用例來完善我們的入門內容。

之前在寫Spring Boot基礎教程的時候寫過一篇《Spring Boot中使用RabbitMQ》。在該文中，我們通過簡單的配置和注解就能實現向RabbitMQ中生產和消費消息。實際上我們使用的對RabbitMQ的starter就是通過Spring Cloud Stream中對RabbitMQ的支持來實現的。下面我們就通過本文來了解一下Spring Cloud Stream。

Spring Cloud Stream是一個用來為微服務應用構建消息驅動能力的框架。它可以基于Spring Boot來創建獨立的、可用于生產的Spring應用程序。它通過使用Spring Integration來連接消息代理中間件以實現消息事件驅動的微服務應用。Spring Cloud Stream為一些供應商的消息中間件產品提供了個性化的自動化配置實現，并且引入了發布-訂閱、消費組以及消息分區這三個核心概念。簡單的說，Spring Cloud Stream本質上就是整合了Spring Boot和Spring Integration，實現了一套輕量級的消息驅動的微服務框架。通過使用Spring Cloud Stream，可以有效地簡化開發人員對消息中間件的使用復雜度，讓系統開發人員可以有更多的精力關注于核心業務邏輯的處理。由于Spring Cloud Stream基于Spring Boot實現，所以它秉承了Spring Boot的優點，實現了自動化配置的功能幫忙我們可以快速的上手使用，但是目前為止Spring Cloud Stream只支持下面兩個著名的消息中間件的自動化配置：

RabbitMQ

Kafka

下面我們通過構建一個簡單的示例來對Spring Cloud Stream有一個初步認識。該示例主要目標是構建一個基于Spring Boot的微服務應用，這個微服務應用將通過使用消息中間件RabbitMQ來接收消息并將消息打印到日志中。所以，在進行下面步驟之前請先確認已經在本地安裝了RabbitMQ，具體安裝步驟請參考此文。

創建一個基礎的Spring Boot工程，命名為：stream-hello

編輯pom.xml中的依賴關系，引入Spring Cloud Stream對RabbitMQ的支持，具體如下：

    org.springframework.boot
    spring-boot-starter-parent
    1.5.9.RELEASE
     



    
        org.springframework.boot
        spring-boot-starter-test
        test
    

    
        org.springframework.cloud
        spring-cloud-starter-stream-rabbit     
    



    
        
            org.springframework.cloud
            spring-cloud-dependencies
            Dalston.SR4
            pom
            import
        
    

創建用于接收來自RabbitMQ消息的消費者SinkReceiver，具體如下：

@EnableBinding(Sink.class)
public class SinkReceiver {

    private static Logger logger = LoggerFactory.getLogger(SinkReceiver.class);

    @StreamListener(Sink.INPUT)
    public void receive(Object payload) {
        logger.info("Received: " + payload);
    }

}

創建應用主類，這里同其他Spring Boot一樣，沒有什么特別之處，具體如下：

@SpringBootApplication
public class SinkApplication {

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

}

到這里，我們快速入門示例的編碼任務就已經完成了。下面我們分別啟動RabbitMQ以及該Spring Boot應用，然后做下面的試驗，看看它們是如何運作的。

我們先來看一下Spring Boot應用的啟動日志。

...
INFO 16272 --- [main] o.s.c.s.b.r.RabbitMessageChannelBinder   : declaring queue for inbound: input.anonymous.Y8VsFILmSC27eS5StsXp6A, bound to: input
INFO 16272 --- [main] o.s.a.r.c.CachingConnectionFactory       : Created new connection: SimpleConnection@3c78e551 [delegate=amqp://guest@127.0.0.1:5672/]
INFO 16272 --- [main] o.s.integration.channel.DirectChannel    : Channel "input.anonymous.Y8VsFILmSC27eS5StsXp6A.bridge" has 1 subscriber(s).
INFO 16272 --- [main] o.s.i.a.i.AmqpInboundChannelAdapter      : started inbound.input.anonymous.Y8VsFILmSC27eS5StsXp6A
...

從上面的日志內容中，我們可以獲得以下信息：

使用guest用戶創建了一個指向127.0.0.1:5672位置的RabbitMQ連接，在RabbitMQ的控制臺中我們也可以發現它。

聲明了一個名為input.anonymous.Y8VsFILmSC27eS5StsXp6A的隊列，并通過RabbitMessageChannelBinder將自己綁定為它的消費者。這些信息我們也能在RabbitMQ的控制臺中發現它們。

下面我們可以在RabbitMQ的控制臺中進入input.anonymous.Y8VsFILmSC27eS5StsXp6A隊列的管理頁面，通過Publish Message功能來發送一條消息到該隊列中。

此時，我們可以在當前啟動的Spring Boot應用程序的控制臺中看到下面的內容：

INFO 16272 --- [C27eS5StsXp6A-1] com.didispace.HelloApplication           : Received: [B@7cba610e

我們可以發現在應用控制臺中輸出的內容就是SinkReceiver中receive方法定義的，而輸出的具體內容則是來自消息隊列中獲取的對象。這里由于我們沒有對消息進行序列化，所以輸出的只是該對象的引用，在后面的小節中我們會詳細介紹接收消息后的處理。

在順利完成上面快速入門的示例后，我們簡單解釋一下上面的步驟是如何將我們的Spring Boot應用連接上RabbitMQ來消費消息以實現消息驅動業務邏輯的。

首先，我們對Spring Boot應用做的就是引入spring-cloud-starter-stream-rabbit依賴，該依賴包是Spring Cloud Stream對RabbitMQ支持的封裝，其中包含了對RabbitMQ的自動化配置等內容。從下面它定義的依賴關系中，我們還可以知道它等價于spring-cloud-stream-binder-rabbit依賴。

    
        org.springframework.cloud
        spring-cloud-stream-binder-rabbit
    

接著，我們再來看看這里用到的幾個Spring Cloud Stream的核心注解，它們都被定義在SinkReceiver中：

@EnableBinding，該注解用來指定一個或多個定義了@Input或@Output注解的接口，以此實現對消息通道（Channel）的綁定。在上面的例子中，我們通過@EnableBinding(Sink.class)綁定了Sink接口，該接口是Spring Cloud Stream中默認實現的對輸入消息通道綁定的定義，它的源碼如下：

public interface Sink {

    String INPUT = "input";

    @Input(Sink.INPUT)
    SubscribableChannel input();

}

它通過@Input注解綁定了一個名為input的通道。除了Sink之外，Spring Cloud Stream還默認實現了綁定output通道的Source接口，還有結合了Sink和Source的Processor接口，實際使用時我們也可以自己通過@Input和@Output注解來定義綁定消息通道的接口。當我們需要為@EnableBinding指定多個接口來綁定消息通道的時候，可以這樣定義：@EnableBinding(value = {Sink.class, Source.class})。

@StreamListener：該注解主要定義在方法上，作用是將被修飾的方法注冊為消息中間件上數據流的事件監聽器，注解中的屬性值對應了監聽的消息通道名。在上面的例子中，我們通過@StreamListener(Sink.INPUT)注解將receive方法注冊為對input消息通道的監聽處理器，所以當我們在RabbitMQ的控制頁面中發布消息的時候，receive方法會做出對應的響應動作。

上面我們通過RabbitMQ的控制臺完成了發送消息來驗證了消息消費程序的功能，雖然這種方法比較low，但是通過上面的步驟，相信大家對RabbitMQ和Spring Cloud Stream的消息消費已經有了一些基礎的認識。下面我們通過編寫生產消息的單元測試用例來完善我們的入門內容。

在上面創建的工程中創建單元測試類：

@RunWith(SpringRunner.class)
@EnableBinding(value = {SinkApplicationTests.SinkSender.class})
public class SinkApplicationTests {

    @Autowired
    private SinkSender sinkSender;

    @Test
    public void sinkSenderTester() {
        sinkSender.output().send(MessageBuilder.withPayload("produce a message ：http://blog.didispace.com").build());
    }

    public interface SinkSender {

        String OUTPUT = "input";

        @Output(SinkSender.OUTPUT)
        MessageChannel output();

    }

}

在應用了上面的消息消費者程序之后，運行這里定義的單元測試程序，我們馬上就能在消息消費者的控制臺中收到下面的內容：

INFO 50947 --- [L2W-c2AcChb2Q-1] com.didispace.stream.SinkReceiver        : Received: produce a message ：http://blog.didispace.com

在上面的單元測試中，我們通過@Output(SinkSender.OUTPUT)定義了一個輸出通過，而該輸出通道的名稱為input，與前文中的Sink中定義的消費通道同名，所以這里的單元測試與前文的消費者程序組成了一對生產者與消費者。到這里，本文的內容就次結束，如果您能夠獨立的完成上面的例子，那么對于Spring Cloud Stream的基礎使用算是入門了。但是，Spring Cloud Stream的使用遠不止于此，在近期的博文中，我講繼續更新這部分內容，幫助他們來理解和用好Spring Cloud Stream來構建消息驅動的微服務！

本文完整實例：

Github

Gitee

如果您對這些感興趣，歡迎star、follow、收藏、轉發給予支持！

本文內容部分節選自我的《Spring Cloud微服務實戰》，但對依賴的Spring Boot和Spring Cloud版本做了升級。

本文首發于我的博客：http://blog.didispace.com

Spring Boot基礎教程

Spring Cloud基礎教程