mall整合RabbitMQ实现延迟消息

本文主要讲解mall整合RabbitMQ实现延迟消息的过程，以发送延迟消息取消超时订单为例。

项目使用框架介绍

RabbitMQ

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

RabbitMQ的安装和使用

1.安装Erlang，下载地址：http://erlang.org/download/otpwin6421.3.exe

2.安装RabbitMQ，下载地址：https://dl.bintray.com/rabbitmq/all/rabbitmq-server/3.7.14/rabbitmq-server-3.7.14.exe

3.安装完成后，进入RabbitMQ安装目录下的sbin目录

4.在地址栏输入cmd并回车启动命令行，然后输入以下命令启动管理功能：

1. rabbitmq-plugins enable rabbitmq_management

5.访问地址查看是否安装成功：http://localhost:15672/

6.输入账号密码并登录：guest guest

7.创建帐号并设置其角色为管理员：mall mall

8.创建一个新的虚拟host为：/mall

9.点击mall用户进入用户配置页面

10.给mall用户配置该虚拟host的权限

11.至此，RabbitMQ的安装和配置完成。

RabbitMQ的消息模型

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

Lombok

Lombok为Java语言添加了非常有趣的附加功能，你可以不用再为实体类手写getter,setter等方法，通过一个注解即可拥有。

注意：需要安装idea的Lombok插件，并在项目中的pom文件中添加依赖。

业务场景说明

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

• 用户进行下单操作（会有锁定商品库存、使用优惠券、积分一系列的操作）；

• 生成订单，获取订单的id；

• 获取到设置的订单超时时间（假设设置的为60分钟不支付取消订单）；

• 按订单超时时间发送一个延迟消息给RabbitMQ，让它在订单超时后触发取消订单的操作；

• 如果用户没有支付，进行取消订单操作（释放锁定商品库存、返还优惠券、返回积分一系列操作）。

整合RabbitMQ实现延迟消息

在pom.xml中添加相关依赖

1. <!--消息队列相关依赖-->

2. <dependency>

3. <groupId>org.springframework.boot</groupId>

4. <artifactId>spring-boot-starter-amqp</artifactId>

5. </dependency>

6. <!--lombok依赖-->

7. <dependency>

8. <groupId>org.projectlombok</groupId>

9. <artifactId>lombok</artifactId>

10. <optional>true</optional>

11. </dependency>

修改SpringBoot配置文件

修改application.yml文件，在spring节点下添加RabbitMQ相关配置。

1. rabbitmq:

2. host: localhost # rabbitmq的连接地址

3. port: 5672 # rabbitmq的连接端口号

4. virtual-host: /mall # rabbitmq的虚拟host

5. username: mall # rabbitmq的用户名

6. password: mall # rabbitmq的密码

7. publisher-confirms: true #如果对异步消息需要回调必须设置为true

添加消息队列的枚举配置类QueueEnum

用于延迟消息队列及处理取消订单消息队列的常量定义，包括交换机名称、队列名称、路由键名称。

1. package com.macro.mall.tiny.dto;

2. import lombok.Getter;

3. /**

4. * 消息队列枚举配置

5. * Created by macro on 2018/9/14.

6. */

7. @Getter

8. public enum QueueEnum {

9. /**

10. * 消息通知队列

11. */

12. QUEUE_ORDER_CANCEL("mall.order.direct", "mall.order.cancel", "mall.order.cancel"),

13. /**

14. * 消息通知ttl队列

15. */

16. QUEUE_TTL_ORDER_CANCEL("mall.order.direct.ttl", "mall.order.cancel.ttl", "mall.order.cancel.ttl");

17. /**

18. * 交换名称

19. */

20. private String exchange;

21. /**

22. * 队列名称

23. */

24. private String name;

25. /**

26. * 路由键

27. */

28. private String routeKey;

29. QueueEnum(String exchange, String name, String routeKey) {

30. this.exchange = exchange;

31. this.name = name;

32. this.routeKey = routeKey;

33. }

34. }

添加RabbitMQ的配置

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

1. package com.macro.mall.tiny.config;

2. import com.macro.mall.tiny.dto.QueueEnum;

3. import org.springframework.amqp.core.*;

4. import org.springframework.context.annotation.Bean;

5. import org.springframework.context.annotation.Configuration;

6. /**

7. * 消息队列配置

8. * Created by macro on 2018/9/14.

9. */

10. @Configuration

11. public class RabbitMqConfig {

12. /**

13. * 订单消息实际消费队列所绑定的交换机

14. */

15. @Bean

16. DirectExchange orderDirect() {

17. return (DirectExchange) ExchangeBuilder

18. .directExchange(QueueEnum.QUEUE_ORDER_CANCEL.getExchange())

19. .durable(true)

20. .build();

21. }

22. /**

23. * 订单延迟队列队列所绑定的交换机

24. */

25. @Bean

26. DirectExchange orderTtlDirect() {

27. return (DirectExchange) ExchangeBuilder

28. .directExchange(QueueEnum.QUEUE_TTL_ORDER_CANCEL.getExchange())

29. .durable(true)

30. .build();

31. }

32. /**

33. * 订单实际消费队列

34. */

35. @Bean

36. public Queue orderQueue() {

37. return new Queue(QueueEnum.QUEUE_ORDER_CANCEL.getName());

38. }

39. /**

40. * 订单延迟队列（死信队列）

41. */

42. @Bean

43. public Queue orderTtlQueue() {

44. return QueueBuilder

45. .durable(QueueEnum.QUEUE_TTL_ORDER_CANCEL.getName())

46. .withArgument("x-dead-letter-exchange", QueueEnum.QUEUE_ORDER_CANCEL.getExchange())//到期后转发的交换机

47. .withArgument("x-dead-letter-routing-key", QueueEnum.QUEUE_ORDER_CANCEL.getRouteKey())//到期后转发的路由键

48. .build();

49. }

50. /**

51. * 将订单队列绑定到交换机

52. */

53. @Bean

54. Binding orderBinding(DirectExchange orderDirect,Queue orderQueue){

55. return BindingBuilder

56. .bind(orderQueue)

57. .to(orderDirect)

58. .with(QueueEnum.QUEUE_ORDER_CANCEL.getRouteKey());

59. }

60. /**

61. * 将订单延迟队列绑定到交换机

62. */

63. @Bean

64. Binding orderTtlBinding(DirectExchange orderTtlDirect,Queue orderTtlQueue){

65. return BindingBuilder

66. .bind(orderTtlQueue)

67. .to(orderTtlDirect)

68. .with(QueueEnum.QUEUE_TTL_ORDER_CANCEL.getRouteKey());

69. }

70. }

在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）里发送消息。

1. package com.macro.mall.tiny.component;

2. import com.macro.mall.tiny.dto.QueueEnum;

3. import org.slf4j.Logger;

4. import org.slf4j.LoggerFactory;

5. import org.springframework.amqp.AmqpException;

6. import org.springframework.amqp.core.AmqpTemplate;

7. import org.springframework.amqp.core.Message;

8. import org.springframework.amqp.core.MessagePostProcessor;

9. import org.springframework.beans.factory.annotation.Autowired;

10. import org.springframework.stereotype.Component;

11. /**

12. * 取消订单消息的发出者

13. * Created by macro on 2018/9/14.

14. */

15. @Component

16. public class CancelOrderSender {

17. private static Logger LOGGER =LoggerFactory.getLogger(CancelOrderSender.class);

18. @Autowired

19. private AmqpTemplate amqpTemplate;

20. public void sendMessage(Long orderId,final long delayTimes){

21. //给延迟队列发送消息

22. amqpTemplate.convertAndSend(QueueEnum.QUEUE_TTL_ORDER_CANCEL.getExchange(), QueueEnum.QUEUE_TTL_ORDER_CANCEL.getRouteKey(), orderId, new MessagePostProcessor() {

23. @Override

24. public Message postProcessMessage(Message message) throws AmqpException {

25. //给消息设置延迟毫秒值

26. message.getMessageProperties().setExpiration(String.valueOf(delayTimes));

27. return message;

28. }

29. });

30. LOGGER.info("send delay message orderId:{}",orderId);

31. }

32. }

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

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

1. package com.macro.mall.tiny.component;

2. import com.macro.mall.tiny.service.OmsPortalOrderService;

3. import org.slf4j.Logger;

4. import org.slf4j.LoggerFactory;

5. import org.springframework.amqp.rabbit.annotation.RabbitHandler;

6. import org.springframework.amqp.rabbit.annotation.RabbitListener;

7. import org.springframework.beans.factory.annotation.Autowired;

8. import org.springframework.stereotype.Component;

9. /**

10. * 取消订单消息的处理者

11. * Created by macro on 2018/9/14.

12. */

13. @Component

14. @RabbitListener(queues = "mall.order.cancel")

15. public class CancelOrderReceiver {

16. private static Logger LOGGER =LoggerFactory.getLogger(CancelOrderReceiver.class);

17. @Autowired

18. private OmsPortalOrderService portalOrderService;

19. @RabbitHandler

20. public void handle(Long orderId){

21. LOGGER.info("receive delay message orderId:{}",orderId);

22. portalOrderService.cancelOrder(orderId);

23. }

24. }

添加OmsPortalOrderService接口

1. package com.macro.mall.tiny.service;

2. import com.macro.mall.tiny.common.api.CommonResult;

3. import com.macro.mall.tiny.dto.OrderParam;

4. import org.springframework.transaction.annotation.Transactional;

5. /**

6. * 前台订单管理Service

7. * Created by macro on 2018/8/30.

8. */

9. public interface OmsPortalOrderService {

10. /**

11. * 根据提交信息生成订单

12. */

13. @Transactional

14. CommonResult generateOrder(OrderParam orderParam);

15. /**

16. * 取消单个超时订单

17. */

18. @Transactional

19. void cancelOrder(Long orderId);

20. }

添加OmsPortalOrderService的实现类OmsPortalOrderServiceImpl

1. package com.macro.mall.tiny.service.impl;

2. import com.macro.mall.tiny.common.api.CommonResult;

3. import com.macro.mall.tiny.component.CancelOrderSender;

4. import com.macro.mall.tiny.dto.OrderParam;

5. import com.macro.mall.tiny.service.OmsPortalOrderService;

6. import org.slf4j.Logger;

7. import org.slf4j.LoggerFactory;

8. import org.springframework.beans.factory.annotation.Autowired;

9. import org.springframework.stereotype.Service;

10. /**

11. * 前台订单管理Service

12. * Created by macro on 2018/8/30.

13. */

14. @Service

15. public class OmsPortalOrderServiceImpl implements OmsPortalOrderService {

16. private static Logger LOGGER = LoggerFactory.getLogger(OmsPortalOrderServiceImpl.class);

17. @Autowired

18. private CancelOrderSender cancelOrderSender;

19. @Override

20. public CommonResult generateOrder(OrderParam orderParam) {

21. //todo 执行一系类下单操作，具体参考mall项目

22. LOGGER.info("process generateOrder");

23. //下单完成后开启一个延迟消息，用于当用户没有付款时取消订单（orderId应该在下单后生成）

24. sendDelayMessageCancelOrder(11L);

25. return CommonResult.success(null, "下单成功");

26. }

27. @Override

28. public void cancelOrder(Long orderId) {

29. //todo 执行一系类取消订单操作，具体参考mall项目

30. LOGGER.info("process cancelOrder orderId:{}",orderId);

31. }

32. private void sendDelayMessageCancelOrder(Long orderId) {

33. //获取订单超时时间，假设为60分钟

34. long delayTimes = 30 * 1000;

35. //发送延迟消息

36. cancelOrderSender.sendMessage(orderId, delayTimes);

37. }

38. }

添加OmsPortalOrderController定义接口

1. package com.macro.mall.tiny.controller;

2. import com.macro.mall.tiny.dto.OrderParam;

3. import com.macro.mall.tiny.service.OmsPortalOrderService;

4. import io.swagger.annotations.Api;

5. import io.swagger.annotations.ApiOperation;

6. import org.springframework.beans.factory.annotation.Autowired;

7. import org.springframework.stereotype.Controller;

8. import org.springframework.web.bind.annotation.RequestBody;

9. import org.springframework.web.bind.annotation.RequestMapping;

10. import org.springframework.web.bind.annotation.RequestMethod;

11. import org.springframework.web.bind.annotation.ResponseBody;

12. /**

13. * 订单管理Controller

14. * Created by macro on 2018/8/30.

15. */

16. @Controller

17. @Api(tags = "OmsPortalOrderController", description = "订单管理")

18. @RequestMapping("/order")

19. public class OmsPortalOrderController {

20. @Autowired

21. private OmsPortalOrderService portalOrderService;

22. @ApiOperation("根据购物车信息生成订单")

23. @RequestMapping(value = "/generateOrder", method = RequestMethod.POST)

24. @ResponseBody

25. public Object generateOrder(@RequestBody OrderParam orderParam) {

26. return portalOrderService.generateOrder(orderParam);

27. }

28. }

进行接口测试

调用下单接口

注意：已经将延迟消息时间设置为30秒

项目源码地址

https://github.com/macrozheng/mall-learning/tree/master/mall-tiny-08

推荐阅读

---

欢迎关注，点个在看