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

• wangzaiplus

• https://www.jianshu.com/p/dca01aad6bc8

一、先扔一张图

说明:

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

• 消息发送确认机制

• 消费确认机制

• 消息的重新投递

• 消费幂等性, 等等

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

二、实现思路

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

2. 编写发送邮件工具类

3. 编写 RabbitMQ 配置文件

4. 生产者发起调用

5. 消费者发送邮件

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

7. 各种异常情况的测试验证

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

三、项目介绍

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

2. RabbitMQ版本 3.7.15

3. MailUtil: 发送邮件工具类

4. RabbitConfig: rabbitmq 相关配置

5. TestServiceImpl: 生产者, 发送消息

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

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

四、代码实现

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

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

1. pom

1. <dependency>

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

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

4. </dependency>

5. <dependency>

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

7. <artifactId>spring-boot-starter-mail</artifactId>

8. </dependency>

1. rabbitmq、邮箱配置

1. spring.rabbitmq.host=localhost

2. spring.rabbitmq.port=5672

3. spring.rabbitmq.username=guest

4. spring.rabbitmq.password=guest

5. spring.rabbitmq.publisher-confirms=true

6. spring.rabbitmq.publisher-returns=true

7. spring.rabbitmq.listener.simple.acknowledge-mode=manual

8. spring.rabbitmq.listener.simple.prefetch=100

9. spring.mail.host=smtp.163.com

10. spring.mail.username=[e-mail]

11. spring.mail.password=123456wangzai

12. spring.mail.from=[e-mail]

13. spring.mail.properties.mail.smtp.auth=true

14. spring.mail.properties.mail.smtp.starttls.enable=true

15. spring.mail.properties.mail.smtp.starttls.required=true

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

1. 表结构

1. CREATE TABLE `msg_log` (

2. `msg_id` varchar(255) NOT NULL DEFAULT '' COMMENT '消息唯一标识',

3. `msg` text COMMENT '消息体, json格式化',

4. `exchange` varchar(255) NOT NULL DEFAULT '' COMMENT '交换机',

5. `routing_key` varchar(255) NOT NULL DEFAULT '' COMMENT '路由键',

6. `status` int(11) NOT NULL DEFAULT '0' COMMENT '状态: 0投递中 1投递成功 2投递失败 3已消费',

7. `try_count` int(11) NOT NULL DEFAULT '0' COMMENT '重试次数',

8. `next_try_time` datetime DEFAULT NULL COMMENT '下一次重试时间',

9. `create_time` datetime DEFAULT NULL COMMENT '创建时间',

10. `update_time` datetime DEFAULT NULL COMMENT '更新时间',

11. PRIMARY KEY (`msg_id`),

12. UNIQUE KEY `unq_msg_id` (`msg_id`) USING BTREE

13. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='消息投递日志';

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

1. MailUtil

1. @Component

2. @Slf4j

3. public class MailUtil {

4. @Value("${spring.mail.from}")

5. private String from;

6. @Autowired

7. private JavaMailSender mailSender;

8. public boolean send(Mail mail) {

9. String to = mail.getTo();

10. String title = mail.getTitle();

11. String content = mail.getContent();

12. SimpleMailMessage message = new SimpleMailMessage();

13. message.setFrom(from);

14. message.setTo(to);

15. message.setSubject(title);

16. message.setText(content);

17. try {

18. mailSender.send(message);

19. log.info("邮件发送成功");

20. return true;

21. } catch (MailException e) {

22. log.error("邮件发送失败, to: {}, title: {}", to, title, e);

23. return false;

24. }

25. }

26. }

1. RabbitConfig

1. @Configuration

2. @Slf4j

3. public class RabbitConfig {

4. @Autowired

5. private CachingConnectionFactory connectionFactory;

6. @Autowired

7. private MsgLogService msgLogService;

8. @Bean

9. public RabbitTemplate rabbitTemplate() {

10. RabbitTemplate rabbitTemplate = new RabbitTemplate(connectionFactory);

11. rabbitTemplate.setMessageConverter(converter());

12. rabbitTemplate.setConfirmCallback((correlationData, ack, cause) -> {

13. if (ack) {

14. log.info("消息成功发送到Exchange");

15. String msgId = correlationData.getId();

16. msgLogService.updateStatus(msgId, Constant.MsgLogStatus.DELIVER_SUCCESS);

17. } else {

18. log.info("消息发送到Exchange失败, {}, cause: {}", correlationData, cause);

19. }

20. });

21. rabbitTemplate.setMandatory(true);

22. rabbitTemplate.setReturnCallback((message, replyCode, replyText, exchange, routingKey) -> {

23. log.info("消息从Exchange路由到Queue失败: exchange: {}, route: {}, replyCode: {}, replyText: {}, message: {}", exchange, routingKey, replyCode, replyText, message);

24. });

25. return rabbitTemplate;

26. }

27. @Bean

28. public Jackson2JsonMessageConverter converter() {

29. return new Jackson2JsonMessageConverter();

30. }

31. public static final String MAIL_QUEUE_NAME = "mail.queue";

32. public static final String MAIL_EXCHANGE_NAME = "mail.exchange";

33. public static final String MAIL_ROUTING_KEY_NAME = "mail.routing.key";

34. @Bean

35. public Queue mailQueue() {

36. return new Queue(MAIL_QUEUE_NAME, true);

37. }

38. @Bean

39. public DirectExchange mailExchange() {

40. return new DirectExchange(MAIL_EXCHANGE_NAME, true, false);

41. }

42. @Bean

43. public Binding mailBinding() {

44. return BindingBuilder.bind(mailQueue()).to(mailExchange()).with(MAIL_ROUTING_KEY_NAME);

45. }

46. }

1. TestServiceImpl生产消息

1. @Service

2. public class TestServiceImpl implements TestService {

3. @Autowired

4. private MsgLogMapper msgLogMapper;

5. @Autowired

6. private RabbitTemplate rabbitTemplate;

7. @Override

8. public ServerResponse send(Mail mail) {

9. String msgId = RandomUtil.UUID32();

10. mail.setMsgId(msgId);

11. MsgLog msgLog = new MsgLog(msgId, mail, RabbitConfig.MAIL_EXCHANGE_NAME, RabbitConfig.MAIL_ROUTING_KEY_NAME);

12. msgLogMapper.insert(msgLog);

13. CorrelationData correlationData = new CorrelationData(msgId);

14. rabbitTemplate.convertAndSend(RabbitConfig.MAIL_EXCHANGE_NAME, RabbitConfig.MAIL_ROUTING_KEY_NAME, MessageHelper.objToMsg(mail), correlationData);

15. return ServerResponse.success(ResponseCode.MAIL_SEND_SUCCESS.getMsg());

16. }

17. }

1. MailConsumer消费消息, 发送邮件

1. @Component

2. @Slf4j

3. public class MailConsumer {

4. @Autowired

5. private MsgLogService msgLogService;

6. @Autowired

7. private MailUtil mailUtil;

8. @RabbitListener(queues = RabbitConfig.MAIL_QUEUE_NAME)

9. public void consume(Message message, Channel channel) throws IOException {

10. Mail mail = MessageHelper.msgToObj(message, Mail.class);

11. log.info("收到消息: {}", mail.toString());

12. String msgId = mail.getMsgId();

13. MsgLog msgLog = msgLogService.selectByMsgId(msgId);

14. if (null == msgLog || msgLog.getStatus().equals(Constant.MsgLogStatus.CONSUMED_SUCCESS)) {

15. log.info("重复消费, msgId: {}", msgId);

16. return;

17. }

18. MessageProperties properties = message.getMessageProperties();

19. long tag = properties.getDeliveryTag();

20. boolean success = mailUtil.send(mail);

21. if (success) {

22. msgLogService.updateStatus(msgId, Constant.MsgLogStatus.CONSUMED_SUCCESS);

23. channel.basicAck(tag, false);

24. } else {

25. channel.basicNack(tag, false, true);

26. }

27. }

28. }

说明: 其实就完成了 3 件事: 1. 保证消费幂等性, 2. 发送邮件, 3. 更新消息状态, 手动 ack

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

1. @Component

2. @Slf4j

3. public class ResendMsg {

4. @Autowired

5. private MsgLogService msgLogService;

6. @Autowired

7. private RabbitTemplate rabbitTemplate;

8. private static final int MAX_TRY_COUNT = 3;

9. @Scheduled(cron = "0/30 * * * * ?")

10. public void resend() {

11. log.info("开始执行定时任务(重新投递消息)");

12. List<MsgLog> msgLogs = msgLogService.selectTimeoutMsg();

13. msgLogs.forEach(msgLog -> {

14. String msgId = msgLog.getMsgId();

15. if (msgLog.getTryCount() >= MAX_TRY_COUNT) {

16. msgLogService.updateStatus(msgId, Constant.MsgLogStatus.DELIVER_FAIL);

17. log.info("超过最大重试次数, 消息投递失败, msgId: {}", msgId);

18. } else {

19. msgLogService.updateTryCount(msgId, msgLog.getNextTryTime());

20. CorrelationData correlationData = new CorrelationData(msgId);

21. rabbitTemplate.convertAndSend(msgLog.getExchange(), msgLog.getRoutingKey(), MessageHelper.objToMsg(msgLog.getMsg()), correlationData);

22. log.info("第 " + (msgLog.getTryCount() + 1) + " 次重新投递消息");

23. }

24. });

25. log.info("定时任务执行结束(重新投递消息)");

26. }

27. }

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

五、基本测试

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

1. 发送请求:

1. 后台日志:

1. 数据库消息记录:

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

1. 查看邮箱

发送成功

六、各种异常情况测试

步骤一罗列了很多关于 RabbitMQ 的知识点, 很重要, 很核心, 而本文也涉及到了这些知识点的实现, 接下来就通过异常测试进行验证 (这些验证都是围绕本文开头扔的那张流程图展开的, 很重要, 所以, 再贴一遍)

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

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

发送失败, 原因: reply-code=404,reply-text=NOT_FOUND-noexchange'mail.exchangeabcd'invhost'/', 该回调能够保证消息正确发送到 Exchange, 测试完成

1. 验证消息从 Exchange 路由到 Queue 失败情况下的回调, 对应上图 X->Q

同理, 修改一下路由键为不存在的即可, 路由失败, 触发回调

发送失败, 原因: route:mail.routing.keyabcd,replyCode:312,replyText:NO_ROUTE

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

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

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

1. 验证消费端幂等性

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

1. 验证消费端发生异常消息也不会丢失

很显然, 消费端代码可能发生异常, 如果不做处理, 业务没正确执行, 消息却不见了, 给我们感觉就是消息丢失了, 由于我们消费端代码做了异常捕获, 业务异常时, 会触发: channel.basicNack(tag,false,true);, 这样会告诉 rabbitmq 该消息消费失败, 需要重新入队, 可以重新投递到其他正常的消费端进行消费, 从而保证消息不被丢失

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

可以看到, 由于 channel.basicNack(tag,false,true), 未被 ack 的消息 (unacked) 会重新入队并被消费, 这样就保证了消息不会走丢

1. 验证定时任务的消息重投

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

定时任务只是保证消息 100% 投递成功, 而多次投递的消费幂等性需要消费端自己保证

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

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

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

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

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

目录结构如下:

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

八、总结

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

我的代码都是经过自测验证过的, 图也都是一点一点自己画的或认真截的, 希望小伙伴能学到一点东西, 路过的点个赞或点个关注呗, 谢谢

项目 Github, 欢迎 fork
https://github.com/wangzaiplus/springboot/tree/wxw

（完）

【推荐阅读】

好文！必须点赞