Vue3 重构：邮件模版的列表

src/views/infra/dataSourceConfig/form.vue

@@ -30,7 +30,6 @@
 </template>
 <script setup lang="ts">
 import * as DataSourceConfigApi from '@/api/infra/dataSourceConfig'
-import { DataSourceConfigVO } from '@/api/infra/dataSourceConfig'
 
 const { t } = useI18n() // 国际化
 const message = useMessage() // 消息弹窗
@@ -39,7 +38,7 @@ const modelVisible = ref(false) // 弹窗的是否展示
 const modelTitle = ref('') // 弹窗的标题
 const formLoading = ref(false) // 表单的加载中：1）修改时的数据加载；2）提交的按钮禁用
 const formType = ref('') // 表单的类型：create - 新增；update - 修改
-const formData = ref<DataSourceConfigVO>({
+const formData = ref<DataSourceConfigApi.DataSourceConfigVO>({
   id: undefined,
   name: '',
   url: '',

src/views/system/mail/account/account.data.ts

@@ -77,9 +77,7 @@ const crudSchemas = reactive<CrudSchema[]>([
   {
     label: '操作',
     field: 'action',
-    form: {
+    isForm: false
-      show: false
-    }
   }
 ])
 export const { allSchemas } = useCrudSchemas(crudSchemas)

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

@@ -1,273 +1,84 @@
 <template>
-  <ContentWrap>
+  <!-- 搜索工作栏 -->
-    <!-- 列表 -->
+  <content-wrap>
-    <XTable @register="registerTable">
+    <Search :schema="allSchemas.searchSchema" @search="setSearchParams" @reset="setSearchParams">
-      <template #accountId_search>
+      <!-- 新增等操作按钮 -->
-        <el-select v-model="queryParams.accountId">
+      <template #actionMore>
-          <el-option :key="undefined" label="全部" :value="undefined" />
+        <el-button
-          <el-option
-            v-for="item in accountOptions"
-            :key="item.id"
-            :label="item.mail"
-            :value="item.id"
-          />
-        </el-select>
-      </template>
-      <template #toolbar_buttons>
-        <!-- 操作：新增 -->
-        <XButton
           type="primary"
-          preIcon="ep:zoom-in"
+          @click="openModal('create')"
-          :title="t('action.add')"
+          v-hasPermi="['system:mail-account:create']"
-          v-hasPermi="['system:mail-template:create']"
+        >
-          @click="handleCreate()"
+          <Icon icon="ep:plus" class="mr-5px" /> 新增
-        />
+        </el-button>
       </template>
-      <template #accountId_default="{ row }">
+    </Search>
-        <span>{{ accountOptions.find((account) => account.id === row.accountId)?.mail }}</span>
+  </content-wrap>
-      </template>
-      <template #actionbtns_default="{ row }">
-        <!-- 操作：测试短信 -->
-        <XTextButton
-          preIcon="ep:cpu"
-          :title="t('action.test')"
-          v-hasPermi="['system:mail-template:send-mail']"
-          @click="handleSendMail(row)"
-        />
-        <!-- 操作：修改 -->
-        <XTextButton
-          preIcon="ep:edit"
-          :title="t('action.edit')"
-          v-hasPermi="['system:mail-template:update']"
-          @click="handleUpdate(row.id)"
-        />
-        <!-- 操作：详情 -->
-        <XTextButton
-          preIcon="ep:view"
-          :title="t('action.detail')"
-          v-hasPermi="['system:mail-template:query']"
-          @click="handleDetail(row.id)"
-        />
-        <!-- 操作：删除 -->
-        <XTextButton
-          preIcon="ep:delete"
-          :title="t('action.del')"
-          v-hasPermi="['system:mail-template:delete']"
-          @click="deleteData(row.id)"
-        />
-      </template>
-    </XTable>
-  </ContentWrap>
 
-  <!-- 添加/修改/详情的弹窗 -->
+  <!-- 列表 -->
-  <XModal id="mailTemplateModel" :loading="modelLoading" v-model="modelVisible" :title="modelTitle">
+  <content-wrap>
-    <!-- 表单：添加/修改 -->
+    <Table
-    <Form
+      :columns="allSchemas.tableColumns"
-      ref="formRef"
+      :data="tableObject.tableList"
-      v-if="['create', 'update'].includes(actionType)"
+      :loading="tableObject.loading"
-      :schema="allSchemas.formSchema"
+      :pagination="{
-      :rules="rules"
+        total: tableObject.total
+      }"
+      v-model:pageSize="tableObject.pageSize"
+      v-model:currentPage="tableObject.currentPage"
     >
-      <template #accountId="form">
+      <template #action="{ row }">
-        <el-select v-model="form.accountId">
+        <el-button
-          <el-option
+          link
-            v-for="item in accountOptions"
+          type="primary"
-            :key="item.id"
+          @click="openModal('update', row.id)"
-            :label="item.mail"
+          v-hasPermi="['system:mail-template:update']"
-            :value="item.id"
+        >
-          />
+          编辑
-        </el-select>
+        </el-button>
+        <el-button
+          link
+          type="danger"
+          v-hasPermi="['system:mail-template:delete']"
+          @click="handleDelete(row.id)"
+        >
+          删除
+        </el-button>
       </template>
-    </Form>
+    </Table>
-    <!-- 表单：详情 -->
+  </content-wrap>
-    <Descriptions
-      v-if="actionType === 'detail'"
-      :schema="allSchemas.detailSchema"
-      :data="detailData"
-    />
-    <template #footer>
-      <!-- 按钮：保存 -->
-      <XButton
-        v-if="['create', 'update'].includes(actionType)"
-        type="primary"
-        :title="t('action.save')"
-        :loading="actionLoading"
-        @click="submitForm()"
-      />
-      <!-- 按钮：关闭 -->
-      <XButton :loading="actionLoading" :title="t('dialog.close')" @click="modelVisible = false" />
-    </template>
-  </XModal>
 
-  <!-- 测试邮件的弹窗 -->
+  <!-- 表单弹窗：添加/修改 -->
-  <XModal id="sendTest" v-model="sendVisible" title="测试">
+  <!--  <mail-template-form ref="modalRef" @success="getList" />-->
-    <el-form :model="sendForm" :rules="sendRules" label-width="200px" label-position="top">
-      <el-form-item label="模板内容" prop="content">
-        <Editor :model-value="sendForm.content" readonly height="150px" />
-      </el-form-item>
-      <el-form-item label="收件邮箱" prop="mail">
-        <el-input v-model="sendForm.mail" placeholder="请输入收件邮箱" />
-      </el-form-item>
-      <el-form-item
-        v-for="param in sendForm.params"
-        :key="param"
-        :label="'参数 {' + param + '}'"
-        :prop="'templateParams.' + param"
-      >
-        <el-input
-          v-model="sendForm.templateParams[param]"
-          :placeholder="'请输入 ' + param + ' 参数'"
-        />
-      </el-form-item>
-    </el-form>
-    <!-- 操作按钮 -->
-    <template #footer>
-      <XButton
-        type="primary"
-        :title="t('action.test')"
-        :loading="actionLoading"
-        @click="sendTest()"
-      />
-      <XButton :title="t('dialog.close')" @click="sendVisible = false" />
-    </template>
-  </XModal>
 </template>
 <script setup lang="ts" name="MailTemplate">
-import { FormExpose } from '@/components/Form'
+import { allSchemas } from './template.data'
-// 业务相关的 import
-import { rules, allSchemas } from './template.data'
 import * as MailTemplateApi from '@/api/system/mail/template'
-import * as MailAccountApi from '@/api/system/mail/account'
+// import MailAccountForm from './form.vue'
 
-const { t } = useI18n() // 国际化
+// tableObject：表格的属性对象，可获得分页大小、条数等属性
-const message = useMessage() // 消息弹窗
+// tableMethods：表格的操作对象，可进行获得分页、删除记录等操作
-
+// 详细可见：https://kailong110120130.gitee.io/vue-element-plus-admin-doc/components/table.html#usetable
-// 列表相关的变量
+const { tableObject, tableMethods } = useTable({
-const queryParams = reactive({
+  getListApi: MailTemplateApi.getMailTemplatePageApi, // 分页接口
-  accountId: null
+  delListApi: MailTemplateApi.deleteMailTemplateApi // 删除接口
 })
-const [registerTable, { reload, deleteData }] = useXTable({
+// 获得表格的各种操作
-  allSchemas: allSchemas,
+const { getList, setSearchParams } = tableMethods
-  params: queryParams,
-  getListApi: MailTemplateApi.getMailTemplatePageApi,
-  deleteApi: MailTemplateApi.deleteMailTemplateApi
-})
-const accountOptions = ref<any[]>([]) // 账号下拉选项
 
-// 弹窗相关的变量
+/** 添加/修改操作 */
-const modelVisible = ref(false) // 是否显示弹出层
+// const modalRef = ref()
-const modelTitle = ref('edit') // 弹出层标题
+// const openModal = (type: string, id?: number) => {
-const modelLoading = ref(false) // 弹出层loading
+//   modalRef.value.openModal(type, id)
-const actionType = ref('') // 操作按钮的类型
+// }
-const actionLoading = ref(false) // 按钮 Loading
-const formRef = ref<FormExpose>() // 表单 Ref
-const detailData = ref() // 详情 Ref
 
-// 设置标题
+/** 删除按钮操作 */
-const setDialogTile = (type: string) => {
+const handleDelete = (id: number) => {
-  modelLoading.value = true
+  tableMethods.delList(id, false)
-  modelTitle.value = t('action.' + type)
-  actionType.value = type
-  modelVisible.value = true
 }
 
-// 新增操作
+/** 初始化 **/
-const handleCreate = () => {
-  setDialogTile('create')
-  modelLoading.value = false
-}
-
-// 修改操作
-const handleUpdate = async (rowId: number) => {
-  setDialogTile('update')
-  // 设置数据
-  const res = await MailTemplateApi.getMailTemplateApi(rowId)
-  unref(formRef)?.setValues(res)
-  modelLoading.value = false
-}
-
-// 详情操作
-const handleDetail = async (rowId: number) => {
-  setDialogTile('detail')
-  const res = await MailTemplateApi.getMailTemplateApi(rowId)
-  detailData.value = res
-  modelLoading.value = false
-}
-
-// 提交按钮
-const submitForm = async () => {
-  const elForm = unref(formRef)?.getElFormRef()
-  if (!elForm) return
-  elForm.validate(async (valid) => {
-    if (valid) {
-      actionLoading.value = true
-      // 提交请求
-      try {
-        const data = unref(formRef)?.formModel as MailTemplateApi.MailTemplateVO
-        if (actionType.value === 'create') {
-          await MailTemplateApi.createMailTemplateApi(data)
-          message.success(t('common.createSuccess'))
-        } else {
-          await MailTemplateApi.updateMailTemplateApi(data)
-          message.success(t('common.updateSuccess'))
-        }
-        modelVisible.value = false
-      } finally {
-        actionLoading.value = false
-        // 刷新列表
-        await reload()
-      }
-    }
-  })
-}
-
-// ========== 测试相关 ==========
-const sendForm = ref({
-  content: '',
-  params: {},
-  mail: '',
-  templateCode: '',
-  templateParams: {}
-})
-const sendRules = ref({
-  mail: [{ required: true, message: '邮箱不能为空', trigger: 'blur' }],
-  templateCode: [{ required: true, message: '模版编号不能为空', trigger: 'blur' }],
-  templateParams: {}
-})
-const sendVisible = ref(false)
-
-const handleSendMail = (row: any) => {
-  sendForm.value.content = row.content
-  sendForm.value.params = row.params
-  sendForm.value.templateCode = row.code
-  sendForm.value.templateParams = row.params.reduce(function (obj, item) {
-    obj[item] = undefined
-    return obj
-  }, {})
-  sendRules.value.templateParams = row.params.reduce(function (obj, item) {
-    obj[item] = { required: true, message: '参数 ' + item + ' 不能为空', trigger: 'change' }
-    return obj
-  }, {})
-  sendVisible.value = true
-}
-
-const sendTest = async () => {
-  const data: MailTemplateApi.MailSendReqVO = {
-    mail: sendForm.value.mail,
-    templateCode: sendForm.value.templateCode,
-    templateParams: sendForm.value.templateParams as unknown as Map<string, Object>
-  }
-  const res = await MailTemplateApi.sendMailApi(data)
-  if (res) {
-    message.success('提交发送成功！发送结果，见发送日志编号：' + res)
-  }
-  sendVisible.value = false
-}
-
-// ========== 初始化 ==========
 onMounted(() => {
-  MailAccountApi.getSimpleMailAccountList().then((data) => {
+  getList()
-    accountOptions.value = data
-  })
 })
 </script>

src/views/system/mail/template/template.data.ts

@@ -1,98 +1,106 @@
-import type { VxeCrudSchema } from '@/hooks/web/useVxeCrudSchemas'
+import type { CrudSchema } from '@/hooks/web/useCrudSchemas'
+import { dateFormatter } from '@/utils/formatTime'
+import { TableColumn } from '@/types/table'
+import { DictTag } from '@/components/DictTag'
+import * as MailAccountApi from '@/api/system/mail/account'
+
+const accounts = await MailAccountApi.getSimpleMailAccountList()
 
 // 表单校验
 export const rules = reactive({
   name: [required],
   code: [required],
   accountId: [required],
-  title: [required],
+  label: [required],
   content: [required],
   params: [required],
   status: [required]
 })
 
-// CrudSchema
+// CrudSchema：https://kailong110120130.gitee.io/vue-element-plus-admin-doc/hooks/useCrudSchemas.html
-const crudSchemas = reactive<VxeCrudSchema>({
+const crudSchemas = reactive<CrudSchema[]>([
-  primaryKey: 'id', // 默认的主键ID
+  {
-  primaryTitle: '编号', // 默认显示的值
+    label: '模板编码',
-  primaryType: null,
+    field: 'code',
-  action: true,
+    isSearch: true
-  actionWidth: '260',
+  },
-  columns: [
+  {
-    {
+    label: '模板名称',
-      title: '模板编码',
+    field: 'name',
-      field: 'code',
+    isSearch: true
-      isSearch: true
+  },
-    },
+  {
-    {
+    label: '模板标题',
-      title: '模板名称',
+    field: 'title'
-      field: 'name',
+  },
-      isSearch: true
+  {
-    },
+    label: '模板内容',
-    {
+    field: 'content',
-      title: '模板标题',
+    form: {
-      field: 'title'
+      component: 'Editor',
-    },
+      colProps: {
-    {
+        span: 24
-      title: '模板内容',
-      field: 'content',
-      form: {
-        component: 'Editor',
-        colProps: {
-          span: 24
-        },
-        componentProps: {
-          valueHtml: ''
-        }
-      }
-    },
-    {
-      title: '邮箱账号',
-      field: 'accountId',
-      isSearch: true,
-      table: {
-        width: 200,
-        slots: {
-          default: 'accountId_default'
-        }
       },
-      search: {
+      componentProps: {
-        slots: {
+        valueHtml: ''
-          default: 'accountId_search'
-        }
       }
+    }
+  },
+  {
+    label: '邮箱账号',
+    field: 'accountId',
+    isSearch: true,
+    width: '200px',
+    formatter: (_: Recordable, __: TableColumn, cellValue: number) => {
+      return accounts.find((account) => account.id === cellValue)?.mail
     },
-    {
+    search: {
-      title: '发送人名称',
+      show: true,
-      field: 'nickname'
+      component: 'Select',
-    },
+      api: () => {
-    {
+        return accounts
-      title: '开启状态',
-      field: 'status',
-      isSearch: true,
-      dictType: DICT_TYPE.COMMON_STATUS,
-      dictClass: 'number'
-    },
-    {
-      title: '备注',
-      field: 'remark',
-      isTable: false
-    },
-    {
-      title: '创建时间',
-      field: 'createTime',
-      isForm: false,
-      formatter: 'formatDate',
-      table: {
-        width: 180
       },
-      search: {
+      componentProps: {
-        show: true,
+        optionsAlias: {
-        itemRender: {
+          labelField: 'mail',
-          name: 'XDataTimePicker'
+          valueField: 'id'
         }
       }
     }
-  ]
+  },
-})
+  {
-export const { allSchemas } = useVxeCrudSchemas(crudSchemas)
+    label: '发送人名称',
+    field: 'nickname'
+  },
+  {
+    label: '开启状态',
+    field: 'status',
+    isSearch: true,
+    formatter: (_: Recordable, __: TableColumn, cellValue: number) => {
+      return h(DictTag, {
+        type: DICT_TYPE.COMMON_STATUS,
+        value: cellValue
+      })
+    },
+    dictType: DICT_TYPE.COMMON_STATUS,
+    dictClass: 'number'
+  },
+  {
+    label: '备注',
+    field: 'remark',
+    isTable: false
+  },
+  {
+    label: '创建时间',
+    field: 'createTime',
+    isForm: false,
+    formatter: dateFormatter,
+    search: {
+      show: true,
+      itemRender: {
+        name: 'XDataTimePicker'
+      }
+    }
+  }
+])
+export const { allSchemas } = useCrudSchemas(crudSchemas)