SpringCloud微服務實戰——搭建企業級開發框架（四十三）：多租戶可配置的電子郵件發送系統設計與實現
- 2022 年 7 月 7 日
- 筆記
- SpringCloud, SpringSecurity, 微服務
在日常生活中，郵件已經被聊天軟件、短訊等更便捷的信息傳送方式代替。但在日常工作中，我們的重要的信息通知等非常有必要去歸檔追溯，那麼郵件就是不可或缺的信息傳送渠道。對於我們工作中經常用到的系統，裏面也基本都集成了郵件發送功能。
SpringBoot提供了基於JavaMail的starter，我們只要按照官方的說明配置郵件服務器信息，即可使我們的系統擁有發送電子郵件的功能。但是，在我們GitEgg開發框架的實際業務開發過程中，有兩個問題需要解決：一個是SpringBoot郵箱服務器的配置是配置在配置文件中的，不支持靈活的界面配置。另外一個是我們的開發框架需要支持多租戶，那麼此時需要對SpringBoot提供的郵件發送功能進行擴展，以滿足我們的需求。
那麼，基於以上需求和問題，我們對GitEgg框架進行擴展，增加以下功能：
1、擴展系統配置：將郵箱服務器的配置信息持久化到數據庫、Redis緩存，和配置文件一起使用，制定讀取優先級。
2、擴展多租戶配置：如果系統開啟了多租戶功能，那麼在郵件發送時，首先讀取租戶的當前配置，如果沒有配置，那麼在讀取系統配置。
3、自有選擇服務器：用戶可在系統界面上選擇指定的郵箱服務器進行郵件發送。
4、提供郵件發送模板：用戶可選擇預先制定的郵件模板進行發送特定郵件。
5、增加發送數量、頻率限制：增加配置，限制模板郵件的發送數量和頻率。
6、保存郵件發送記錄：不一定把所有附件都保存，只需保存郵件發送關鍵信息，如果需要保存所有附件等需要自己擴展。
同一個租戶可以配置多個電子郵件服務器，但只可以設置一個服務器為啟用狀態。默認情況下，系統通知類的功能只使用啟用狀態的服務器進行郵件發送。在有定製化需求的情況下，比如從頁面直接指定某個服務器進行郵件發送，那麼提供可以選擇的接口，指定某個服務器進行郵件發送。
一、集成spring-boot-starter-mail擴展基礎郵件發送功能
1、在基礎框架gitegg-platform中新建gitegg-platform-mail子項目，引入郵件必需的相關依賴包。
<dependencies>
<!-- gitegg Spring Boot自定義及擴展 -->
<dependency>
<groupId>com.gitegg.platform</groupId>
<artifactId>gitegg-platform-boot</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
<!-- 去除springboot默認的logback配置-->
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
2、擴展郵件服務器配置類，增加租戶等信息，方便從緩存讀取到信息之後進行配置轉換。
@Data
@JsonIgnoreProperties(ignoreUnknown = true)
public class GitEggMailProperties extends MailProperties {
/**
* 配置id
*/
private Long id;
/**
* 租戶id
*/
private Long tenantId;
/**
* 渠道id
*/
private String channelCode;
/**
* 狀態
*/
private Integer channelStatus;
/**
* 配置的md5值
*/
private String md5;
}
3、擴展郵件發送實現類JavaMailSenderImpl，添加多租戶和郵箱服務器編碼，便於多租戶和渠道選擇。
@Data
public class GitEggJavaMailSenderImpl extends JavaMailSenderImpl {
/**
* 配置id
*/
private Long id;
/**
* 租戶id
*/
private Long tenantId;
/**
* 渠道編碼
*/
private String channelCode;
/**
* 配置的md5值
*/
private String md5;
}
4、新建郵件發送實例工廠類JavaMailSenderFactory，在郵件發送時，根據需求生產需要的郵件發送實例。
@Slf4j
public class JavaMailSenderFactory {
private RedisTemplate redisTemplate;
private JavaMailSenderImpl javaMailSenderImpl;
/**
* 是否開啟租戶模式
*/
private Boolean enable;
/**
* JavaMailSender 緩存
* 儘管存在多個微服務，但是只需要在每個微服務初始化一次即可
*/
private final static Map<String, GitEggJavaMailSenderImpl> javaMailSenderMap = new ConcurrentHashMap<>();
public JavaMailSenderFactory(RedisTemplate redisTemplate, JavaMailSenderImpl javaMailSenderImpl, Boolean enable) {
this.redisTemplate = redisTemplate;
this.javaMailSenderImpl = javaMailSenderImpl;
this.enable = enable;
}
/**
* 指定郵件發送渠道
* @return
*/
public JavaMailSenderImpl getMailSender(String... channelCode){
if (null == channelCode || channelCode.length == GitEggConstant.COUNT_ZERO
|| null == channelCode[GitEggConstant.Number.ZERO])
{
return this.getDefaultMailSender();
}
// 首先判斷是否開啟多租戶
String mailConfigKey = JavaMailConstant.MAIL_TENANT_CONFIG_KEY;
if (enable) {
mailConfigKey += GitEggAuthUtils.getTenantId();
} else {
mailConfigKey = JavaMailConstant.MAIL_CONFIG_KEY;
}
// 從緩存獲取郵件配置信息
// 根據channel code獲取配置，用channel code時，不區分是否是默認配置
String propertiesStr = (String) redisTemplate.opsForHash().get(mailConfigKey, channelCode[GitEggConstant.Number.ZERO]);
if (StringUtils.isEmpty(propertiesStr))
{
throw new BusinessException("未獲取到[" + channelCode[GitEggConstant.Number.ZERO] + "]的郵件配置信息");
}
GitEggMailProperties properties = null;
try {
properties = JsonUtils.jsonToPojo(propertiesStr, GitEggMailProperties.class);
} catch (Exception e) {
log.error("轉換郵件配置信息異常:{}", e);
throw new BusinessException("轉換郵件配置信息異常:" + e);
}
return this.getMailSender(mailConfigKey, properties);
}
/**
* 不指定郵件發送渠道，取默認配置
* @return
*/
public JavaMailSenderImpl getDefaultMailSender(){
// 首先判斷是否開啟多租戶
String mailConfigKey = JavaMailConstant.MAIL_TENANT_CONFIG_KEY;
if (enable) {
mailConfigKey += GitEggAuthUtils.getTenantId();
} else {
mailConfigKey = JavaMailConstant.MAIL_CONFIG_KEY;
}
// 獲取所有郵件配置列表
Map<Object, Object> propertiesMap = redisTemplate.opsForHash().entries(mailConfigKey);
Iterator<Map.Entry<Object, Object>> entries = propertiesMap.entrySet().iterator();
// 如果沒有設置取哪個配置，那麼獲取默認的配置
GitEggMailProperties properties = null;
try {
while (entries.hasNext()) {
Map.Entry<Object, Object> entry = entries.next();
// 轉為系統配置對象
GitEggMailProperties propertiesEnable = JsonUtils.jsonToPojo((String) entry.getValue(), GitEggMailProperties.class);
if (propertiesEnable.getChannelStatus().intValue() == GitEggConstant.ENABLE) {
properties = propertiesEnable;
break;
}
}
} catch (Exception e) {
e.printStackTrace();
}
return this.getMailSender(mailConfigKey, properties);
}
private JavaMailSenderImpl getMailSender(String mailConfigKey, GitEggMailProperties properties) {
// 根據最新配置信息判斷是否從本地獲取mailSender，在配置保存時，計算實體配置的md5值，然後進行比較，不要在每次對比的時候進行md5計算
if (null != properties && !StringUtils.isEmpty(properties.getMd5()))
{
GitEggJavaMailSenderImpl javaMailSender = javaMailSenderMap.get(mailConfigKey);
if (null == javaMailSender || !properties.getMd5().equals(javaMailSender.getMd5()))
{
// 如果沒有配置信息，那麼直接返回系統默認配置的mailSender
javaMailSender = new GitEggJavaMailSenderImpl();
this.applyProperties(properties, javaMailSender);
javaMailSender.setMd5(properties.getMd5());
javaMailSender.setId(properties.getId());
// 將MailSender放入緩存
javaMailSenderMap.put(mailConfigKey, javaMailSender);
}
return javaMailSender;
}
else
{
return this.javaMailSenderImpl;
}
}
private void applyProperties(MailProperties properties, JavaMailSenderImpl sender) {
sender.setHost(properties.getHost());
if (properties.getPort() != null) {
sender.setPort(properties.getPort());
}
sender.setUsername(properties.getUsername());
sender.setPassword(properties.getPassword());
sender.setProtocol(properties.getProtocol());
if (properties.getDefaultEncoding() != null) {
sender.setDefaultEncoding(properties.getDefaultEncoding().name());
}
if (!properties.getProperties().isEmpty()) {
sender.setJavaMailProperties(this.asProperties(properties.getProperties()));
}
}
private Properties asProperties(Map<String, String> source) {
Properties properties = new Properties();
properties.putAll(source);
return properties;
}
}
5、配置異步郵件發送的線程池，這裡需注意異步線程池上下文變量共享問題，有兩種方式解決，一個是使用裝飾器TaskDecorator將父子線程變量進行複製，還有一種方式是transmittable-thread-local來共享線程上下文，這裡不展開描述，後續會專門針對如何在微服務異步線程池中共享上線文進行說明。
@Configuration
public class MailThreadPoolConfig {
@Value("${spring.mail-task.execution.pool.core-size}")
private int corePoolSize;
@Value("${spring.mail-task.execution.pool.max-size}")
private int maxPoolSize;
@Value("${spring.mail-task.execution.pool.queue-capacity}")
private int queueCapacity;
@Value("${spring.mail-task.execution.thread-name-prefix}")
private String namePrefix;
@Value("${spring.mail-task.execution.pool.keep-alive}")
private int keepAliveSeconds;
/**
* 郵件發送的線程池
* @return
*/
@Bean("mailTaskExecutor")
public Executor mailTaskExecutor(){
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
//最大線程數
executor.setMaxPoolSize(maxPoolSize);
//核心線程數
executor.setCorePoolSize(corePoolSize);
//任務隊列的大小
executor.setQueueCapacity(queueCapacity);
//線程前綴名
executor.setThreadNamePrefix(namePrefix);
//線程存活時間
executor.setKeepAliveSeconds(keepAliveSeconds);
// 設置裝飾器，父子線程共享request header變量
executor.setTaskDecorator(new RequestHeaderTaskDecorator());
/**
* 拒絕處理策略
* CallerRunsPolicy()：交由調用方線程運行，比如 main 線程。
* AbortPolicy()：直接拋出異常。
* DiscardPolicy()：直接丟棄。
* DiscardOldestPolicy()：丟棄隊列中最老的任務。
*/
executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
// 線程初始化
executor.initialize();
return executor;
}
}
6、增加郵件發送結果的枚舉類MailResultCodeEnum
public enum MailResultCodeEnum {
/**
* 默認
*/
SUCCESS("success", "郵件發送成功"),
/**
* 自定義
*/
ERROR("error", "郵件發送失敗");
public String code;
public String message;
MailResultCodeEnum(String code, String message) {
this.code = code;
this.message = message;
}
public String getCode() {
return code;
}
public void setCode(String code) {
this.code = code;
}
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
}
7、增加郵箱服務器相關默認配置的常量類JavaMailConstant.java
public class JavaMailConstant {
/**
* Redis JavaMail配置config key
*/
public static final String MAIL_CONFIG_KEY = "mail:config";
/**
* 當開啟多租戶模式時，Redis JavaMail配置config key
*/
public static final String MAIL_TENANT_CONFIG_KEY = "mail:tenant:config:";
}
8、增加GitEggJavaMail自動裝配類，根據Nacos或者系統配置進行裝配。
@Slf4j
@Configuration
@RequiredArgsConstructor(onConstructor_ = @Autowired)
public class GitEggJavaMailConfiguration {
private final JavaMailSenderImpl javaMailSenderImpl;
private final RedisTemplate redisTemplate;
/**
* 是否開啟租戶模式
*/
@Value("${tenant.enable}")
private Boolean enable;
@Bean
public JavaMailSenderFactory gitEggAuthRequestFactory() {
return new JavaMailSenderFactory(redisTemplate, javaMailSenderImpl, enable);
}
}
二、增加郵箱服務器配置界面
郵箱服務器的配置，實際就是不同郵箱渠道的配置，這裡我們將表和字段設計好，然後使用GitEgg自帶代碼生成器，生成業務的CRUD代碼即可。
1、郵箱渠道配置表設計
CREATE TABLE `t_sys_mail_channel` (
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主鍵',
`tenant_id` bigint(20) NOT NULL DEFAULT 0 COMMENT '租戶id',
`channel_code` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '渠道編碼',
`channel_name` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '渠道名稱',
`host` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT 'SMTP服務器地址',
`port` int(11) NULL DEFAULT NULL COMMENT 'SMTP服務器端口',
`username` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '賬戶名',
`password` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '密碼',
`protocol` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL DEFAULT 'smtp' COMMENT '協議',
`default_encoding` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '默認編碼',
`jndi_name` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '會話JNDI名稱',
`properties` varchar(500) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT 'JavaMail 配置',
`channel_status` tinyint(2) NOT NULL DEFAULT 0 COMMENT '渠道狀態 1有效 0禁用',
`md5` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT 'MD5',
`comments` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '描述',
`create_time` datetime(0) NULL DEFAULT NULL COMMENT '創建時間',
`creator` bigint(20) NULL DEFAULT NULL COMMENT '創建者',
`update_time` datetime(0) NULL DEFAULT NULL COMMENT '更新時間',
`operator` bigint(20) NULL DEFAULT NULL COMMENT '更新者',
`del_flag` tinyint(2) NULL DEFAULT 0 COMMENT '是否刪除',
PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 1 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci COMMENT = '郵件渠道' ROW_FORMAT = DYNAMIC;
SET FOREIGN_KEY_CHECKS = 1;
2、根據表設計，然後配置代碼生成界面，生成前後端代碼。
3、生成代碼後，進行相關權限配置，前端界面展示：
三、以同樣的方式增加郵箱模板配置界面和郵件發送日誌記錄
1、郵箱模板和郵件發送日誌數據庫表設計
郵件模板數據庫表設計：
CREATE TABLE `t_sys_mail_template` (
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主鍵',
`tenant_id` bigint(20) NOT NULL DEFAULT 0 COMMENT '租戶id',
`template_code` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '模板編碼',
`template_name` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '模板名稱',
`sign_name` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '模板簽名',
`template_status` tinyint(2) NOT NULL DEFAULT 1 COMMENT '模板狀態',
`template_type` tinyint(2) NULL DEFAULT NULL COMMENT '模板類型',
`template_content` text CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL COMMENT '模板內容',
`cache_code_key` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '緩存key',
`cache_time_out` bigint(20) NULL DEFAULT 0 COMMENT '緩存有效期 值',
`cache_time_out_unit` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '緩存有效期 單位',
`send_times_limit` bigint(20) NULL DEFAULT 0 COMMENT '發送次數限制',
`send_times_limit_period` bigint(20) NULL DEFAULT 0 COMMENT '限制時間間隔',
`send_times_limit_period_unit` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '限制時間間隔 單位',
`comments` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '描述',
`create_time` datetime(0) NULL DEFAULT NULL COMMENT '創建時間',
`creator` bigint(20) NULL DEFAULT NULL COMMENT '創建者',
`update_time` datetime(0) NULL DEFAULT NULL COMMENT '更新時間',
`operator` bigint(20) NULL DEFAULT NULL COMMENT '更新者',
`del_flag` tinyint(2) NULL DEFAULT 0 COMMENT '是否刪除',
PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 1 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci COMMENT = '郵件模板' ROW_FORMAT = DYNAMIC;
SET FOREIGN_KEY_CHECKS = 1;
郵件日誌數據庫表設計：
CREATE TABLE `t_sys_mail_log` (
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主鍵',
`tenant_id` bigint(20) NOT NULL DEFAULT 0 COMMENT '租戶id',
`channel_id` bigint(20) NULL DEFAULT NULL COMMENT 'mail渠道id',
`template_id` bigint(20) NULL DEFAULT NULL COMMENT 'mail模板id',
`mail_subject` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '郵件主題',
`mail_from` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '發送人',
`mail_to` text CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL COMMENT '收件人',
`mail_cc` text CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL COMMENT '抄送',
`mail_bcc` text CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL COMMENT '密抄送',
`mail_content` text CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL COMMENT '郵件內容',
`attachment_name` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT '0' COMMENT '附件名稱',
`attachment_size` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT '0' COMMENT '附件大小',
`send_time` datetime(0) NULL DEFAULT NULL COMMENT '發送時間',
`send_result_code` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT '1' COMMENT '發送結果碼',
`send_result_msg` varchar(500) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '發送結果消息',
`create_time` datetime(0) NULL DEFAULT NULL COMMENT '創建日期',
`creator` bigint(20) NULL DEFAULT NULL COMMENT '創建者',
`update_time` datetime(0) NULL DEFAULT NULL COMMENT '更新日期',
`operator` bigint(20) NULL DEFAULT NULL COMMENT '更新者',
`del_flag` tinyint(2) NOT NULL DEFAULT 0 COMMENT '是否刪除 1:刪除 0:不刪除',
PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 1 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci COMMENT = '郵件記錄' ROW_FORMAT = DYNAMIC;
SET FOREIGN_KEY_CHECKS = 1;
2、郵件模板和郵件發送日誌界面
四、QQ郵箱配置和阿里雲企業郵箱配置測試
上面的基本功能開發完成之後，那麼我們就需要進行測試，這裡選擇兩種類型的郵箱進行測試，一種是QQ郵箱，還有一種是阿里雲企業郵箱。
1、QQ郵箱配置
QQ郵箱在配置的時候不能使用QQ的登錄密碼，需要單獨設置QQ郵箱的授權碼，下面是操作步驟：
- 開通qq郵箱的smtp功能
- 經過一系列的驗證之後，會獲取到一個授權碼：
- 系統中配置QQ郵箱相關信息
2、 阿里雲企業郵箱配置
阿里雲企業郵箱的配置相比較而言就簡單一些，配置的密碼就是企業郵箱登錄的密碼。
- 賬戶設置，開啟POP3/SMTP和IMAP/SMTP服務
- 系統中配置阿里雲企業郵箱相關信息
3、Nacos中配置默認郵件服務器，同時增加郵件異步線程池配置
mail:
username: XXXXXXXXXXX
password: XXXXXXXXXX
default-encoding: UTF-8
host: smtp.mxhichina.com
port: 25
protocol: smtp
properties:
mail:
smtp:
auth: true
ssl:
enable: false
# 異步發送郵件，核心線程池數配置
mail-task:
execution:
pool:
core-size: 5
max-size: 10
queue-capacity: 5
keep-alive: 60
thread-name-prefix: mail-send-task-
4、在郵件渠道配置界面進行郵件發送測試，有兩種測試方式，一種是選擇指定渠道進行發送，另外一種是選擇系統默認渠道進行郵件發送。發送完成後查看郵件日誌模塊，檢查是否有郵件發送成功的記錄。
- 選擇需要測試的郵箱服務器
- 填寫測試郵箱發送內容
- 查看郵箱發送日誌
源碼地址:
Gitee: //gitee.com/wmz1930/GitEgg
GitHub: //github.com/wmz1930/GitEgg
