Spring Cloud （十五）Stream 入门、主要概念与自定义消息发送与接收

2022-10-15 18:54:54

前言

不写随笔的日子仿佛就是什么都没有产出一般……上节说到要学Spring Cloud Bus，这里发现按照官方文档的顺序反而会更好些，因为不必去后边的章节去为当前章节去打基础，所以我们先学习Spring Cloud Stream，还有一个就是本文有很多官方文档的翻译以及《Spring Cloud 微服务实战》书中的内容和DD博客中的内容，可能会有杂糅的地方，望大家见谅。

代码详见：https://github.com/HellxZ/SpringCloudLearn

快速入门

五分钟左右为你展示如何创建一个Spring Cloud Stream的应用程序，它是如何从消息中间件中接收并输出接收的信息到console，这里的消息中间件有两种选择：RabbitMQ和Kafka，本文以RabbitMQ为准

这节主要简化官方文档为两步:

使用idea新建项目
添加 Message Handler , Building 并运行

一、使用idea新建项目

打开项目目录，新建一个moudle，名为FirstStream，pom文件如下

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

	<modelVersion>4.0.0</modelVersion>

	<groupId>com.cnblogs.hellxz</groupId>

	<artifactId>FirstStream</artifactId>

	<version>0.0.1-SNAPSHOT</version>

	<packaging>jar</packaging>

	<name>FirstStream</name>

	<description>Demo project for Spring Boot</description>

	<parent>

		<groupId>org.springframework.cloud</groupId>

		<artifactId>spring-cloud-starter-parent</artifactId>

		<version>Dalston.SR5</version>

		<relativePath/>

	</parent>

	<dependencies>

		<!-- Spring boot 测试用 -->

		<dependency>

			<groupId>org.springframework.boot</groupId>

			<artifactId>spring-boot-starter-test</artifactId>

			<scope>test</scope>

		</dependency>

		<!-- Stream rabbit 依赖中包含 binder-rabbit,所以只需导入此依赖即可 -->

		<dependency>

			<groupId>org.springframework.cloud</groupId>

			<artifactId>spring-cloud-starter-stream-rabbit</artifactId>

			<version>2.0.0.RELEASE</version>

		</dependency>

	</dependencies>

</project>

二、添加 Message Handler , Building 并运行

在com.cnblogs.hellxz包下添加启动类，并添加

@SpringBootApplication

@EnableBinding(Sink.class)

public class FirstStreamApp {

	public static void main(String[] args) {

		SpringApplication.run(FirstStreamApp.class, args);

	}

	@StreamListener(Sink.INPUT)

	public void receive(Object payload) {

		logger.info("Received: " + payload);

	}

}

我们通过使用@EnableBinding(Sink.class)开启了Sink的binding(绑定)，这样做会向框架发出信号，以启动与消息传递中间件的绑定，并自动创建绑定到Sink.INPUT通道的目标（即queue，topic和其他）。
我们添加了一个处理方法，去监听消息类型为String的消息，这么做是为么向你展示框架的核心特性之一——自动转换入参消息体为指定类型

启动项目，我们去查看RabbitMQ的网页 http://localhost:15672 点击Connections，发现现在已经有一个连接进来了，我们刚才的项目，在Queues中也有一个队列被创建，我的是input.anonymous.L92bTj6FRTyOC0QE-Pl0HA，我们点开那个唯一的队列，往下拉点开publish message，payload处输入一个hello world，点Publlish message发送一个消息

查看控制台，你会看到Received: hello world

对于连接非本地RabbitMQ的配置：

spring.rabbitmq.host=<rabbitMQ所在的ip>

spring.rabbitmq.port=<端口号>

spring.rabbitmq.username=<登录用户名>

spring.rabbitmq.password=<密码>

Spring Cloud Stream介绍

Spring Cloud Stream是一个用于构建消息驱动的微服务应用程序的框架，是一个基于Spring Boot 创建的独立生产级的，使用Spring Integration提供连接到消息代理的Spring应用。介绍持久发布 - 订阅(persistent publish-subscribe)的语义，消费组(consumer groups)和分区(partitions)的概念。

你可以添加@EnableBinding注解在你的应用上，从而立即连接到消息代理，在方法上添加@StreamListener以使其接收流处理事件，下面的例子展示了一个Sink应用接收外部信息

@SpringBootApplication

@EnableBinding(Sink.class)

public class VoteRecordingSinkApplication {

  public static void main(String[] args) {

    SpringApplication.run(VoteRecordingSinkApplication.class, args);

  }

  @StreamListener(Sink.INPUT)

  public void processVote(Vote vote) {

      votingService.recordVote(vote);

  }

}

@EnableBinding注解会带着一个或多个接口作为参数(举例中使用的是Sink的接口)，一个接口往往声名了输入和输出的渠道，Spring Stream提供了Source、Sink、Processor这三个接口，你也可以自己定义接口。

下面展示的是Sink的接口内容

public interface Sink {

  String INPUT = "input";

  @Input(Sink.INPUT)

  SubscribableChannel input();

}

@Input注解区分了一个输入channel，通过它接收消息到应用中，使用@Output注解区分输出channel，消息通过它离开应用，使用这两个注解可以带一个channel的名字作为参数，如果未提供channel名称，则使用带注释的方法的名称。

你可以使用Spring Cloud Stream 现成的接口，也可以使用@Autowired注入这个接口，下面在测试类中举例

@RunWith(SpringJUnit4ClassRunner.class)

@SpringBootTest

public class LoggingConsumerApplicationTests {

	@Autowired

	private Sink sink;

	@Test

	public void contextLoads() {

		assertNotNull(this.sink.input());

	}

}

主要概念(Main Concepts)

应用模型

应用程序通过 inputs 或者 outputs 来与 Spring Cloud Stream 中Binder 交互，通过我们配置来绑定，而 Spring Cloud Stream 的 Binder 负责与中间件交互。所以，我们只需要搞清楚如何与 Spring Cloud Stream 交互就可以方便使用消息驱动的方式。

抽象绑定器（The Binder Abstraction）

Spring Cloud Stream实现Kafkat和RabbitMQ的Binder实现，也包括了一个TestSupportBinder，用于测试。你也可以写根据API去写自己的Binder.

Spring Cloud Stream 同样使用了Spring boot的自动配置，并且抽象的Binder使Spring Cloud Stream的应用获得更好的灵活性，比如：我们可以在application.yml或application.properties中指定参数进行配置使用Kafka或者RabbitMQ，而无需修改我们的代码。

在前面我们测试的项目中并没有修改application.properties，自动配置得益于Spring Boot

通过 Binder ，可以方便地连接中间件，可以通过修改application.yml中的spring.cloud.stream.bindings.input.destination 来进行改变消息中间件（对应于Kafka的topic，RabbitMQ的exchanges）

在这两者间的切换甚至不需要修改一行代码。

发布-订阅(Persistent Publish-Subscribe Support)

如下图是经典的Spring Cloud Stream的发布-订阅模型，生产者生产消息发布在shared topic（共享主题）上，然后消费者通过订阅这个topic来获取消息

其中topic对应于Spring Cloud Stream中的destinations（Kafka 的topic，RabbitMQ的 exchanges）

官方文档这块原理说的有点深，就没写，详见官方文档

消费组（Consumer Groups）

尽管发布-订阅模型通过共享的topic连接应用变得很容易，但是通过创建特定应用的多个实例的来扩展服务的能力同样重要，但是如果这些实例都去消费这条数据，那么很可能会出现重复消费的问题，我们只需要同一应用中只有一个实例消费该消息，这时我们可以通过消费组来解决这种应用场景， 当一个应用程序不同实例放置在一个具有竞争关系的消费组中，组里面的实例中只有一个能够消费消息

设置消费组的配置为spring.cloud.stream.bindings.<channelName>.group，

下面举一个DD博客中的例子：

下图中，通过网络传递过来的消息通过主题，按照分组名进行传递到消费者组中

此时可以通过spring.cloud.stream.bindings.input.group=Group-A或spring.cloud.stream.bindings.input.group=Group-B进行指定消费组

所有订阅指定主题的组都会收到发布消息的一个备份，每个组中只有一个成员会收到该消息；如果没有指定组，那么默认会为该应用分配一个匿名消费者组，与所有其它组处于订阅-发布关系中。ps:也就是说如果管道没有指定消费组，那么这个匿名消费组会与其它组一起消费消息，出现了重复消费的问题。

消费者类型（Consumer Types）

1）支持有两种消费者类型：
- Message-driven (消息驱动型，有时简称为异步)
- Polled (轮询型，有时简称为 同步)
在Spring Cloud 2.0版本前只支持 Message-driven这种异步类型的消费者，消息一旦可用就会传递，并且有一个线程可以处理它；当你想控制消息的处理速度时，可能需要用到同步消费者类型。

2）持久化

一般来说所有拥有订阅主题的消费组都是持久化的，除了匿名消费组。 Binder的实现确保了所有订阅关系的消费订阅是持久的，一个消费组中至少有一个订阅了主题，那么被订阅主题的消息就会进入这个组中，无论组内是否停止。

注意：匿名订阅本身是非持久化的，但是有一些Binder的实现（比如RabbitMQ）则可以创建非持久化的组订阅

通常情况下，当有一个应用绑定到目的地的时候，最好指定消费消费组。扩展Spring Cloud Stream应用程序时，必须为每个输入绑定指定一个使用者组。这样做可以防止应用程序的实例接收重复的消息（除非需要这种行为，这是不寻常的）。
分区支持（Partitioning Support）

在消费组中我们可以保证消息不会被重复消费，但是在同组下有多个实例的时候，我们无法确定每次处理消息的是不是被同一消费者消费，分区的作用就是为了确保具有共同特征标识的数据由同一个消费者实例进行处理，当然前边的例子是狭义的，通信代理（broken topic）也可以被理解为进行了同样的分区划分。Spring Cloud Stream 的分区概念是抽象的，可以为不支持分区Binder实现（例如RabbitMQ）也可以使用分区。

注意：要使用分区处理，你必须同时对生产者和消费者进行配置。

编程模型（Programming Model）

为了理解编程模型，需要熟悉下列核心概念：

Destination Binders（目的地绑定器）：负责与外部消息系统集成交互的组件
Destination Bindings（目的地绑定）：在外部消息系统和应用的生产者和消费者之间的桥梁（由Destination Binders创建）
Message （消息）：用于生产者、消费者通过Destination Binders沟通的规范数据。

Destination Binders（目的地绑定器）：

Destination Binders是Spring Cloud Stream与外部消息中间件提供了必要的配置和实现促进集成的扩展组件。集成了生产者和消费者的消息的路由、连接和委托、数据类型转换、用户代码调用等。

尽管Binders帮我们处理了许多事情，我们仍需要对他进行配置。之后会讲
Destination Bindings （目的地绑定） ：

如前所述，Destination Bindings 提供连接外部消息中间件和应用提供的生产者和消费者中间的桥梁。

使用@EnableBinding 注解打在一个配置类上来定义一个Destination Binding，这个注解本身包含有@Configuration，会触发Spring Cloud Stream的基本配置。

接下来的例子展示完全配置且正常运行的Spring Cloud Stream应用，由INPUT接收消息转换成String 类型并打印在控制台上，然后转换出一个大写的信息返回到OUTPUT中。

@SpringBootApplication

@EnableBinding(Processor.class)

public class MyApplication {

	public static void main(String[] args) {

		SpringApplication.run(MyApplication.class, args);

	}

	@StreamListener(Processor.INPUT)

	@SendTo(Processor.OUTPUT)

	public String handle(String value) {

		System.out.println("Received: " + value);

		return value.toUpperCase();

	}

}

通过SendTo注解将方法内返回值转发到其他消息通道中，这里因为没有定义接收通道，提示消息已丢失，解决方法是新建一个接口，如下
public interface MyPipe{

    //方法1

    @Input(Processor.OUTPUT) //这里使用Processor.OUTPUT是因为要同一个管道，或者名称相同

    SubscribableChannel input();

    //还可以如下这样=====二选一即可==========

    //方法2

    String INPUT = "output";

    @Input(MyPipe.INPUT)

    SubscribableChannel input();

}
然后在在上边的方法下边加一个方法，并在@EnableBinding注解中改成@EnableBinding({Processor.class, MyPipe.class})
	@StreamListener(MyPipe.INPUT)

	public void handleMyPipe(String value) {

		System.out.println("Received: " + value);

	}

Spring Cloud Stream已经为我们提供了三个绑定消息通道的默认实现

Sink：通过指定消费消息的目标来标识消息使用者的约定。
Source：与Sink相反，用于标识消息生产者的约定。
Processor：集成了Sink和Source的作用，标识消息生产者和使用者

他们的源码分别为：

public interface Sink {

    String INPUT = "input";

    @Input("input")

    SubscribableChannel input();

}

public interface Source {

    String OUTPUT = "output";

    @Output("output")

    MessageChannel output();

}

public interface Processor extends Source, Sink {

}

Sink和Source中分别通过@Input和@Output注解定义了输入通道和输出通道，通过使用这两个接口中的成员变量来定义输入和输出通道的名称，Processor由于继承自这两个接口，所以同时拥有这两个通道。

注意：拥有多条管道的时候不能有输入输出管道名相同的，否则会出现发送消息被自己接收或报错的情况

我们可以根据上述源码的方式来定义我们自己的输入输出通道，定义输入通道需要返回SubscribaleChannel接口对象，这个接口继承自MessageChannel接口，它定义了维护消息通道订阅者的方法；定义输出通道则需要返回MessageChannel接口对象，它定义了向消息通道发送消息的方法。

自定义消息通道发送与接收

依照上面的内容，我们也可以创建自己的绑定通道 如果你实现了上边的MyPipe接口，那么直接使用这个接口就好

和主类同包下建一个MyPipe接口，实现如下

package com.cnblogs.hellxz;

import org.springframework.cloud.stream.annotation.Input;

import org.springframework.cloud.stream.messaging.Source;

import org.springframework.messaging.SubscribableChannel;

public interface MyPipe {

    //方法1

//    @Input(Source.OUTPUT) //Source.OUTPUT的值是output，我们自定义也是一样的

//    SubscribableChannel input(); //使用@Input注解标注的输入管道需要使用SubscribableChannel来订阅通道

    //========二选一使用===========

    //方法2

    String INPUT = "output";

    @Input(MyPipe.INPUT)

    SubscribableChannel input();

}

这里用Source.OUTPUT和第二种方法是一样的，我们只要将消息发送到名为output的管道中，那么监听output管道的输入流一端就能获得数据

扩展主类，添加监听output管道方法

	@StreamListener(MyPipe.INPUT)

	public void receiveFromMyPipe(Object payload){

		logger.info("Received: "+payload);

	}

在主类的头上的@EnableBinding改为@EnableBinding({Sink.class, MyPipe.class})，加入了Mypipe接口的绑定

在test/java下创建com.cnblogs.hellxz，并在包下新建一个测试类，如下

package com.cnblogs.hellxz;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.boot.test.context.SpringBootTest;

import org.springframework.cloud.stream.annotation.EnableBinding;

import org.springframework.cloud.stream.messaging.Source;

import org.springframework.messaging.support.MessageBuilder;

import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)

@EnableBinding(value = {Source.class})

@SpringBootTest

public class TestSendMessage {

    @Autowired

    private Source source; //注入接口和注入MessageChannel的区别在于发送时需不需要调用接口内的方法

    @Test

    public void testSender() {

        source.output().send(MessageBuilder.withPayload("Message from MyPipe").build());

        //假设注入了MessageChannel messageChannel; 因为绑定的是Source这个接口，

        //所以会使用其中的唯一产生MessageChannel的方法，那么下边的代码会是

        //messageChannel.send(MessageBuilder.withPayload("Message from MyPipe").build());

    }

}

启动主类，清空输出，运行测试类，然后你就会得到在主类的控制台的消息以log形式输出Message from MyPipe

我们是通过注入消息通道，并调用他的output方法声明的管道获得的MessageChannel实例，发送的消息

管道注入过程中可能会出现的问题

通过注入消息通道的方式虽然很直接，但是也容易犯错，当一个接口中有多个通道的时候，他们返回的实例都是MessageChannel，这样通过@Autowired注入的时候往往会出现有多个实例找到无法确定需要注入实例的错误，我们可以通过@Qualifier指定消息通道的名称，下面举例：

在主类包内创建一个拥有多个输出流的管道

/**

 * 多个输出管道

 */

public interface MutiplePipe {

    @Output("output1")

    MessageChannel output1();

    @Output("output2")

    MessageChannel output2();

}

创建一个测试类

@RunWith(SpringRunner.class)

@EnableBinding(value = {MutiplePipe.class}) //开启绑定功能

@SpringBootTest //测试

public class TestMultipleOutput {

    @Autowired

    private MessageChannel messageChannel;

    @Test

    public void testSender() {

        //向管道发送消息

        messageChannel.send(MessageBuilder.withPayload("produce by multiple pipe").build());

    }

}

启动测试类，会出现刚才说的不唯一的bean，无法注入

Caused by: org.springframework.beans.factory.NoUniqueBeanDefinitionException: No qualifying bean of type 'org.springframework.messaging.MessageChannel' available: expected single matching bean but found 6: output1,output2,input,output,nullChannel,errorChannel

我们在@Autowired旁边加上@Qualifier("output1")，然后测试就可以正常启动了

通过上边的错误，我们可以清楚的看到，每个MessageChannel都是使用消息通道的名字做为bean的名称。

这里我们没有使用监听这个管道，仅为了测试并发现问题

常用配置

消费组和分区的设置

给消费者设置消费组和主题

设置消费组： spring.cloud.stream.bindings.<通道名>.group=<消费组名>
设置主题： spring.cloud.stream.bindings.<通道名>.destination=<主题名>

给生产者指定通道的主题：spring.cloud.stream.bindings.<通道名>.destination=<主题名>

消费者开启分区，指定实例数量与实例索引

开启消费分区： spring.cloud.stream.bindings.<通道名>.consumer.partitioned=true
消费实例数量： spring.cloud.stream.instanceCount=1 (具体指定)
实例索引： spring.cloud.stream.instanceIndex=1 #设置当前实例的索引值

生产者指定分区键

分区键： spring.cloud.stream.bindings.<通道名>.producer.partitionKeyExpress=<分区键>
分区数量： spring.cloud.stream.bindings.<通道名>.producer.partitionCount=<分区数量>

本文参考与引用

《Spring Cloud 微服务实战》以及作者的博客

https://www.jianshu.com/p/fb7d11c7f798

https://blog.****.net/jack281706/article/details/73743148

http://www.laomn.com/article/item/33322

官方文档

码农公寓

前言