refactor: config vxe

2022-11-22 15:10:00 +08:00 · 2022-11-22 15:10:00 +08:00 · 3dd2203803
commit 3dd2203803
parent 7b2871ac72
4 changed files with 219 additions and 242 deletions
--- a/yudao-ui-admin-vue3/src/api/infra/config/index.ts
+++ b/yudao-ui-admin-vue3/src/api/infra/config/index.ts
@ -1,8 +1,30 @@
 import request from '@/config/axios'
-import type { ConfigVO } from './types'
+
+export type ConfigVO = {
+  id: number
+  group: string
+  name: string
+  key: string
+  value: string
+  type: string
+  visible: boolean
+  remark: string
+  createTime: string
+}
+export interface ConfigPageReqVO extends PageParam {
+  name?: string
+  type?: number
+  createTime?: string[]
+}
+
+export interface ConfigExportReqVO {
+  name?: string
+  type?: number
+  createTime?: string[]
+}

 // 查询参数列表
-export const getConfigPageApi = (params) => {
+export const getConfigPageApi = (params: ConfigPageReqVO) => {
  return request.get({ url: '/infra/config/page', params })
 }

@ -32,6 +54,6 @@ export const deleteConfigApi = (id: number) => {
 }

 // 导出参数
-export const exportConfigApi = (params) => {
+export const exportConfigApi = (params: ConfigExportReqVO) => {
  return request.download({ url: '/infra/config/export', params })
 }
--- a/yudao-ui-admin-vue3/src/api/infra/config/types.ts
+++ b/yudao-ui-admin-vue3/src/api/infra/config/types.ts
@ -1,11 +0,0 @@
-export type ConfigVO = {
-  id: number
-  group: string
-  name: string
-  key: string
-  value: string
-  type: string
-  visible: boolean
-  remark: string
-  createTime: string
-}
--- a/yudao-ui-admin-vue3/src/views/infra/config/config.data.ts
+++ b/yudao-ui-admin-vue3/src/views/infra/config/config.data.ts
@ -1,8 +1,8 @@
 import { reactive } from 'vue'
 import { useI18n } from '@/hooks/web/useI18n'
 import { required } from '@/utils/formRules'
-import { CrudSchema, useCrudSchemas } from '@/hooks/web/useCrudSchemas'
 import { DICT_TYPE } from '@/utils/dict'
+import { VxeCrudSchema, useVxeCrudSchemas } from '@/hooks/web/useVxeCrudSchemas'
 const { t } = useI18n() // 国际化

 // 表单校验
@ -14,52 +14,44 @@ export const rules = reactive({
 })

 // CrudSchema
-const crudSchemas = reactive<CrudSchema[]>([
+const crudSchemas = reactive<VxeCrudSchema>({
+  primaryKey: 'id',
+  primaryType: 'seq',
+  action: true,
+  columns: [
    {
-    label: t('common.index'),
-    field: 'id',
-    type: 'index',
-    form: {
-      show: false
-    },
-    detail: {
-      show: false
-    }
-  },
-  {
-    label: '参数分类',
+      title: '参数分类',
      field: 'category'
    },
    {
-    label: '参数名称',
+      title: '参数名称',
      field: 'name',
-    search: {
-      show: true
-    }
+      isSearch: true
    },
    {
-    label: '参数键名',
+      title: '参数键名',
      field: 'key',
-    search: {
-      show: true
-    }
+      isSearch: true
    },
    {
-    label: '参数键值',
+      title: '参数键值',
      field: 'value'
    },
    {
-    label: '系统内置',
+      title: '系统内置',
      field: 'type',
      dictType: DICT_TYPE.INFRA_CONFIG_TYPE,
      dictClass: 'number',
-    search: {
-      show: true
-    }
+      isSearch: true
    },
    {
-    label: '是否可见',
+      title: '是否可见',
      field: 'visible',
+      table: {
+        slots: {
+          default: 'visible_default'
+        }
+      },
      form: {
        component: 'RadioButton',
        componentProps: {
@ -71,8 +63,9 @@ const crudSchemas = reactive<CrudSchema[]>([
      }
    },
    {
-    label: t('form.remark'),
+      title: t('form.remark'),
      field: 'remark',
+      isTable: false,
      form: {
        component: 'Input',
        componentProps: {
@ -82,37 +75,20 @@ const crudSchemas = reactive<CrudSchema[]>([
        colProps: {
          span: 24
        }
-    },
-    table: {
-      show: false
      }
    },
    {
-    label: t('common.createTime'),
+      title: t('common.createTime'),
      field: 'createTime',
-    form: {
-      show: false
-    },
+      formatter: 'formatDate',
+      isForm: false,
      search: {
        show: true,
-      component: 'DatePicker',
-      componentProps: {
-        type: 'datetimerange',
-        valueFormat: 'YYYY-MM-DD HH:mm:ss',
-        defaultTime: [new Date(2000, 1, 1, 0, 0, 0), new Date(2000, 2, 1, 23, 59, 59)]
+        itemRender: {
+          name: 'XDataTimePicker'
        }
      }
-  },
-  {
-    label: t('table.action'),
-    field: 'action',
-    width: '240px',
-    form: {
-      show: false
-    },
-    detail: {
-      show: false
    }
-  }
-])
-export const { allSchemas } = useCrudSchemas(crudSchemas)
+  ]
+})
+export const { allSchemas } = useVxeCrudSchemas(crudSchemas)
--- a/yudao-ui-admin-vue3/src/views/infra/config/index.vue
+++ b/yudao-ui-admin-vue3/src/views/infra/config/index.vue
@ -1,140 +1,34 @@
-<script setup lang="ts">
-import { ref, unref } from 'vue'
-import dayjs from 'dayjs'
-import { ElMessage } from 'element-plus'
-import { DICT_TYPE } from '@/utils/dict'
-import { useTable } from '@/hooks/web/useTable'
-import { useI18n } from '@/hooks/web/useI18n'
-import { FormExpose } from '@/components/Form'
-import type { ConfigVO } from '@/api/infra/config/types'
-import { rules, allSchemas } from './config.data'
-import * as ConfigApi from '@/api/infra/config'
-const { t } = useI18n() // 国际化
-
-// ========== 列表相关 ==========
-const { register, tableObject, methods } = useTable<ConfigVO>({
-  getListApi: ConfigApi.getConfigPageApi,
-  delListApi: ConfigApi.deleteConfigApi,
-  exportListApi: ConfigApi.exportConfigApi
-})
-const { getList, setSearchParams, delList, exportList } = methods
-
-// ========== CRUD 相关 ==========
-const actionLoading = ref(false) // 遮罩层
-const actionType = ref('') // 操作按钮的类型
-const dialogVisible = ref(false) // 是否显示弹出层
-const dialogTitle = ref('edit') // 弹出层标题
-const formRef = ref<FormExpose>() // 表单 Ref
-
-// 设置标题
-const setDialogTile = (type: string) => {
-  dialogTitle.value = t('action.' + type)
-  actionType.value = type
-  dialogVisible.value = true
-}
-
-// 新增操作
-const handleCreate = () => {
-  setDialogTile('create')
-}
-
-// 修改操作
-const handleUpdate = async (row: ConfigVO) => {
-  setDialogTile('update')
-  // 设置数据
-  const res = await ConfigApi.getConfigApi(row.id)
-  unref(formRef)?.setValues(res)
-}
-
-// 提交按钮
-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 ConfigVO
-        if (actionType.value === 'create') {
-          await ConfigApi.createConfigApi(data)
-          ElMessage.success(t('common.createSuccess'))
-        } else {
-          await ConfigApi.updateConfigApi(data)
-          ElMessage.success(t('common.updateSuccess'))
-        }
-        // 操作成功，重新加载列表
-        dialogVisible.value = false
-        await getList()
-      } finally {
-        actionLoading.value = false
-      }
-    }
-  })
-}
-
-// ========== 详情相关 ==========
-const detailRef = ref() // 详情 Ref
-
-// 详情操作
-const handleDetail = async (row: ConfigVO) => {
-  // 设置数据
-  detailRef.value = row
-  setDialogTile('detail')
-}
-
-// ========== 初始化 ==========
-getList()
-</script>
-
 <template>
-  <!-- 搜索工作区 -->
  <ContentWrap>
-    <Search :schema="allSchemas.searchSchema" @search="setSearchParams" @reset="setSearchParams" />
-  </ContentWrap>
-  <ContentWrap>
-    <!-- 操作工具栏 -->
-    <div class="mb-10px">
-      <el-button type="primary" v-hasPermi="['infra:config:create']" @click="handleCreate">
-        <Icon icon="ep:zoom-in" class="mr-5px" /> {{ t('action.add') }}
-      </el-button>
-      <el-button
-        type="warning"
-        v-hasPermi="['infra:config:export']"
-        :loading="tableObject.exportLoading"
-        @click="exportList('参数配置.xls')"
-      >
-        <Icon icon="ep:download" class="mr-5px" /> {{ t('action.export') }}
-      </el-button>
-    </div>
    <!-- 列表 -->
-    <Table
-      :columns="allSchemas.tableColumns"
-      :selection="false"
-      :data="tableObject.tableList"
-      :loading="tableObject.loading"
-      :pagination="{
-        total: tableObject.total
-      }"
-      v-model:pageSize="tableObject.pageSize"
-      v-model:currentPage="tableObject.currentPage"
-      @register="register"
-    >
-      <template #visible="{ row }">
+    <vxe-grid ref="xGrid" v-bind="gridOptions" class="xtable-scrollbar">
+      <template #toolbar_buttons>
+        <!-- 操作：新增 -->
+        <XButton
+          type="primary"
+          preIcon="ep:zoom-in"
+          :title="t('action.add')"
+          v-hasPermi="['infra:config:create']"
+          @click="handleCreate()"
+        />
+        <!-- 操作：导出 -->
+        <XButton
+          type="warning"
+          preIcon="ep:download"
+          :title="t('action.export')"
+          v-hasPermi="['infra:config:export']"
+          @click="handleExport()"
+        />
+      </template>
+      <template #visible_default="{ row }">
        <span>{{ row.visible ? '是' : '否' }} </span>
      </template>
-      <template #type="{ row }">
-        <DictTag :type="DICT_TYPE.INFRA_CONFIG_TYPE" :value="row.type" />
-      </template>
-      <template #createTime="{ row }">
-        <span>{{ dayjs(row.createTime).format('YYYY-MM-DD HH:mm:ss') }}</span>
-      </template>
-      <template #action="{ row }">
+      <template #actionbtns_default="{ row }">
        <el-button
          link
          type="primary"
          v-hasPermi="['infra:config:update']"
-          @click="handleUpdate(row)"
+          @click="handleUpdate(row.id)"
        >
          <Icon icon="ep:edit" class="mr-1px" /> {{ t('action.edit') }}
        </el-button>
@ -142,7 +36,7 @@ getList()
          link
          type="primary"
          v-hasPermi="['infra:config:update']"
-          @click="handleDetail(row)"
+          @click="handleDetail(row.id)"
        >
          <Icon icon="ep:view" class="mr-1px" /> {{ t('action.detail') }}
        </el-button>
@ -150,12 +44,12 @@ getList()
          link
          type="primary"
          v-hasPermi="['infra:config:delete']"
-          @click="delList(row.id, false)"
+          @click="handleDelete(row.id)"
        >
          <Icon icon="ep:delete" class="mr-1px" /> {{ t('action.del') }}
        </el-button>
      </template>
-    </Table>
+    </vxe-grid>
  </ContentWrap>

  <XModal v-model="dialogVisible" :title="dialogTitle">
@ -170,7 +64,7 @@ getList()
    <Descriptions
      v-if="actionType === 'detail'"
      :schema="allSchemas.detailSchema"
-      :data="detailRef"
+      :data="detailData"
    >
      <template #visible="{ row }">
        <span>{{ row.visible ? '是' : '否' }} </span>
@ -191,3 +85,99 @@ getList()
    </template>
  </XModal>
 </template>
+
+<script setup lang="ts">
+// 全局相关的 import
+import { ref, unref } from 'vue'
+import { useI18n } from '@/hooks/web/useI18n'
+import { useMessage } from '@/hooks/web/useMessage'
+import { useVxeGrid } from '@/hooks/web/useVxeGrid'
+import { VxeGridInstance } from 'vxe-table'
+import { FormExpose } from '@/components/Form'
+// 业务相关的 import
+import * as ConfigApi from '@/api/infra/config'
+import { rules, allSchemas } from './config.data'
+
+const { t } = useI18n() // 国际化
+const message = useMessage() // 消息弹窗
+// 列表相关的变量
+const xGrid = ref<VxeGridInstance>() // 列表 Grid Ref
+const { gridOptions, getList, deleteData, exportList } = useVxeGrid<ConfigApi.ConfigVO>({
+  allSchemas: allSchemas,
+  getListApi: ConfigApi.getConfigPageApi,
+  deleteApi: ConfigApi.deleteConfigApi,
+  exportListApi: ConfigApi.exportConfigApi
+})
+
+// ========== CRUD 相关 ==========
+const actionLoading = ref(false) // 遮罩层
+const actionType = ref('') // 操作按钮的类型
+const dialogVisible = ref(false) // 是否显示弹出层
+const dialogTitle = ref('edit') // 弹出层标题
+const formRef = ref<FormExpose>() // 表单 Ref
+const detailData = ref() // 详情 Ref
+
+// 设置标题
+const setDialogTile = (type: string) => {
+  dialogTitle.value = t('action.' + type)
+  actionType.value = type
+  dialogVisible.value = true
+}
+
+// 新增操作
+const handleCreate = () => {
+  setDialogTile('create')
+}
+
+// 导出操作
+const handleExport = async () => {
+  await exportList(xGrid, '配置.xls')
+}
+
+// 修改操作
+const handleUpdate = async (rowId: number) => {
+  setDialogTile('update')
+  // 设置数据
+  const res = await ConfigApi.getConfigApi(rowId)
+  unref(formRef)?.setValues(res)
+}
+
+// 详情操作
+const handleDetail = async (rowId: number) => {
+  setDialogTile('detail')
+  const res = await ConfigApi.getConfigApi(rowId)
+  detailData.value = res
+}
+
+// 删除操作
+const handleDelete = async (rowId: number) => {
+  await deleteData(xGrid, rowId)
+}
+
+// 提交按钮
+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 ConfigApi.ConfigVO
+        if (actionType.value === 'create') {
+          await ConfigApi.createConfigApi(data)
+          message.success(t('common.createSuccess'))
+        } else {
+          await ConfigApi.updateConfigApi(data)
+          message.success(t('common.updateSuccess'))
+        }
+        dialogVisible.value = false
+      } finally {
+        actionLoading.value = false
+        // 刷新列表
+        await getList(xGrid)
+      }
+    }
+  })
+}
+</script>