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

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

**Spring Cloud Stream**在 Spring Cloud 體系內用於構建高度可擴充套件的基於事件驅動的微服務，其目的是為了簡化訊息在 Spring Cloud 應用程式中的開發。

Spring Cloud Stream (後面以 SCS 代替 Spring Cloud Stream) 本身內容很多，而且它還有很多外部的依賴，想要熟悉 SCS，必須要先了解 Spring Messaging 和 Spring Integration 這兩個專案，接下來，文章將圍繞以下三點進行展開：

- 什麼是 Spring Messaging
- 什麼是 Spring Integration
- 什麼是 SCS 體系及其原理

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

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

# Spring Messaging
Spring Messaging 是 Spring Framework 中的一個模組，其作用就是統一訊息的程式設計模型。

- 比如訊息 Messaging 對應的模型就包括一個訊息體 Payload 和訊息頭 Header：

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

```
package org.springframework.messaging;
public interface Message<t> {
    T getPayload();
    MessageHeaders getHeaders();
}
```

- 訊息通道 MessageChannel 用於接收訊息，呼叫send方法可以將訊息傳送至該訊息通道中：

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

```
@FunctionalInterface
public interface MessageChannel {
    long INDEFINITE_TIMEOUT = -1;
    default boolean send(Message> message) {

return send(message, INDEFINITE_TIMEOUT);

}
     boolean send(Message> message, long timeout);
}
```

#### 訊息通道里的訊息如何被消費呢？

- 由訊息通道的子介面可訂閱的訊息通道SubscribableChannel實現，被MessageHandler訊息處理器所訂閱：

```
public interface SubscribableChannel extends MessageChannel {
    boolean subscribe(MessageHandler handler);
    boolean unsubscribe(MessageHandler handler);
}
```

- 由MessageHandler真正地消費/處理訊息：

```
@FunctionalInterface
public interface MessageHandler {
    void handleMessage(Message> message) throws MessagingException;
}
```

#### Spring Messaging 內部在訊息模型的基礎上衍生出了其它的一些功能，如：

- 訊息接收引數及返回值處理：訊息接收引數處理器HandlerMethodArgumentResolver配合@Header, @Payload等註解使用；訊息接收後的返回值處理器HandlerMethodReturnValueHandler配合@SendTo註解使用；
- 訊息體內容轉換器MessageConverter；
- 統一抽象的訊息傳送模板AbstractMessageSendingTemplate；
- 訊息通道攔截器ChannelInterceptor；

# Spring Integration
Spring Integration 提供了 Spring 程式設計模型的擴充套件用來支援企業整合模式(Enterprise Integration Patterns)，是對 Spring Messaging 的擴充套件。

它提出了不少新的概念，包括訊息路由MessageRoute、訊息分發MessageDispatcher、訊息過濾Filter、訊息轉換Transformer、訊息聚合Aggregator、訊息分割Splitter等等。同時還提供了MessageChannel和MessageHandler的實現，分別包括 DirectChannel、ExecutorChannel、PublishSubscribeChannel和MessageFilter、ServiceActivatingHandler、MethodInvokingSplitter 等內容。

#### 這裡為大家介紹幾種訊息的處理方式：

- 訊息的分割：

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

- 訊息的聚合：

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

- 訊息的過濾：

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

- 訊息的分發：

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

#### 接下來，我們以一個最簡單的例子來嘗試一下 Spring Integration。

這段程式碼解釋為：

```
SubscribableChannel messageChannel =new DirectChannel(); // 1

messageChannel.subscribe(msg-> { // 2
 System.out.println("receive: " +msg.getPayload());
});

messageChannel.send(MessageBuilder.withPayload("msgfrom alibaba").build()); // 3
```

- 構造一個可訂閱的訊息通道messageChannel。
- 使用MessageHandler去消費這個訊息通道里的訊息。
- 傳送一條訊息到這個訊息通道，訊息最終被訊息通道里的MessageHandler所消費。
- 最後控制檯列印出:receive: msg from alibaba。

DirectChannel內部有個UnicastingDispatcher型別的訊息分發器，會分發到對應的訊息通道MessageChannel中，從名字也可以看出來，UnicastingDispatcher是個單播的分發器，只能選擇一個訊息通道。那麼如何選擇呢? 內部提供了LoadBalancingStrategy負載均衡策略，預設只有輪詢的實現，可以進行擴充套件。

我們對上段程式碼做一點修改，使用多個 MessageHandler 去處理訊息：

```
SubscribableChannel messageChannel = new DirectChannel();

messageChannel.subscribe(msg -> {
     System.out.println("receive1: " + msg.getPayload());
});

messageChannel.subscribe(msg -> {
     System.out.println("receive2: " + msg.getPayload());
});

messageChannel.send(MessageBuilder.withPayload("msg from alibaba").build());
messageChannel.send(MessageBuilder.withPayload("msg from alibaba").build());
```

由於DirectChannel內部的訊息分發器是UnicastingDispatcher單播的方式，並且採用輪詢的負載均衡策略，所以這裡兩次的消費分別對應這兩個MessageHandler。控制檯列印出：

```
receive1: msg from alibaba
receive2: msg from alibaba
```

既然存在單播的訊息分發器UnicastingDispatcher，必然也會存在廣播的訊息分發器，那就是BroadcastingDispatcher，它被 PublishSubscribeChannel 這個訊息通道所使用。廣播訊息分發器會把訊息分發給所有的 MessageHandler：

```
SubscribableChannel messageChannel = new PublishSubscribeChannel();

messageChannel.subscribe(msg -> {
     System.out.println("receive1: " + msg.getPayload());
});

messageChannel.subscribe(msg -> {
     System.out.println("receive2: " + msg.getPayload());
});

messageChannel.send(MessageBuilder.withPayload("msg from alibaba").build());
messageChannel.send(MessageBuilder.withPayload("msg from alibaba").build());
```

# Spring Cloud Stream
#### SCS 與各模組之間的關係是：

- SCS 在 Spring Integration 的基礎上進行了封裝，提出了Binder, Binding, @EnableBinding, @StreamListener等概念。
- SCS 與 Spring Boot Actuator 整合，提供了/bindings, /channelsendpoint。
- SCS 與 Spring Boot Externalized Configuration 整合，提供了BindingProperties, BinderProperties等外部化配置類。
- SCS 增強了訊息傳送失敗的和消費失敗情況下的處理邏輯等功能。
- SCS 是 Spring Integration 的加強，同時與 Spring Boot 體系進行了融合，也是 Spring Cloud Bus 的基礎。它遮蔽了底層訊息中介軟體的實現細節，希望以統一的一套 API 來進行訊息的傳送/消費，底層訊息中介軟體的實現細節由各訊息中介軟體的 Binder 完成。

Binder是提供與外部訊息中介軟體整合的元件，為構造Binding提供了 2 個方法，分別是bindConsumer和bindProducer，它們分別用於構造生產者和消費者。目前官方的實現有 Rabbit Binder 和 Kafka Binder， Spring Cloud Alibaba 內部已經實現了 RocketMQ Binder。

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

從圖中可以看出，Binding是連線應用程式跟訊息中介軟體的橋樑，用於訊息的消費和生產。我們來看一個最簡單的使用 RocketMQ Binder 的例子，然後分析一下它的底層處理原理：

- 啟動類及訊息的傳送：

```
@SpringBootApplication
@EnableBinding({ Source.class, Sink.class }) // 1
public class SendAndReceiveApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(SendAndReceiveApplication.class, args);
    }
 
       @Bean // 2
    public CustomRunner customRunner() {
        return new CustomRunner();
    }

public static class CustomRunner implements CommandLineRunner {

@Autowired
        private Source source;

@Override
        public void run(String... args) throws Exception {
            int count = 5;
            for (int index = 1; index <= count; index++) {
                source.output().send(MessageBuilder.withPayload("msg-" + index).build()); // 3
            }
        }
    }
}
```

- 訊息的接收：

```
@Service
public class StreamListenerReceiveService {

@StreamListener(Sink.INPUT) // 4
    public void receiveByStreamListener1(String receiveMsg) {
        System.out.println("receiveByStreamListener: " + receiveMsg);
    }

}
```

這段程式碼很簡單，沒有涉及到 RocketMQ 相關的程式碼，訊息的傳送和接收都是基於 SCS 體系完成的。如果想切換成 RabbitMQ 或 Kafka，只需修改配置檔案即可，程式碼無需修改。

我們來分析下這段程式碼的原理：

1.@EnableBinding對應的兩個介面屬性Source和Sink是 SCS 內部提供的。SCS 內部會基於Source和Sink構造BindableProxyFactory，且對應的 output 和 input 方法返回的 MessageChannel 是DirectChannel。output 和 input 方法修飾的註解對應的 value 是配置檔案中 binding 的 name。

```
public interface Source {
    String OUTPUT = "output";
    @Output(Source.OUTPUT)
    MessageChannel output();
}
public interface Sink {
    String INPUT = "input";
    @Input(Sink.INPUT)
    SubscribableChannel input();
}
```

配置檔案裡 bindings 的 name 為 output 和 input，對應Source和Sink介面的方法上的註解裡的 value：

```
spring.cloud.stream.bindings.output.destination=test-topic
spring.cloud.stream.bindings.output.content-type=text/plain
spring.cloud.stream.rocketmq.bindings.output.producer.group=demo-group

spring.cloud.stream.bindings.input.destination=test-topic
spring.cloud.stream.bindings.input.content-type=text/plain
spring.cloud.stream.bindings.input.group=test-group1
```

2. 構造CommandLineRunner，程式啟動的時候會執行CustomRunner的run方法。

3. 呼叫Source介面裡的 output 方法獲取DirectChannel，併傳送訊息到這個訊息通道中。這裡跟之前 Spring Integration 章節裡的程式碼一致。

- Source 裡的 output 傳送訊息到DirectChannel訊息通道之後會被AbstractMessageChannelBinder#SendingHandler這個MessageHandler處理，然後它會委託給AbstractMessageChannelBinder#createProducerMessageHandler建立的 MessageHandler 處理(該方法由不同的訊息中介軟體實現)。
- 不同的訊息中介軟體對應的AbstractMessageChannelBinder#createProducerMessageHandler方法返回的 MessageHandler 內部會把 Spring Message 轉換成對應中介軟體的 Message 模型併傳送到對應中介軟體的 broker。

4. 使用@StreamListener進行訊息的訂閱。請注意，註解裡的Sink.input對應的值是 "input"，會根據配置檔案裡 binding 對應的 name 為 input 的值進行配置：

- 不同的訊息中介軟體對應的AbstractMessageChannelBinder#createConsumerEndpoint方法會使用 Consumer 訂閱訊息，訂閱到訊息後內部會把中介軟體對應的 Message 模型轉換成 Spring Message。
- 訊息轉換之後會把 Spring Message 傳送至 name 為 input 的訊息通道中。
- @StreamListener對應的StreamListenerMessageHandler訂閱了 name 為 input 的訊息通道，進行了訊息的消費。

這個過程文字描述有點囉嗦，用一張圖總結一下(黃色部分涉及到各訊息中介軟體的 Binder 實現以及 MQ 基本的訂閱釋出功能)：

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

#### SCS 章節的最後，我們來看一段 SCS 關於訊息的處理方式的一段程式碼：

```
@StreamListener(value = Sink.INPUT, condition = "headers['index']=='1'")
public void receiveByHeader(Message msg) {
     System.out.println("receive by headers['index']=='1': " + msg);
}

@StreamListener(value = Sink.INPUT, condition = "headers['index']=='9999'")
public void receivePerson(@Payload Person person) {
     System.out.println("receive Person: " + person);
}

@StreamListener(value = Sink.INPUT)
public void receiveAllMsg(String msg) {
     System.out.println("receive allMsg by StreamListener. content: " + msg);
}

@StreamListener(value = Sink.INPUT)
public void receiveHeaderAndMsg(@Header("index") String index, Message msg) {
     System.out.println("receive by HeaderAndMsg by StreamListener. content: " + msg);
}
```

有沒有發現這段程式碼跟 Spring MVC Controller 中接收請求的程式碼很像? 實際上他們的架構都是類似的，Spring MVC 對於 Controller 中引數和返回值的處理類分別是org.springframework.web.method.support.HandlerMethodArgumentResolver、org.springframework.web.method.support.HandlerMethodReturnValueHandler。

Spring Messaging 中對於引數和返回值的處理類之前也提到過，分別是org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver、org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandler。

它們的類名一模一樣，甚至內部的方法名也一樣。

# 總結

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

上圖是 SCS 體系相關類說明的總結，關於 SCS 以及 RocketMQ Binder 更多相關的示例，可以參考 [RocketMQ Binder Demos](https://github.com/fangjian0423/rocketmq-binder-demo)，包含了訊息的聚合、分割、過濾；訊息異常處理；訊息標籤、SQL 過濾；同步、非同步消費等等。</t>

Spring Cloud Stream 體系及原理介紹

相關文章