SpringBoot整合RabbitMQ实现延迟消息

RabbitMQ

RabbitMQ是一个被广泛使用的开源消息队列。它是轻量级且易于部署的，它能支持多种消息协议。RabbitMQ可以部署在分布式和联合配置中，以满足高规模、高可用性的需求。

RabbitMQ的安装与部署

在这里就不在陈述了，如果需要的话请看这篇博客https://www.cnblogs.com/chy-op/p/9611124.html

RabbitMQ的消息模型

标志	中文名	英文名	描述
P	生产者	Producer	消息的发送者，可以将消息发送到交换机
C	消费者	Consumer	消息的接收者，从队列中获取消息进行消费
X	交换机	Exchange	接收生产者发送的消息，并根据路由键发送给指定队列
Q	队列	Queue	存储从交换机发来的消息
type	交换机类型	type	direct表示直接根据路由键（orange/black）发送消息

半藏商城中应用消息队列的场景

1、用于解决用户下单以后，订单超时如何取消订单的问题。

• 用户进行提交订单操作（会有锁定商品库存等操作）；
• 生成订单，获取订单的id；
• 获取到设置的订单超时时间（假设设置的为60分钟不支付取消订单）；
• 按订单超时时间发送一个延迟消息给RabbitMQ，让它在订单超时后触发取消订单的操作；
• 如果用户没有支付，进行取消订单操作（释放锁定商品库存一系列操作）。

实现方法

• 需要一个订单延迟消息队列 以及一个取消订单消息队列，
• 一旦有消息以延迟订单设置的路由键发送过来，会转发到订单延迟消息队列，并在此队列保存一定时间，等到超时后会自动将消息发送到取消订单消息消费队列。

2、短信验证码以及邮箱验证码都采用消息队列进行消费。

• 采用队列，交换机，路由键进行消费。一条队列，一个交换机，一个路由键就可以实现。

在pom.xml中添加相关依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-amqp</artifactId>
</dependency>

修改SpringBoot配置文件

#SpringBoot配置RabbitMq
  rabbitmq:
    host: localhost # rabbitmq的连接地址
    port: 5672 # rabbitmq的连接端口号
    virtual-host: /hanzoMall # rabbitmq的虚拟host
    username: hanzoMall # rabbitmq的用户名
    password: hanzoMall # rabbitmq的密码
    publisher-confirms: true #如果对异步消息需要回调必须设置为true

消息队列的枚举配置类QueueEnum

用于延迟消息队列及处理取消订单消息队列的常量定义，包括交换机名称、队列名称、路由键名称。
以及短信发送消息队列和邮箱验证码发送消息队列的常量定义，包括交换机名称、队列名称、路由键名称。

package ltd.hanzo.mall.common;

import com.rabbitmq.client.AMQP;
import lombok.Getter;

/**
 * @Author 皓宇QAQ
 * @email 2469653218@qq.com
 * @Date 2020/5/23 21:00
 * @link https://github.com/Tianhaoy/hanzomall
 * @Description: 消息队列枚举配置
 */
@Getter
public enum  QueueEnum {
    /**
     * 发送短信消息通知队列
     */
    QUEUE_SMS_SEND("mall.sms.direct", "mall.sms.send", "mall.sms.send"),

    /**
     * 发送邮件消息通知队列
     */
    QUEUE_EMAIL_SEND("mall.email.direct", "mall.email.send", "mall.email.send"),

    /**
     * 消息通知队列
     * mall.order.direct（取消订单消息队列所绑定的交换机）:绑定的队列为mall.order.cancel，一旦有消息以mall.order.cancel为路由键发过来，会发送到此队列。
     */
    QUEUE_ORDER_CANCEL("mall.order.direct", "mall.order.cancel", "mall.order.cancel"),

    /**
     * 消息通知ttl队列
     * mall.order.direct.ttl（订单延迟消息队列所绑定的交换机）:绑定的队列为mall.order.cancel.ttl，一旦有消息以mall.order.cancel.ttl为路由键发送过来，会转发到此队列，并在此队列保存一定时间，等到超时后会自动将消息发送到mall.order.cancel（取消订单消息消费队列）。
     */
    QUEUE_TTL_ORDER_CANCEL("mall.order.direct.ttl", "mall.order.cancel.ttl", "mall.order.cancel.ttl");

    /**
     * 交换机名称
     */
    private String exchange;
    /**
     * 队列名称
     */
    private String name;
    /**
     * 路由键
     */
    private String routeKey;

    QueueEnum(String exchange, String name, String routeKey) {
        this.exchange = exchange;
        this.name = name;
        this.routeKey = routeKey;
    }
}

添加RabbitMq的配置

用于配置交换机、队列及队列与交换机的绑定关系。

package ltd.hanzo.mall.config;

import ltd.hanzo.mall.common.QueueEnum;
import org.springframework.amqp.core.*;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @Author 皓宇QAQ
 * @email 2469653218@qq.com
 * @Date 2020/5/23 21:04
 * @link https://github.com/Tianhaoy/hanzomall
 * @Description: 消息队列配置
 */
@Configuration
public class RabbitMqConfig {

    /**
     * 1.0发送短信消息通知队列所绑定的->交换机
     */
    @Bean
    DirectExchange sendSmsDirect() {
        return (DirectExchange) ExchangeBuilder
                .directExchange(QueueEnum.QUEUE_SMS_SEND.getExchange())
                .durable(true)
                .build();
    }

    /**
     * 1.0发送短信的->消费队列
     */
    @Bean
    public Queue sendSmsQueue() {
        return new Queue(QueueEnum.QUEUE_SMS_SEND.getName());
    }

    /**
     * 1.0将发送短信 队列绑定到->交换机
     */
    @Bean
    Binding sendSmsBinding(DirectExchange sendSmsDirect, Queue sendSmsQueue){
        return BindingBuilder
                .bind(sendSmsQueue)
                .to(sendSmsDirect)
                .with(QueueEnum.QUEUE_SMS_SEND.getRouteKey());
    }

    /**
     * 2.0发送邮件消息通知队列所绑定的->交换机
     */
    @Bean
    DirectExchange sendEmailDirect() {
        return (DirectExchange) ExchangeBuilder
                .directExchange(QueueEnum.QUEUE_EMAIL_SEND.getExchange())
                .durable(true)
                .build();
    }

    /**
     * 2.0发送邮件的->消费队列
     */
    @Bean
    public Queue sendEmailQueue() {
        return new Queue(QueueEnum.QUEUE_EMAIL_SEND.getName());
    }

    /**
     * 2.0将发送邮件 队列绑定到->交换机
     */
    @Bean
    Binding sendEmailBinding(DirectExchange sendEmailDirect, Queue sendEmailQueue){
        return BindingBuilder
                .bind(sendEmailQueue)
                .to(sendEmailDirect)
                .with(QueueEnum.QUEUE_EMAIL_SEND.getRouteKey());
    }

    /**
     * 3.0订单消息实际消费队列所绑定的->交换机
     */
    @Bean
    DirectExchange orderDirect() {
        return (DirectExchange) ExchangeBuilder
                .directExchange(QueueEnum.QUEUE_ORDER_CANCEL.getExchange())
                .durable(true)
                .build();
    }

    /**
     * 3.0订单实际消费队列
     */
    @Bean
    public Queue orderQueue() {
        return new Queue(QueueEnum.QUEUE_ORDER_CANCEL.getName());
    }

    /**
     * 3.0将订单队列绑定到交换机
     */
    @Bean
    Binding orderBinding(DirectExchange orderDirect,Queue orderQueue){
        return BindingBuilder
                .bind(orderQueue)
                .to(orderDirect)
                .with(QueueEnum.QUEUE_ORDER_CANCEL.getRouteKey());
    }

    /**
     * 4.0订单延迟队列队列所绑定的->交换机
     */
    @Bean
    DirectExchange orderTtlDirect() {
        return (DirectExchange) ExchangeBuilder
                .directExchange(QueueEnum.QUEUE_TTL_ORDER_CANCEL.getExchange())
                .durable(true)
                .build();
    }

    /**
     * 4.0订单延迟队列（死信队列）
     */
    @Bean
    public Queue orderTtlQueue() {
        return QueueBuilder
                .durable(QueueEnum.QUEUE_TTL_ORDER_CANCEL.getName())
                .withArgument("x-dead-letter-exchange", QueueEnum.QUEUE_ORDER_CANCEL.getExchange())//到期后转发的交换机
                .withArgument("x-dead-letter-routing-key", QueueEnum.QUEUE_ORDER_CANCEL.getRouteKey())//到期后转发的路由键
                .build();
    }
    /**
     * 4.0将订单延迟队列绑定到交换机
     */
    @Bean
    Binding orderTtlBinding(DirectExchange orderTtlDirect,Queue orderTtlQueue){
        return BindingBuilder
                .bind(orderTtlQueue)
                .to(orderTtlDirect)
                .with(QueueEnum.QUEUE_TTL_ORDER_CANCEL.getRouteKey());
    }
}

在RabbitMQ管理页面可以看到以下交换机和队列

交换机及队列说明

• mall.order.direct（取消订单消息队列所绑定的交换机）:绑定的队列为mall.order.cancel，一旦有消息以mall.order.cancel为路由键发过来，会发送到此队列。
• mall.order.direct.ttl（订单延迟消息队列所绑定的交换机）:绑定的队列为mall.order.cancel.ttl，一旦有消息以mall.order.cancel.ttl为路由键发送过来，会转发到此队列，并在此队列保存一定时间，等到超时后会自动将消息发送到mall.order.cancel（取消订单消息消费队列）。

添加延迟消息的发送者CancelOrderSender

用于向订单延迟消息队列（mall.order.cancel.ttl）里发送消息。

package ltd.hanzo.mall.component;

import lombok.extern.slf4j.Slf4j;
import ltd.hanzo.mall.common.QueueEnum;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.amqp.AmqpException;
import org.springframework.amqp.core.AmqpTemplate;
import org.springframework.amqp.core.Message;
import org.springframework.amqp.core.MessagePostProcessor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/**
 * @Author 皓宇QAQ
 * @Date 2020/6/6 17:24
 * @Description:取消订单消息的发出者
 */
@Component
@Slf4j
public class CancelOrderSender {
    @Autowired
    private AmqpTemplate amqpTemplate;

    public void sendMessage(String orderNo,final long delayTimes){
        //给延迟队列发送消息
        amqpTemplate.convertAndSend(QueueEnum.QUEUE_TTL_ORDER_CANCEL.getExchange(), QueueEnum.QUEUE_TTL_ORDER_CANCEL.getRouteKey(), orderNo, new MessagePostProcessor() {
            @Override
            public Message postProcessMessage(Message message) throws AmqpException {
                //给消息设置延迟毫秒值
                message.getMessageProperties().setExpiration(String.valueOf(delayTimes));
                return message;
            }
        });
        log.info("send delay message orderNo:{}",orderNo);
    }
}

添加取消订单消息的接收者CancelOrderReceiver

用于从取消订单的消息队列（mall.order.cancel）里接收消息。

package ltd.hanzo.mall.component;

import lombok.extern.slf4j.Slf4j;
import ltd.hanzo.mall.service.HanZoMallOrderService;
import ltd.hanzo.mall.service.TaskService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.amqp.rabbit.annotation.RabbitHandler;
import org.springframework.amqp.rabbit.annotation.RabbitListener;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/**
 * @Author 皓宇QAQ
 * @Date 2020/6/6 17:25
 * @Description:取消订单消息的处理者
 */
@Component
@RabbitListener(queues = "mall.order.cancel")
@Slf4j
public class CancelOrderReceiver {
    @Autowired
    private HanZoMallOrderService hanZoMallOrderService;
    @Autowired
    private TaskService taskService;

    @RabbitHandler
    public void handle(String orderNo){
        log.info("receive delay message orderNo:{}",orderNo);
        hanZoMallOrderService.cancelOrder(orderNo);
        taskService.cancelOrderSendSimpleMail(orderNo);
    }
}

添加HanZoMallOrderService接口

public interface HanZoMallOrderService {
    /**
     * 保存订单
     *
     * @param user
     * @param myShoppingCartItems
     * @return
     */
    String saveOrder(HanZoMallUserVO user, List<HanZoMallShoppingCartItemVO> myShoppingCartItems);

    /**
     * 取消单个超时订单
     */
    @Transactional
    void cancelOrder(String orderNo);


}

添加HanZoMallOrderService实现类HanZoMallOrderServiceImpl

@Slf4j
@Service
public class HanZoMallOrderServiceImpl implements HanZoMallOrderService {
    @Resource
    private HanZoMallOrderMapper hanZoMallOrderMapper;
    @Resource
    private HanZoMallOrderItemMapper hanZoMallOrderItemMapper;
    @Resource
    private HanZoMallShoppingCartItemMapper hanZoMallShoppingCartItemMapper;
    @Resource
    private HanZoMallGoodsMapper hanZoMallGoodsMapper;
    @Autowired
    private CancelOrderSender cancelOrderSender;

    @Override
    @Transactional
    public String saveOrder(HanZoMallUserVO user, List<HanZoMallShoppingCartItemVO> myShoppingCartItems) {
        //todo 执行一系类下单操作，代码在github中
        //下单完成后开启一个延迟消息，用于当用户没有付款时取消订单		 
        sendDelayMessageCancelOrder(orderNo);
        //所有操作成功后，将订单号返回，以供Controller方法跳转到订单详情
        return orderNo;	 
｝

    @Override
    public void cancelOrder(String orderNo) {
        HanZoMallOrder hanZoMallOrder = hanZoMallOrderMapper.selectByOrderNo(orderNo);
        if (hanZoMallOrder != null && hanZoMallOrder.getOrderStatus() == 0) {
            //超时取消订单
            hanZoMallOrderMapper.closeOrder(Collections.singletonList(hanZoMallOrder.getOrderId()), HanZoMallOrderStatusEnum.ORDER_CLOSED_BY_EXPIRED.getOrderStatus());

        }
    }

    private void sendDelayMessageCancelOrder(String orderNo) {
        //获取订单超时时间，假设为60分钟
        long delayTimes = 36 * 100000;
        //发送延迟消息
        cancelOrderSender.sendMessage(orderNo, delayTimes);
    }

添加OrderController定义接口

    代码在Github中>https://github.com/Tianhaoy/hanzomall

总结

到此为止，整合RabbitMQ实现延迟消息的相关流程就介绍完毕了，知识只有分享出来才有价值。如果有问题的话，可以在关于我的页面，通过我的邮箱联系我进行探讨。