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、總結

發送郵件其實很簡單, 但深究起來其實有不少須要注意和完善的點, 一個看似很小的知識點, 也能夠引伸出不少問題, 甚至涉及到方方面面, 這些都須要本身踩坑, 固然我這代碼確定還有不少不完善和須要優化的點, 但願小夥伴多多提意見和建議。