前言
發送郵件功能，借鑒
剛果商城，根據文檔及項目代碼實現。整理總結便有了此文，文章有不對的點，請聯系博主指出，請多多點贊收藏，您的支持是我最大的動力~
發送郵件功能主要借助 mail、freemarker以及rocketmq實現。
剛果商城是個分布式項目，近看發送消息模塊即可。
標準的DDD分層架構。
RocketMQ部署
方便起見，使用docker部署環境
RocketMQ 4.5.1 安裝部署
安裝 NameServer
docker run -d -p 9876:9876 --name rmqnamesrv foxiswho/rocketmq:server-4.5.1
安裝 Brocker
1）新建配置目錄
mkdir -p /mydata/rocketmq/conf
2）新建配置文件 broker.conf
brokerClusterName = DefaultCluster
brokerName = broker-a
brokerId = 0
deleteWhen = 04
fileReservedTime = 48
brokerRole = ASYNC_MASTER
flushDiskType = ASYNC_FLUSH
# 此處為本地ip, 如果部署服務器, 需要填寫服務器外網ip
brokerIP1 = xx.xx.xx.xx
3）創建容器
docker run -d \
-p 10911:10911 \
-p 10909:10909 \
--name rmqbroker \
--link rmqnamesrv:namesrv \
-v /mydata/rocketmq/conf/broker.conf:/etc/rocketmq/broker.conf \
-e "NAMESRV_ADDR=namesrv:9876" \
-e "JAVA_OPTS=-Duser.home=/opt" \
-e "JAVA_OPT_EXT=-server -Xms512m -Xmx512m" \
foxiswho/rocketmq:broker-4.5.1
安裝 rocketmq 控制臺
docker pull pangliang/rocketmq-console-ng
docker run -d \
--link rmqnamesrv:namesrv \
-e "JAVA_OPTS=-Drocketmq.config.namesrvAddr=namesrv:9876 -Drocketmq.config.isVIPChannel=false" \
--name rmqconsole \
-p 8088:8080 \
-t pangliang/rocketmq-console-ng
運行成功，稍等幾秒啟動時間，瀏覽器輸入 ip:8088 查看。
記得放行上述所有端口，最終結果如下：
RocketMQ安裝成功~
引入主要依賴
<!-- 發送郵件主要依賴 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-mail</artifactId></dependency><!-- 模板引擎 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-freemarker</artifactId></dependency><!-- 消息隊列 實現解耦 --><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-stream-rocketmq</artifactId></dependency>
配置文件
主要看application.yaml 和 application-dev.yaml
application.yaml
server:port: 8001spring:profiles:active: devapplication:name: message-servicestream:bindings:# 主要是如下兩個通道的配置 （消費者通道）mailSend:consumer:concurrency: 4max-attempts: 1content-type: application/jsondestination: message-center_topicgroup: message-center_mail-send_cg# 生產者通道 messageOutput:content-type: application/jsondestination: message-center_topicgroup: message-center_general-send_pgrocketmq:bindings:mailSend:consumer:delay-level-when-next-consume: -1tags: common_message-center_mail-send_tag# ...
application-dev.yaml
spring:cloud:nacos:discovery:server-addr: 127.0.0.1:8848stream:rocketmq:binder:name-server: 127.0.0.1:9876 # rocketmq服務mail:default-encoding: UTF-8host: smtp.163.compassword: xxxport: 25protocol: smtpusername: xxx@163.com
重要的是mail中參數（用的是網易郵箱），username：網易郵箱賬號，password：登錄 SMTP server 的密碼
登錄 SMTP server 密碼
password獲取步驟如下：
一、登錄網頁版郵箱（https://email.163.com/)，進入郵箱首頁。
二、點擊上方設置，選擇POP/SMTP/IMAP選項。
三、在客戶端協議界面，選擇開啟對應的協議，IMAP或者POP3分別為不同的收信協議，選擇只開啟需要的收信協議，比如IMAP，推薦使用IMAP協議來收發郵件，它可以和網頁版完全同步。
四、點擊開啟，繼續開啟，手機掃碼發送短信后，得到的一串密碼即為登錄密碼
真正代碼實現
interfaces層
用戶接口層，入參為CQRS風格，參數都在application層
發送郵件入參：
@Data
@ApiModel("郵箱發送")
public class MailSendCommand {@ApiModelProperty(value = "標題", example = "剛果商城郵箱驗證碼提醒")@NotBlank(message = "郵箱標題不能為空")private String title;@Email@ApiModelProperty(value = "發送者", example = "congomall@163.com")@NotBlank(message = "郵箱發送者不能為空")private String sender;@Email@ApiModelProperty(value = "接收者", example = "7798432@163.com", notes = "實際發送時更改為自己郵箱")@NotBlank(message = "郵箱接收者不能為空")private String receiver;@Email@ApiModelProperty("抄送者")private String cc;@ApiModelProperty(value = "消息參數")private List<String> paramList;// 與數據庫對應@ApiModelProperty(value = "模板ID", example = "userRegisterVerification")@NotBlank(message = "郵箱模板ID不能為空")private String templateId;
}
application層
直接調用到application層Service實現類方法，該層封裝好參數直接調用基礎層中消息生產者。
domain層
領域層里面主要是一些常量、實體類，接口以及倉儲接口具體實現在基礎層。
infrastructure層 ☆
消息通道配置
source -> sink
public interface MessageSource {String OUTPUT = "messageOutput";@Output(MessageSource.OUTPUT)MessageChannel messageOutput();
}
public interface MessageSink {String MAIL_SEND = "mailSend";@Input(MessageSink.MAIL_SEND)SubscribableChannel mailSend();
}
常量與配置文件中通道名稱保持一致
消息生產者
@Slf4j
@Component
@AllArgsConstructor
public class MessageSendProduce {// 屬性名與配置文件中通道名保持一致private final MessageChannel messageOutput;/*** 郵箱消息發送*/public void mailMessageSend(MailMessageSendEvent mailMessageSendEvent) {String keys = UUID.randomUUID().toString();Message<?> message = MessageBuilder.withPayload(JSON.toJSONString(mailMessageSendEvent)).setHeader(MessageConst.PROPERTY_KEYS, keys).setHeader(MessageConst.PROPERTY_TAGS, MessageRocketMQConstants.MESSAGE_MAIL_SEND_TAG).build();long startTime = SystemClock.now();boolean sendResult = false;try {// 發送消息給mqsendResult = messageOutput.send(message, 2000L);} finally {log.info("郵箱消息發送，發送狀態: {}, Keys: {}, 執行時間: {} ms, 消息內容: {}", sendResult, keys, SystemClock.now() - startTime, JSON.toJSONString(mailMessageSendEvent));}}
}
消息消費者
@Slf4j
@Component
@RequiredArgsConstructor
public class MailMessageSendConsume {private final MessageSendFacade messageSendFacade;// 冪等性注解，還沒研究@Idempotent(uniqueKeyPrefix = "mail_message_send:",key = "#event.messageSendId+'_'+#event.hashCode()",type = IdempotentTypeEnum.SPEL,scene = IdempotentSceneEnum.MQ,keyTimeout = 600L)@StreamListener(MessageSink.MAIL_SEND)public void mailMessageSend(@Payload MailMessageSendEvent event, @Headers Map headers) {long startTime = System.currentTimeMillis();try {MessageSend messageSend = BeanUtil.toBean(event, MessageSend.class);// 【外觀模式】: 抽象消息發送、消息存儲以及失敗回調業務方等邏輯messageSendFacade.mailMessageSend(messageSend);} finally {log.info("Keys: {}, Msg id: {}, Execute time: {} ms, Message: {}", headers.get("rocketmq_KEYS"), headers.get("rocketmq_MESSAGE_ID"), System.currentTimeMillis() - startTime,JSON.toJSONString(event));}}
}
【外觀模式】
直接與外觀類交互，外觀類封裝了做某件事的所有操作，無需與一個個子操作一一交互，
降低了復雜性，提高了可維護性。
以消息發送為例，將發送郵箱以及消息存儲和失敗回調業務封裝為一個方法降低調用處理復雜度。
發送郵箱核心實現類 ☆
@Slf4j
@Component
@AllArgsConstructor
public class MailMessageProduceImpl implements ApplicationListener<ApplicationInitializingEvent>, MailMessageProduce {private final MailTemplateMapper mailTemplateMapper;private final JavaMailSender javaMailSender;private final Configuration configuration;@SneakyThrows@Overridepublic boolean send(MessageSend messageSend) {try {// 根據模板id查詢模板 模板id：userRegisterVerificationMailTemplateDO mailTemplateDO = mailTemplateMapper.selectOne(Wrappers.lambdaQuery(MailTemplateDO.class).eq(MailTemplateDO::getTemplateId, messageSend.getTemplateId()));MimeMessage mimeMessage = javaMailSender.createMimeMessage();MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);helper.setFrom(messageSend.getSender());helper.setSubject(messageSend.getTitle());if (StrUtil.isNotBlank(messageSend.getCc())) {helper.setCc(messageSend.getCc().split(","));}if (StrUtil.isNotBlank(messageSend.getReceiver())) {helper.setTo(messageSend.getReceiver().split(","));}Map<String, Object> model = Maps.newHashMap();// 模板參數名稱與下面freemarker模板中參數一一對應String[] templateParams = mailTemplateDO.getTemplateParam().split(",");if (ArrayUtil.isNotEmpty(templateParams)) {for (int i = 0; i < templateParams.length; i++) {model.put(templateParams[i], messageSend.getParamList().get(i));}}// 模板id就是模板名String templateKey = messageSend.getTemplateId() + ".ftl";// 從單例對象容器獲取模板Template template = Singleton.get(templateKey, () -> {try {return configuration.getTemplate(templateKey);} catch (IOException e) {throw new RuntimeException(e);}});String html = FreeMarkerTemplateUtils.processTemplateIntoString(template, model);helper.setText(html, true);// freemarker填充參數，發送郵箱javaMailSender.send(mimeMessage);} catch (Throwable ex) {log.error("郵件發送失敗，Request: {}", JSONUtil.toJsonStr(messageSend), ex);return false;}return true;}/*** 初始化郵箱模板 【率先先將所有模板初始化到單例對象容器中】*/@SneakyThrows@Overridepublic void onApplicationEvent(ApplicationInitializingEvent event) {Resource[] resources = new PathMatchingResourcePatternResolver().getResources(ResourceUtils.CLASSPATH_URL_PREFIX + "templates/*.ftl");for (Resource resource : resources) {String templateName = resource.getFilename();Singleton.put(templateName, configuration.getTemplate(templateName));}}
}
模板具體內容：
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<body>
<div><p style="caret-color: rgb(86, 90, 92); color: rgb(86, 90, 92); font-family: Helvetica, 微軟雅黑, 宋體; text-size-adjust: auto; font-size: 20px;">親愛的用戶：</p><p style="caret-color: rgb(86, 90, 92); color: rgb(86, 90, 92); font-family: Helvetica, 微軟雅黑, 宋體; font-size: 18px; text-size-adjust: auto;">您好！感謝您的使用，您本次的驗證碼為：<span class="Apple-converted-space"> </span></p><bstyle="font-family: Helvetica, 微軟雅黑, 宋體; text-size-adjust: auto; font-size: 32px; color: rgb(45, 123, 255);">${validCode}</b><p style="caret-color: rgb(86, 90, 92); color: rgb(86, 90, 92); font-family: Helvetica, 微軟雅黑, 宋體; text-size-adjust: auto; font-size: 20px;">安全提示：</p><p style="caret-color: rgb(86, 90, 92); color: rgb(86, 90, 92); font-family: Helvetica, 微軟雅黑, 宋體; font-size: 18px; text-size-adjust: auto;">為保障您的帳戶安全，請在 5 分鐘內完成驗證，否則驗證碼將自動失效。<span class="Apple-converted-space"> </span></p>
</div>
<div><includetail><!--<![endif]--></includetail>
</div>
</body>
</html>
最終實現效果
測試結果如下：
收件為QQ郵箱：
收件為谷歌郵箱：
經我測試發現，
配置的是網易郵箱，發送者就只能是網易郵箱，接收者可以是任意郵箱。
