feat: 短信模板

apps/web-antd/src/api/system/sms/smsTemplate/index.ts

@@ -0,0 +1,70 @@
+import type { PageParam } from '@vben/request';
+
+import { requestClient } from '#/api/request';
+
+export namespace SystemSmsTemplateApi {
+  /** 短信模板信息 */
+  export interface SmsTemplateVO {
+    id?: number;
+    type?: number;
+    status: number;
+    code: string;
+    name: string;
+    content: string;
+    remark: string;
+    apiTemplateId: string;
+    channelId?: number;
+    channelCode?: string;
+    params?: string[];
+    createTime?: Date;
+  }
+
+  /** 发送短信请求 */
+  export interface SendSmsReqVO {
+    mobile: string;
+    templateCode: string;
+    templateParams: Record<string, any>;
+  }
+}
+
+/** 查询短信模板列表 */
+export function getSmsTemplatePage(params: PageParam) {
+  return requestClient.get<{
+    list: SystemSmsTemplateApi.SmsTemplateVO[];
+    total: number;
+  }>('/system/sms-template/page', { params });
+}
+
+/** 查询短信模板详情 */
+export function getSmsTemplate(id: number) {
+  return requestClient.get<SystemSmsTemplateApi.SmsTemplateVO>(
+    `/system/sms-template/get?id=${id}`,
+  );
+}
+
+/** 新增短信模板 */
+export function createSmsTemplate(data: SystemSmsTemplateApi.SmsTemplateVO) {
+  return requestClient.post({ url: '/system/sms-template/create', data });
+}
+
+/** 修改短信模板 */
+export function updateSmsTemplate(data: SystemSmsTemplateApi.SmsTemplateVO) {
+  return requestClient.put({ url: '/system/sms-template/update', data });
+}
+
+/** 删除短信模板 */
+export function deleteSmsTemplate(id: number) {
+  return requestClient.delete({ url: `/system/sms-template/delete?id=${id}` });
+}
+
+/** 导出短信模板 */
+export function exportSmsTemplate(params: SystemSmsTemplateApi.SmsTemplateVO) {
+  return requestClient.download('/system/sms-template/export-excel', {
+    params,
+  });
+}
+
+/** 发送短信 */
+export function sendSms(data: SystemSmsTemplateApi.SendSmsReqVO) {
+  return requestClient.post({ url: '/system/sms-template/send-sms', data });
+}

apps/web-antd/src/views/system/sms/template/data.ts

@@ -0,0 +1,252 @@
+import type { VbenFormSchema } from '#/adapter/form';
+import type { OnActionClickFn, VxeTableGridOptions } from '#/adapter/vxe-table';
+import type { SystemSmsTemplateApi } from '#/api/system/sms/smsTemplate';
+
+import { z } from '#/adapter/form';
+import { getSimpleSmsChannelList } from '#/api/system/sms/smsChannel';
+import { CommonStatusEnum } from '#/utils/constants';
+import { DICT_TYPE, getDictOptions } from '#/utils/dict';
+
+/** 新增/修改的表单 */
+export function useFormSchema(): VbenFormSchema[] {
+  return [
+    {
+      component: 'Input',
+      fieldName: 'id',
+      label: 'id',
+      dependencies: {
+        triggerFields: [''],
+        show: () => false,
+      },
+    },
+    {
+      fieldName: 'type',
+      label: '短信类型',
+      component: 'Select',
+      componentProps: {
+        class: 'w-full',
+        options: getDictOptions(DICT_TYPE.SYSTEM_SMS_TEMPLATE_TYPE, 'number'),
+      },
+      rules: 'required',
+    },
+    {
+      component: 'Input',
+      fieldName: 'name',
+      label: '模板名称',
+      rules: 'required',
+    },
+    {
+      component: 'Input',
+      fieldName: 'code',
+      label: '模板编码',
+      rules: 'required',
+    },
+    {
+      fieldName: 'channelId',
+      label: '短信渠道',
+      component: 'ApiSelect',
+      componentProps: {
+        api: async () => await getSimpleSmsChannelList(),
+        class: 'w-full',
+        labelField: 'signature',
+        valueField: 'id',
+      },
+      rules: 'required',
+    },
+    {
+      fieldName: 'status',
+      label: '开启状态',
+      component: 'RadioGroup',
+      componentProps: {
+        options: getDictOptions(DICT_TYPE.COMMON_STATUS, 'number'),
+        buttonStyle: 'solid',
+        optionType: 'button',
+      },
+      rules: z.number().default(CommonStatusEnum.ENABLE),
+    },
+    {
+      component: 'Textarea',
+      fieldName: 'content',
+      label: '模板内容',
+      rules: 'required',
+    },
+    {
+      component: 'Input',
+      fieldName: 'apiTemplateId',
+      label: '短信 API 的模板编号',
+    },
+    {
+      fieldName: 'remark',
+      label: '备注',
+      component: 'Textarea',
+    },
+  ];
+}
+
+/** 列表的搜索表单 */
+export function useGridFormSchema(): VbenFormSchema[] {
+  return [
+    {
+      fieldName: 'type',
+      label: '短信类型',
+      component: 'Select',
+      componentProps: {
+        allowClear: true,
+        options: getDictOptions(DICT_TYPE.SYSTEM_SMS_TEMPLATE_TYPE, 'number'),
+      },
+    },
+    {
+      fieldName: 'status',
+      label: '开启状态',
+      component: 'Select',
+      componentProps: {
+        allowClear: true,
+        options: getDictOptions(DICT_TYPE.COMMON_STATUS, 'number'),
+      },
+    },
+    {
+      fieldName: 'code',
+      label: '模板编码',
+      component: 'Input',
+    },
+    {
+      fieldName: 'name',
+      label: '模板名称',
+      component: 'Input',
+    },
+    {
+      fieldName: 'channelId',
+      label: '短信渠道',
+      component: 'ApiSelect',
+      componentProps: {
+        api: async () => await getSimpleSmsChannelList(),
+        labelField: 'signature',
+        valueField: 'id',
+        allowClear: true,
+      },
+    },
+    {
+      fieldName: 'createTime',
+      label: '创建时间',
+      component: 'RangePicker',
+      componentProps: {
+        allowClear: true,
+      },
+    },
+  ];
+}
+
+/** 发送短信表单 */
+export function useSendSmsFormSchema(): VbenFormSchema[] {
+  return [
+    {
+      component: 'Input',
+      fieldName: 'mobile',
+      label: '手机号码',
+      rules: 'required',
+    },
+    {
+      fieldName: 'templateParams',
+      label: '模板参数',
+      component: 'Input',
+      dependencies: {
+        triggerFields: [''],
+        show: () => false,
+      },
+    },
+  ];
+}
+
+/** 列表的字段 */
+export function useGridColumns<T = SystemSmsTemplateApi.SmsTemplateVO>(
+  onActionClick: OnActionClickFn<T>,
+): VxeTableGridOptions['columns'] {
+  return [
+    {
+      field: 'id',
+      title: '编号',
+      minWidth: 100,
+    },
+    {
+      field: 'type',
+      title: '短信类型',
+      minWidth: 120,
+      cellRender: {
+        name: 'CellDict',
+        props: { type: DICT_TYPE.SYSTEM_SMS_TEMPLATE_TYPE },
+      },
+    },
+    {
+      field: 'name',
+      title: '模板名称',
+      minWidth: 120,
+    },
+    {
+      field: 'code',
+      title: '模板编码',
+      minWidth: 120,
+    },
+    {
+      field: 'content',
+      title: '模板内容',
+      minWidth: 200,
+    },
+    {
+      field: 'status',
+      title: '开启状态',
+      minWidth: 100,
+      cellRender: {
+        name: 'CellDict',
+        props: { type: DICT_TYPE.COMMON_STATUS },
+      },
+    },
+    {
+      field: 'remark',
+      title: '备注',
+      minWidth: 120,
+    },
+    {
+      field: 'apiTemplateId',
+      title: '短信 API 的模板编号',
+      minWidth: 180,
+    },
+    {
+      field: 'channelCode',
+      title: '短信渠道',
+      minWidth: 100,
+      cellRender: {
+        name: 'CellDict',
+        props: { type: DICT_TYPE.SYSTEM_SMS_CHANNEL_CODE },
+      },
+    },
+    {
+      field: 'createTime',
+      title: '创建时间',
+      minWidth: 180,
+      formatter: 'formatDateTime',
+    },
+    {
+      field: 'operation',
+      title: '操作',
+      minWidth: 300,
+      align: 'center',
+      fixed: 'right',
+      cellRender: {
+        attrs: {
+          nameField: 'name',
+          nameTitle: '短信模板',
+          onClick: onActionClick,
+        },
+        name: 'CellOperation',
+        options: [
+          'edit', // 默认的编辑按钮
+          'delete', // 默认的删除按钮
+          {
+            code: 'sms-send',
+            text: '发送短信',
+          },
+        ],
+      },
+    },
+  ];
+}

apps/web-antd/src/views/system/sms/template/index.vue

@@ -0,0 +1,149 @@
+<script lang="ts" setup>
+import type {
+  OnActionClickParams,
+  VxeTableGridOptions,
+} from '#/adapter/vxe-table';
+import type { SystemSmsTemplateApi } from '#/api/system/sms/smsTemplate';
+
+import { Page, useVbenModal } from '@vben/common-ui';
+import { Download, Plus } from '@vben/icons';
+
+import { Button, message } from 'ant-design-vue';
+
+import { useVbenVxeGrid } from '#/adapter/vxe-table';
+import {
+  deleteSmsTemplate,
+  exportSmsTemplate,
+  getSmsTemplatePage,
+} from '#/api/system/sms/smsTemplate';
+import { $t } from '#/locales';
+import { downloadByData } from '#/utils/download';
+
+import { useGridColumns, useGridFormSchema } from './data';
+import Form from './modules/form.vue';
+import SendForm from './modules/send-form.vue';
+
+const [FormModal, formModalApi] = useVbenModal({
+  connectedComponent: Form,
+  destroyOnClose: true,
+});
+
+const [SendModal, sendModalApi] = useVbenModal({
+  connectedComponent: SendForm,
+  destroyOnClose: true,
+});
+
+/** 刷新表格 */
+function onRefresh() {
+  gridApi.query();
+}
+
+/** 导出表格 */
+async function onExport() {
+  const data = await exportSmsTemplate(await gridApi.formApi.getValues());
+  downloadByData(data, '短信模板.xls');
+}
+
+/** 创建短信模板 */
+function onCreate() {
+  formModalApi.setData(null).open();
+}
+
+/** 编辑短信模板 */
+function onEdit(row: SystemSmsTemplateApi.SmsTemplateVO) {
+  formModalApi.setData(row).open();
+}
+
+/** 发送测试短信 */
+function onSend(row: SystemSmsTemplateApi.SmsTemplateVO) {
+  sendModalApi.setData(row).open();
+}
+
+/** 删除短信模板 */
+async function onDelete(row: SystemSmsTemplateApi.SmsTemplateVO) {
+  const hideLoading = message.loading({
+    content: $t('ui.actionMessage.deleting', [row.name]),
+    duration: 0,
+    key: 'action_process_msg',
+  });
+  try {
+    await deleteSmsTemplate(row.id as number);
+    message.success({
+      content: $t('ui.actionMessage.deleteSuccess', [row.name]),
+      key: 'action_process_msg',
+    });
+    onRefresh();
+  } finally {
+    hideLoading();
+  }
+}
+
+/** 表格操作按钮的回调函数 */
+function onActionClick({
+  code,
+  row,
+}: OnActionClickParams<SystemSmsTemplateApi.SmsTemplateVO>) {
+  switch (code) {
+    case 'delete': {
+      onDelete(row);
+      break;
+    }
+    case 'edit': {
+      onEdit(row);
+      break;
+    }
+    case 'sms-send': {
+      onSend(row);
+      break;
+    }
+  }
+}
+
+const [Grid, gridApi] = useVbenVxeGrid({
+  formOptions: {
+    schema: useGridFormSchema(),
+  },
+  gridOptions: {
+    columns: useGridColumns(onActionClick),
+    height: 'auto',
+    keepSource: true,
+    proxyConfig: {
+      ajax: {
+        query: async ({ page }, formValues) => {
+          return await getSmsTemplatePage({
+            pageNo: page.currentPage,
+            pageSize: page.pageSize,
+            ...formValues,
+          });
+        },
+      },
+    },
+    rowConfig: {
+      keyField: 'id',
+    },
+    toolbarConfig: {
+      refresh: { code: 'query' },
+      search: true,
+    },
+  } as VxeTableGridOptions<SystemSmsTemplateApi.SmsTemplateVO>,
+});
+</script>
+
+<template>
+  <Page auto-content-height>
+    <FormModal @success="onRefresh" />
+    <SendModal />
+    <Grid table-title="短信模板列表">
+      <template #toolbar-tools>
+        <Button type="primary" @click="onCreate">
+          <Plus class="size-5" />
+          {{ $t('ui.actionTitle.create', ['短信模板']) }}
+        </Button>
+        <Button type="primary" class="ml-2" @click="onExport">
+          <Download class="size-5" />
+          {{ $t('ui.actionTitle.export') }}
+        </Button>
+      </template>
+    </Grid>
+  </Page>
+</template>

apps/web-antd/src/views/system/sms/template/modules/form.vue

@@ -0,0 +1,84 @@
+<script lang="ts" setup>
+import type { SystemSmsTemplateApi } from '#/api/system/sms/smsTemplate';
+
+import { computed, ref } from 'vue';
+
+import { useVbenModal } from '@vben/common-ui';
+
+import { message } from 'ant-design-vue';
+
+import { useVbenForm } from '#/adapter/form';
+import {
+  createSmsTemplate,
+  getSmsTemplate,
+  updateSmsTemplate,
+} from '#/api/system/sms/smsTemplate';
+import { $t } from '#/locales';
+
+import { useFormSchema } from '../data';
+
+const emit = defineEmits(['success']);
+const formData = ref<SystemSmsTemplateApi.SmsTemplateVO>();
+const getTitle = computed(() => {
+  return formData.value?.id
+    ? $t('ui.actionTitle.edit', ['短信模板'])
+    : $t('ui.actionTitle.create', ['短信模板']);
+});
+
+const [Form, formApi] = useVbenForm({
+  layout: 'horizontal',
+  schema: useFormSchema(),
+  showDefaultActions: false,
+});
+
+const [Modal, modalApi] = useVbenModal({
+  async onConfirm() {
+    const { valid } = await formApi.validate();
+    if (!valid) {
+      return;
+    }
+    modalApi.lock();
+    // 提交表单
+    const data =
+      (await formApi.getValues()) as SystemSmsTemplateApi.SmsTemplateVO;
+    try {
+      await (formData.value?.id
+        ? updateSmsTemplate(data)
+        : createSmsTemplate(data));
+      // 关闭并提示
+      await modalApi.close();
+      emit('success');
+      message.success({
+        content: $t('ui.actionMessage.operationSuccess'),
+        key: 'action_process_msg',
+      });
+    } finally {
+      modalApi.lock(false);
+    }
+  },
+  async onOpenChange(isOpen) {
+    if (!isOpen) {
+      return;
+    }
+    // 加载数据
+    const data = modalApi.getData<SystemSmsTemplateApi.SmsTemplateVO>();
+    if (!data || !data.id) {
+      return;
+    }
+    modalApi.lock();
+    try {
+      formData.value = await getSmsTemplate(data.id);
+      // 设置到 values
+      await formApi.setValues(formData.value);
+    } finally {
+      modalApi.lock(false);
+    }
+  },
+});
+</script>
+
+<template>
+  <Modal :title="getTitle">
+    <Form class="mx-4" />
+  </Modal>
+</template>

apps/web-antd/src/views/system/sms/template/modules/send-form.vue

@@ -0,0 +1,109 @@
+<script lang="ts" setup>
+import type { SystemSmsTemplateApi } from '#/api/system/sms/smsTemplate';
+
+import { computed, ref } from 'vue';
+
+import { useVbenModal } from '@vben/common-ui';
+
+import { message } from 'ant-design-vue';
+
+import { useVbenForm } from '#/adapter/form';
+import { sendSms } from '#/api/system/sms/smsTemplate';
+import { $t } from '#/locales';
+
+import { useSendSmsFormSchema } from '../data';
+
+const emit = defineEmits(['success']);
+const templateData = ref<SystemSmsTemplateApi.SmsTemplateVO>();
+const getTitle = computed(() => {
+  return $t('ui.actionTitle.send', ['短信']);
+});
+
+// 动态构建表单
+const buildSchema = () => {
+  const schema = useSendSmsFormSchema();
+
+  // 添加参数字段
+  if (templateData.value?.params && templateData.value.params.length > 0) {
+    templateData.value.params.forEach((param) => {
+      schema.push({
+        component: 'Input',
+        fieldName: `param_${param}`,
+        label: `参数 ${param}`,
+        rules: 'required',
+      });
+    });
+  }
+
+  return schema;
+};
+
+const [Form, formApi] = useVbenForm({
+  layout: 'horizontal',
+  schema: buildSchema(),
+  showDefaultActions: false,
+});
+
+const [Modal, modalApi] = useVbenModal({
+  async onConfirm() {
+    const { valid } = await formApi.validate();
+    if (!valid) {
+      return;
+    }
+    modalApi.lock();
+    // 获取表单数据
+    const values = await formApi.getValues();
+
+    // 提取参数
+    const paramsObj: Record<string, string> = {};
+    if (templateData.value?.params) {
+      templateData.value.params.forEach((param) => {
+        paramsObj[param] = values[`param_${param}`];
+      });
+    }
+
+    // 构建发送短信请求
+    const data: SystemSmsTemplateApi.SendSmsReqVO = {
+      mobile: values.mobile,
+      templateCode: templateData.value?.code || '',
+      templateParams: paramsObj,
+    };
+
+    try {
+      await sendSms(data);
+      // 关闭并提示
+      await modalApi.close();
+      emit('success');
+      message.success({
+        content: '短信发送成功',
+        key: 'action_process_msg',
+      });
+    } catch (error) {
+      console.error('发送短信失败', error);
+    } finally {
+      modalApi.lock(false);
+    }
+  },
+  async onOpenChange(isOpen) {
+    if (!isOpen) {
+      return;
+    }
+    // 获取数据
+    const data = modalApi.getData<SystemSmsTemplateApi.SmsTemplateVO>();
+    if (!data) {
+      return;
+    }
+
+    templateData.value = data;
+    // 更新表单结构
+    const schema = buildSchema();
+    await formApi.updateSchema(schema);
+  },
+});
+</script>
+
+<template>
+  <Modal :title="getTitle">
+    <Form class="mx-4" />
+  </Modal>
+</template>