refactor:优化 sms 短信的实现

This commit is contained in:
YunaiV
2025-04-04 18:20:59 +08:00
parent 9f352291d7
commit 5705098fc7
16 changed files with 175 additions and 212 deletions

View File

@@ -80,7 +80,7 @@ export function useGridFormSchema(): VbenFormSchema[] {
}
/** 列表的字段 */
export function useGridColumns<T = SystemSmsLogApi.SmsLog>(
export function useGridColumns<T = SystemSmsLogApi.SystemSmsLog>(
onActionClick: OnActionClickFn<T>,
): VxeTableGridOptions['columns'] {
return [

View File

@@ -1,13 +1,9 @@
<script lang="ts" setup>
import type {
OnActionClickParams,
VxeTableGridOptions,
} from '#/adapter/vxe-table';
import type { OnActionClickParams, VxeTableGridOptions } from '#/adapter/vxe-table';
import type { SystemSmsLogApi } from '#/api/system/sms/log';
import { Page, useVbenModal } from '@vben/common-ui';
import { Download } from '@vben/icons';
import { Button } from 'ant-design-vue';
import { useVbenVxeGrid } from '#/adapter/vxe-table';
@@ -16,10 +12,10 @@ import { $t } from '#/locales';
import { downloadByData } from '#/utils/download';
import { useGridColumns, useGridFormSchema } from './data';
import Form from './modules/form.vue';
import Detail from './modules/detail.vue';
const [FormModal, formModalApi] = useVbenModal({
connectedComponent: Form,
const [DetailModal, detailModalApi] = useVbenModal({
connectedComponent: Detail,
destroyOnClose: true,
});
@@ -35,15 +31,15 @@ async function onExport() {
}
/** 查看短信日志详情 */
function onView(row: SystemSmsLogApi.SmsLog) {
formModalApi.setData(row).open();
function onView(row: SystemSmsLogApi.SystemSmsLog) {
detailModalApi.setData(row).open();
}
/** 表格操作按钮的回调函数 */
function onActionClick({
code,
row,
}: OnActionClickParams<SystemSmsLogApi.SmsLog>) {
}: OnActionClickParams<SystemSmsLogApi.SystemSmsLog>) {
switch (code) {
case 'view': {
onView(row);
@@ -78,13 +74,13 @@ const [Grid, gridApi] = useVbenVxeGrid({
refresh: { code: 'query' },
search: true,
},
} as VxeTableGridOptions<SystemSmsLogApi.SmsLog>,
} as VxeTableGridOptions<SystemSmsLogApi.SystemSmsLog>,
});
</script>
<template>
<Page auto-content-height>
<FormModal @success="onRefresh" />
<DetailModal @success="onRefresh" />
<Grid table-title="短信日志列表">
<template #toolbar-tools>
<Button type="primary" class="ml-2" @click="onExport">

View File

@@ -0,0 +1,95 @@
<script lang="ts" setup>
import type { SystemSmsLogApi } from '#/api/system/sms/log';
import { useVbenModal } from '@vben/common-ui';
import { Descriptions, Tag } from 'ant-design-vue';
import { ref } from 'vue';
import { formatDateTime } from '@vben/utils';
import { DICT_TYPE, getDictLabel } from '#/utils/dict';
const formData = ref<SystemSmsLogApi.SystemSmsLog>();
const [Modal, modalApi] = useVbenModal({
async onOpenChange(isOpen: boolean) {
if (!isOpen) {
return;
}
// 加载数据
const data = modalApi.getData<SystemSmsLogApi.SystemSmsLog>();
if (!data || !data.id) {
return;
}
modalApi.lock();
try {
formData.value = data;
} finally {
modalApi.lock(false);
}
},
});
</script>
<template>
<Modal title="短信日志详情" class="w-1/2">
<Descriptions bordered :column="2" size="middle" class="mx-4">
<Descriptions.Item label="创建时间">
{{ formatDateTime(formData?.createTime || '') }}
</Descriptions.Item>
<Descriptions.Item label="手机号">
{{ formData?.mobile }}
</Descriptions.Item>
<Descriptions.Item label="短信渠道">
{{ formData?.channelCode }}
</Descriptions.Item>
<Descriptions.Item label="模板编号">
{{ formData?.templateId }}
</Descriptions.Item>
<Descriptions.Item label="模板类型">
<!-- TODO @芋艿: 数据字典-->
<Tag color="processing">
{{ getDictLabel(DICT_TYPE.SYSTEM_SMS_TEMPLATE_TYPE, formData?.templateType) }}
</Tag>
</Descriptions.Item>
<Descriptions.Item label="短信内容">
{{ formData?.templateContent }}
</Descriptions.Item>
<Descriptions.Item label="发送状态">
<!-- TODO @芋艿: 数据字典-->
<Tag color="processing">
{{ getDictLabel(DICT_TYPE.SYSTEM_SMS_SEND_STATUS, formData?.sendStatus) }}
</Tag>
</Descriptions.Item>
<Descriptions.Item label="发送时间">
{{ formatDateTime(formData?.sendTime || '') }}
</Descriptions.Item>
<Descriptions.Item label="API 发送编码">
{{ formData?.apiSendCode }}
</Descriptions.Item>
<Descriptions.Item label="API 发送消息">
{{ formData?.apiSendMsg }}
</Descriptions.Item>
<Descriptions.Item label="接收状态">
<!-- TODO @芋艿: 数据字典-->
<Tag color="processing">
{{ getDictLabel(DICT_TYPE.SYSTEM_SMS_RECEIVE_STATUS, formData?.receiveStatus) }}
</Tag>
</Descriptions.Item>
<Descriptions.Item label="接收时间">
{{ formatDateTime(formData?.receiveTime || '') }}
</Descriptions.Item>
<Descriptions.Item label="API 接收编码">
{{ formData?.apiReceiveCode }}
</Descriptions.Item>
<Descriptions.Item label="API 接收消息" :span="2">
{{ formData?.apiReceiveMsg }}
</Descriptions.Item>
<Descriptions.Item label="API 请求 ID">
{{ formData?.apiRequestId }}
</Descriptions.Item>
<Descriptions.Item label="API 序列号">
{{ formData?.apiSerialNo }}
</Descriptions.Item>
</Descriptions>
</Modal>
</template>

View File

@@ -1,109 +0,0 @@
<script lang="ts" setup>
import type { SystemSmsLogApi } from '#/api/system/sms/log';
import { ref } from 'vue';
import { useVbenModal } from '@vben/common-ui';
import { formatDateTime } from '@vben/utils';
import { Descriptions, Tag } from 'ant-design-vue';
import { DICT_TYPE, getDictLabel } from '#/utils/dict';
const formData = ref<SystemSmsLogApi.SmsLog>();
const [Modal, modalApi] = useVbenModal({
async onOpenChange(isOpen: boolean) {
if (!isOpen) {
return;
}
// 加载数据
const data = modalApi.getData<SystemSmsLogApi.SmsLog>();
if (!data || !data.id) {
return;
}
modalApi.lock();
try {
formData.value = data;
} finally {
modalApi.lock(false);
}
},
});
</script>
<template>
<Modal title="短信日志详情">
<div class="p-4">
<Descriptions
:column="{ xxl: 3, xl: 3, lg: 3, md: 2, sm: 2, xs: 1 }"
bordered
>
<Descriptions.Item label="创建时间">
{{ formatDateTime(formData?.createTime || '') }}
</Descriptions.Item>
<Descriptions.Item label="手机号">
{{ formData?.mobile }}
</Descriptions.Item>
<Descriptions.Item label="短信渠道">
{{ formData?.channelCode }}
</Descriptions.Item>
<Descriptions.Item label="模板编号">
{{ formData?.templateId }}
</Descriptions.Item>
<Descriptions.Item label="模板类型">
{{ formData?.templateType }}
</Descriptions.Item>
<Descriptions.Item label="短信内容" :span="3">
{{ formData?.templateContent }}
</Descriptions.Item>
<Descriptions.Item label="发送状态">
<!-- TODO @芋艿: 数据字典-->
<Tag color="processing">
{{
getDictLabel(
DICT_TYPE.SYSTEM_SMS_SEND_STATUS,
formData?.sendStatus,
)
}}
</Tag>
</Descriptions.Item>
<Descriptions.Item label="发送时间">
{{ formatDateTime(formData?.sendTime || '') }}
</Descriptions.Item>
<Descriptions.Item label="API发送编码">
{{ formData?.apiSendCode }}
</Descriptions.Item>
<Descriptions.Item label="API发送消息" :span="2">
{{ formData?.apiSendMsg }}
</Descriptions.Item>
<Descriptions.Item label="接收状态">
<!-- TODO @芋艿: 数据字典-->
<Tag color="processing">
{{
getDictLabel(
DICT_TYPE.SYSTEM_SMS_RECEIVE_STATUS,
formData?.receiveStatus,
)
}}
</Tag>
</Descriptions.Item>
<Descriptions.Item label="接收时间">
{{ formatDateTime(formData?.receiveTime || '') }}
</Descriptions.Item>
<Descriptions.Item label="API接收编码">
{{ formData?.apiReceiveCode }}
</Descriptions.Item>
<Descriptions.Item label="API接收消息" :span="2">
{{ formData?.apiReceiveMsg }}
</Descriptions.Item>
<Descriptions.Item label="API请求ID">
{{ formData?.apiRequestId }}
</Descriptions.Item>
<Descriptions.Item label="API序列号">
{{ formData?.apiSerialNo }}
</Descriptions.Item>
</Descriptions>
</div>
</Modal>
</template>