Skip to content

phsl / admin

Go to a project
Commit 74aeffec by YunaiV
Options

Vue3 重构：REVIEW 短信模版

parent 6b194bb9
Showing with 176 additions and 186 deletions
src/api/system/sms/smsTemplate/index.ts
...@@ -3,7 +3,7 @@ import request from '@/config/axios' ...@@ -3,7 +3,7 @@ import request from '@/config/axios'
export interface SmsTemplateVO { export interface SmsTemplateVO {
id: number | null id: number | null
type: number | null type: number | null
status: number | null status: number
code: string code: string
name: string name: string
content: string content: string
...@@ -21,60 +21,40 @@ export interface SendSmsReqVO { ...@@ -21,60 +21,40 @@ export interface SendSmsReqVO {
templateParams: Map<String, Object> templateParams: Map<String, Object>
} }
export interface SmsTemplatePageReqVO extends PageParam {
type?: number | null
status?: number | null
code?: string
content?: string
apiTemplateId?: string
channelId?: number | null
createTime?: Date[]
}
export interface SmsTemplateExportReqVO {
type?: number
status?: number
code?: string
content?: string
apiTemplateId?: string
channelId?: number
createTime?: Date[]
}
// 查询短信模板列表 // 查询短信模板列表
export const getSmsTemplatePageApi = (params: SmsTemplatePageReqVO) => { export const getSmsTemplatePage = (params: PageParam) => {
return request.get({ url: '/system/sms-template/page', params }) return request.get({ url: '/system/sms-template/page', params })
} }
// 查询短信模板详情 // 查询短信模板详情
export const getSmsTemplateApi = (id: number) => { export const getSmsTemplate = (id: number) => {
return request.get({ url: '/system/sms-template/get?id=' + id }) return request.get({ url: '/system/sms-template/get?id=' + id })
} }
// 新增短信模板 // 新增短信模板
export const createSmsTemplateApi = (data: SmsTemplateVO) => { export const createSmsTemplate = (data: SmsTemplateVO) => {
return request.post({ url: '/system/sms-template/create', data }) return request.post({ url: '/system/sms-template/create', data })
} }
// 修改短信模板 // 修改短信模板
export const updateSmsTemplateApi = (data: SmsTemplateVO) => { export const updateSmsTemplate = (data: SmsTemplateVO) => {
return request.put({ url: '/system/sms-template/update', data }) return request.put({ url: '/system/sms-template/update', data })
} }
// 删除短信模板 // 删除短信模板
export const deleteSmsTemplateApi = (id: number) => { export const deleteSmsTemplate = (id: number) => {
return request.delete({ url: '/system/sms-template/delete?id=' + id }) return request.delete({ url: '/system/sms-template/delete?id=' + id })
} }
// 发送短信
export const sendSmsApi = (data: SendSmsReqVO) => {
return request.post({ url: '/system/sms-template/send-sms', data })
}
// 导出短信模板 // 导出短信模板
export const exportPostApi = (params: SmsTemplateExportReqVO) => { export const exportSmsTemplate = (params) => {
return request.download({ return request.download({
url: '/system/sms-template/export-excel', url: '/system/sms-template/export-excel',
params params
}) })
} }
// 发送短信
export const sendSms = (data: SendSmsReqVO) => {
return request.post({ url: '/system/sms-template/send-sms', data })
}
src/views/system/sms/log/index.vue
...@@ -102,7 +102,7 @@ ...@@ -102,7 +102,7 @@
plain plain
@click="handleExport" @click="handleExport"
:loading="exportLoading" :loading="exportLoading"
v-hasPermi="['infra:config:export']" v-hasPermi="['system:sms-log:export']"
> >
<Icon icon="ep:download" class="mr-5px" /> 导出 <Icon icon="ep:download" class="mr-5px" /> 导出
</el-button> </el-button>
......
src/views/system/sms/template/form.vue → src/views/system/sms/template/SmsTemplateForm.vue
<template> <template>
<Dialog :title="modelTitle" v-model="modelVisible"> <Dialog :title="modelTitle" v-model="modelVisible">
<!-- 修改/新增 -->
<el-form <el-form
v-if="['template.addTitle', 'template.updtaeTitle'].includes(formType)"
ref="formRef" ref="formRef"
:model="formData" :model="formData"
:rules="formRules" :rules="formRules"
label-width="140px" label-width="140px"
v-loading="formLoading"
> >
<el-form-item label="短信渠道编号" prop="channelId"> <el-form-item label="短信渠道编号" prop="channelId">
<el-select v-model="formData.channelId" placeholder="请选择短信渠道编号"> <el-select v-model="formData.channelId" placeholder="请选择短信渠道编号">
<el-option <el-option
v-for="channel in channelOptions" v-for="channel in channelList"
:key="channel.id" :key="channel.id"
:value="channel.id" :value="channel.id"
:label=" :label="
channel.signature + optionLabel(DICT_TYPE.SYSTEM_SMS_CHANNEL_CODE, channel.code) channel.signature +
`【 ${getDictLabel(DICT_TYPE.SYSTEM_SMS_CHANNEL_CODE, channel.code)}】`
" "
/> />
</el-select> </el-select>
...@@ -23,10 +23,10 @@ ...@@ -23,10 +23,10 @@
<el-form-item label="短信类型" prop="type"> <el-form-item label="短信类型" prop="type">
<el-select v-model="formData.type" placeholder="请选择短信类型"> <el-select v-model="formData.type" placeholder="请选择短信类型">
<el-option <el-option
v-for="dict in getDictOptions(DICT_TYPE.SYSTEM_SMS_TEMPLATE_TYPE)" v-for="dict in getIntDictOptions(DICT_TYPE.SYSTEM_SMS_TEMPLATE_TYPE)"
:key="dict.value" :key="dict.value"
:label="dict.label" :label="dict.label"
:value="parseInt(dict.value)" :value="dict.value"
/> />
</el-select> </el-select>
</el-form-item> </el-form-item>
...@@ -42,11 +42,12 @@ ...@@ -42,11 +42,12 @@
<el-form-item label="开启状态" prop="status"> <el-form-item label="开启状态" prop="status">
<el-radio-group v-model="formData.status"> <el-radio-group v-model="formData.status">
<el-radio <el-radio
v-for="dict in getDictOptions(DICT_TYPE.COMMON_STATUS)" v-for="dict in getIntDictOptions(DICT_TYPE.COMMON_STATUS)"
:key="dict.value" :key="dict.value"
:label="parseInt(dict.value)" :label="parseInt(dict.value)"
>{{ dict.label }}</el-radio
> >
{{ dict.label }}
</el-radio>
</el-radio-group> </el-radio-group>
</el-form-item> </el-form-item>
<el-form-item label="短信 API 模板编号" prop="apiTemplateId"> <el-form-item label="短信 API 模板编号" prop="apiTemplateId">
...@@ -56,66 +57,28 @@ ...@@ -56,66 +57,28 @@
<el-input v-model="formData.remark" placeholder="请输入备注" /> <el-input v-model="formData.remark" placeholder="请输入备注" />
</el-form-item> </el-form-item>
</el-form> </el-form>
<!-- 短信测试 -->
<el-form
v-if="formType === 'template.sendSms'"
ref="sendSmsFormRef"
:model="sendSmsForm"
:rules="sendSmsRules"
>
<el-form-item label="模板内容" prop="content">
<el-input
v-model="sendSmsForm.content"
type="textarea"
placeholder="请输入模板内容"
readonly
/>
</el-form-item>
<el-form-item label="手机号" prop="mobile">
<el-input v-model="sendSmsForm.mobile" placeholder="请输入手机号" />
</el-form-item>
<el-form-item
v-for="param in sendSmsForm.params"
:key="param"
:label="'参数 {' + param + '}'"
:prop="'templateParams.' + param"
>
<el-input
v-model="sendSmsForm.templateParams[param]"
:placeholder="'请输入 ' + param + ' 参数'"
/>
</el-form-item>
</el-form>
<template #footer> <template #footer>
<div class="dialog-footer"> <el-button @click="submitForm" type="primary" :disabled="formLoading">确 定</el-button>
<el-button @click="submitForm" type="primary" :disabled="formLoading">确 定</el-button> <el-button @click="modelVisible = false">取 消</el-button>
<el-button @click="modelVisible = false">取 消</el-button>
</div>
</template> </template>
</Dialog> </Dialog>
</template> </template>
<script setup lang="ts" name="SmsTemplateFrom"> <script setup lang="ts">
import { DICT_TYPE, getDictOptions, getDictLabel } from '@/utils/dict' import { DICT_TYPE, getIntDictOptions, getDictLabel } from '@/utils/dict'
import * as templateApi from '@/api/system/sms/smsTemplate' import * as SmsTemplateApi from '@/api/system/sms/smsTemplate'
import * as SmsChannelApi from '@/api/system/sms/smsChannel' import * as SmsChannelApi from '@/api/system/sms/smsChannel'
import { CommonStatusEnum } from '@/utils/constants'
const { t } = useI18n() // 国际化 const { t } = useI18n() // 国际化
const message = useMessage() // 消息弹窗 const message = useMessage() // 消息弹窗
defineProps({
channelOptions: {
type: Array as PropType<SmsChannelApi.SmsChannelListVO[]>,
define: () => {}
}
})
const modelVisible = ref(false) // 弹窗的是否展示 const modelVisible = ref(false) // 弹窗的是否展示
const modelTitle = ref('') // 弹窗的标题 const modelTitle = ref('') // 弹窗的标题
const formLoading = ref(false) // 表单的加载中：1）修改时的数据加载；2）提交的按钮禁用 const formLoading = ref(false) // 表单的加载中：1）修改时的数据加载；2）提交的按钮禁用
const formType = ref('') // 表单的类型 const formType = ref('') // 表单的类型
const formData = ref<templateApi.SmsTemplateVO>({ const formData = ref<SmsTemplateApi.SmsTemplateVO>({
id: null, id: null,
type: null, type: null,
status: null, status: CommonStatusEnum.ENABLE,
code: '', code: '',
name: '', name: '',
content: '', content: '',
...@@ -132,94 +95,50 @@ const formRules = reactive({ ...@@ -132,94 +95,50 @@ const formRules = reactive({
apiTemplateId: [{ required: true, message: '短信 API 的模板编号不能为空', trigger: 'blur' }], apiTemplateId: [{ required: true, message: '短信 API 的模板编号不能为空', trigger: 'blur' }],
channelId: [{ required: true, message: '短信渠道编号不能为空', trigger: 'change' }] channelId: [{ required: true, message: '短信渠道编号不能为空', trigger: 'change' }]
}) })
const formRef = ref() // 表单 Ref const formRef = ref() // 表单 Ref
const optionLabel = computed( const channelList = ref([]) // 短信渠道列表
() => (type: string, code: string) => `【${getDictLabel(type, code)}】`
) const open = async (type: string, id?: number) => {
// 发送短信表单相关
const sendSmsForm = ref({
content: '',
params: {},
mobile: '',
templateCode: '',
templateParams: {}
})
const sendSmsRules = reactive({
mobile: [{ required: true, message: '手机不能为空', trigger: 'blur' }],
templateCode: [{ required: true, message: '模版编码不能为空', trigger: 'blur' }],
templateParams: {}
})
const sendSmsFormRef = ref()
/** 打开弹窗 */
interface openModalOption {
type: string
// 编辑传id
id?: ''
// 短信测试传row
row?: any
}
const openModal = async (option: openModalOption) => {
modelVisible.value = true modelVisible.value = true
modelTitle.value = t('dialog.sms.' + option.type) modelTitle.value = t('action.' + type)
formType.value = option.type formType.value = type
resetForm() resetForm()
resetSendSms()
// 短信测试
if (option.row) {
sendSmsForm.value.content = option.row.content
sendSmsForm.value.params = option.row.params
sendSmsForm.value.templateCode = option.row.code
sendSmsForm.value.templateParams = option.row.params.reduce(function (obj, item) {
obj[item] = undefined
return obj
}, {})
sendSmsRules.templateParams = option.row.params.reduce(function (obj, item) {
obj[item] = { required: true, message: '参数 ' + item + ' 不能为空', trigger: 'change' }
return obj
}, {})
}
// 修改时，设置数据 // 修改时，设置数据
if (option.id) { if (id) {
formLoading.value = true formLoading.value = true
try { try {
formData.value = await templateApi.getSmsTemplateApi(option.id) formData.value = await SmsTemplateApi.getSmsTemplate(id)
} finally { } finally {
formLoading.value = false formLoading.value = false
} }
} }
// 加载渠道列表
channelList.value = await SmsChannelApi.getSimpleSmsChannelList()
} }
defineExpose({ openModal }) // 提供 openModal 方法，用于打开弹窗 defineExpose({ open }) // 提供 open 方法，用于打开弹窗
const emit = defineEmits(['success']) // 定义 success 事件，用于操作成功后的回调
/** 提交表单 */ /** 提交表单 */
const emit = defineEmits(['success']) // 定义 success 事件，用于操作成功后的回调
const submitForm = async () => { const submitForm = async () => {
// 校验表单
if (!formRef) return
const valid = await formRef.value.validate()
if (!valid) return
formLoading.value = true formLoading.value = true
// 提交请求 try {
if (['template.addTitle', 'template.updtaeTitle'].includes(formType.value)) { const data = formData.value as SmsTemplateApi.SmsTemplateVO
// 校验表单 if (formType.value === 'create') {
if (!formRef) return await SmsTemplateApi.createSmsTemplate(data)
const valid = await formRef.value.validate() message.success(t('common.createSuccess'))
if (!valid) return } else {
try { await SmsTemplateApi.updateSmsTemplate(data)
const data = formData.value as templateApi.SmsTemplateVO message.success(t('common.updateSuccess'))
if (formType.value === 'template.addTitle') {
await templateApi.createSmsTemplateApi(data)
message.success(t('common.createSuccess'))
} else {
await templateApi.updateSmsTemplateApi(data)
message.success(t('common.updateSuccess'))
}
modelVisible.value = false
// 发送操作成功的事件
emit('success')
} finally {
formLoading.value = false
} }
} modelVisible.value = false
if (formType.value === 'template.sendSms') { // 发送操作成功的事件
sendSmsTest() emit('success')
} finally {
formLoading.value = false
} }
} }
...@@ -228,7 +147,7 @@ const resetForm = () => { ...@@ -228,7 +147,7 @@ const resetForm = () => {
formData.value = { formData.value = {
id: null, id: null,
type: null, type: null,
status: null, status: CommonStatusEnum.ENABLE,
code: '', code: '',
name: '', name: '',
content: '', content: '',
...@@ -238,30 +157,4 @@ const resetForm = () => { ...@@ -238,30 +157,4 @@ const resetForm = () => {
} }
formRef.value?.resetFields() formRef.value?.resetFields()
} }
/** 重置发送短信的表单 */
const resetSendSms = () => {
// 根据 row 重置表单
sendSmsForm.value = {
content: '',
params: {},
mobile: '',
templateCode: '',
templateParams: {}
}
sendSmsFormRef.value?.resetFields()
}
/** 发送短信 */
const sendSmsTest = async () => {
const data: templateApi.SendSmsReqVO = {
mobile: sendSmsForm.value.mobile,
templateCode: sendSmsForm.value.templateCode,
templateParams: sendSmsForm.value.templateParams as unknown as Map<string, Object>
}
const res = await templateApi.sendSmsApi(data)
if (res) {
message.success('提交发送成功！发送结果，见发送日志编号：' + res)
}
formLoading.value = false
modelVisible.value = false
}
</script> </script>
src/views/system/sms/template/SmsTemplateSendForm.vue 0 → 100644
<template>
<Dialog title="测试" v-model="modelVisible">
<el-form
ref="formRef"
:model="formData"
:rules="formRules"
label-width="140px"
v-loading="formLoading"
>
<el-form-item label="模板内容" prop="content">
<el-input
v-model="formData.content"
type="textarea"
placeholder="请输入模板内容"
readonly
/>
</el-form-item>
<el-form-item label="手机号" prop="mobile">
<el-input v-model="formData.mobile" placeholder="请输入手机号" />
</el-form-item>
<el-form-item
v-for="param in formData.params"
:key="param"
:label="'参数 {' + param + '}'"
:prop="'templateParams.' + param"
>
<el-input
v-model="formData.templateParams[param]"
:placeholder="'请输入 ' + param + ' 参数'"
/>
</el-form-item>
</el-form>
<template #footer>
<el-button @click="submitForm" type="primary" :disabled="formLoading">确 定</el-button>
<el-button @click="modelVisible = false">取 消</el-button>
</template>
</Dialog>
</template>
<script setup lang="ts">
import * as SmsTemplateApi from '@/api/system/sms/smsTemplate'
const message = useMessage() // 消息弹窗
const modelVisible = ref(false) // 弹窗的是否展示
const formLoading = ref(false) // 表单的加载中：1）修改时的数据加载；2）提交的按钮禁用
// 发送短信表单相关
const formData = ref({
content: '',
params: {},
mobile: '',
templateCode: '',
templateParams: new Map()
})
const formRules = reactive({
mobile: [{ required: true, message: '手机不能为空', trigger: 'blur' }],
templateCode: [{ required: true, message: '模版编码不能为空', trigger: 'blur' }],
templateParams: {}
})
const formRef = ref() // 表单 Ref
const open = async (id: number) => {
modelVisible.value = true
resetForm()
// 设置数据
formLoading.value = true
try {
const data = await SmsTemplateApi.getSmsTemplate(id)
// 设置动态表单
formData.value.content = data.content
formData.value.params = data.params
formData.value.templateCode = data.code
formData.value.templateParams = data.params.reduce((obj, item) => {
obj[item] = '' // 给每个动态属性赋值，避免无法读取
return obj
}, {})
formRules.templateParams = data.params.reduce((obj, item) => {
obj[item] = { required: true, message: '参数 ' + item + ' 不能为空', trigger: 'blur' }
return obj
}, {})
} finally {
formLoading.value = false
}
}
defineExpose({ open }) // 提供 open 方法，用于打开弹窗
/** 提交表单 */
const submitForm = async () => {
// 校验表单
if (!formRef) return
const valid = await formRef.value.validate()
if (!valid) return
// 提交请求
formLoading.value = true
try {
const data = formData.value as SmsTemplateApi.SendSmsReqVO
const logId = await SmsTemplateApi.sendSms(data)
if (logId) {
message.success('提交发送成功！发送结果，见发送日志编号：' + logId)
}
modelVisible.value = false
} finally {
formLoading.value = false
}
}
/** 重置表单 */
const resetForm = () => {
formData.value = {
content: '',
params: {},
mobile: '',
templateCode: '',
templateParams: new Map()
}
formRef.value?.resetFields()
}
</script>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment