springboot 整合rabbitmq发送邮件(保证消息100%投递成功并被消费)

前言:

RabbitMQ相关知识请参考://www.greatytc.com/p/cc3d2017e7b3

Linux安装RabbitMQ请参考://www.greatytc.com/p/ee9f7594212b

Windows安装RabbitMQ请参考://www.greatytc.com/p/c7726ba4b046

一、先扔一张图


说明:

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

消息发送确认机制

消费确认机制

消息的重新投递

消费幂等性, 等等

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


二、实现思路

简略介绍163邮箱授权码的获取

编写发送邮件工具类

编写RabbitMQ配置文件

生产者发起调用

消费者发送邮件

定时任务定时拉取投递失败的消息, 重新投递

各种异常情况的测试验证

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


三、项目介绍

springboot版本2.1.5.RELEASE, 旧版本可能有些配置属性不能使用, 需要以代码形式进行配置

RabbitMQ版本3.7.15

MailUtil: 发送邮件工具类

RabbitConfig: rabbitmq相关配置

TestServiceImpl: 生产者, 发送消息

MailConsumer: 消费者, 消费消息, 发送邮件

ResendMsg: 定时任务, 重新投递发送失败的消息

说明: 上面是核心代码,MsgLogService mapper xml等均未贴出, 完整代码可以参考GitHub, 欢迎fork,https://github.com/wangzaiplus/springboot/tree/wxw

四、代码实现

163邮箱授权码的获取, 如图:

image.png

该授权码就是配置文件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、邮箱配置

# rabbitmqspring.rabbitmq.host=localhostspring.rabbitmq.port=5672spring.rabbitmq.username=guestspring.rabbitmq.password=guest# 开启confirms回调 P -> Exchangespring.rabbitmq.publisher-confirms=true# 开启returnedMessage回调 Exchange -> Queuespring.rabbitmq.publisher-returns=true# 设置手动确认(ack) Queue -> Cspring.rabbitmq.listener.simple.acknowledge-mode=manualspring.rabbitmq.listener.simple.prefetch=100# mailspring.mail.host=smtp.163.comspring.mail.username=186****2249@163.comspring.mail.password=***spring.mail.from=186****2249@163.comspring.mail.properties.mail.smtp.auth=truespring.mail.properties.mail.smtp.starttls.enable=truespring.mail.properties.mail.smtp.starttls.required=true

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

表结构

CREATETABLE`msg_log`(`msg_id`varchar(255)NOTNULLDEFAULT''COMMENT'消息唯一标识',`msg` textCOMMENT'消息体, json格式化',`exchange`varchar(255)NOTNULLDEFAULT''COMMENT'交换机',`routing_key`varchar(255)NOTNULLDEFAULT''COMMENT'路由键',`status`int(11)NOTNULLDEFAULT'0'COMMENT'状态: 0投递中 1投递成功 2投递失败 3已消费',`try_count`int(11)NOTNULLDEFAULT'0'COMMENT'重试次数',`next_try_time` datetimeDEFAULTNULLCOMMENT'下一次重试时间',`create_time` datetimeDEFAULTNULLCOMMENT'创建时间',`update_time` datetimeDEFAULTNULLCOMMENT'更新时间',PRIMARYKEY(`msg_id`),UNIQUEKEY`unq_msg_id`(`msg_id`)USINGBTREE)ENGINE=InnoDBDEFAULTCHARSET=utf8mb4COMMENT='消息投递日志';

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

MailUtil

@Component@Slf4jpublicclassMailUtil{@Value("${spring.mail.from}")privateStringfrom;@AutowiredprivateJavaMailSender mailSender;/**

    * 发送简单邮件

    *

    * @param mail

    */publicbooleansend(Mail mail){String to=mail.getTo();// 目标邮箱String title=mail.getTitle();// 邮件标题String content=mail.getContent();// 邮件正文SimpleMailMessage message=newSimpleMailMessage();message.setFrom(from);message.setTo(to);message.setSubject(title);message.setText(content);try{mailSender.send(message);log.info("邮件发送成功");returntrue;}catch(MailException e){log.error("邮件发送失败, to: {}, title: {}",to,title,e);returnfalse;}}}

RabbitConfig

@Configuration@Slf4jpublicclassRabbitConfig{@AutowiredprivateCachingConnectionFactoryconnectionFactory;@AutowiredprivateMsgLogServicemsgLogService;@BeanpublicRabbitTemplaterabbitTemplate(){RabbitTemplaterabbitTemplate=newRabbitTemplate(connectionFactory);rabbitTemplate.setMessageConverter(converter());// 消息是否成功发送到ExchangerabbitTemplate.setConfirmCallback((correlationData,ack,cause)->{if(ack){log.info("消息成功发送到Exchange");StringmsgId=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);});returnrabbitTemplate;}@BeanpublicJackson2JsonMessageConverterconverter(){returnnewJackson2JsonMessageConverter();}// 发送邮件publicstaticfinalStringMAIL_QUEUE_NAME="mail.queue";publicstaticfinalStringMAIL_EXCHANGE_NAME="mail.exchange";publicstaticfinalStringMAIL_ROUTING_KEY_NAME="mail.routing.key";@BeanpublicQueuemailQueue(){returnnewQueue(MAIL_QUEUE_NAME,true);}@BeanpublicDirectExchangemailExchange(){returnnewDirectExchange(MAIL_EXCHANGE_NAME,true,false);}@BeanpublicBindingmailBinding(){returnBindingBuilder.bind(mailQueue()).to(mailExchange()).with(MAIL_ROUTING_KEY_NAME);}}

TestServiceImpl生产消息

@ServicepublicclassTestServiceImplimplementsTestService{@AutowiredprivateMsgLogMappermsgLogMapper;@AutowiredprivateRabbitTemplaterabbitTemplate;@OverridepublicServerResponsesend(Mailmail){StringmsgId=RandomUtil.UUID32();mail.setMsgId(msgId);MsgLogmsgLog=newMsgLog(msgId,mail,RabbitConfig.MAIL_EXCHANGE_NAME,RabbitConfig.MAIL_ROUTING_KEY_NAME);msgLogMapper.insert(msgLog);// 消息入库CorrelationDatacorrelationData=newCorrelationData(msgId);rabbitTemplate.convertAndSend(RabbitConfig.MAIL_EXCHANGE_NAME,RabbitConfig.MAIL_ROUTING_KEY_NAME,MessageHelper.objToMsg(mail),correlationData);// 发送消息returnServerResponse.success(ResponseCode.MAIL_SEND_SUCCESS.getMsg());}}

MailConsumer消费消息, 发送邮件

@Component@Slf4jpublicclassMailConsumer{@AutowiredprivateMsgLogServicemsgLogService;@AutowiredprivateMailUtilmailUtil;@RabbitListener(queues=RabbitConfig.MAIL_QUEUE_NAME)publicvoidconsume(Messagemessage,Channelchannel)throwsIOException{Mailmail=MessageHelper.msgToObj(message,Mail.class);log.info("收到消息: {}",mail.toString());StringmsgId=mail.getMsgId();MsgLogmsgLog=msgLogService.selectByMsgId(msgId);if(null==msgLog||msgLog.getStatus().equals(Constant.MsgLogStatus.CONSUMED_SUCCESS)){// 消费幂等性log.info("重复消费, msgId: {}",msgId);return;}MessagePropertiesproperties=message.getMessageProperties();longtag=properties.getDeliveryTag();booleansuccess=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@Slf4jpublicclassResendMsg{@AutowiredprivateMsgLogServicemsgLogService;@AutowiredprivateRabbitTemplaterabbitTemplate;// 最大投递次数privatestaticfinalintMAX_TRY_COUNT=3;/**

    * 每30s拉取投递失败的消息, 重新投递

    */@Scheduled(cron="0/30 * * * * ?")publicvoidresend(){log.info("开始执行定时任务(重新投递消息)");List<MsgLog>msgLogs=msgLogService.selectTimeoutMsg();msgLogs.forEach(msgLog->{StringmsgId=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());// 投递次数+1CorrelationDatacorrelationData=newCorrelationData(msgId);rabbitTemplate.convertAndSend(msgLog.getExchange(),msgLog.getRoutingKey(),MessageHelper.objToMsg(msgLog.getMsg()),correlationData);// 重新投递log.info("第 "+(msgLog.getTryCount()+1)+" 次重新投递消息");}});log.info("定时任务执行结束(重新投递消息)");}}

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

五、基本测试

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

发送请求:


后台日志:


数据库消息记录:


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

查看邮箱


发送成功

六、各种异常情况测试

步骤一罗列了很多关于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%投递成功, 而多次投递的消费幂等性需要消费端自己保证

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

image.png


可以看到, 消息会重投3次, 超过3次放弃, 将消息状态置为投递失败状态, 出现这种非正常情况, 就需要人工介入排查原因

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

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

为达到这个目的, 有很多方法, 可以用spring aop, 可以用拦截器, 可以用静态代理, 也可以用动态代理, 在这里, 我用的是动态代理

目录结构如下:

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

八、总结

发送邮件其实很简单, 但深究起来其实有很多需要注意和完善的点, 一个看似很小的知识点, 也可以引申出很多问题, 甚至涉及到方方面面, 这些都需要自己踩坑, 当然我这代码肯定还有很多不完善和需要优化的点, 希望小伙伴多多提意见和建议

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 211,194评论 6赞 490
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,058评论 2赞 385
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 156,780评论 0赞 346
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,388评论 1赞 283
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,430评论 5赞 384
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,764评论 1赞 290
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,907评论 3赞 406
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,679评论 0赞 266
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,122评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,459评论 2赞 325
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,605评论 1赞 340
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,270评论 4赞 329
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,867评论 3赞 312
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,734评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,961评论 1赞 265
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,297评论 2赞 360
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,472评论 2赞 348