SpringCloudStream消息驱动的使用以及解决消息重复消费

港控/mmm° 2023-09-30 13:59 35阅读 0赞

## 场景 ##

SpringCloudConfig集成Bus消息总线实现动态刷新配置(全局广播和定点通知)：

[SpringCloudConfig集成Bus消息总线实现动态刷新配置(全局广播和定点通知)\_霸道流氓气质的博客-CSDN博客][SpringCloudConfig_Bus_-CSDN]

在上面实现消息总线的基础上，下面学习Stream消息驱动的使用。

### Stream ###

屏蔽底层消息中间件的差异，降低切换成本，统一消息的编程模型。

官网：

[Spring Cloud Stream][]

![8a0c9c611af5b3e016b8d955d83b524a.png][]

官方定义SpringCloudStream是一个构建消息驱动微服务的框架。

应用程序通过inputs或者outputs来与SpringCloudStream中binder对象交互。

通过我们配置来binging(绑定)，而SpringCloudStream中的binder对象负责与消息中间件交互。

所以，我们只需要搞清楚如何与SpringCloudStream交互就可以方便使用消息驱动的方式。

通过使用Spring Intergration来连接消息代理中间件以实现消息事件驱动。

SpringCloudStream为一些供应商的消息中间件产品提供了个性化的自动化配置实现，引用了发布-订阅、消费组、分区的三个核心概念。

目前仅支持RabbitMQ、Kafka。

比方说一个系统中用到了RabbitMQ和Kafka，由于这两个消息中间件的架构上的不同。

这些中间件的差异性导致我们实际项目开发给我们造成了一定的困扰，我们如果使用了两个消息队列中的一种，后面的业务需求，想往另一种消息队列进行迁移，这时候无疑是灾难性的，因为它跟我们的系统耦合了，这时候springcloudstream提供了一种解耦合的方式。

### 绑定器 ###

在没有绑定器这个概念的情况下，我们的SpringBoot应用要直接与消息中间件进行消息交互的时候，由于各消息中间件构建的初衷不同，它们的实现细节上会有较大的差异性。

通过定义绑定器作为中间件，完美地实现了应用与消息中间件细节之间的隔离。

通过向应用程序保留统一的Channel通道，使得应用程序不需要再考虑各种不同的消息中间件实现。

### 发布订阅模式 ###

Stream中的消息通信方式遵循了发布-订阅模式。

使用Topic主题进行广播，在RabbitMQ就是Exchange,在Kafka中就是Topic。

### 标准流程 ###

![626161a59d3f5295b1fd2c9387cd91e5.png][]

Binder:很方便的连接中间件，屏蔽差异。

Channel:通道，是队列Quene的一种抽象，在消息通讯系统中就是实现存储和转发的媒介，通过Channel对队列进行配置。

Source和Sink:简单的可以理解为参考对象是SpringCloudStream自身，从Stream发布消息就是输出，接受消息就是输入。

### 编码API和常用注解 ###

Middleware:中间件，目前只支持RabbitMQ和Kafka。

Binder:Binder是应用与消息中间件之间的封装，目前实现了Kafka和RabbitMQ的Binder,通过Binder可以很方便的连接中间件，可以动态的改变消息类型（对应于Kafka的topic，RabbitMQ的exchange),这些都可以通过配置文件来实现。

@Input:注解标识输入通道，通过该输入通道接收到的消息进入应用程序。

@Output:注解标识输出通道，发布的消息将通过该通道离开应用程序。

@StreamListener:监听队列，用于消费者的队列的消息接收。

@EnableBinding:指通道channel和exchange绑定在一起。

注：

博客：  
[霸道流氓气质的博客\_CSDN博客-C\#,架构之路,SpringBoot领域博主][CSDN_-C_SpringBoot]  
关注公众号  
霸道的程序猿  
获取编程相关电子书、教程推送与免费下载。

## 实现 ##

1、Rabbitmq环境搭建

Windows上安装rabbirmq(包括安装erlong环境与配置环境变量)：

[Windows上安装rabbirmq(包括安装erlong环境与配置环境变量)\_霸道流氓气质的博客-CSDN博客\_rabbitmq默认安装路径][Windows_rabbirmq_erlong_-CSDN_rabbitmq]

2、新建消息驱动生产者

参考前面新建模块的流程，新建cloud-stream-rabbitmq-consumer8802

修改其pom文件添加stream依赖

<dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-stream-rabbit</artifactId>
            </dependency>

完整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">
        <parent>
            <artifactId>SpringCloudDemo</artifactId>
            <groupId>com.badao</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>cloud-stream-rabbitmq-provider8801</artifactId>
    
        <properties>
            <maven.compiler.source>8</maven.compiler.source>
            <maven.compiler.target>8</maven.compiler.target>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-actuator</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-stream-rabbit</artifactId>
            </dependency>
        </dependencies>
    </project>

然后新建并修改配置文件application.yml

server:
      port: 8801
    
    spring:
      application:
        name: cloud-stream-provider
      cloud:
          stream:
            binders: # 在此处配置要绑定的rabbitmq的服务信息；
              defaultRabbit: # 表示定义的名称，用于于binding整合
                type: rabbit # 消息组件类型
                environment: # 设置rabbitmq的相关的环境配置
                  spring:
                    rabbitmq:
                      host: localhost
                      port: 5672
                      username: guest
                      password: guest
            bindings: # 服务的整合处理
              output: # 这个名字是一个通道的名称
                destination: studyExchange # 表示要使用的Exchange名称定义
                content-type: application/json # 设置消息类型，本次为json，文本则设置“text/plain”
                binder: defaultRabbit # 设置要绑定的消息服务的具体设置
    
    eureka:
      client: # 客户端进行Eureka注册的配置
        service-url:
          defaultZone: http://localhost:7001/eureka
      instance:
        lease-renewal-interval-in-seconds: 2 # 设置心跳的时间间隔（默认是30秒）
        lease-expiration-duration-in-seconds: 5 # 如果现在超过了5秒的间隔（默认是90秒）
        instance-id: send-8801.com  # 在信息列表时显示主机名称
        prefer-ip-address: true     # 访问的路径变为IP地址

这里要将rabbitmq的配置修改为自己对应的，这里是本地的地址。

新建service并添加发送消息方法

package com.badao.springclouddemo.service;
    
    
    public interface IMessageProvider
    {
        public String send();
    }

新建service的impl，实现send方法，这里要添加注解@EnableBingding

package com.badao.springclouddemo.service.impl;
    
    import com.badao.springclouddemo.service.IMessageProvider;
    import org.springframework.cloud.stream.annotation.EnableBinding;
    import org.springframework.integration.support.MessageBuilderFactory;
    import org.springframework.messaging.MessageChannel;
    import org.springframework.integration.support.MessageBuilder;
    import javax.annotation.Resource;
    import org.springframework.cloud.stream.messaging.Source;
    
    import javax.annotation.Resource;
    import java.util.UUID;
    
    
    @EnableBinding(Source.class) //定义消息的推送管道
    public class MessageProviderImpl implements IMessageProvider
    {
        @Resource
        private MessageChannel output; // 消息发送管道
    
        @Override
        public String send()
        {
            String serial = UUID.randomUUID().toString();
            output.send(MessageBuilder.withPayload(serial).build());
            System.out.println("*****serial: "+serial);
            return null;
        }
    }

注意这里发送消息的方式

output.send(MessageBuilder.withPayload(serial).build());

这里使用方式可以参考官网或者如下中文教程地址：

[Spring Cloud Stream中文指导手册][Spring Cloud Stream 1]

![e2b564190399f4443f85c7fe68ca7664.png][]

新建controller用来调用发送消息的service

package com.badao.springclouddemo.controller;
    
    import com.badao.springclouddemo.service.IMessageProvider;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.annotation.Resource;
    
    @RestController
    public class SendMessageController
    {
        @Resource
        private IMessageProvider messageProvider;
    
        @GetMapping(value = "/sendMessage")
        public String sendMessage()
        {
            return messageProvider.send();
        }
    
    }

新建主启动类

package com.badao.springclouddemo;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class StreamMQMain8801
    {
        public static void main(String[] args)
        {
            SpringApplication.run(StreamMQMain8801.class,args);
        }
    }

3、新建消息驱动消费者

参考上面新建子模块的流程，新建cloud-stream-rabbitmq-consumer8802

同上一样修改其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">
        <parent>
            <artifactId>SpringCloudDemo</artifactId>
            <groupId>com.badao</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>cloud-stream-rabbitmq-consumer8802</artifactId>
    
        <properties>
            <maven.compiler.source>8</maven.compiler.source>
            <maven.compiler.target>8</maven.compiler.target>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-stream-rabbit</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-actuator</artifactId>
            </dependency>
        </dependencies>
    </project>

新建并修改其application.yml

server:
      port: 8802
    
    spring:
      application:
        name: cloud-stream-consumer
      cloud:
          stream:
            binders: # 在此处配置要绑定的rabbitmq的服务信息；
              defaultRabbit: # 表示定义的名称，用于于binding整合
                type: rabbit # 消息组件类型
                environment: # 设置rabbitmq的相关的环境配置
                  spring:
                    rabbitmq:
                      host: localhost
                      port: 5672
                      username: guest
                      password: guest
            bindings: # 服务的整合处理
              input: # 这个名字是一个通道的名称
                destination: studyExchange # 表示要使用的Exchange名称定义
                content-type: application/json # 设置消息类型，本次为对象json，如果是文本则设置“text/plain”
                binder: defaultRabbit # 设置要绑定的消息服务的具体设置
    
     
    
    eureka:
      client: # 客户端进行Eureka注册的配置
        service-url:
          defaultZone: http://localhost:7001/eureka
      instance:
        lease-renewal-interval-in-seconds: 2 # 设置心跳的时间间隔（默认是30秒）
        lease-expiration-duration-in-seconds: 5 # 如果现在超过了5秒的间隔（默认是90秒）
        instance-id: receive-8802.com  # 在信息列表时显示主机名称
        prefer-ip-address: true     # 访问的路径变为IP地址

这里只需要新建controller用来进行消息接收，需要新增@EnableBind(Sink.class)注解

并且在消息接收的方法上添加@StreamListener(Sink.INPUT)注解

package com.badao.springclouddemo.controller;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.cloud.stream.annotation.EnableBinding;
    import org.springframework.cloud.stream.annotation.StreamListener;
    import org.springframework.cloud.stream.messaging.Sink;
    import org.springframework.messaging.Message;
    import org.springframework.stereotype.Component;
    
    @Component
    @EnableBinding(Sink.class)
    public class ReceiveMessageListenerController
    {
        @Value("${server.port}")
        private String serverPort;
    
        @StreamListener(Sink.INPUT)
        public void input(Message<String> message)
        {
            System.out.println("消费者1号,----->接受到的消息: "+message.getPayload()+"\t  port: "+serverPort);
        }
    }

然后新建主启动类

package com.badao.springclouddemo;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class StreamMQMain8802
    {
        public static void main(String[] args)
        {
            SpringApplication.run(StreamMQMain8802.class,args);
        }
    }

4、测试消息生产者和消费者发送消息效果

启动Eureka Server7001、消息驱动生产者8801、消息驱动消费者8802，然后调用8801的接口发送消息

[http://127.0.0.1:8801/sendMessage][http_127.0.0.1_8801_sendMessage]

可以看到8801发送成功

![290f7ecb58c7f8430d2454f9846e6141.png][]

而在8802上能收到消息

![43845ab1d32997b91276e64ba039c38c.png][]

5、消息重复消费

参考上面新建消息驱动消费者8802的过程，再复制出一个一模一样的消息驱动消费者8803

然后再进行上面的过程会发现

![0862ec40eb06d475b1f85d00c56d7f26.gif][]

在8802和8803上会收到两套一模一样的消息，如果该消息是用在下订单支付服务上，就会导致

多个重复的订单生成。

所以如何应对这种消息重复消费的场景下的处理。

导致原因：

默认分组下group是不同的，可以登录rabbitmq的web页面进行查看

![0c58d60555ebb9abe668e2e35ae95edc.png][]

可以看到这两个消费者属于两个不同的组。

解决方案：

自定义配置分组，将其分在一个组，就能保证消息只会被其中一个应用消费一次，不同的组是可以消费的，同一个组内

会发生竞争关系，只有其中一个可以消费。

修改消息驱动消费者8802和8803的application.ym配置文件，在bindings下新增group配置，使其在同一个组内

![0aacb82415b408ac22d0f987a8908107.png][]

修改之后完整的配置文件

server:
      port: 8802
    
    spring:
      application:
        name: cloud-stream-consumer
      cloud:
          stream:
            binders: # 在此处配置要绑定的rabbitmq的服务信息；
              defaultRabbit: # 表示定义的名称，用于于binding整合
                type: rabbit # 消息组件类型
                environment: # 设置rabbitmq的相关的环境配置
                  spring:
                    rabbitmq:
                      host: localhost
                      port: 5672
                      username: guest
                      password: guest
            bindings: # 服务的整合处理
              input: # 这个名字是一个通道的名称
                destination: studyExchange # 表示要使用的Exchange名称定义
                content-type: application/json # 设置消息类型，本次为对象json，如果是文本则设置“text/plain”
                binder: defaultRabbit # 设置要绑定的消息服务的具体设置
                group: badaodechengxvyuan
    
    
    eureka:
      client: # 客户端进行Eureka注册的配置
        service-url:
          defaultZone: http://localhost:7001/eureka
      instance:
        lease-renewal-interval-in-seconds: 2 # 设置心跳的时间间隔（默认是30秒）
        lease-expiration-duration-in-seconds: 5 # 如果现在超过了5秒的间隔（默认是90秒）
        instance-id: receive-8802.com  # 在信息列表时显示主机名称
        prefer-ip-address: true     # 访问的路径变为IP地址

修改之后再查看rabbitmq时就看到只有一个组了

![6b9cfa9dfcd59a987fbfbe36dbec6bc8.png][]

此时再进行测试就不会有重复消费现象了

![fde677134104936234fdc4739dc039ab.gif][]

[SpringCloudConfig_Bus_-CSDN]: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/125079775
[Spring Cloud Stream]: https://spring.io/projects/spring-cloud-stream#overview
[8a0c9c611af5b3e016b8d955d83b524a.png]: https://img-blog.csdnimg.cn/img_convert/8a0c9c611af5b3e016b8d955d83b524a.png
[626161a59d3f5295b1fd2c9387cd91e5.png]: https://img-blog.csdnimg.cn/img_convert/626161a59d3f5295b1fd2c9387cd91e5.png
[CSDN_-C_SpringBoot]: https://blog.csdn.net/badao_liumang_qizhi
[Windows_rabbirmq_erlong_-CSDN_rabbitmq]: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/124411641
[Spring Cloud Stream 1]: https://m.wang1314.com/doc/webapp/topic/20971999.html
[e2b564190399f4443f85c7fe68ca7664.png]: https://img-blog.csdnimg.cn/img_convert/e2b564190399f4443f85c7fe68ca7664.png
[http_127.0.0.1_8801_sendMessage]: http://127.0.0.1:8801/sendMessage
[290f7ecb58c7f8430d2454f9846e6141.png]: https://img-blog.csdnimg.cn/img_convert/290f7ecb58c7f8430d2454f9846e6141.png
[43845ab1d32997b91276e64ba039c38c.png]: https://img-blog.csdnimg.cn/img_convert/43845ab1d32997b91276e64ba039c38c.png
[0862ec40eb06d475b1f85d00c56d7f26.gif]: https://img-blog.csdnimg.cn/img_convert/0862ec40eb06d475b1f85d00c56d7f26.gif
[0c58d60555ebb9abe668e2e35ae95edc.png]: https://img-blog.csdnimg.cn/img_convert/0c58d60555ebb9abe668e2e35ae95edc.png
[0aacb82415b408ac22d0f987a8908107.png]: https://img-blog.csdnimg.cn/img_convert/0aacb82415b408ac22d0f987a8908107.png
[6b9cfa9dfcd59a987fbfbe36dbec6bc8.png]: https://img-blog.csdnimg.cn/img_convert/6b9cfa9dfcd59a987fbfbe36dbec6bc8.png
[fde677134104936234fdc4739dc039ab.gif]: https://img-blog.csdnimg.cn/img_convert/fde677134104936234fdc4739dc039ab.gif