REVIEW 站内信模版的发送

src/api/system/notify/template/index.ts

@@ -1,24 +1,17 @@
 import request from '@/config/axios'
 
 export interface NotifyTemplateVO {
-  id: number | null
+  id?: number
   name: string
   nickname: string
   code: string
   content: string
-  type: number | null
+  type: number
   params: string
-  status: number | null
+  status: number
   remark: string
 }
 
-export interface NotifyTemplatePageReqVO extends PageParam {
-  name?: string
-  code?: string
-  status?: number
-  createTime?: Date[]
-}
-
 export interface NotifySendReqVO {
   userId: number | null
   templateCode: string
@@ -26,22 +19,22 @@ export interface NotifySendReqVO {
 }
 
 // 查询站内信模板列表
-export const getNotifyTemplatePageApi = async (params: NotifyTemplatePageReqVO) => {
+export const getNotifyTemplatePage = async (params: PageParam) => {
   return await request.get({ url: '/system/notify-template/page', params })
 }
 
 // 查询站内信模板详情
-export const getNotifyTemplateApi = async (id: number) => {
+export const getNotifyTemplate = async (id: number) => {
   return await request.get({ url: '/system/notify-template/get?id=' + id })
 }
 
 // 新增站内信模板
-export const createNotifyTemplateApi = async (data: NotifyTemplateVO) => {
+export const createNotifyTemplate = async (data: NotifyTemplateVO) => {
   return await request.post({ url: '/system/notify-template/create', data })
 }
 
 // 修改站内信模板
-export const updateNotifyTemplateApi = async (data: NotifyTemplateVO) => {
+export const updateNotifyTemplate = async (data: NotifyTemplateVO) => {
   return await request.put({ url: '/system/notify-template/update', data })
 }
 
@@ -51,6 +44,6 @@ export const deleteNotifyTemplateApi = async (id: number) => {
 }
 
 // 发送站内信
-export const sendNotifyApi = (data: NotifySendReqVO) => {
+export const sendNotify = (data: NotifySendReqVO) => {
   return request.post({ url: '/system/notify-template/send-notify', data })
 }

src/views/system/notify/template/NotifyTemplateForm.vue

@@ -25,7 +25,7 @@
             v-for="dict in getIntDictOptions(DICT_TYPE.SYSTEM_NOTIFY_TEMPLATE_TYPE)"
             :key="dict.value"
             :label="dict.label"
-            :value="parseInt(dict.value)"
+            :value="dict.value"
           />
         </el-select>
       </el-form-item>
@@ -34,7 +34,7 @@
           <el-radio
             v-for="dict in getIntDictOptions(DICT_TYPE.COMMON_STATUS)"
             :key="dict.value"
-            :label="parseInt(dict.value as string)"
+            :label="dict.value as string"
           >
             {{ dict.label }}
           </el-radio>
@@ -81,6 +81,7 @@ const formRules = reactive({
 })
 const formRef = ref() // 表单 Ref
 
+/** 打开弹窗 */
 const open = async (type: string, id?: number) => {
   dialogVisible.value = true
   dialogTitle.value = type
@@ -90,7 +91,7 @@ const open = async (type: string, id?: number) => {
   if (id) {
     formLoading.value = true
     try {
-      formData.value = await NotifyTemplateApi.getNotifyTemplateApi(id)
+      formData.value = await NotifyTemplateApi.getNotifyTemplate(id)
     } finally {
       formLoading.value = false
     }
@@ -107,12 +108,12 @@ const submitForm = async () => {
   if (!valid) return
   formLoading.value = true
   try {
-    const data = formData.value as NotifyTemplateApi.NotifyTemplateVO
+    const data = formData.value as unknown as NotifyTemplateApi.NotifyTemplateVO
     if (formType.value === 'create') {
-      await NotifyTemplateApi.createNotifyTemplateApi(data)
+      await NotifyTemplateApi.createNotifyTemplate(data)
       message.success('新增成功')
     } else {
-      await NotifyTemplateApi.updateNotifyTemplateApi(data)
+      await NotifyTemplateApi.updateNotifyTemplate(data)
       message.success('修改成功')
     }
     dialogVisible.value = false

src/views/system/notify/template/NotifyTemplateSendForm.vue

@@ -0,0 +1,127 @@
+<template>
+  <Dialog v-model="dialogVisible" title="测试发送" :max-height="500">
+    <el-form
+      ref="formRef"
+      v-loading="formLoading"
+      :model="formData"
+      :rules="formRules"
+      label-width="140px"
+    >
+      <el-form-item label="模板内容" prop="content">
+        <el-input
+          v-model="formData.content"
+          placeholder="请输入模板内容"
+          readonly
+          type="textarea"
+        />
+      </el-form-item>
+      <el-form-item label="接收人" prop="userId">
+        <el-select v-model="formData.userId" placeholder="请选择接收人">
+          <el-option
+            v-for="item in userOption"
+            :key="item.id"
+            :label="item.nickname"
+            :value="item.id"
+          />
+        </el-select>
+      </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 :disabled="formLoading" type="primary" @click="submitForm">确 定</el-button>
+      <el-button @click="dialogVisible = false">取 消</el-button>
+    </template>
+  </Dialog>
+</template>
+<script lang="ts" name="SystemNotifyTemplateSendForm" setup>
+import * as SmsTemplateApi from '@/api/system/sms/smsTemplate'
+import * as UserApi from '@/api/system/user'
+import * as NotifyTemplateApi from '@/api/system/notify/template'
+const message = useMessage() // 消息弹窗
+
+const dialogVisible = ref(false) // 弹窗的是否展示
+const formLoading = ref(false) // 表单的加载中：1）修改时的数据加载；2）提交的按钮禁用
+const formData = ref({
+  content: '',
+  params: {},
+  userId: null,
+  templateCode: '',
+  templateParams: new Map()
+})
+const formRules = reactive({
+  userId: [{ required: true, message: '用户编号不能为空', trigger: 'change' }],
+  templateCode: [{ required: true, message: '模版编号不能为空', trigger: 'blur' }],
+  templateParams: {}
+})
+const formRef = ref() // 表单 Ref
+const userOption = ref<UserApi.UserVO[]>([])
+
+const open = async (id: number) => {
+  dialogVisible.value = true
+  resetForm()
+  // 设置数据
+  formLoading.value = true
+  try {
+    const data = await NotifyTemplateApi.getNotifyTemplate(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
+  }
+  // 加载用户列表
+  userOption.value = await UserApi.getSimpleUserList()
+}
+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)
+    }
+    dialogVisible.value = false
+  } finally {
+    formLoading.value = false
+  }
+}
+
+/** 重置表单 */
+const resetForm = () => {
+  formData.value = {
+    content: '',
+    params: {},
+    mobile: '',
+    templateCode: '',
+    templateParams: new Map()
+  }
+  formRef.value?.resetFields()
+}
+</script>

src/views/system/notify/template/index.vue

@@ -1,8 +1,8 @@
 <template>
   <doc-alert title="站内信配置" url="https://doc.iocoder.cn/notify/" />
 
+  <!-- 搜索工作栏 -->
   <ContentWrap>
-    <!-- 搜索工作栏 -->
     <el-form
       class="-mb-15px"
       :model="queryParams"
@@ -99,7 +99,6 @@
         width="200"
         :show-overflow-tooltip="true"
       />
-
       <el-table-column label="开启状态" align="center" prop="status" width="80">
         <template #default="scope">
           <dict-tag :type="DICT_TYPE.COMMON_STATUS" :value="scope.row.status" />
@@ -151,67 +150,22 @@
     />
   </ContentWrap>
 
-  <Dialog v-model="dialogFormVisible" title="测试发送" :max-height="500">
-    <el-form
-      ref="sendFormRef"
-      :model="sendFormData"
-      :rules="sendFormRules"
-      label-width="140px"
-      v-loading="formLoading"
-    >
-      <el-form-item label="模板内容" prop="content">
-        <el-input v-model="sendFormData.content" readonly />
-      </el-form-item>
-      <el-form-item label="接收人" prop="userId">
-        <el-select v-model="sendFormData.userId" placeholder="请选择接收人">
-          <el-option
-            v-for="item in userOption"
-            :key="item.id"
-            :label="item.nickname"
-            :value="item.id"
-          />
-        </el-select>
-      </el-form-item>
-      <el-form-item
-        v-for="param in sendFormData.params"
-        :key="param"
-        :label="'参数 {' + param + '}'"
-        :prop="'templateParams.' + param"
-      >
-        <el-input
-          v-model="sendFormData.templateParams[param]"
-          :placeholder="'请输入 ' + param + ' 参数'"
-        />
-      </el-form-item>
-    </el-form>
-    <template #footer>
-      <span class="dialog-footer">
-        <el-button @click="dialogFormVisible = false">取消</el-button>
-        <el-button type="primary" @click="submitForm"> 确定 </el-button>
-      </span>
-    </template>
-  </Dialog>
-
   <!-- 表单弹窗：添加/修改 -->
   <NotifyTemplateForm ref="formRef" @success="getList" />
+  <!-- 表单弹窗：测试发送 -->
+  <NotifyTemplateSendForm ref="sendFormRef" />
 </template>
 <script setup lang="ts" name="NotifySmsTemplate">
 import { DICT_TYPE, getIntDictOptions } from '@/utils/dict'
 import { dateFormatter } from '@/utils/formatTime'
 import * as NotifyTemplateApi from '@/api/system/notify/template'
-import { getSimpleUserList, UserVO } from '@/api/system/user'
 import NotifyTemplateForm from './NotifyTemplateForm.vue'
-
+import NotifyTemplateSendForm from './NotifyTemplateSendForm.vue'
 const message = useMessage() // 消息弹窗
 
 const loading = ref(false) // 列表的加载中
 const total = ref(0) // 列表的总页数
 const list = ref([]) // 列表的数据
-const queryFormRef = ref() // 搜索的表单
-
-const formLoading = ref(false)
-const dialogFormVisible = ref(false)
-const sendFormRef = ref() // 表单 Ref
 const queryParams = reactive({
   pageNo: 1,
   pageSize: 10,
@@ -220,28 +174,13 @@ const queryParams = reactive({
   code: undefined,
   createTime: []
 })
-
+const queryFormRef = ref() // 搜索的表单
-const sendFormData = ref({
-  content: '',
-  params: {},
-  userId: null,
-  templateCode: '',
-  templateParams: {}
-})
-
-const sendFormRules = ref({
-  userId: [{ required: true, message: '用户编号不能为空', trigger: 'change' }],
-  templateCode: [{ required: true, message: '模版编号不能为空', trigger: 'blur' }],
-  templateParams: {}
-})
-
-const userOption = ref<UserVO[]>([])
 
 /** 查询列表 */
 const getList = async () => {
   loading.value = true
   try {
-    const data = await NotifyTemplateApi.getNotifyTemplatePageApi(queryParams)
+    const data = await NotifyTemplateApi.getNotifyTemplatePage(queryParams)
     list.value = data.list
     total.value = data.total
   } finally {
@@ -280,50 +219,14 @@ const handleDelete = async (id: number) => {
   } catch {}
 }
 
-const openSendForm = (row: any) => {
+/** 发送站内信按钮 */
-  sendFormData.value.content = row.content
+const sendFormRef = ref() // 表单 Ref
-  sendFormData.value.params = row.params
+const openSendForm = (row: NotifyTemplateApi.NotifyTemplateVO) => {
-  sendFormData.value.templateCode = row.code
+  sendFormRef.value.open(row.id)
-  sendFormData.value.templateParams = row.params.reduce(function (obj, item) {
-    obj[item] = undefined
-    return obj
-  }, {})
-  sendFormRules.value.templateParams = row.params.reduce(function (obj, item) {
-    obj[item] = { required: true, message: '参数 ' + item + ' 不能为空', trigger: 'change' }
-    return obj
-  }, {})
-  dialogFormVisible.value = true
-}
-
-/** 提交表单 */
-const submitForm = async () => {
-  // 校验表单
-  if (!sendFormRef) return
-  const valid = await sendFormRef.value.validate()
-  if (!valid) return
-  // 提交请求
-  formLoading.value = true
-  try {
-    const data: NotifyTemplateApi.NotifySendReqVO = {
-      userId: sendFormData.value.userId,
-      templateCode: sendFormData.value.templateCode,
-      templateParams: sendFormData.value.templateParams as unknown as Map<string, Object>
-    }
-    const res = await NotifyTemplateApi.sendNotifyApi(data)
-    if (res) {
-      message.success('提交发送成功！发送结果，见消息记录编号：' + res)
-    }
-    dialogFormVisible.value = false
-  } finally {
-    formLoading.value = false
-  }
 }
 
 /** 初始化 **/
 onMounted(() => {
   getList()
-  getSimpleUserList().then((data) => {
-    userOption.value = data
-  })
 })
 </script>