一、发送者的可靠性
- 如何确保MQ消息可靠性?
- 假设发送失败,是否拥有兜底方案?
- 消息流转流程:
- 发送消息时丢失:
- 发送消息时连接MQ失败;
- 发送消息到达MQ后未找到Exchange;
- 发送消息到达MQ的Exchange后,未找到合适的Queue
- 消息到达MQ后,处理消息的进程发生异常;
- MQ导致消息丢失:
- 消息到达MQ,保存到队列后,尚未消费就突然宕机
- 消费者处理消息时:
- 消息接收后尚未处理突然宕机
- 消息接收后处理过程中抛出异常
- 总结:
- 确保生产者一定把消息发送到MQ
- 确保MQ不会将消息弄丢
- 确保消费者一定要处理消息
1.生产者重试机制
- 问题:发消息时,网络故障,与MQ连接中断。
- 解决:SpringAMQP提供了消息发送重试机制。即:当RabbitTemplate与MQ连接超时后,多次重试。
spring:
rabbitmq:
connection-timeout: 1s # 设置MQ的连接超时时间
template:
retry:
enabled: true # 开启超时重试机制
initial-interval: 1000ms # 失败后的初始等待时间
multiplier: 1 # 失败后下次的等待时长倍数,下次等待时长 = initial-interval * multiplier
max-attempts: 3 # 最大重试次数
- 注:SpringAMQP提供的重试机制是阻塞式的重试,即:多次重试等待的过程中,线程是被阻塞的。
2.生产者确认机制
一般来讲,生产者与MQ间的网路连接顺畅,基本不会出现发送消息丢失的情况。
不过,仍存在在少数情况:①MQ内部处理消息的进程发生了异常;②消息到达MQ后未找到Exchange;③消息到达MQ的Exchange后,未找到合适的Queue。
RabbitMQ提供了生产者消息确认机制,包括Publisher Confirm和Publisher Return两种。开启后,MQ会根据消息处理的情况返回不同的回执。
- 消息投递到MQ,但路由失败,会通过Publisher Return返回异常信息,同时返回ack的确认信息,代表投递成功;
- 临时消息到了MQ,且入队成功,返回ACK,告知投递成功;
- 持久消息到了MQ,且入队完成持久化,返回ACK ,告知投递成功;
- 其它情况都会返回NACK,告知投递失败。
ack和nack属于Publisher Confirm机制,ack是投递成功;nack是投递失败。而return则属于Publisher Return机制。默认两种机制都是关闭状态,需要通过配置文件来开启。
3.实现生产者确认
- 开启生产者确认
spring:
rabbitmq:
publisher-confirm-type: correlated # 开启publisher confirm机制,并设置confirm类型
# none:关闭confirm机制
# simple:同步阻塞等待MQ的回执
# correlated:MQ异步回调返回回执,推荐
publisher-returns: true # 开启publisher return机制
- 定义ReturnCallback
每个RabbitTemplate只能配置一个ReturnCallback,在配置类中统一设置。
// 在publisher模块定义一个配置类:
package com.itheima.publisher.config;
import lombok.AllArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.amqp.core.ReturnedMessage;
import org.springframework.amqp.rabbit.core.RabbitTemplate;
import org.springframework.context.annotation.Configuration;
import javax.annotation.PostConstruct;
@Slf4j
@AllArgsConstructor
@Configuration
public class MqConfig {
private final RabbitTemplate rabbitTemplate;
@PostConstruct
public void init(){
rabbitTemplate.setReturnsCallback(new RabbitTemplate.ReturnsCallback() {
@Override
public void returnedMessage(ReturnedMessage returned) {
log.error("触发return callback,");
log.debug("exchange: {}", returned.getExchange());
log.debug("routingKey: {}", returned.getRoutingKey());
log.debug("message: {}", returned.getMessage());
log.debug("replyCode: {}", returned.getReplyCode());
log.debug("replyText: {}", returned.getReplyText());
}
});
}
}
- 定义ConfirmCallback
每个消息发送时的处理逻辑不一定相同,因此ConfirmCallback需要在每次发消息时定义。在调用RabbitTemplate中的convertAndSend方法时,多传递一个参数:
CorrelationData中包含两个核心的东西:
id:消息的唯一标示,MQ对不同的消息的回执以此做判断,避免混淆
SettableListenableFuture:回执结果的Future对象
将来MQ的回执就会通过这个Future来返回,可提前给CorrelationData中的Future添加回调函数来处理消息回执:
// 新建一个测试,向系统自带的交换机发送消息,并且添加ConfirmCallback:
@Test
void testPublisherConfirm() {
// 1.创建CorrelationData
CorrelationData cd = new CorrelationData();
// 2.给Future添加ConfirmCallback
cd.getFuture().addCallback(new ListenableFutureCallback<CorrelationData.Confirm>() {
@Override
public void onFailure(Throwable ex) {
// 2.1.Future发生异常时的处理逻辑,基本不会触发
log.error("send message fail", ex);
}
@Override
public void onSuccess(CorrelationData.Confirm result) {
// 2.2.Future接收到回执的处理逻辑,参数中的result就是回执内容
if(result.isAck()){ // result.isAck(),boolean类型,true代表ack回执,false 代表 nack回执
log.debug("发送消息成功,收到 ack!");
}else{ // result.getReason(),String类型,返回nack时的异常描述
log.error("发送消息失败,收到 nack, reason : {}", result.getReason());
}
}
});
// 3.发送消息
rabbitTemplate.convertAndSend("hmall.direct", "q", "hello", cd);
}
由于传递的RoutingKey是错误的,路由失败后,触发了return callback,同时也收到了ack。当修改为正确的RoutingKey以后,就不会触发return callback了,只收到ack。而如果连交换机都是错误的,则只会收到nack。
注:
生产者确认比较消耗MQ性能,一般不建议开启。而且大家思考一下触发确认的几种情况:
- 路由失败:一般是因为RoutingKey错误导致,往往是编程导致;
- 交换机名称错误:同样是编程错误导致;
- MQ内部故障:这种需要处理,但概率往往较低。
只有对消息可靠性要求非常高的业务才需要开启,而且仅仅需要开启ConfirmCallback处理nack就可以了。
二、MQ的可靠性
MQ在消息存储方面也得要可靠。
1.数据持久化
MQ的数据默认在内存存储,重启后会消失。有下面三点来保证持久化。
- 交换机持久化
在控制台的Exchanges页面,添加交换机时可以配置交换机的Durability参数:Durable是持久化模式,Transient是临时模式。
- 队列持久化
在控制台的Queues页面,添加队列时,同样可以配置队列的Durability参数:
- 消息持久化
发送消息的时候,可添加参数,而消息的持久化是要配置一个properties:
在开启持久化机制后,若同时还开启了生产者确认,那么MQ会在消息持久化以后才发送ACK回执,进一步确保消息的可靠性。
不过出于性能考虑,为减少IO次数,MQ的消息并不是逐条持久化到数据库的,而是每隔一段时间批量持久化。一般间隔100毫秒,这就会导致ACK有一定的延迟,因此建议生产者确认全部采用异步方式。
2.LazyQueue
RabbitMQ默认将接收到的信息保存在内存中以降低消息收发的延迟。但有时会导致消息积压,比如:
①消费者宕机或网络故障;②消息发送量激增,超过了消费者处理速度;③消费者处理业务发生阻塞。
PageOut:消息堆积太多,内存爆了往磁盘上写的行为。
PageOut耗时,且阻塞队列进程。
出现PageOut耗时,RabbitMQ不会再处理新消息,生产者的所有请求都会被阻塞。
解决:RabbitMQ从3.6.0版本开始,增加了Lazy Queues的模式,也就是惰性队列。
特征:
收到消息后直接存入磁盘而非内存;
消费者要消费消息时才会从磁盘中读取并加载到内存(也就是懒加载);
支持数百万条的消息存储。
从3.12版本之后,LazyQueue成为所有队列的默认格式。推荐所有队列都设置为LazyQueue模式。
- 控制台配置Lazy模式
添加队列的时候,添加x-queue-mod=lazy参数即可设置队列为Lazy模式:
- 代码配置Lazy模式
// 利用SpringAMQP声明队列的时,添加x-queue-mod=lazy参数也可设置队列为Lazy模式:
@Bean
public Queue lazyQueue(){
return QueueBuilder
.durable("lazy.queue")
.lazy() // 开启Lazy模式
.build();
}
底层代码:
基于注解声明队列并设置为Lazy模式:
@RabbitListener(queuesToDeclare = @Queue(
name = "lazy.queue",
durable = "true",
arguments = @Argument(name = "x-queue-mode", value = "lazy")
))
public void listenLazyQueue(String msg){
log.info("接收到 lazy.queue的消息:{}", msg);
}
- 更新已有队列为lazy模式
已存在的队列也可配置lazy模式,但要通过设置policy实现。
rabbitmqctl set_policy Lazy "^lazy-queue$" '{"queue-mode":"lazy"}' --apply-to queues
# rabbitmqctl :RabbitMQ的命令行工具
# set_policy :添加一个策略
# Lazy :策略名称,可以自定义
# "^lazy-queue$" :用正则表达式匹配队列的名字
# {"queue-mode":"lazy"} :设置队列模式为lazy模式
# --apply-to queues:策略的作用对象,是所有的队列
也可在控制台配置policy,进入在控制台的Admin页面,点击Policies,即可添加配置:
三、消费者的可靠性
消费者有没有正确消费消息,RabbitMQ需要知道,比如:
①消息投递的过程中出现了网络故障
②消费者接收到消息后突然宕机
③消费者接收到消息后,因处理不当导致异常;等
1、消费者确认机制
为确认消费者是否成功处理消息,RabbitMQ提供了消费者确认机制(Consumer Acknowledgement)。即:处理消息后,应有回执告知消息处理状态
ack:成功处理消息,RabbitMQ从队列中删除该消息
nack:消息处理失败,RabbitMQ需要再次投递消息
reject:消息处理失败并拒绝该消息,RabbitMQ从队列中删除该消息
一般reject用的较少,除非是消息格式有问题,那就是开发问题。因此大多数情况下需将消息处理的代码通过try catch机制捕获,消息处理成功时返回ack,处理失败时返回nack.
由于消息回执的处理代码比较统一,因此SpringAMQP帮我们实现了消息确认。并允许通过配置文件设置ACK处理方式,有三种模式:
none:不处理。即消息投递给消费者后立刻ack,消息会立刻从MQ删除。非常不安全,不建议使用
manual:手动模式。需要自己在业务代码中调用api,发送`ack`或`reject`,存在业务入侵,但更灵活
auto:自动模式。SpringAMQP利用AOP对我们的消息处理逻辑做了环绕增强,当业务正常执行时则自动返回ack. 当业务出现异常时,根据异常判断返回不同结果:
业务异常,会自动返回nack;
消息处理或校验异常,自动返回reject;
- 通过下面的配置可以修改SpringAMQP的ACK处理方式:
spring:
rabbitmq:
listener:
simple:
acknowledge-mode: none # 不做处理
- 测试
在异常位置打断点,发送消息,程序卡在断点,可发现此时消息状态为unacked(未确定状态):
放行后,由于抛出的是消息转换异常,因此Spring会自动返回reject,所以消息依然会被删除:
将异常改为RuntimeException类型:
@RabbitListener(queues = "simple.queue")
public void listenSimpleQueueMessage(String msg) throws InterruptedException {
log.info("spring 消费者接收到消息:【" + msg + "】");
if (true) {
throw new RuntimeException("故意的");
}
log.info("消息处理完成");
}
在异常位置打断点,然后再次发送消息测试,程序卡在断点时,可以发现此时消息状态为unacked(未确定状态):
放行以后,由于抛出的是业务异常,所以Spring返回ack,最终消息恢复至Ready状态,并且没有被RabbitMQ删除:
把配置改为auto时,消息处理失败后,会回到RabbitMQ,并重新投递到消费者。
2、失败重试机制
消费者异常后,消息会不断requeue(重入队)到队列,再重发给消费者。若消费者再次执行依然出错,消息会再次requeue到队列,再次投递,直到消息处理成功为止。
若一直无法执行,则消息requeue就无限循环,导致MQ的消息处理飙升,带来不必要的压力:
当然,极端情况概率极低。但Spring提供了消费者失败重试机制:在消费者出现异常时利用本地重试,而不是无限制的requeue到mq队列。
修改consumer服务的application.yml文件,添加内容:
spring:
rabbitmq:
listener:
simple:
retry:
enabled: true # 开启消费者失败重试
initial-interval: 1000ms # 初识的失败等待时长为1秒
multiplier: 1 # 失败的等待时长倍数,下次等待时长 = multiplier * last-interval
max-attempts: 3 # 最大重试次数
stateless: true # true无状态;false有状态。如果业务中包含事务,这里改为false
- 重启consumer服务来测试:
①消费者失败后消息没重新回到MQ无限重新投递,而是在本地重试了3次;
②本地重试3次后,抛出了AmqpRejectAndDontRequeueException。查看RabbitMQ控制台,发现消息被删,说明最后SpringAMQP返回的是reject;
- 结论:
- 开启本地重试时,消息处理过程中抛出异常,不会requeue到队列,而是在消费者本地重试;
- 重试达到最大次数后,Spring会返回reject,消息会被丢弃;
3、失败处理策略
问题:在高消息可靠性的场景下,超过最大重试次数后,丢弃消息行为不合适。
解决:Spring允许自定义重试次数耗尽后的消息处理策略。
- 由MessageRecovery接口来定义的,有3个不同实现:
- RejectAndDontRequeueRecoverer:重试耗尽后,直接reject,丢弃消息。默认;
- ImmediateRequeueMessageRecoverer:重试耗尽后,返回nack,消息重新入队;
- RepublishMessageRecoverer:重试耗尽后,将失败消息投递到指定的交换机。
常用处理方案:RepublishMessageRecoverer,失败后将消息投递到指定的,专门存放异常消息的队列,后续由人工集中处理。
- 在consumer服务中定义处理失败消息的交换机和队列
@Bean
public DirectExchange errorMessageExchange(){
return new DirectExchange("error.direct");
}
@Bean
public Queue errorQueue(){
return new Queue("error.queue", true);
}
@Bean
public Binding errorBinding(Queue errorQueue, DirectExchange errorMessageExchange){
return BindingBuilder.bind(errorQueue).to(errorMessageExchange).with("error");
}
- 定义一个RepublishMessageRecoverer,关联队列和交换机
@Bean
public MessageRecoverer republishMessageRecoverer(RabbitTemplate rabbitTemplate){
return new RepublishMessageRecoverer(rabbitTemplate, "error.direct", "error");
}
package com.itheima.consumer.config;
import org.springframework.amqp.core.Binding;
import org.springframework.amqp.core.BindingBuilder;
import org.springframework.amqp.core.DirectExchange;
import org.springframework.amqp.core.Queue;
import org.springframework.amqp.rabbit.core.RabbitTemplate;
import org.springframework.amqp.rabbit.retry.MessageRecoverer;
import org.springframework.amqp.rabbit.retry.RepublishMessageRecoverer;
import org.springframework.context.annotation.Bean;
@Configuration
@ConditionalOnProperty(name = "spring.rabbitmq.listener.simple.retry.enabled", havingValue = "true")
public class ErrorMessageConfig {
@Bean
public DirectExchange errorMessageExchange(){
return new DirectExchange("error.direct");
}
@Bean
public Queue errorQueue(){
return new Queue("error.queue", true);
}
@Bean
public Binding errorBinding(Queue errorQueue, DirectExchange errorMessageExchange){
return BindingBuilder.bind(errorQueue).to(errorMessageExchange).with("error");
}
@Bean
public MessageRecoverer republishMessageRecoverer(RabbitTemplate rabbitTemplate){
return new RepublishMessageRecoverer(rabbitTemplate, "error.direct", "error");
}
}
4、业务幂等性
幂等性:在程序开发中,同一个业务,执行一次或多次,其对业务状态的影响是一致的。如:根据id删除数据;查询数据;新增数据
但数据的更新往往不是幂等的,重复执行可造成不一样的后果。如:订单取消,恢复库存,会出现增加的情况。
实际场景中,由于意外经常会出现业务被重复执行的情况,例如:服务间调用的重试;MQ消息的重复投递等;
如:用户支付后,系统改订单为已支付状态,但出现故障,商家继续投递交易服务,在消费者接收前,顾客退款,然后消息接收后改为已支付状态。
- 唯一消息ID
给每一条消息生成唯一id,与消息一起投递,消费者接收到消息后处理自己的业务,处理成功将消息ID存到数据库,若下次收到相同消息,去数据库查询判断是否存在,存在则为重复消息放弃处理。
SpringAMQP的MessageConverter自带了MessageID的功能,我们只要开启这个功能即可。
// 以Jackson的消息转换器为例:
@Bean
public MessageConverter messageConverter(){
// 1.定义消息转换器
Jackson2JsonMessageConverter jjmc = new Jackson2JsonMessageConverter();
// 2.配置自动创建消息id,用于识别不同消息,也可以在业务中基于ID判断是否是重复消息
jjmc.setCreateMessageIds(true);
return jjmc;
}
- 业务判断
基于业务本身的逻辑或状态来判断是否是重复的请求或消息,不同的业务场景判断的思路也不一样。
如当前案例中,处理消息的业务逻辑是把订单状态从未支付修改为已支付。因此可在执行业务时判断订单状态是否是未支付,如果不是则证明订单已经被处理过,无需重复处理。
消息ID的方案需要改造原有数据库,所以更推荐使用业务判断的方案。
以支付修改订单的业务为例,我们需要修改OrderServiceImpl中的markOrderPaySuccess方法:
@Override
public void markOrderPaySuccess(Long orderId) {
// 1.查询订单
Order old = getById(orderId);
// 2.判断订单状态
if (old == null || old.getStatus() != 1) {
// 订单不存在或者订单状态不是1,放弃处理
return;
}
// 3.尝试更新订单
Order order = new Order();
order.setId(orderId);
order.setStatus(2);
order.setPayTime(LocalDateTime.now());
updateById(order);
}
可能存在线程安全问题,因此可合并为:
@Override
public void markOrderPaySuccess(Long orderId) {
// UPDATE `order` SET status = ? , pay_time = ? WHERE id = ? AND status = 1
lambdaUpdate()
.set(Order::getStatus, 2)
.set(Order::getPayTime, LocalDateTime.now())
.eq(Order::getId, orderId)
.eq(Order::getStatus, 1)
.update();
}
上述代码等同于这样的SQL语句:
UPDATE `order` SET status = ? , pay_time = ? WHERE id = ? AND status = 1
在where条件中除了判断id以外,还加上了status必须为1的条件。若条件不符(说明订单已支付),则SQL匹配不到数据,根本不会执行。
5、兜底方案
MQ通知不一定发送到交易服务,那交易服务就自己主动去查询状态。这样即便MQ通知失败,依然能通过主动查询来保证订单状态的一致。
流程如下:
通常采取定时任务定期查询,如每隔20秒就查询一次,并判断支付状态。如果发现订单已经支付,则立刻更新订单状态为已支付即可。
- 支付服务与交易服务之间的订单状态一致性是如何保证的?
- 首先,支付服务会在用户支付成功后利用MQ消息通知交易服务,完成订单状态同步。
- 其次,为保证消息可靠性,采用了生产者确认机制、消费者确认、消费者失败重试等策略,确保消息投递的可靠性。
- 最后,还在交易服务设置了定时任务,定期查询订单支付状态。即便MQ通知失败,还可利用定时任务作兜底方案,确保订单支付状态的最终一致性。
四、延迟消息
1、死信交换机和延迟消息
- 死信交换机
死信交换机(Dead Letter Exchange):如果队列通过dead-letter-exchange属性指定了一个交换机,那么该队列中的死信就会投递到这个交换机中。
死信(满足以下之一):
1.消费者使用basic.reject或 basic.nack声明消费失败,并且消息的requeue参数设置为false;
2.消息是一个过期消息,超时无人消费;
3.要投递的队列消息满了,无法投递。
死信交换机作用:
1.收集那些因处理失败而被拒绝的消息
2.收集那些因队列满了而被拒绝的消息
3.收集因TTL(有效期)到期的消息
- 延迟消息
死信交换机可当做一种消息处理的最终兜底方案,与消费者重试时讲的RepublishMessageRecoverer作用类似。
有一场景:
有一组绑定的交换机(ttl.fanout)和队列(ttl.queue)。但是ttl.queue没有消费者监听,而是设定了死信交换机hmall.direct,而队列direct.queue1则与死信交换机绑定,RoutingKey是blue:
假如现在发送一条消息到ttl.fanout,RoutingKey为blue,并设置消息有效期为5000毫秒:
尽管ttl.fanout不需要RoutingKey,但当消息变为死信并投递到死信交换机时,会沿用之前的RoutingKey,这样hmall.direct才能正确路由消息。
消息会被投递到ttl.queue之后,由于没有消费者,因此消息无人消费。5秒之后,消息的有效期到期,成为死信:
死信被再次投递到死信交换机hmall.direct,并沿用之前的RoutingKey,也就是blue:
由于direct.queue1与hmall.direct绑定的key是blue,因此最终消息被成功路由到direct.queue1,如果此时有消费者与direct.queue1绑定, 也就能成功消费消息了。但此时已经是5秒钟以后了:
因此消费者5s后接收到消息,成功实现延迟消息。
- 总结
RabbitMQ的消息过期是基于追溯方式来实现的,即当一个消息的TTL到期后不一定会被移除或投递到死信交换机,而是在消息恰好处于队首时才会被处理。当队列中消息堆积很多的时候,过期消息可能不会被按时处理,因此设置的TTL时间不一定准确。
2、DelayExchange插件
死信队列实现延迟消息太麻烦。因此RabbitMQ社区提供了一个延迟消息插件。
- 下载
- 安装
- 声明延迟交换机
基于注解方式:
@RabbitListener(bindings = @QueueBinding(
value = @Queue(name = "delay.queue", durable = "true"),
exchange = @Exchange(name = "delay.direct", delayed = "true"),
key = "delay"
))
public void listenDelayMessage(String msg){
log.info("接收到delay.queue的延迟消息:{}", msg);
}
基于@Bean的方式:
package com.itheima.consumer.config;
import lombok.extern.slf4j.Slf4j;
import org.springframework.amqp.core.*;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Slf4j
@Configuration
public class DelayExchangeConfig {
@Bean
public DirectExchange delayExchange(){
return ExchangeBuilder
.directExchange("delay.direct") // 指定交换机类型和名称
.delayed() // 设置delay的属性为true
.durable(true) // 持久化
.build();
}
@Bean
public Queue delayedQueue(){
return new Queue("delay.queue");
}
@Bean
public Binding delayQueueBinding(){
return BindingBuilder.bind(delayedQueue()).to(delayExchange()).with("delay");
}
}
- 发送延迟消息
发送消息时,通过x-delay属性设定延迟时间:
@Test
void testPublisherDelayMessage() {
// 1.创建消息
String message = "hello, delayed message";
// 2.发送消息,利用消息后置处理器添加消息头
rabbitTemplate.convertAndSend("delay.direct", "delay", message, new MessagePostProcessor() {
@Override
public Message postProcessMessage(Message message) throws AmqpException {
// 添加延迟消息属性
message.getMessageProperties().setDelay(5000);
return message;
}
});
}
注:延迟消息插件内部会维护一个本地数据库表,同时使用Elang Timers功能实现计时。若消息的延迟时间设置较长,可能会导致堆积的延迟消息非常多,会带来较大的CPU开销,同时延迟消息的时间会存在误差。不建议设置延迟时间过长。
3、超时订单问题
交易服务中利用延迟消息实现订单超时取消功能。大概思路:
若订单超时支付时间为30分钟,理论上下单时发送一条延迟消息,时间为30分钟。这样就可以在接收到消息时检验订单支付状态,关闭未支付订单。
- 定义常量
消息发送还是接收都在交易服务完成,因此在trade-service中定义一个常量类,用于记录交换机、队列、RoutingKey等常量:
package com.hmall.trade.constants;
public interface MQConstants {
String DELAY_EXCHANGE_NAME = "trade.delay.direct";
String DELAY_ORDER_QUEUE_NAME = "trade.delay.order.queue";
String DELAY_ORDER_KEY = "delay.order.query";
}
- 配置MQ
在trade-service模块的pom.xml中引入amqp的依赖:
<!--amqp-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-amqp</artifactId>
</dependency>
在trade-service的application.yaml中添加MQ的配置:
spring:
rabbitmq:
host: 192.168.150.101
port: 5672
virtual-host: /hmall
username: hmall
password: 123
- 改造下单业务,发送延迟消息
下单完成后,发送延迟消息,查询支付状态。
修改trade-service模块的com.hmall.trade.service.impl.OrderServiceImpl类的createOrder方法,添加消息发送的代码:
- 编写查询支付状态接口
MQ消息处理时需要查询支付状态,因此要在pay-service模块定义一个这样的接口,并提供对应的FeignClient。
首先,在hm-api模块定义三个类:
PayOrderDTO代码如下:
package com.hmall.api.dto;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.time.LocalDateTime;
/**
* <p>
* 支付订单
* </p>
*/
@Data
@ApiModel(description = "支付单数据传输实体")
public class PayOrderDTO {
@ApiModelProperty("id")
private Long id;
@ApiModelProperty("业务订单号")
private Long bizOrderNo;
@ApiModelProperty("支付单号")
private Long payOrderNo;
@ApiModelProperty("支付用户id")
private Long bizUserId;
@ApiModelProperty("支付渠道编码")
private String payChannelCode;
@ApiModelProperty("支付金额,单位分")
private Integer amount;
@ApiModelProperty("付类型,1:h5,2:小程序,3:公众号,4:扫码,5:余额支付")
private Integer payType;
@ApiModelProperty("付状态,0:待提交,1:待支付,2:支付超时或取消,3:支付成功")
private Integer status;
@ApiModelProperty("拓展字段,用于传递不同渠道单独处理的字段")
private String expandJson;
@ApiModelProperty("第三方返回业务码")
private String resultCode;
@ApiModelProperty("第三方返回提示信息")
private String resultMsg;
@ApiModelProperty("支付成功时间")
private LocalDateTime paySuccessTime;
@ApiModelProperty("支付超时时间")
private LocalDateTime payOverTime;
@ApiModelProperty("支付二维码链接")
private String qrCodeUrl;
@ApiModelProperty("创建时间")
private LocalDateTime createTime;
@ApiModelProperty("更新时间")
private LocalDateTime updateTime;
}
PayClient代码如下:
package com.hmall.api.client;
import com.hmall.api.client.fallback.PayClientFallback;
import com.hmall.api.dto.PayOrderDTO;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
@FeignClient(value = "pay-service", fallbackFactory = PayClientFallback.class)
public interface PayClient {
/**
* 根据交易订单id查询支付单
* @param id 业务订单id
* @return 支付单信息
*/
@GetMapping("/pay-orders/biz/{id}")
PayOrderDTO queryPayOrderByBizOrderNo(@PathVariable("id") Long id);
}
PayClientFallback代码如下:
package com.hmall.api.client.fallback;
import com.hmall.api.client.PayClient;
import com.hmall.api.dto.PayOrderDTO;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.openfeign.FallbackFactory;
@Slf4j
public class PayClientFallback implements FallbackFactory<PayClient> {
@Override
public PayClient create(Throwable cause) {
return new PayClient() {
@Override
public PayOrderDTO queryPayOrderByBizOrderNo(Long id) {
return null;
}
};
}
}
在pay-service模块的PayController中实现该接口:
@ApiOperation("根据id查询支付单")
@GetMapping("/biz/{id}")
public PayOrderDTO queryPayOrderByBizOrderNo(@PathVariable("id") Long id){
PayOrder payOrder = payOrderService.lambdaQuery().eq(PayOrder::getBizOrderNo, id).one();
return BeanUtils.copyBean(payOrder, PayOrderDTO.class);
}
- 监听消息,查询支付状态
在trader-service编写一个监听器,监听延迟消息,查询订单支付状态:OrderDelayMessageListener
package com.hmall.trade.listener;
@Component
@RequiredArgsConstructor
public class OrderDelayMessageListener {
private final IOrderService orderService;
private final PayClient payClient;
@RabbitListener(bindings = @QueueBinding(
value = @Queue(name = MQConstants.DELAY_ORDER_QUEUE_NAME),
exchange = @Exchange(name = MQConstants.DELAY_EXCHANGE_NAME, delayed = "true"),
key = MQConstants.DELAY_ORDER_KEY
))
public void listenOrderDelayMessage(Long orderId){
// 1.查询订单
Order order = orderService.getById(orderId);
// 2.检测订单状态,判断是否已支付
if(order == null || order.getStatus() != 1){
// 订单不存在或者已经支付
return;
}
// 3.未支付,需要查询支付流水状态
PayOrderDTO payOrder = payClient.queryPayOrderByBizOrderNo(orderId);
// 4.判断是否支付
if(payOrder != null && payOrder.getStatus() == 3){
// 4.1.已支付,标记订单状态为已支付
orderService.markOrderPaySuccess(orderId);
}else{
// TODO 4.2.未支付,取消订单,回复库存
orderService.cancelOrder(orderId);
}
}
}