refactor:优化 notify 站内信的实现

This commit is contained in:
YunaiV
2025-04-04 18:02:02 +08:00
parent a59c3bed8a
commit 9f352291d7
15 changed files with 106 additions and 150 deletions

View File

@@ -155,15 +155,6 @@ export function useSendNotifyFormSchema(): VbenFormSchema[] {
disabled: true,
},
},
{
fieldName: 'userId',
label: '用户编号',
component: 'Input',
componentProps: {
placeholder: '请输入用户编号',
},
rules: 'required',
},
{
fieldName: 'templateCode',
label: '模板编码',
@@ -173,6 +164,15 @@ export function useSendNotifyFormSchema(): VbenFormSchema[] {
show: () => false,
},
},
{
fieldName: 'userId',
label: '用户编号',
component: 'Input',
componentProps: {
placeholder: '请输入用户编号',
},
rules: 'required',
},
{
fieldName: 'templateParams',
label: '模板参数',
@@ -186,7 +186,7 @@ export function useSendNotifyFormSchema(): VbenFormSchema[] {
}
/** 列表的字段 */
export function useGridColumns<T = SystemNotifyTemplateApi.NotifyTemplate>(
export function useGridColumns<T = SystemNotifyTemplateApi.SystemNotifyTemplate>(
onActionClick: OnActionClickFn<T>,
): VxeTableGridOptions['columns'] {
return [
@@ -258,9 +258,9 @@ export function useGridColumns<T = SystemNotifyTemplateApi.NotifyTemplate>(
},
name: 'CellOperation',
options: [
{ code: 'edit', text: '编辑' },
{ code: 'notify-send', text: '测试' },
{ code: 'delete', text: '删除' },
'edit', // 默认的编辑按钮
{ code: 'send', text: '测试' },
'delete', // 默认的删除按钮
],
},
},

View File

@@ -1,8 +1,5 @@
<script lang="ts" setup>
import type {
OnActionClickParams,
VxeTableGridOptions,
} from '#/adapter/vxe-table';
import type { OnActionClickParams, VxeTableGridOptions } from '#/adapter/vxe-table';
import type { SystemNotifyTemplateApi } from '#/api/system/notify/template';
import { Page, useVbenModal } from '@vben/common-ui';
@@ -11,13 +8,9 @@ import { Button, message } from 'ant-design-vue';
import Form from './modules/form.vue';
import SendForm from './modules/send-form.vue';
import { useVbenVxeGrid } from '#/adapter/vxe-table';
import {
deleteNotifyTemplate,
exportNotifyTemplate,
getNotifyTemplatePage,
} from '#/api/system/notify/template';
import { $t } from '#/locales';
import { useVbenVxeGrid } from '#/adapter/vxe-table';
import { deleteNotifyTemplate, exportNotifyTemplate, getNotifyTemplatePage } from '#/api/system/notify/template';
import { downloadByData } from '#/utils/download';
import { useGridColumns, useGridFormSchema } from './data';
@@ -49,17 +42,17 @@ function onCreate() {
}
/** 编辑站内信模板 */
function onEdit(row: SystemNotifyTemplateApi.NotifyTemplate) {
function onEdit(row: SystemNotifyTemplateApi.SystemNotifyTemplate) {
formModalApi.setData(row).open();
}
/** 发送测试站内信 */
function onSend(row: SystemNotifyTemplateApi.NotifyTemplate) {
function onSend(row: SystemNotifyTemplateApi.SystemNotifyTemplate) {
sendModalApi.setData(row).open();
}
/** 删除站内信模板 */
async function onDelete(row: SystemNotifyTemplateApi.NotifyTemplate) {
async function onDelete(row: SystemNotifyTemplateApi.SystemNotifyTemplate) {
const hideLoading = message.loading({
content: $t('ui.actionMessage.deleting', [row.name]),
duration: 0,
@@ -81,17 +74,17 @@ async function onDelete(row: SystemNotifyTemplateApi.NotifyTemplate) {
function onActionClick({
code,
row,
}: OnActionClickParams<SystemNotifyTemplateApi.NotifyTemplate>) {
}: OnActionClickParams<SystemNotifyTemplateApi.SystemNotifyTemplate>) {
switch (code) {
case 'delete': {
onDelete(row);
break;
}
case 'edit': {
onEdit(row);
break;
}
case 'notify-send': {
case 'delete': {
onDelete(row);
break;
}
case 'send': {
onSend(row);
break;
}
@@ -124,9 +117,10 @@ const [Grid, gridApi] = useVbenVxeGrid({
refresh: { code: 'query' },
search: true,
},
} as VxeTableGridOptions<SystemNotifyTemplateApi.NotifyTemplate>,
} as VxeTableGridOptions<SystemNotifyTemplateApi.SystemNotifyTemplate>,
});
</script>
<template>
<Page auto-content-height>
<FormModal @success="onRefresh" />

View File

@@ -7,16 +7,12 @@ import { message } from 'ant-design-vue';
import { $t } from '#/locales';
import { computed, ref } from 'vue';
import { useVbenForm } from '#/adapter/form';
import {
createNotifyTemplate,
getNotifyTemplate,
updateNotifyTemplate,
} from '#/api/system/notify/template';
import { createNotifyTemplate, getNotifyTemplate, updateNotifyTemplate } from '#/api/system/notify/template';
import { useFormSchema } from '../data';
const emit = defineEmits(['success']);
const formData = ref<SystemNotifyTemplateApi.NotifyTemplate>();
const formData = ref<SystemNotifyTemplateApi.SystemNotifyTemplate>();
const getTitle = computed(() => {
return formData.value?.id
? $t('ui.actionTitle.edit', ['站内信模板'])
@@ -27,9 +23,6 @@ const [Form, formApi] = useVbenForm({
layout: 'horizontal',
schema: useFormSchema(),
showDefaultActions: false,
commonConfig: {
labelWidth: 120,
},
});
const [Modal, modalApi] = useVbenModal({
@@ -40,12 +33,9 @@ const [Modal, modalApi] = useVbenModal({
}
modalApi.lock();
// 提交表单
const data =
(await formApi.getValues()) as SystemNotifyTemplateApi.NotifyTemplate;
const data = (await formApi.getValues()) as SystemNotifyTemplateApi.SystemNotifyTemplate;
try {
await (formData.value?.id
? updateNotifyTemplate(data)
: createNotifyTemplate(data));
await (formData.value?.id ? updateNotifyTemplate(data) : createNotifyTemplate(data));
// 关闭并提示
await modalApi.close();
emit('success');
@@ -62,7 +52,7 @@ const [Modal, modalApi] = useVbenModal({
return;
}
// 加载数据
const data = modalApi.getData<SystemNotifyTemplateApi.NotifyTemplate>();
const data = modalApi.getData<SystemNotifyTemplateApi.SystemNotifyTemplate>();
if (!data || !data.id) {
return;
}

View File

@@ -4,7 +4,7 @@ import type { SystemNotifyTemplateApi } from '#/api/system/notify/template';
import { useVbenModal } from '@vben/common-ui';
import { message } from 'ant-design-vue';
import { computed, ref } from 'vue';
import { ref } from 'vue';
import { useVbenForm } from '#/adapter/form';
import { sendNotify } from '#/api/system/notify/template';
import { $t } from '#/locales';
@@ -12,39 +12,17 @@ import { $t } from '#/locales';
import { useSendNotifyFormSchema } from '../data';
const emit = defineEmits(['success']);
const templateData = ref<SystemNotifyTemplateApi.NotifyTemplate>();
const getTitle = computed(() => {
return $t('ui.actionTitle.send', ['站内信']);
});
// 动态构建表单
const buildSchema = () => {
const schema = useSendNotifyFormSchema();
// 添加参数字段
if (templateData.value?.params) {
templateData.value.params.forEach((param) => {
schema.push({
fieldName: `param_${param}`,
label: `参数 ${param}`,
component: 'Input',
rules: 'required',
});
});
}
return schema;
};
const formData = ref<SystemNotifyTemplateApi.SystemNotifyTemplate>();
const [Form, formApi] = useVbenForm({
layout: 'horizontal',
schema: buildSchema(),
showDefaultActions: false,
commonConfig: {
labelWidth: 120,
},
});
// TODO @puhui999有个用户类型的选项。不同的用户类型对应的接收人处理不同。
const [Modal, modalApi] = useVbenModal({
async onConfirm() {
const { valid } = await formApi.validate();
@@ -52,24 +30,21 @@ const [Modal, modalApi] = useVbenModal({
return;
}
modalApi.lock();
// 获取表单数据
// 构建发送邮件请求
const values = await formApi.getValues();
// 提取参数
const paramsObj: Record<string, string> = {};
if (templateData.value?.params) {
templateData.value.params.forEach((param) => {
if (formData.value?.params) {
formData.value.params.forEach((param) => {
paramsObj[param] = values[`param_${param}`];
});
}
// 构建发送站内信请求
const data: SystemNotifyTemplateApi.NotifySendReq = {
const data: SystemNotifyTemplateApi.SystemNotifySendReqVO = {
userId: values.userId,
templateCode: templateData.value?.code || '',
templateCode: formData.value?.code || '',
templateParams: paramsObj,
};
// 提交表单
try {
await sendNotify(data);
// 关闭并提示
@@ -90,27 +65,44 @@ const [Modal, modalApi] = useVbenModal({
return;
}
// 获取数据
const data = modalApi.getData<SystemNotifyTemplateApi.NotifyTemplate>();
const data = modalApi.getData<SystemNotifyTemplateApi.SystemNotifyTemplate>();
if (!data || !data.id) {
return;
}
templateData.value = data;
// 更新表单结构
const schema = buildSchema();
formData.value = data;
// 更新 form schema
const schema = buildFormSchema();
formApi.setState({ schema });
// 设置表单初始值
// 设置到 values
await formApi.setValues({
content: data.content,
templateCode: data.code,
});
},
});
/** 动态构建表单 schema */
const buildFormSchema = () => {
const schema = useSendNotifyFormSchema();
if (formData.value?.params) {
formData.value.params.forEach((param: string) => {
schema.push({
fieldName: `param_${param}`,
label: `参数 ${param}`,
component: 'Input',
rules: 'required',
componentProps: {
placeholder: `请输入参数 ${param}`,
}
});
});
}
return schema;
};
</script>
<template>
<Modal :title="getTitle">
<Modal title="测试发送站内信">
<Form class="mx-4" />
</Modal>
</template>