ContiNew/continew-admin
1
1
Fork 0
mirror of https://github.com/continew-org/continew-admin.git synced 2025-10-31 22:57:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat(system/sms): 短信渠道支持数据字典配置 (#159)

Browse Source
This commit is contained in:
Top2Hub
2025-04-21 16:11:25 +08:00
committed by GitHub
parent c9d5810f7d
commit e4828bf2a3
13 changed files with 220 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
continew-module-system/src/main/java/top/continew/admin/system/config/sms/SmsConfigUtil.java Normal file
View File

@@ -0,0 +1,88 @@
/*
* Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package top.continew.admin.system.config.sms;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import org.dromara.sms4j.provider.config.BaseConfig;
import org.dromara.sms4j.provider.factory.BaseProviderFactory;
import org.dromara.sms4j.provider.factory.ProviderFactoryHolder;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.AccessLevel;
import lombok.NoArgsConstructor;
import top.continew.admin.system.model.resp.SmsConfigResp;
/**
* 短信配置工具类
*
* @author Top2Hub
* @since 2025/04/21 14:00
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class SmsConfigUtil {
private static final TypeReference<Map<String, Object>> CONFIG_MAP_TYPE = new TypeReference<Map<String, Object>>() {};
private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper()
.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
/**
* 将本地配置对象转换为 BaseConfig
*
* @param smsConfig 本地配置对象
* @return SMS4j 配置基类
*/
public static BaseConfig from(SmsConfigResp smsConfig) {
if (Objects.isNull(smsConfig))
return null;
String supplierName = smsConfig.getSupplier();
BaseProviderFactory<?, ?> providerFactory = ProviderFactoryHolder.requireForSupplier(supplierName);
if (Objects.isNull(providerFactory))
return null;
Map<String, Object> configInfo = new HashMap<>();
configInfo.put("configId", smsConfig.getId().toString());
configInfo.put("accessKeyId", smsConfig.getAccessKey());
configInfo.put("accessKeySecret", smsConfig.getSecretKey());
configInfo.put("signature", smsConfig.getSignature());
configInfo.put("templateId", smsConfig.getTemplateId());
if (Objects.nonNull(smsConfig.getWeight()))
configInfo.put("weight", smsConfig.getWeight());
if (Objects.nonNull(smsConfig.getRetryInterval()))
configInfo.put("retryInterval", smsConfig.getRetryInterval());
if (Objects.nonNull(smsConfig.getMaxRetries()))
configInfo.put("maxRetries", smsConfig.getMaxRetries());
if (Objects.nonNull(smsConfig.getSupplierConfig())) {
Map<String, Object> supplierInfo = OBJECT_MAPPER.convertValue(smsConfig
.getSupplierConfig(), CONFIG_MAP_TYPE);
configInfo.putAll(supplierInfo);
}
BaseConfig config = (BaseConfig)OBJECT_MAPPER.convertValue(configInfo, providerFactory.getConfigClass());
return config;
}
}

6
continew-module-system/src/main/java/top/continew/admin/system/config/sms/SmsReadConfigDatabaseImpl.java
View File

@@ -18,9 +18,11 @@ package top.continew.admin.system.config.sms;
import cn.hutool.core.collection.CollUtil;
import lombok.RequiredArgsConstructor;
import org.dromara.sms4j.core.datainterface.SmsReadConfig;
import org.dromara.sms4j.provider.config.BaseConfig;
import org.springframework.stereotype.Component;
import top.continew.admin.common.enums.DisEnableStatusEnum;
import top.continew.admin.system.model.query.SmsConfigQuery;
import top.continew.admin.system.model.resp.SmsConfigResp;
@@ -48,7 +50,7 @@ public class SmsReadConfigDatabaseImpl implements SmsReadConfig {
if (DisEnableStatusEnum.DISABLE.equals(smsConfig.getStatus())) {
return null;
}
return smsConfig.getSupplier().toBaseConfig(smsConfig);
return SmsConfigUtil.from(smsConfig);
}
@Override
@@ -59,6 +61,6 @@ public class SmsReadConfigDatabaseImpl implements SmsReadConfig {
if (CollUtil.isEmpty(list)) {
return List.of();
}
return list.stream().map(smsConfig -> smsConfig.getSupplier().toBaseConfig(smsConfig)).toList();
return list.stream().map(smsConfig -> SmsConfigUtil.from(smsConfig)).toList();
}
}

3
continew-module-system/src/main/java/top/continew/admin/system/enums/SmsSupplierEnum.java
View File

@@ -32,7 +32,10 @@ import top.continew.starter.core.enums.BaseEnum;
* @author luoqiz
* @author Charles7c
* @since 2025/03/15 22:15
*
* @deprecated 使用数据字典`sms_supplier_type`动态维护
*/
@Deprecated
@Getter
@RequiredArgsConstructor
public enum SmsSupplierEnum implements BaseEnum<String> {

3
continew-module-system/src/main/java/top/continew/admin/system/model/entity/SmsConfigDO.java
View File

@@ -20,7 +20,6 @@ import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
import top.continew.admin.common.enums.DisEnableStatusEnum;
import top.continew.admin.common.model.entity.BaseDO;
import top.continew.admin.system.enums.SmsSupplierEnum;
import top.continew.starter.security.crypto.annotation.FieldEncrypt;
import java.io.Serial;
@@ -47,7 +46,7 @@ public class SmsConfigDO extends BaseDO {
/**
* 厂商
*/
private SmsSupplierEnum supplier;
private String supplier;
/**
* Access Key

3
continew-module-system/src/main/java/top/continew/admin/system/model/query/SmsConfigQuery.java
View File

@@ -19,7 +19,6 @@ package top.continew.admin.system.model.query;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import top.continew.admin.common.enums.DisEnableStatusEnum;
import top.continew.admin.system.enums.SmsSupplierEnum;
import top.continew.starter.data.core.annotation.Query;
import top.continew.starter.data.core.enums.QueryType;
@@ -52,7 +51,7 @@ public class SmsConfigQuery implements Serializable {
*/
@Schema(description = "厂商", example = "cloopen")
@Query
private SmsSupplierEnum supplier;
private String supplier;
/**
* Access Key

3
continew-module-system/src/main/java/top/continew/admin/system/model/req/SmsConfigReq.java
View File

@@ -24,7 +24,6 @@ import io.swagger.v3.oas.annotations.media.Schema;
import org.hibernate.validator.constraints.Length;
import top.continew.admin.common.enums.DisEnableStatusEnum;
import top.continew.admin.system.enums.SmsSupplierEnum;
import java.io.Serial;
import java.io.Serializable;
@@ -56,7 +55,7 @@ public class SmsConfigReq implements Serializable {
*/
@Schema(description = "厂商", example = "cloopen")
@NotNull(message = "厂商无效")
private SmsSupplierEnum supplier;
private String supplier;
/**
* Access Key

11
continew-module-system/src/main/java/top/continew/admin/system/model/resp/SmsConfigResp.java
View File

@@ -20,9 +20,10 @@ import com.alibaba.excel.annotation.ExcelIgnoreUnannotated;
import com.alibaba.excel.annotation.ExcelProperty;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import top.continew.admin.common.config.excel.DictExcelProperty;
import top.continew.admin.common.config.excel.ExcelDictConverter;
import top.continew.admin.common.enums.DisEnableStatusEnum;
import top.continew.admin.common.model.resp.BaseDetailResp;
import top.continew.admin.system.enums.SmsSupplierEnum;
import top.continew.starter.file.excel.converter.ExcelBaseEnumConverter;
import top.continew.starter.security.mask.annotation.JsonMask;
@@ -52,10 +53,14 @@ public class SmsConfigResp extends BaseDetailResp {
/**
* 厂商
* 对齐 sms4j 短信服务商常量类
*
* @see org.dromara.sms4j.comm.constant.SupplierConstant
*/
@Schema(description = "厂商", example = "cloopen")
@ExcelProperty(value = "厂商")
private SmsSupplierEnum supplier;
@ExcelProperty(value = "厂商", converter = ExcelDictConverter.class)
@DictExcelProperty("sms_supplier_type")
private String supplier;
/**
* Access Key

14
continew-module-system/src/main/java/top/continew/admin/system/service/impl/SmsConfigServiceImpl.java
View File

@@ -16,12 +16,13 @@
package top.continew.admin.system.service.impl;
import cn.hutool.core.bean.BeanUtil;
import lombok.RequiredArgsConstructor;
import org.dromara.sms4j.core.factory.SmsFactory;
import org.dromara.sms4j.provider.config.BaseConfig;
import org.springframework.stereotype.Service;
import top.continew.admin.system.enums.SmsSupplierEnum;
import top.continew.admin.system.config.sms.SmsConfigUtil;
import top.continew.admin.system.mapper.SmsConfigMapper;
import top.continew.admin.system.model.entity.SmsConfigDO;
import top.continew.admin.system.model.query.SmsConfigQuery;
@@ -31,6 +32,7 @@ import top.continew.admin.system.service.SmsConfigService;
import top.continew.starter.extension.crud.service.BaseServiceImpl;
import java.util.List;
import java.util.Objects;
/**
* 短信配置业务实现
@@ -69,9 +71,11 @@ public class SmsConfigServiceImpl extends BaseServiceImpl<SmsConfigMapper, SmsCo
* @param entity 配置信息
*/
private void load(SmsConfigDO entity) {
SmsSupplierEnum supplier = entity.getSupplier();
BaseConfig config = supplier.toBaseConfig(BeanUtil.toBean(entity, SmsConfigResp.class));
SmsFactory.createSmsBlend(config);
SmsConfigResp smsConfig = this.get(entity.getId());
BaseConfig config = SmsConfigUtil.from(smsConfig);
if (Objects.nonNull(config))
SmsFactory.createSmsBlend(config);
}
/**