hhyykk/ipms-sjy
1
1
Fork 0
mirror of https://gitee.com/hhyykk/ipms-sjy.git synced 2025-07-24 16:05:08 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

1. 编写短信模板的前端

Browse Source
This commit is contained in:
YunaiV
2021-04-10 01:39:27 +08:00
parent 9f794ecb15
commit 73a2f4d84c
21 changed files with 181 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/main/java/cn/iocoder/dashboard/common/pojo/CommonResult.java
View File

@ -74,7 +74,7 @@ public class CommonResult<T> implements Serializable {
@JsonIgnore // 避免 jackson 序列化
public boolean isSuccess() {
return isSuccess(GlobalErrorCodeConstants.SUCCESS.getCode());
return isSuccess(code);
}
@JsonIgnore // 避免 jackson 序列化

20
src/main/java/cn/iocoder/dashboard/framework/sms/core/enums/SmsFrameworkErrorCodeConstants.java
View File

@ -15,17 +15,17 @@ public interface SmsFrameworkErrorCodeConstants {
ErrorCode SMS_CHANNEL_API_KEY_MISSING = new ErrorCode(2001000101, "API Key 不存在");
ErrorCode SMS_CHANNEL_PERMISSION_DENY = new ErrorCode(2001000102, "没有发送短信的权限");
// ========== 模板相关(200 开头) ==========
ErrorCode SMS_TEMPLATE_NOT_EXISTS = new ErrorCode(200, "短信模板不存在");
ErrorCode SMS_TEMPLATE_DISABLE = new ErrorCode(201, "短信模板被禁用"); // 例如说，我们在管理后台禁用了
ErrorCode SMS_TEMPLATE_INVALID = new ErrorCode(202, "短信模板不可用"); // 例如说，短信模板正在审核中
ErrorCode SMS_TEMPLATE_PARAM_ERROR = new ErrorCode(203, "模板参数不正确");
// ========== 模板相关(2001000200 开头) ==========
ErrorCode SMS_TEMPLATE_NOT_EXISTS = new ErrorCode(2001000200, "短信模板不存在");
ErrorCode SMS_TEMPLATE_DISABLE = new ErrorCode(2001000201, "短信模板被禁用"); // 例如说，我们在管理后台禁用了
ErrorCode SMS_TEMPLATE_INVALID = new ErrorCode(2001000202, "短信模板不可用"); // 例如说，短信模板正在审核中
ErrorCode SMS_TEMPLATE_PARAM_ERROR = new ErrorCode(2001000203, "模板参数不正确");
// ========== 其它相关(900 开头) ==========
ErrorCode SMS_API_PARAM_ERROR = new ErrorCode(900, "请求参数缺失");
// ========== 其它相关(2001000900 开头) ==========
ErrorCode SMS_API_PARAM_ERROR = new ErrorCode(2001000900, "请求参数缺失");
ErrorCode SMS_SEND_LIMIT_CONTROL = new ErrorCode(997, "业务限流"); // 将短信发送频率限制在正常的业务限流范围内。默认短信验证码：使用同一签名，对同一个手机号验证码，支持 1 条 / 分钟，5 条 / 小时，累计 10 条 / 天。
ErrorCode EXCEPTION = new ErrorCode(998, "调用异常");
ErrorCode SMS_UNKNOWN = new ErrorCode(999, "未知错误，需要解析");
ErrorCode SMS_SEND_LIMIT_CONTROL = new ErrorCode(2001000997, "业务限流"); // 将短信发送频率限制在正常的业务限流范围内。默认短信验证码：使用同一签名，对同一个手机号验证码，支持 1 条 / 分钟，5 条 / 小时，累计 10 条 / 天。
ErrorCode EXCEPTION = new ErrorCode(2001000998, "调用异常");
ErrorCode SMS_UNKNOWN = new ErrorCode(2001000999, "未知错误，需要解析");
}

2
src/main/java/cn/iocoder/dashboard/modules/system/controller/dict/SysDictDataController.java
View File

@ -61,7 +61,7 @@ public class SysDictDataController {
@GetMapping("/list-all-simple")
@ApiOperation(value = "获得全部字典数据列表", notes = "一般用于管理后台缓存字典数据在本地")
// 无需添加权限认证，因为前端全局都需要
public CommonResult<List<SysDictDataSimpleVO>> getSimpleDictDatas() {
public CommonResult<List<SysDictDataSimpleRespVO>> getSimpleDictDatas() {
List<SysDictDataDO> list = dictDataService.getDictDatas();
return success(SysDictDataConvert.INSTANCE.convertList(list));
}

4
src/main/java/cn/iocoder/dashboard/modules/system/controller/dict/vo/data/SysDictDataSimpleVO.java → src/main/java/cn/iocoder/dashboard/modules/system/controller/dict/vo/data/SysDictDataSimpleRespVO.java
View File

@ -4,9 +4,9 @@ import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
@ApiModel("数据字典精简 VO")
@ApiModel("数据字典精简 Response VO")
@Data
public class SysDictDataSimpleVO {
public class SysDictDataSimpleRespVO {
@ApiModelProperty(value = "字典类型", required = true, example = "gender")
private String dictType;

16
src/main/java/cn/iocoder/dashboard/modules/system/controller/sms/SysSmsChannelController.java
View File

@ -2,10 +2,7 @@ package cn.iocoder.dashboard.modules.system.controller.sms;
import cn.iocoder.dashboard.common.pojo.CommonResult;
import cn.iocoder.dashboard.common.pojo.PageResult;
import cn.iocoder.dashboard.modules.system.controller.sms.vo.channel.SysSmsChannelCreateReqVO;
import cn.iocoder.dashboard.modules.system.controller.sms.vo.channel.SysSmsChannelPageReqVO;
import cn.iocoder.dashboard.modules.system.controller.sms.vo.channel.SysSmsChannelRespVO;
import cn.iocoder.dashboard.modules.system.controller.sms.vo.channel.SysSmsChannelUpdateReqVO;
import cn.iocoder.dashboard.modules.system.controller.sms.vo.channel.*;
import cn.iocoder.dashboard.modules.system.convert.sms.SysSmsChannelConvert;
import cn.iocoder.dashboard.modules.system.dal.dataobject.sms.SysSmsChannelDO;
import cn.iocoder.dashboard.modules.system.service.sms.SysSmsChannelService;
@ -17,6 +14,8 @@ import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
import javax.validation.Valid;
import java.util.Comparator;
import java.util.List;
import static cn.iocoder.dashboard.common.pojo.CommonResult.success;
@ -69,4 +68,13 @@ public class SysSmsChannelController {
return success(SysSmsChannelConvert.INSTANCE.convertPage(pageResult));
}
@GetMapping("/list-all-simple")
@ApiOperation(value = "获得短信渠道精简列表", notes = "包含被禁用的短信渠道")
public CommonResult<List<SysSmsChannelSimpleRespVO>> getSimpleSmsChannels() {
List<SysSmsChannelDO> list = smsChannelService.getSmsChannelList();
// 排序后，返回给前端
list.sort(Comparator.comparing(SysSmsChannelDO::getId));
return success(SysSmsChannelConvert.INSTANCE.convertList03(list));
}
}

12
src/main/java/cn/iocoder/dashboard/modules/system/controller/sms/SysSmsTemplateController.http Normal file
View File

@ -0,0 +1,12 @@
### 请求 /menu/list 接口 => 成功
POST {{baseUrl}}/system/sms-template/send-sms
Authorization: Bearer {{token}}
Content-Type: application/json
{
"code": "test_01",
"params": {
"key01": "value01",
"key02": "value02"
}
}

7
src/main/java/cn/iocoder/dashboard/modules/system/controller/sms/SysSmsTemplateController.java
View File

@ -84,4 +84,11 @@ public class SysSmsTemplateController {
ExcelUtils.write(response, "短信模板.xls", "数据", SysSmsTemplateExcelVO.class, datas);
}
@PostMapping("/send-sms")
@ApiOperation("导出短信模板 Excel")
@PreAuthorize("@ss.hasPermission('system:sms-template:send-sms')")
public CommonResult<Boolean> sendSms(@Valid @RequestBody SysSmsTemplateSendReqVO sendReqVO) {
return success(true);
}
}

24
src/main/java/cn/iocoder/dashboard/modules/system/controller/sms/vo/channel/SysSmsChannelSimpleRespVO.java Normal file
View File

@ -0,0 +1,24 @@
package cn.iocoder.dashboard.modules.system.controller.sms.vo.channel;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import javax.validation.constraints.NotNull;
@ApiModel("短信渠道精简 Response VO")
@Data
public class SysSmsChannelSimpleRespVO {
@ApiModelProperty(value = "编号", required = true, example = "1024")
@NotNull(message = "编号不能为空")
private Long id;
@ApiModelProperty(value = "短信签名", required = true, example = "芋道源码")
@NotNull(message = "短信签名不能为空")
private String signature;
@ApiModelProperty(value = "渠道编码", required = true, example = "YUN_PIAN", notes = "参见 SmsChannelEnum 枚举类")
private String code;
}

21
src/main/java/cn/iocoder/dashboard/modules/system/controller/sms/vo/template/SysSmsTemplateSendReqVO.java Normal file
View File

@ -0,0 +1,21 @@
package cn.iocoder.dashboard.modules.system.controller.sms.vo.template;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import javax.validation.constraints.NotNull;
import java.util.Map;
@ApiModel("短信模板的发送 Request VO")
@Data
public class SysSmsTemplateSendReqVO {
@ApiModelProperty(value = "模板编码", required = true, example = "test_01")
@NotNull(message = "模板编码不能为空")
private String code;
@ApiModelProperty(value = "模板参数")
private Map<String, Object> params;
}

2
src/main/java/cn/iocoder/dashboard/modules/system/convert/dict/SysDictDataConvert.java
View File

@ -13,7 +13,7 @@ public interface SysDictDataConvert {
SysDictDataConvert INSTANCE = Mappers.getMapper(SysDictDataConvert.class);
List<SysDictDataSimpleVO> convertList(List<SysDictDataDO> list);
List<SysDictDataSimpleRespVO> convertList(List<SysDictDataDO> list);
SysDictDataRespVO convert(SysDictDataDO bean);

3
src/main/java/cn/iocoder/dashboard/modules/system/convert/sms/SysSmsChannelConvert.java
View File

@ -4,6 +4,7 @@ import cn.iocoder.dashboard.common.pojo.PageResult;
import cn.iocoder.dashboard.framework.sms.core.property.SmsChannelProperties;
import cn.iocoder.dashboard.modules.system.controller.sms.vo.channel.SysSmsChannelCreateReqVO;
import cn.iocoder.dashboard.modules.system.controller.sms.vo.channel.SysSmsChannelRespVO;
import cn.iocoder.dashboard.modules.system.controller.sms.vo.channel.SysSmsChannelSimpleRespVO;
import cn.iocoder.dashboard.modules.system.controller.sms.vo.channel.SysSmsChannelUpdateReqVO;
import cn.iocoder.dashboard.modules.system.dal.dataobject.sms.SysSmsChannelDO;
import org.mapstruct.Mapper;
@ -33,4 +34,6 @@ public interface SysSmsChannelConvert {
List<SmsChannelProperties> convertList02(List<SysSmsChannelDO> list);
List<SysSmsChannelSimpleRespVO> convertList03(List<SysSmsChannelDO> list);
}

4
src/main/java/cn/iocoder/dashboard/modules/system/enums/SysErrorCodeConstants.java
View File

@ -31,7 +31,7 @@ public interface SysErrorCodeConstants {
// ========== 角色模块 1002003000 ==========
ErrorCode ROLE_NOT_EXISTS = new ErrorCode(1002003000, "角色不存在");
ErrorCode ROLE_NAME_DUPLICATE = new ErrorCode(1002003001, "已经存在名为【{}}】的角色");
ErrorCode ROLE_CODE_DUPLICATE = new ErrorCode(1002003002, "已经存在编码为【{}}】的角色");
ErrorCode ROLE_CODE_DUPLICATE = new ErrorCode(1002003002, "已经存在编码为【{}】的角色");
ErrorCode ROLE_CAN_NOT_UPDATE_SYSTEM_TYPE_ROLE = new ErrorCode(1002003004, "不能操作类型为系统内置的角色");
// ========== 用户模块 1002004000 ==========
@ -84,7 +84,7 @@ public interface SysErrorCodeConstants {
// ========== 短信模板 1002011000 ==========
ErrorCode SMS_TEMPLATE_NOT_EXISTS = new ErrorCode(1002011000, "短信模板不存在");
ErrorCode SMS_TEMPLATE_CODE_DUPLICATE = new ErrorCode(1002011001, "已经存在编码为【{}}】的短信模板");
ErrorCode SMS_TEMPLATE_CODE_DUPLICATE = new ErrorCode(1002011001, "已经存在编码为【{}】的短信模板");
// ========== 短信发送 1002012000 ==========
ErrorCode SMS_SEND_MOBILE_NOT_EXISTS = new ErrorCode(1002012000, "手机号不存在");

7
src/main/java/cn/iocoder/dashboard/modules/system/service/sms/SysSmsChannelService.java
View File

@ -61,6 +61,13 @@ public interface SysSmsChannelService {
*/
List<SysSmsChannelDO> getSmsChannelList(Collection<Long> ids);
/**
* 获得所有短信渠道列表
*
* @return 短信渠道列表
*/
List<SysSmsChannelDO> getSmsChannelList();
/**
* 获得短信渠道分页
*

5
src/main/java/cn/iocoder/dashboard/modules/system/service/sms/impl/SysSmsChannelServiceImpl.java
View File

@ -90,6 +90,11 @@ public class SysSmsChannelServiceImpl implements SysSmsChannelService {
return smsChannelMapper.selectBatchIds(ids);
}
@Override
public List<SysSmsChannelDO> getSmsChannelList() {
return smsChannelMapper.selectList();
}
@Override
public PageResult<SysSmsChannelDO> getSmsChannelPage(SysSmsChannelPageReqVO pageReqVO) {
return smsChannelMapper.selectPage(pageReqVO);

4
src/main/java/cn/iocoder/dashboard/modules/system/service/sms/impl/SysSmsTemplateServiceImpl.java
View File

@ -162,10 +162,10 @@ public class SysSmsTemplateServiceImpl implements SysSmsTemplateService {
}
// 如果 id 为空，说明不用比较是否为相同 id 的字典类型
if (id == null) {
throw exception(SMS_TEMPLATE_CODE_DUPLICATE);
throw exception(SMS_TEMPLATE_CODE_DUPLICATE, code);
}
if (!template.getId().equals(id)) {
throw exception(SMS_TEMPLATE_CODE_DUPLICATE);
throw exception(SMS_TEMPLATE_CODE_DUPLICATE, code);
}
}

4
src/main/resources/codegen/vue/views/index.vue.vm
View File

@ -137,7 +137,7 @@
</el-select>
</el-form-item>
#elseif($column.htmlType == "checkbox")## 多选框
<el-form-item label="${comment}">
<el-form-item label="${comment}" prop="${javaField}">
<el-checkbox-group v-model="form.${javaField}">
#if ("" != $dictType)## 有数据字典
<el-checkbox v-for="dict in this.getDictDatas(DICT_TYPE.$dictType.toUpperCase())"
@ -148,7 +148,7 @@
</el-checkbox-group>
</el-form-item>
#elseif($column.htmlType == "radio")## 单选框
<el-form-item label="${comment}">
<el-form-item label="${comment}" prop="${javaField}">
<el-radio-group v-model="form.${javaField}">
#if ("" != $dictType)## 有数据字典
<el-radio v-for="dict in this.getDictDatas(DICT_TYPE.$dictType.toUpperCase())"