一、先扔一張圖

說明:

本文涵蓋了關于RabbitMQ很多方面的知識點, 如:

• 消息發送確認機制

• 消費確認機制

• 消息的重新投遞

• 消費冪等性, 等等

這些都是圍繞上面那張整體流程圖展開的, 所以有必要先貼出來, 見圖知意

二、實現思路

簡略介紹 163 郵箱授權碼的獲取

編寫發送郵件工具類

編寫 RabbitMQ 配置文件

生產者發起調用

消費者發送郵件

定時任務定時拉取投遞失敗的消息, 重新投遞

各種異常情況的測試驗證

拓展: 使用動態代理實現消費端冪等性驗證和消息確認 (ack)

三、項目介紹

springboot版本2.1.5.RELEASE, 舊版本可能有些配置屬性不能使用, 需要以代碼形式進行配置

RabbitMQ版本3.7.15

MailUtil: 發送郵件工具類

RabbitConfig: rabbitmq 相關配置

TestServiceImpl: 生產者, 發送消息

MailConsumer: 消費者, 消費消息, 發送郵件

ResendMsg: 定時任務, 重新投遞發送失敗的消息

四、代碼實現

163 郵箱授權碼的獲取, 如圖:

該授權碼就是配置文件spring.mail.password需要的密碼

pom

org.springframework.bootspring-boot-starter-amqp

org.springframework.bootspring-boot-starter-mail

rabbitmq、郵箱配置

spring.rabbitmq.host=localhost
spring.rabbitmq.port=5672
spring.rabbitmq.username=guest
spring.rabbitmq.password=guest

spring.rabbitmq.publisher-confirms=true

spring.rabbitmq.publisher-returns=true

spring.rabbitmq.listener.simple.acknowledge-mode=manual
spring.rabbitmq.listener.simple.prefetch=100


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;


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());


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);
}
});


rabbitTemplate.setMandatory(true);

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;


@Scheduled(cron = "0/30 * * * * ?")
public void resend() {
log.info("開始執行定時任務(重新投遞消息)");

List 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());
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綁定, 所有消息重投共用這一個定時任務即可

五、基本測試

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% 投遞成功, 而多次投遞的消費冪等性需要消費端自己保證

我們可以將回調和消費成功后更新消息狀態的代碼注釋掉, 開啟定時任務, 查看是否重投

可以看到, 消息會重投 3 次, 超過 3 次放棄, 將消息狀態置為投遞失敗狀態, 出現這種非正常情況, 就需要人工介入排查原因

七、拓展: 使用動態代理實現消費端冪等性驗證和消費確認 (ack)

不知道大家發現沒有, 在MailConsumer中, 真正的業務邏輯其實只是發送郵件mailUtil.send(mail)而已, 但我們又不得不在調用send方法之前校驗消費冪等性, 發送后, 還要更新消息狀態為 "已消費" 狀態, 并手動 ack, 實際項目中, 可能還有很多生產者 - 消費者的應用場景, 如記錄日志, 發送短信等等, 都需要 rabbitmq, 如果每次都寫這些重復的公用代碼, 沒必要, 也難以維護, 所以, 我們可以將公共代碼抽離出來, 讓核心業務邏輯只關心自己的實現, 而不用做其他操作, 其實就是 AOP

為達到這個目的, 有很多方法, 可以用 spring aop, 可以用攔截器, 可以用靜態代理, 也可以用動態代理, 在這里, 我用的是動態代理

目錄結構如下:

核心代碼就是代理的實現, 這里就不把所有代碼貼出來了, 只是提供一個思路, 我們要盡可能地把代碼寫的更簡潔更優雅

總結

以上是生活随笔為你收集整理的exchange 只发送邮件 不能登录_springboot + rabbitmq发送邮件的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。