Springboot 整合 RabbitMQ ,用心看完这一篇就够了
原文链接:https://blog.csdn.net/qq_35387940/article/details/100514134
源码下载:下载
概念梳理
该篇文章内容较多,包括有 RabbitMQ 相关的一些简单理论介绍,provider 消息推送实例,consumer 消息消费实例,Direct、Topic、Fanout的使用,消息回调、手动确认等。 (但是关于 RabbitMQ 的安装,就不介绍了)
在安装完 RabbitMQ 后,输入 http://ip:15672/ ,是可以看到一个简单后台管理界面的。
在这个界面里面我们可以做些什么?
可以手动创建虚拟 host,创建用户,分配权限,创建交换机,创建队列等等,还有查看队列消息,消费效率,推送效率等等。
以上这些管理界面的操作在这篇暂时不做扩展描述,我想着重介绍后面实例里会使用到的。
首先先介绍一个简单的一个消息推送到接收的流程,提供一个简单的图:
黄色的圈圈就是我们的消息推送服务,将消息推送到 中间方框里面也就是 RabbitMQ 的服务器,然后经过服务器里面的交换机、队列等各种关系(后面会详细讲)将数据处理入列后,最终右边的蓝色圈圈消费者获取对应监听的消息。
常用的交换机有以下三种,因为消费者是从队列获取信息的,队列是绑定交换机的(一般),所以对应的消息推送/接收模式也会有以下几种:
直连型交换机,根据消息携带的路由键将消息投递给对应队列。
大致流程,有一个队列绑定到一个直连交换机上,同时赋予一个路由键 routing key 。
然后当一个消息携带着路由值为 X,这个消息通过生产者发送给交换机时,交换机就会根据这个路由值X去寻找绑定值也是 X 的队列。
扇型交换机,这个交换机没有路由键概念,就算你绑了路由键也是无视的。 这个交换机在接收到消息后,会直接转发到绑定到它上面的所有队列。
Topic Exchange**
1 | *(星号) 用来表示一个单词 (必须出现的) |
1 | 队列 Q1 绑定键为 .TT. 队列 Q2 绑定键为 TT.# |
当一个队列的绑定键为 “#”(井号) 的时候,这个队列将会无视消息的路由键,接收所有的消息。
当 * (星号) 和 # (井号) 这两个特殊字符都未在绑定键中出现的时候,此时主题交换机就拥有的直连交换机的行为。
所以主题交换机也就实现了扇形交换机的功能,和直连交换机的功能。
另外还有 Header Exchange 头交换机 ,Default Exchange 默认交换机,Dead Letter Exchange 死信交换机,这几个该篇暂不做讲述。
项目建立与 Direct 直连交换机
本次实例教程需要创建 2 个 springboot 项目,一个 rabbitmq_study_provider (生产者),一个 rabbitmq_study_consumer(消费者)。
首先创建 rabbitmq_study_provider,
pom.xml 里用到的 jar 依赖:
1 | <!--rabbitmq--> |
然后application.yml:
1 | server: |
那么怎么建一个单独的 host 呢? 假如我就是想给某个项目接入,使用一个单独 host,顺便使用一个单独的账号,就好像我文中配置的 root 这样。
其实也很简便:
virtual-host的创建:
账号 user 的创建:
然后记得给账号分配权限,指定使用某个 virtual host:
其实还可以特定指定交换机使用权等等:
回归正题,继续继续。
创建 SpringBoot 启动文件
RabbitmqSpringApplication:
1 | import org.springframework.boot.SpringApplication; |
接着我们先使用下 direct exchange (直连型交换机),创建 DirectRabbitConfig.java(对于队列和交换机持久化以及连接使用设置,在注释里有说明,后面的不同交换机的配置就不做同样说明了):
DirectRabbitConfig.java:
1 | import org.springframework.amqp.core.Binding; |
然后写个简单的接口进行消息推送(根据需求也可以改为定时任务等等,具体看需求),SendMessageController.java:
SendMessageController.java:
1 | import org.springframework.amqp.rabbit.core.RabbitTemplate; |
把 rabbitmq_study_provider 项目运行,调用下接口:
因为我们目前还没弄消费者 rabbitmq_study_consumer,消息没有被消费的,我们去 RabbitMQ 管理页面看看,是否推送成功:
再看看队列(界面上的各个英文项代表什么意思,可以自己查查哈,对理解还是有帮助的):
很好,消息已经推送到 RabbitMQ 服务器上面了。
接下来,创建 rabbitmq_study_consumer 项目:
pom.xml里的jar依赖:
1 | <!--rabbitmq--> |
然后是 application.yml:
1 | server: |
创建 Springboot 启动类
1 | import org.springframework.boot.SpringApplication; |
然后一样,创建 DirectRabbitConfig.java(消费者单纯的使用,其实可以不用添加这个配置,直接建后面的监听就好,使用注解来让监听器监听对应的队列即可。配置上了的话,其实消费者也是生成者的身份,也能推送该消息。):
DirectRabbitConfig:
1 | import org.springframework.amqp.core.Binding; |
然后是创建消息接收监听类,DirectReceiver.java:
DirectReceiver:
1 | import org.springframework.amqp.rabbit.annotation.RabbitHandler; |
然后将 rabbitmq_study_consumer 项目运行起来,可以看到把之前推送的那条消息消费下来了:
然后可以再继续调用 rabbitmq_study_provider 项目的推送消息接口,可以看到消费者即时消费消息:
那么直连交换机既然是一对一,那如果咱们配置多台监听绑定到同一个直连交互的同一个队列,会怎么样?
可以看到是实现了轮询的方式对消息进行消费,而且不存在重复消费。
Topic Exchange 主题交换机
接着,我们使用 Topic Exchange 主题交换机。
在 rabbitmq_study_provider 项目里面创建TopicRabbitConfig.java:
TopicRabbitConfig:
1 | import org.springframework.amqp.core.Binding; |
然后添加多2个接口,用于推送消息到主题交换机:
SendMessageController:
1 | @GetMapping("/sendTopicMessage1") |
生产者这边已经完事,先不急着运行,在 rabbitmq_study_consumer 项目上,创建 TopicManReceiver.java:
TopicManReceiver:
1 | import org.springframework.amqp.rabbit.annotation.RabbitHandler; |
同样,加主题交换机的相关配置,TopicRabbitConfig.java(消费者一定要加这个配置吗? 不需要的其实,理由在前面已经说过了。):
TopicRabbitConfig:
1 | import org.springframework.amqp.core.Binding; |
然后把 rabbitmq_study_provider,rabbitmq_study_consumer 两个项目都跑起来,先调用 /sendTopicMessage1 接口:
然后看消费者 rabbitmq_study_consumer 的控制台输出情况:
1 | TopicManReceiver监听队列1,绑定键为:topic.man |
所以可以看到两个监听消费者 receiver 都成功消费到了消息,因为这两个 recevier 监听的队列的绑定键都能与这条消息携带的路由键匹配上。
接下来调用接口 /sendTopicMessage2:
然后看消费者 rabbitmq_study_consumer 的控制台输出情况:
1 | TopicManReceiver 监听队列1,绑定键为:topic.man |
所以可以看到两个监听消费者只有 TopicTotalReceiver 成功消费到了消息。
Fanout Exchang 扇型交换机。
同样地,先在 rabbitmq_study_provider 项目上创建 FanoutRabbitConfig.java:
FanoutRabbitConfig:
1 | import org.springframework.amqp.core.Binding; |
然后是写一个接口用于推送消息,
SendMessageController:
1 | @GetMapping("/sendFanoutMessage") |
接着在 rabbitmq_study_consumer 项目里加上消息消费类,
FanoutReceiverA:
1 | import org.springframework.amqp.rabbit.annotation.RabbitHandler; |
FanoutReceiverB:
1 | import org.springframework.amqp.rabbit.annotation.RabbitHandler; |
FanoutReceiverC.java:
1 | import org.springframework.amqp.rabbit.annotation.RabbitHandler; |
然后加上扇型交换机的配置类,FanoutRabbitConfig.java(消费者真的要加这个配置吗? 不需要的其实,理由在前面已经说过了):
FanoutRabbitConfig:
1 | import org.springframework.amqp.core.Binding; |
最后将 rabbitmq_study_provider 和 rabbitmq_study_consumer项目都跑起来,调用下接口 /sendFanoutMessage :
然后看看 rabbitmq_study_consumer 项目的控制台情况:
可以看到只要发送到 fanoutExchange 这个扇型交换机的消息, 三个队列都绑定这个交换机,所以三个消息接收类都监听到了这条消息。
到了这里其实三个常用的交换机的使用我们已经完毕了。
消息确认机制
那么接下来我们继续讲讲消息的回调,其实就是消息确认(生产者推送消息成功,消费者接收消息成功)。
在 rabbitmq_study_provider 项目的 application.yml 文件上,加上消息确认的配置项后:
如果你们在配置确认回调,测试发现无法触发回调函数,那么存在原因也许是因为版本导致的配置项不起效,
可以把 publisher-confirms: true 替换为 publisher-confirm-type: correlated
1 | server: |
然后是配置相关的消息确认回调函数,RabbitConfig.java:
RabbitConfig:
1 | import org.springframework.amqp.core.Message; |
到这里,生产者推送消息的消息确认调用回调函数已经完毕。
可以看到上面写了两个回调函数,一个叫 ConfirmCallback ,一个叫 RetrunCallback;
那么以上这两种回调函数都是在什么情况会触发呢?
先从总体的情况分析,推送消息存在四种情况:
1 | ①消息推送到server,但是在server里找不到交换机 |
那么我先写几个接口来分别测试和认证下以上4种情况,消息确认触发回调函数的情况:
1 | ①消息推送到 server,但是在 server 里找不到交换机 |
写个测试接口,把消息推送到名为 non-existent-exchange
的交换机上(这个交换机是没有创建没有配置的):
1 | @GetMapping("/TestMessageAck") |
调用接口,查看 rabbitmq-provuder 项目的控制台输出情况(原因里面有说,没有找到交换机non-existent-exchange
):
1 | 2019-09-04 09:37:45.197 ERROR 8172 --- [ 127.0.0.1:5672] o.s.a.r.c.CachingConnectionFactory : Channel shutdown: channel error; protocol method: #method<channel.close>(reply-code=404, reply-text=NOT_FOUND - no exchange 'non-existent-exchange' in vhost 'JCcccHost', class-id=60, method-id=40) |
消息确认总结
①这种情况触发的是 ConfirmCallback 回调函数。
②消息推送到 server,找到交换机了,但是没找到队列
这种情况就是需要新增一个交换机,但是不给这个交换机绑定队列,我来简单地在 DirectRabitConfig 里面新增一个直连交换机,名叫lonelyDirectExchange
,但没给它做任何绑定配置操作:
1 | @Bean |
然后写个测试接口,把消息推送到名为 lonelyDirectExchange
的交换机上(这个交换机是没有任何队列配置的):
1 | @GetMapping("/TestMessageAck2") |
调用接口,查看 rabbitmq-provuder 项目的控制台输出情况:
1 | ConfirmCallback: 相关数据:null |
可以看到这种情况,两个函数都被调用了;
这种情况下,消息是推送成功到服务器了的,所以ConfirmCallback对消息确认情况是true;
而在RetrunCallback回调函数的打印参数里面可以看到,消息是推送到了交换机成功了,但是在路由分发给队列的时候,找不到队列,所以报了错误 NO_ROUTE 。
结论:②这种情况触发的是 ConfirmCallback 和 RetrunCallback 两个回调函数。
③消息推送到sever,交换机和队列啥都没找到
这种情况其实一看就觉得跟①很像,没错 ,③和①情况回调是一致的,所以不做结果说明了。
结论: ③这种情况触发的是 ConfirmCallback 回调函数。
④消息推送成功
那么测试下,按照正常调用之前消息推送的接口就行,就调用下 /sendFanoutMessage接口,可以看到控制台输出:
1 | ConfirmCallback: 相关数据:null |
结论: ④这种情况触发的是 ConfirmCallback 回调函数。
以上是生产者推送消息的消息确认 回调函数的使用介绍(可以在回调函数根据需求做对应的扩展或者业务数据处理)。
接下来我们继续, 消费者接收到消息的消息确认机制。
和生产者的消息确认机制不同,因为消息接收本来就是在监听消息,符合条件的消息就会消费下来。
所以,消息接收的确认机制主要存在三种模式:
①自动确认, 这也是默认的消息确认情况。 AcknowledgeMode.NONE
RabbitMQ成功将消息发出(即将消息成功写入TCP Socket)中立即认为本次投递已经被正确处理,不管消费者端是否成功处理本次投递。
所以这种情况如果消费端消费逻辑抛出异常,也就是消费端没有处理成功这条消息,那么就相当于丢失了消息。
一般这种情况我们都是使用try catch捕捉异常后,打印日志用于追踪数据,这样找出对应数据再做后续处理。
② 根据情况确认, 这个不做介绍
③ 手动确认, 这个比较关键,也是我们配置接收消息确认机制时,多数选择的模式。
消费者收到消息后,手动调用 basic.ack/basic.nack/basic.reject 后,RabbitMQ 收到这些消息后,才认为本次投递成功。
1 | basic.ack 用于肯定确认 |
消费者端以上的 3 个方法都表示消息已经被正确投递,但是 basic.ack 表示消息已经被正确处理。
而 basic.nack,basic.reject 表示没有被正确处理:
着重讲下 reject,因为有时候一些场景是需要重新入列的。
channel.basicReject(deliveryTag, true); 拒绝消费当前消息,如果第二参数传入true,就是将数据重新丢回队列里,那么下次还会消费这消息。设置false,就是告诉服务器,我已经知道这条消息数据了,因为一些原因拒绝它,而且服务器也把这个消息丢掉就行。 下次不想再消费这条消息了。
使用拒绝后重新入列这个确认模式要谨慎,因为一般都是出现异常的时候,catch异常再拒绝入列,选择是否重入列。
但是如果使用不当会导致一些每次都被你重入列的消息一直消费-入列-消费-入列这样循环,会导致消息积压。
顺便也简单讲讲 nack,这个也是相当于设置不消费某条消息。
1 | channel.basicNack(deliveryTag, false, true); |
1 | # 第一个参数依然是当前消息到的数据的唯一id; |
消息确认代码(手动确认)
在消费者项目里,
新建 MessageListenerConfig.java 上添加代码相关的配置代码:
1 | import org.springframework.amqp.core.AcknowledgeMode; |
对应的手动确认消息监听类,MyAckReceiver.java(手动确认模式需要实现 ChannelAwareMessageListener):
//之前的相关监听器可以先注释掉,以免造成多个同类型监听器都监听同一个队列。
1 | import com.rabbitmq.client.Channel; |
这时,先调用接口 /sendDirectMessage, 给直连交换机 TestDirectExchange 的队列 TestDirectQueue 推送一条消息,可以看到监听器正常消费了下来:
到这里,我们其实已经掌握了怎么去使用消息消费的手动确认了。
但是这个场景往往不够! 因为很多伙伴之前给我评论反应,他们需要这个消费者项目里面,监听的好几个队列都想变成手动确认模式,而且处理的消息业务逻辑不一样。
没有问题,接下来看代码
场景: 除了直连交换机的队列 TestDirectQueue 需要变成手动确认以外,我们还需要将一个其他的队列或者多个队列也变成手动确认,而且不同队列实现不同的业务处理。
那么我们需要做的第一步,往 SimpleMessageListenerContainer 里添加多个队列:
然后我们的手动确认消息监听类,MyAckReceiver.java 就可以同时将上面设置到的队列的消息都消费下来。
但是我们需要做不用的业务逻辑处理,那么只需要 根据消息来自的队列名进行区分处理即可,如:
1 | import com.rabbitmq.client.Channel; |
ok,这时候我们来分别往不同队列推送消息,看看效果:
调用接口 /sendDirectMessage 和 /sendFanoutMessage ,
如果你还想新增其他的监听队列,也就是按照这种方式新增配置即可(或者完全可以分开多个消费者项目去监听处理)。
好,这篇 Springboot 整合 RabbitMQ 教程就暂且到此。