Springboot整合RabbitMQ实现消息延迟消费

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

应用场景

用户下单后，订单超时自动取消订单；订单签收后自动确认收货等
• 用户进行下单操作（会有锁定商品库存、使用优惠券、积分一系列的操作）；
• 生成订单，获取订单的ID；
• 获取到设置的订单超时时间（假设60分钟不支付取消订单）；
• 按订单超时时间发送一个延迟消息给RabbitMQ，让它在订单超时后触发取消订单的操作；
• 如果用户没有支付，进行取消订单操作（释放锁定商品库存、返还优惠券、返还积分一系列操作）

整合RabbitMQ实现延迟消息

在pom.xml文件中添加依赖

<!--消息队列相关依赖-->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-amqp</artifactId>
</dependency>
<!--lombok依赖-->
<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
  <version>1.18.12</version>
</dependency>

修改application.yml文件，添加RabbitMQ相关配置

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

添加消息队列的枚举配置类QueueEnum – 用于延迟消息队列及处理取消订单消息队列的常量定义，包括交换机名称、队列名称、路由键名称

import lombok.Getter;
/**
 * 消息队列枚举配置
 */
@Getter
public enum QueueEnum {
    /**
     * 插件实现延迟队列
     */
    QUEUE_ORDER_PLUGIN_CANCEL("order.direct", "order.cancel", "order.cancel");
    /**
     * 交换名称
     */
    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配置类

import com.xx.util.QueueEnum;
import org.springframework.amqp.core.Binding;
import org.springframework.amqp.core.BindingBuilder;
import org.springframework.amqp.core.CustomExchange;
import org.springframework.amqp.core.Queue;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.util.HashMap;
import java.util.Map;
/**
 * 消息队列配置
 */
@Configuration
public class RabbitMqConfig {
    /**
     * 订单延迟插件消息队列所绑定的交换机
     */
    @Bean
    CustomExchange orderPluginDirect() {
        //创建一个自定义交换机，可以发送延迟消息
        Map<String, Object> args = new HashMap<>();
        args.put("x-delayed-type", "direct");
        return new CustomExchange(QueueEnum.QUEUE_ORDER_PLUGIN_CANCEL.getExchange(), "x-delayed-message",true, false,args);
    }
    /**
     * 订单延迟插件队列
     */
    @Bean
    public Queue orderPluginQueue() {
        return new Queue(QueueEnum.QUEUE_ORDER_PLUGIN_CANCEL.getName());
    }
    /**
     * 将订单延迟插件队列绑定到交换机
     */
    @Bean
    public Binding orderPluginBinding(CustomExchange orderPluginDirect, Queue orderPluginQueue) {
        return BindingBuilder
                .bind(orderPluginQueue)
                .to(orderPluginDirect)
                .with(QueueEnum.QUEUE_ORDER_PLUGIN_CANCEL.getRouteKey())
                .noargs();
    }
}

OrderParam实体类

import lombok.Data;
/**
 * 生成订单时传入的参数
 */
@Data
public class OrderParam {
    //收货地址id
    private Long memberReceiveAddressId;
    //优惠券id
    private Long couponId;
    //使用的积分数
    private Integer useIntegration;
    //支付方式
    private Integer payType;
}

添加延迟消息发送者 – 用于向订单延迟消息队列（order.cancel.ttl）里发送消息

import com.xx.util.QueueEnum;
import lombok.extern.slf4j.Slf4j;
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;
@Component
@Slf4j
public class CancelOrderSender {
    @Autowired
    private AmqpTemplate amqpTemplate;
    public void sendMessage(Long orderId, final long delayTimes){
        //给延迟队列发送消息
        amqpTemplate.convertAndSend(QueueEnum.QUEUE_ORDER_PLUGIN_CANCEL.getExchange(), QueueEnum.QUEUE_ORDER_PLUGIN_CANCEL.getRouteKey(), orderId, new MessagePostProcessor() {
            @Override
            public Message postProcessMessage(Message message) throws AmqpException {
                //给消息设置延迟毫秒值
                message.getMessageProperties().setHeader("x-delay",delayTimes);
                return message;
            }
        });
        log.info("发送延迟消息 订单号:{}", orderId);
    }
}

添加延迟消息消费者 – 用于从取消订单的消息队列（order.cancel）里接收消息

import com.xx.service.OrderService;
import lombok.extern.slf4j.Slf4j;
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;
@Component
@Slf4j
@RabbitListener(queues = "order.cancel")
public class CancelOrderReceiver {
    @Autowired
    private OrderService orderService;
    @RabbitHandler
    public void handle(Long orderId){
        log.info("接收延迟消息 orderId:{}", orderId);
        orderService.cancelOrder(orderId);
    }
}

OrderService接口

import com.xx.util.OrderParam;
import org.springframework.transaction.annotation.Transactional;
public interface OrderService {
    /**
     * 根据提交信息生成订单
     */
    @Transactional
    void generateOrder(OrderParam orderParam);
    /**
     * 取消单个超时订单
     */
    @Transactional
    void cancelOrder(Long orderId);
}

OrderService的实现类OrderServiceImpl

import com.xx.delay.CancelOrderSender;
import com.xx.util.OrderParam;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
/**
 * 订单管理Service
 */
@Slf4j
@Service
public class OrderServiceImpl implements OrderService {
    @Autowired
    private CancelOrderSender cancelOrderSender;
    @Override
    public void generateOrder(OrderParam orderParam) {
        //执行一系类下单操作
        log.info("执行下单操作");
        //下单完成后开启一个延迟消息，用于当用户没有付款时取消订单（orderId应该在下单后生成）
        sendDelayMessageCancelOrder(2020007071500000L);
    }
    @Override
    public void cancelOrder(Long orderId) {
        //执行一系类取消订单操作
        log.info("执行取消订单操作 orderId:{}", orderId);
    }
    private void sendDelayMessageCancelOrder(Long orderId) {
        //获取订单超时时间，假设为60分钟(测试设置为30秒)
        long delayTimes = 30 * 1000;
        //发送延迟消息
        cancelOrderSender.sendMessage(orderId, delayTimes);
    }
}

DelayMessageController

import com.xx.service.OrderService;
import com.xx.util.OrderParam;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class DelayMessageController {
    @Autowired
    private OrderService orderService;
    /**
     * 下单操作
     */
    @GetMapping("/order")
    @ResponseBody
    public String delaymessage(){
        OrderParam orderParam = new OrderParam();
        orderService.generateOrder(orderParam);
        return "success";
    }
}

开启rabbitmq插件服务

rabbitmq-plugins enable rabbitmq_delayed_message_exchange

接口测试（GET:localhost:8080/order）