SpringBoot + RabbitMQ ，保证消息100% 投递成功并被消费（附源码）

1、先扔一张图

说明:

本文涵盖了关于RabbitMQ不少方面的知识点, 如:

1. 消息发送确认机制
2. 消费确认机制
3. 消息的从新投递
4. 消费幂等性, 等等

这些都是围绕上面那张总体流程图展开的, 因此有必要先贴出来, 见图知意

2、实现思路

1. 简略介绍163邮箱受权码的获取
2. 编写发送邮件工具类
3. 编写RabbitMQ配置文件
4. 生产者发起调用
5. 消费者发送邮件
6. 定时任务定时拉取投递失败的消息, 从新投递
7. 各类异常状况的测试验证

拓展: 使用动态代理实现消费端幂等性验证和消息确认(ack)

3、项目介绍

1. springboot版本2.1.5.RELEASE, 旧版本可能有些配置属性不能使用, 须要以代码形式进行配置
2. RabbitMQ版本3.7.15
3. MailUtil: 发送邮件工具类
4. RabbitConfig: rabbitmq相关配置
5. TestServiceImpl: 生产者, 发送消息
6. MailConsumer: 消费者, 消费消息, 发送邮件
7. ResendMsg: 定时任务, 从新投递发送失败的消息

说明: 上面是核心代码, MsgLogService mapper xml等均未贴出, 完整代码能够参考GitHub上的源码，地址在文末。

4、代码实现

一、163邮箱受权码的获取, 如图:

该受权码就是配置文件spring.mail.password须要的密码

二、pom

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

三、rabbitmq、邮箱配置

# rabbitmq spring.rabbitmq.host=localhost spring.rabbitmq.port=5672 spring.rabbitmq.username=guest spring.rabbitmq.password=guest # 开启confirms回调 P -> Exchange spring.rabbitmq.publisher-confirms=true # 开启returnedMessage回调 Exchange -> Queue spring.rabbitmq.publisher-returns=true # 设置手动确认(ack) Queue -> C spring.rabbitmq.listener.simple.acknowledge-mode=manual spring.rabbitmq.listener.simple.prefetch=100 # mail spring.mail.host=smtp.163.com spring.mail.username=18621142249@163.com spring.mail.password=123456wangzai spring.mail.from=18621142249@163.com spring.mail.properties.mail.smtp.auth=true spring.mail.properties.mail.smtp.starttls.enable=true spring.mail.properties.mail.smtp.starttls.required=true 

说明: password即受权码, username和from要一致

四、表结构

CREATE TABLE `msg_log` (   `msg_id` varchar(255) NOT NULL DEFAULT '' COMMENT '消息惟一标识',   `msg` text COMMENT '消息体, json格式化',   `exchange` varchar(255) NOT NULL DEFAULT '' COMMENT '交换机',   `routing_key` varchar(255) NOT NULL DEFAULT '' COMMENT '路由键',   `status` int(11) NOT NULL DEFAULT '0' COMMENT '状态: 0投递中 1投递成功 2投递失败 3已消费',   `try_count` int(11) NOT NULL DEFAULT '0' COMMENT '重试次数',   `next_try_time` datetime DEFAULT NULL COMMENT '下一次重试时间',   `create_time` datetime DEFAULT NULL COMMENT '建立时间',   `update_time` datetime DEFAULT NULL COMMENT '更新时间',   PRIMARY KEY (`msg_id`),   UNIQUE KEY `unq_msg_id` (`msg_id`) USING BTREE ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='消息投递日志'; 

说明: exchange routing_key字段是在定时任务从新投递消息时须要用到的

五、MailUtil

@Component @Slf4j public class MailUtil {     @Value("${spring.mail.from}")     private String from;     @Autowired     private JavaMailSender mailSender;     /**      * 发送简单邮件      *      * @param mail      */     public boolean send(Mail mail) {         String to = mail.getTo();// 目标邮箱         String title = mail.getTitle();// 邮件标题         String content = mail.getContent();// 邮件正文         SimpleMailMessage message = new SimpleMailMessage();         message.setFrom(from);         message.setTo(to);         message.setSubject(title);         message.setText(content);         try {             mailSender.send(message);             log.info("邮件发送成功");             return true;         } catch (MailException e) {             log.error("邮件发送失败, to: {}, title: {}", to, title, e);             return false;         }     } } 

六、RabbitConfig

@Configuration @Slf4j public class RabbitConfig {     @Autowired     private CachingConnectionFactory connectionFactory;     @Autowired     private MsgLogService msgLogService;     @Bean     public RabbitTemplate rabbitTemplate() {         RabbitTemplate rabbitTemplate = new RabbitTemplate(connectionFactory);         rabbitTemplate.setMessageConverter(converter());         // 消息是否成功发送到Exchange         rabbitTemplate.setConfirmCallback((correlationData, ack, cause) -> {             if (ack) {                 log.info("消息成功发送到Exchange");                 String msgId = correlationData.getId();                 msgLogService.updateStatus(msgId, Constant.MsgLogStatus.DELIVER_SUCCESS);             } else {                 log.info("消息发送到Exchange失败, {}, cause: {}", correlationData, cause);             }         });         // 触发setReturnCallback回调必须设置mandatory=true, 不然Exchange没有找到Queue就会丢弃掉消息, 而不会触发回调         rabbitTemplate.setMandatory(true);         // 消息是否从Exchange路由到Queue, 注意: 这是一个失败回调, 只有消息从Exchange路由到Queue失败才会回调这个方法         rabbitTemplate.setReturnCallback((message, replyCode, replyText, exchange, routingKey) -> {             log.info("消息从Exchange路由到Queue失败: exchange: {}, route: {}, replyCode: {}, replyText: {}, message: {}", exchange, routingKey, replyCode, replyText, message);         });         return rabbitTemplate;     }     @Bean     public Jackson2JsonMessageConverter converter() {         return new Jackson2JsonMessageConverter();     }     // 发送邮件     public static final String MAIL_QUEUE_NAME = "mail.queue";     public static final String MAIL_EXCHANGE_NAME = "mail.exchange";     public static final String MAIL_ROUTING_KEY_NAME = "mail.routing.key";     @Bean     public Queue mailQueue() {         return new Queue(MAIL_QUEUE_NAME, true);     }     @Bean     public DirectExchange mailExchange() {         return new DirectExchange(MAIL_EXCHANGE_NAME, true, false);     }     @Bean     public Binding mailBinding() {         return BindingBuilder.bind(mailQueue()).to(mailExchange()).with(MAIL_ROUTING_KEY_NAME);     } } 

七、TestServiceImpl生产消息

@Service public class TestServiceImpl implements TestService {     @Autowired     private MsgLogMapper msgLogMapper;     @Autowired     private RabbitTemplate rabbitTemplate;     @Override     public ServerResponse send(Mail mail) {         String msgId = RandomUtil.UUID32();         mail.setMsgId(msgId);         MsgLog msgLog = new MsgLog(msgId, mail, RabbitConfig.MAIL_EXCHANGE_NAME, RabbitConfig.MAIL_ROUTING_KEY_NAME);         msgLogMapper.insert(msgLog);// 消息入库         CorrelationData correlationData = new CorrelationData(msgId);         rabbitTemplate.convertAndSend(RabbitConfig.MAIL_EXCHANGE_NAME, RabbitConfig.MAIL_ROUTING_KEY_NAME, MessageHelper.objToMsg(mail), correlationData);// 发送消息         return ServerResponse.success(ResponseCode.MAIL_SEND_SUCCESS.getMsg());     } } 

八、MailConsumer消费消息, 发送邮件

@Component @Slf4j public class MailConsumer {     @Autowired     private MsgLogService msgLogService;     @Autowired     private MailUtil mailUtil;     @RabbitListener(queues = RabbitConfig.MAIL_QUEUE_NAME)     public void consume(Message message, Channel channel) throws IOException {         Mail mail = MessageHelper.msgToObj(message, Mail.class);         log.info("收到消息: {}", mail.toString());         String msgId = mail.getMsgId();         MsgLog msgLog = msgLogService.selectByMsgId(msgId);         if (null == msgLog || msgLog.getStatus().equals(Constant.MsgLogStatus.CONSUMED_SUCCESS)) {// 消费幂等性             log.info("重复消费, msgId: {}", msgId);             return;         }         MessageProperties properties = message.getMessageProperties();         long tag = properties.getDeliveryTag();         boolean success = mailUtil.send(mail);         if (success) {             msgLogService.updateStatus(msgId, Constant.MsgLogStatus.CONSUMED_SUCCESS);             channel.basicAck(tag, false);// 消费确认         } else {             channel.basicNack(tag, false, true);         }     } } 

说明: 其实就完成了3件事: 1.保证消费幂等性, 2.发送邮件, 3.更新消息状态, 手动ack，这样就保证了应答正确性，更多的大厂实践文章能够在码匠笔记订阅号后台回复实践免费获取。

九、ResendMsg定时任务从新投递发送失败的消息

@Component @Slf4j public class ResendMsg {     @Autowired     private MsgLogService msgLogService;     @Autowired     private RabbitTemplate rabbitTemplate;     // 最大投递次数     private static final int MAX_TRY_COUNT = 3;     /**      * 每30s拉取投递失败的消息, 从新投递      */     @Scheduled(cron = "0/30 * * * * ?")     public void resend() {         log.info("开始执行定时任务(从新投递消息)");         List<MsgLog> msgLogs = msgLogService.selectTimeoutMsg();         msgLogs.forEach(msgLog -> {             String msgId = msgLog.getMsgId();             if (msgLog.getTryCount() >= MAX_TRY_COUNT) {                 msgLogService.updateStatus(msgId, Constant.MsgLogStatus.DELIVER_FAIL);                 log.info("超过最大重试次数, 消息投递失败, msgId: {}", msgId);             } else {                 msgLogService.updateTryCount(msgId, msgLog.getNextTryTime());// 投递次数+1                 CorrelationData correlationData = new CorrelationData(msgId);                 rabbitTemplate.convertAndSend(msgLog.getExchange(), msgLog.getRoutingKey(), MessageHelper.objToMsg(msgLog.getMsg()), correlationData);// 从新投递                 log.info("第 " + (msgLog.getTryCount() + 1) + " 次从新投递消息");             }         });         log.info("定时任务执行结束(从新投递消息)");     } } 

说明: 每一条消息都和exchange routingKey绑定, 全部消息重投共用这一个定时任务便可

5、基本测试

OK, 目前为止, 代码准备就绪, 如今进行正常流程的测试

一、发送请求:

二、后台日志:

三、数据库消息记录:

状态为3, 代表已消费, 消息重试次数为0, 代表一次投递就成功了

四、查看邮箱

发送成功

6、各类异常状况测试

步骤一罗列了不少关于RabbitMQ的知识点, 很重要, 很核心, 而本文也涉及到了这些知识点的实现, 接下来就经过异常测试进行验证

一、验证消息发送到Exchange失败状况下的回调, 对应上图P -> X

如何验证? 能够随便指定一个不存在的交换机名称, 请求接口, 看是否会触发回调

发送失败, 缘由: reply-code=404, reply-text=NOT_FOUND - no exchange 'mail.exchangeabcd' in vhost '/', 该回调可以保证消息正确发送到Exchange, 测试完成

二、验证消息从Exchange路由到Queue失败状况下的回调, 对应上图X -> Q同理, 修改一下路由键为不存在的便可, 路由失败, 触发回调

发送失败, 缘由: route: mail.routing.keyabcd, replyCode: 312, replyText: NO_ROUTE

三、验证在手动ack模式下, 消费端必须进行手动确认(ack), 不然消息会一直保存在队列中, 直到被消费, 对应上图Q -> C

将消费端代码channel.basicAck(tag, false);// 消费确认注释掉, 查看控制台和rabbitmq管控台

能够看到, 虽然消息确实被消费了, 可是因为是手动确认模式, 而最后又没手动确认, 因此, 消息仍被rabbitmq保存, 因此, 手动ack可以保证消息必定被消费, 但必定要记得basicAck

四、验证消费端幂等性

接着上一步, 去掉注释, 重启服务器, 因为有一条未被ack的消息, 因此重启后监听到消息, 进行消费, 可是因为消费前会判断该消息的状态是否未被消费, 发现status=3, 即已消费, 因此, 直接return, 这样就保证了消费端的幂等性, 即便因为网络等缘由投递成功而未触发回调, 从而屡次投递, 也不会重复消费进而发生业务异常

五、验证消费端发生异常消息也不会丢失

很显然, 消费端代码可能发生异常, 若是不作处理, 业务没正确执行, 消息却不见了, 给咱们感受就是消息丢失了, 因为咱们消费端代码作了异常捕获, 业务异常时, 会触发: channel.basicNack(tag, false, true);, 这样会告诉rabbitmq该消息消费失败, 须要从新入队, 能够从新投递到其余正常的消费端进行消费, 从而保证消息不被丢失

测试: send方法直接返回false便可(这里跟抛出异常一个意思)

能够看到, 因为channel.basicNack(tag, false, true), 未被ack的消息(unacked)会从新入队并被消费, 这样就保证了消息不会走丢

六、验证定时任务的消息重投

实际应用场景中, 可能因为网络缘由, 或者消息未被持久化MQ就宕机了, 使得投递确认的回调方法ConfirmCallback没有被执行, 从而致使数据库该消息状态一直是投递中的状态, 此时就须要进行消息重投, 即便也许消息已经被消费了

定时任务只是保证消息100%投递成功, 而屡次投递的消费幂等性须要消费端本身保证

咱们能够将回调和消费成功后更新消息状态的代码注释掉, 开启定时任务, 查看是否重投

能够看到, 消息会重投3次, 超过3次放弃, 将消息状态置为投递失败状态, 出现这种非正常状况, 就须要人工介入排查缘由

7、拓展: 使用动态代理实现消费端幂等性验证和消费确认(ack)

不知道你们发现没有, 在MailConsumer中, 真正的业务逻辑其实只是发送邮件mailUtil.send(mail)而已, 但咱们又不得不在调用send方法以前校验消费幂等性, 发送后, 还要更新消息状态为"已消费"状态, 并手动ack, 实际项目中, 可能还有不少生产者-消费者的应用场景, 如记录日志, 发送短信等等, 都须要rabbitmq, 若是每次都写这些重复的公用代码, 不必, 也难以维护, 因此, 咱们能够将公共代码抽离出来, 让核心业务逻辑只关心本身的实现, 而不用作其余操做, 其实就是AOP

为达到这个目的, 有不少方法, 能够用spring aop, 能够用拦截器, 能够用静态代理, 也能够用动态代理, 在这里, 我用的是动态代理

目录结构以下:

核心代码就是代理的实现, 这里就不把全部代码贴出来了, 只是提供一个思路, 咱们要尽量地把代码写的更简洁更优雅

8、总结

发送邮件其实很简单, 但深究起来其实有不少须要注意和完善的点, 一个看似很小的知识点, 也能够引伸出不少问题, 甚至涉及到方方面面, 这些都须要本身踩坑, 固然我这代码确定还有不少不完善和须要优化的点, 但愿小伙伴多多提意见和建议。