feat: tenant

2025-10-31 18:28:43 +08:00 · 2022-11-22 13:15:07 +08:00
parent 88cb5497c5
commit 407ac853cb
10 changed files with 290 additions and 359 deletions
--- a/yudao-ui-admin-vue3/src/views/system/tenant/index.vue
+++ b/yudao-ui-admin-vue3/src/views/system/tenant/index.vue
@@ -1,79 +1,55 @@
 <template>
-  <!-- 搜索工作区 -->
  <ContentWrap>
-    <Search :schema="allSchemas.searchSchema" @search="setSearchParams" @reset="setSearchParams" />
-  </ContentWrap>
-  <ContentWrap>
-    <!-- 操作工具栏 -->
-    <div class="mb-10px">
-      <XButton
-        type="primary"
-        preIcon="ep:zoom-in"
-        :title="t('action.add')"
-        v-hasPermi="['system:tenant:create']"
-        @click="handleCreate()"
-      />
-      <XButton
-        type="warning"
-        preIcon="ep:download"
-        :title="t('action.export')"
-        v-hasPermi="['system:tenant:export']"
-        @click="exportList('租户数据.xls')"
-      />
-    </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"
-    >
+    <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="['system:tenant:create']"
+          @click="handleCreate()"
+        />
+        <XButton
+          type="warning"
+          preIcon="ep:download"
+          :title="t('action.export')"
+          v-hasPermi="['system:tenant:export']"
+          @click="handleExport()"
+        />
+      </template>
      <template #accountCount="{ row }">
        <el-tag> {{ row.accountCount }} </el-tag>
      </template>
-      <template #status="{ row }">
-        <DictTag :type="DICT_TYPE.COMMON_STATUS" :value="row.status" />
-      </template>
      <template #packageId="{ row }">
        <el-tag v-if="row.packageId === 0" type="danger">系统租户</el-tag>
        <el-tag v-else type="success"> {{ getPackageName(row.packageId) }} </el-tag>
      </template>
-      <template #expireTime="{ row }">
-        <span>{{ dayjs(row.expireTime).format('YYYY-MM-DD HH:mm:ss') }}</span>
-      </template>
-      <template #createTime="{ row }">
-        <span>{{ dayjs(row.createTime).format('YYYY-MM-DD HH:mm:ss') }}</span>
-      </template>
-      <template #action="{ row }">
+      <template #actionbtns_default="{ row }">
        <!-- 操作：修改 -->
        <XTextButton
          preIcon="ep:edit"
          :title="t('action.edit')"
          v-hasPermi="['system:tenant:update']"
-          @click="handleUpdate(row)"
+          @click="handleUpdate(row.id)"
        />
        <!-- 操作：详情 -->
        <XTextButton
          preIcon="ep:view"
          :title="t('action.detail')"
          v-hasPermi="['system:tenant:update']"
-          @click="handleDetail(row)"
+          @click="handleDetail(row.id)"
        />
        <!-- 操作：删除 -->
        <XTextButton
          preIcon="ep:delete"
          :title="t('action.del')"
          v-hasPermi="['system:tenant:delete']"
-          @click="delList(row.id, false)"
+          @click="handleDelete(row.id)"
        />
      </template>
-    </Table>
+    </vxe-grid>
  </ContentWrap>

  <XModal v-model="dialogVisible" :title="dialogTitle">
@@ -124,27 +100,33 @@
 <script setup lang="ts">
 import { ref, unref, onMounted } from 'vue'
 import dayjs from 'dayjs'
-import { ElMessage, ElTag, ElSelect, ElOption } from 'element-plus'
-import { DICT_TYPE } from '@/utils/dict'
-import { useTable } from '@/hooks/web/useTable'
 import { useI18n } from '@/hooks/web/useI18n'
+import { useMessage } from '@/hooks/web/useMessage'
+import { useVxeGrid } from '@/hooks/web/useVxeGrid'
+import { VxeGridInstance } from 'vxe-table'
+import { ElTag, ElSelect, ElOption } from 'element-plus'
 import { FormExpose } from '@/components/Form'
-import type { TenantVO } from '@/api/system/tenant/types'
-import { rules, allSchemas } from './tenant.data'
 import * as TenantApi from '@/api/system/tenant'
-import { getTenantPackageList } from '@/api/system/tenantPackage'
-import { TenantPackageVO } from '@/api/system/tenantPackage/types'
-const { t } = useI18n() // 国际化
+import { rules, allSchemas } from './tenant.data'
+import { getTenantPackageList, TenantPackageVO } from '@/api/system/tenantPackage'

-// ========== 列表相关 ==========
-const { register, tableObject, methods } = useTable<TenantVO>({
+const { t } = useI18n() // 国际化
+const message = useMessage() // 消息弹窗
+// 列表相关的变量
+const xGrid = ref<VxeGridInstance>() // 列表 Grid Ref
+const { gridOptions, getList, deleteData, exportList } = useVxeGrid<TenantApi.TenantVO>({
+  allSchemas: allSchemas,
  getListApi: TenantApi.getTenantPageApi,
-  delListApi: TenantApi.deleteTenantApi,
+  deleteApi: TenantApi.deleteTenantApi,
  exportListApi: TenantApi.exportTenantApi
 })
-const { getList, setSearchParams, delList, exportList } = methods

-// ========== 套餐 ==========
+const actionLoading = ref(false) // 遮罩层
+const actionType = ref('') // 操作按钮的类型
+const dialogVisible = ref(false) // 是否显示弹出层
+const dialogTitle = ref('edit') // 弹出层标题
+const formRef = ref<FormExpose>() // 表单 Ref
+const detailRef = ref() // 详情 Ref
 const tenantPackageId = ref() // 套餐
 const tenantPackageOptions = ref<TenantPackageVO[]>([]) //套餐列表

@@ -160,12 +142,6 @@ const getPackageName = (packageId: number) => {
  }
  return '未知套餐'
 }
-// ========== 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) => {
@@ -182,15 +158,34 @@ const handleCreate = () => {
 }

 // 修改操作
-const handleUpdate = async (row: any) => {
+const handleUpdate = async (rowId: number) => {
  setDialogTile('update')
  // 设置数据
-  const res = await TenantApi.getTenantApi(row.id)
+  const res = await TenantApi.getTenantApi(rowId)
  tenantPackageId.value = res.packageId
  res.expireTime = dayjs(res.expireTime).format('YYYY-MM-DD HH:mm:ss')
  unref(formRef)?.setValues(res)
 }

+// 详情操作
+const handleDetail = async (rowId: number) => {
+  // 设置数据
+  const res = await TenantApi.getTenantApi(rowId)
+  tenantPackageId.value = res.packageId
+  detailRef.value = res
+  setDialogTile('detail')
+}
+
+// 删除操作
+const handleDelete = async (rowId: number) => {
+  await deleteData(xGrid, rowId)
+}
+
+// 导出操作
+const handleExport = async () => {
+  await exportList(xGrid, '租户列表.xls')
+}
+
 // 提交按钮
 const submitForm = async () => {
  const elForm = unref(formRef)?.getElFormRef()
@@ -200,40 +195,30 @@ const submitForm = async () => {
      actionLoading.value = true
      // 提交请求
      try {
-        const data = unref(formRef)?.formModel as TenantVO
+        const data = unref(formRef)?.formModel as TenantApi.TenantVO
        data.packageId = tenantPackageId.value
        if (actionType.value === 'create') {
          data.expireTime = dayjs(data.expireTime).valueOf().toString()
          await TenantApi.createTenantApi(data)
-          ElMessage.success(t('common.createSuccess'))
+          message.success(t('common.createSuccess'))
        } else {
          data.expireTime = dayjs(data.expireTime).valueOf().toString()
          await TenantApi.updateTenantApi(data)
-          ElMessage.success(t('common.updateSuccess'))
+          message.success(t('common.updateSuccess'))
        }
        // 操作成功，重新加载列表
        dialogVisible.value = false
-        await getList()
      } finally {
        actionLoading.value = false
+        // 刷新列表
+        await getList(xGrid)
      }
    }
  })
 }

-// ========== 详情相关 ==========
-const detailRef = ref() // 详情 Ref
-
-// 详情操作
-const handleDetail = async (row: any) => {
-  // 设置数据
-  detailRef.value = row
-  setDialogTile('detail')
-}
-
 // ========== 初始化 ==========
 onMounted(async () => {
-  await getList()
  await getTenantPackageOptions()
 })
 </script>
--- a/yudao-ui-admin-vue3/src/views/system/tenant/tenant.data.ts
+++ b/yudao-ui-admin-vue3/src/views/system/tenant/tenant.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() // 国际化

 // 表单校验
@@ -18,115 +18,82 @@ export const rules = reactive({
 })

 // CrudSchema.
-const crudSchemas = reactive<CrudSchema[]>([
-  {
-    label: t('common.index'),
-    field: 'id',
-    type: 'index',
-    form: {
-      show: false
+const crudSchemas = reactive<VxeCrudSchema>({
+  primaryKey: 'id',
+  primaryType: 'seq',
+  action: true,
+  columns: [
+    {
+      title: '租户名称',
+      field: 'name',
+      isSearch: true
    },
-    detail: {
-      show: false
-    }
-  },
-  {
-    label: '租户名称',
-    field: 'name',
-    search: {
-      show: true
-    }
-  },
-  {
-    label: '租户套餐',
-    field: 'packageId'
-  },
-  {
-    label: '联系人',
-    field: 'contactName',
-    search: {
-      show: true
-    }
-  },
-  {
-    label: '联系手机',
-    field: 'contactMobile',
-    search: {
-      show: true
-    }
-  },
-  {
-    label: '用户名称',
-    field: 'username',
-    table: {
-      show: false
+    {
+      title: '租户套餐',
+      field: 'packageId'
    },
-    detail: {
-      show: false
-    }
-  },
-  {
-    label: '用户密码',
-    field: 'password',
-    table: {
-      show: false
+    {
+      title: '联系人',
+      field: 'contactName',
+      isSearch: true
    },
-    detail: {
-      show: false
+    {
+      title: '联系手机',
+      field: 'contactMobile',
+      isSearch: true
    },
-    form: {
-      component: 'InputPassword'
-    }
-  },
-  {
-    label: '账号额度',
-    field: 'accountCount',
-    form: {
-      component: 'InputNumber'
-    }
-  },
-  {
-    label: '过期时间',
-    field: 'expireTime',
-    form: {
-      show: true,
-      component: 'DatePicker',
-      componentProps: {
-        type: 'datetime',
-        valueFormat: 'x'
+    {
+      title: '用户名称',
+      field: 'username',
+      isTable: false,
+      isDetail: false
+    },
+    {
+      title: '用户密码',
+      field: 'password',
+      isTable: false,
+      isDetail: false,
+      form: {
+        component: 'InputPassword'
      }
-    }
-  },
-  {
-    label: '绑定域名',
-    field: 'domain'
-  },
-  {
-    label: '租户状态',
-    field: 'status',
-    dictType: DICT_TYPE.COMMON_STATUS,
-    dictClass: 'number',
-    search: {
-      show: true
-    }
-  },
-  {
-    label: t('table.createTime'),
-    field: 'createTime',
-    form: {
-      show: false
-    }
-  },
-  {
-    label: t('table.action'),
-    field: 'action',
-    width: '240px',
-    form: {
-      show: false
    },
-    detail: {
-      show: false
+    {
+      title: '账号额度',
+      field: 'accountCount',
+      form: {
+        component: 'InputNumber'
+      }
+    },
+    {
+      title: '过期时间',
+      field: 'expireTime',
+      formatter: 'formatDate',
+      form: {
+        show: true,
+        component: 'DatePicker',
+        componentProps: {
+          type: 'datetime',
+          valueFormat: 'x'
+        }
+      }
+    },
+    {
+      title: '绑定域名',
+      field: 'domain'
+    },
+    {
+      title: '租户状态',
+      field: 'status',
+      dictType: DICT_TYPE.COMMON_STATUS,
+      dictClass: 'number',
+      isSearch: true
+    },
+    {
+      title: t('table.createTime'),
+      field: 'createTime',
+      formatter: 'formatDate',
+      isForm: false
    }
-  }
-])
-export const { allSchemas } = useCrudSchemas(crudSchemas)
+  ]
+})
+export const { allSchemas } = useVxeCrudSchemas(crudSchemas)
--- a/yudao-ui-admin-vue3/src/views/system/tenantPackage/index.vue
+++ b/yudao-ui-admin-vue3/src/views/system/tenantPackage/index.vue
@@ -1,42 +1,20 @@
 <template>
-  <!-- 搜索工作区 -->
  <ContentWrap>
-    <Search :schema="allSchemas.searchSchema" @search="setSearchParams" @reset="setSearchParams" />
-  </ContentWrap>
-  <ContentWrap>
-    <!-- 操作工具栏 -->
-    <div class="mb-10px">
-      <XButton
-        type="primary"
-        preIcon="ep:zoom-in"
-        :title="t('action.add')"
-        @click="handleCreate()"
-      />
-    </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 #status="{ row }">
-        <DictTag :type="DICT_TYPE.COMMON_STATUS" :value="row.status" />
+    <vxe-grid ref="xGrid" v-bind="gridOptions" class="xtable-scrollbar">
+      <template #toolbar_buttons>
+        <XButton
+          type="primary"
+          preIcon="ep:zoom-in"
+          :title="t('action.add')"
+          @click="handleCreate()"
+        />
      </template>
-      <template #createTime="{ row }">
-        <span>{{ dayjs(row.createTime).format('YYYY-MM-DD HH:mm:ss') }}</span>
+      <template #actionbtns_default="{ row }">
+        <XTextButton preIcon="ep:edit" :title="t('action.edit')" @click="handleUpdate(row.id)" />
+        <XTextButton preIcon="ep:delete" :title="t('action.del')" @click="handleDelete(row.id)" />
      </template>
-      <template #action="{ row }">
-        <XTextButton preIcon="ep:edit" :title="t('action.edit')" @click="handleUpdate(row)" />
-        <XTextButton preIcon="ep:delete" :title="t('action.del')" @click="delList(row.id, false)" />
-      </template>
-    </Table>
+    </vxe-grid>
  </ContentWrap>

  <XModal v-model="dialogVisible" :title="dialogTitle">
@@ -89,28 +67,39 @@
 </template>
 <script setup lang="ts">
 import { onMounted, ref, unref } from 'vue'
-import dayjs from 'dayjs'
 import { handleTree } from '@/utils/tree'
-import { DICT_TYPE } from '@/utils/dict'
-import { useTable } from '@/hooks/web/useTable'
 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 { TenantPackageVO } from '@/api/system/tenantPackage/types'
-import { ElMessage, ElCard, ElSwitch, ElTree } from 'element-plus'
+import { ElCard, ElSwitch, ElTree } from 'element-plus'
+// 业务相关的 import
 import { rules, allSchemas } from './tenantPackage.data'
 import * as TenantPackageApi from '@/api/system/tenantPackage'
 import { listSimpleMenusApi } from '@/api/system/menu'
+
 const { t } = useI18n() // 国际化
+const message = useMessage() // 消息弹窗
+
+const menuOptions = ref<any[]>([]) // 树形结构
+const menuExpand = ref(false)
+const menuNodeAll = ref(false)
+const treeRef = ref<InstanceType<typeof ElTree>>()
+const treeNodeAll = ref(false)
+const xGrid = ref<VxeGridInstance>() // 列表 Grid Ref
+const formRef = ref<FormExpose>() // 表单 Ref
+const loading = ref(false) // 遮罩层
+const actionType = ref('') // 操作按钮的类型
+const dialogVisible = ref(false) // 是否显示弹出层
+const dialogTitle = ref('edit') // 弹出层标题

 const defaultProps = {
  children: 'children',
  label: 'name',
  value: 'id'
 }
-// ========== 创建菜单树结构 ==========
-const menuOptions = ref<any[]>([]) // 树形结构
-const treeRef = ref<InstanceType<typeof ElTree>>()
-const treeNodeAll = ref(false)
+
 // 全选/全不选
 const handleCheckedTreeNodeAll = () => {
  treeRef.value!.setCheckedNodes(treeNodeAll.value ? menuOptions.value : [])
@@ -119,22 +108,12 @@ const getTree = async () => {
  const res = await listSimpleMenusApi()
  menuOptions.value = handleTree(res)
 }
-const menuExpand = ref(false)
-const menuNodeAll = ref(false)

-// ========== 列表相关 ==========
-const { register, tableObject, methods } = useTable<TenantPackageVO>({
+const { gridOptions, getList, deleteData } = useVxeGrid<TenantPackageApi.TenantPackageVO>({
+  allSchemas: allSchemas,
  getListApi: TenantPackageApi.getTenantPackageTypePageApi,
-  delListApi: TenantPackageApi.deleteTenantPackageTypeApi
+  deleteApi: TenantPackageApi.deleteTenantPackageTypeApi
 })
-const { getList, setSearchParams, delList } = methods
-
-// ========== CRUD 相关 ==========
-const loading = ref(false) // 遮罩层
-const formRef = ref<FormExpose>() // 表单 Ref
-const actionType = ref('') // 操作按钮的类型
-const dialogVisible = ref(false) // 是否显示弹出层
-const dialogTitle = ref('edit') // 弹出层标题

 // 设置标题
 const setDialogTile = (type: string) => {
@@ -153,14 +132,20 @@ const handleCreate = () => {
 }

 // 修改操作
-const handleUpdate = async (row: any) => {
+const handleUpdate = async (rowId: number) => {
  setDialogTile('update')
  // 设置数据
-  const res = await TenantPackageApi.getTenantPackageApi(row.id)
+  const res = await TenantPackageApi.getTenantPackageApi(rowId)
  unref(formRef)?.setValues(res)
  // 设置选中
  unref(treeRef)?.setCheckedKeys(res.menuIds)
 }
+
+// 删除操作
+const handleDelete = async (rowId: number) => {
+  await deleteData(xGrid, rowId)
+}
+
 // 提交按钮
 const submitForm = async () => {
  const elForm = unref(formRef)?.getElFormRef()
@@ -170,20 +155,21 @@ const submitForm = async () => {
      loading.value = true
      // 提交请求
      try {
-        const data = unref(formRef)?.formModel as TenantPackageVO
+        const data = unref(formRef)?.formModel as TenantPackageApi.TenantPackageVO
        data.menuIds = treeRef.value!.getCheckedKeys(false) as string[]
        if (actionType.value === 'create') {
          await TenantPackageApi.createTenantPackageTypeApi(data)
-          ElMessage.success(t('common.createSuccess'))
+          message.success(t('common.createSuccess'))
        } else {
          await TenantPackageApi.updateTenantPackageTypeApi(data)
-          ElMessage.success(t('common.updateSuccess'))
+          message.success(t('common.updateSuccess'))
        }
        // 操作成功，重新加载列表
        dialogVisible.value = false
-        await getList()
      } finally {
        loading.value = false
+        // 刷新列表
+        await getList(xGrid)
      }
    }
  })
@@ -191,7 +177,6 @@ const submitForm = async () => {

 // ========== 初始化 ==========
 onMounted(async () => {
-  await getList()
  await getTree()
 })
 // getList()
--- a/yudao-ui-admin-vue3/src/views/system/tenantPackage/tenantPackage.data.ts
+++ b/yudao-ui-admin-vue3/src/views/system/tenantPackage/tenantPackage.data.ts
@@ -1,8 +1,8 @@
 import { reactive } from 'vue'
 import { required } from '@/utils/formRules'
 import { useI18n } from '@/hooks/web/useI18n'
-import { CrudSchema, useCrudSchemas } from '@/hooks/web/useCrudSchemas'
 import { DICT_TYPE } from '@/utils/dict'
+import { VxeCrudSchema, useVxeCrudSchemas } from '@/hooks/web/useVxeCrudSchemas'
 const { t } = useI18n() // 国际化

 // 表单校验
@@ -16,75 +16,49 @@ export const rules = reactive({
 })

 // CrudSchema
-const crudSchemas = reactive<CrudSchema[]>([
-  {
-    label: t('common.index'),
-    field: 'id',
-    type: 'index',
-    form: {
-      show: false
+const crudSchemas = reactive<VxeCrudSchema>({
+  primaryKey: 'id',
+  primaryType: 'seq',
+  action: true,
+  columns: [
+    {
+      title: '套餐名称',
+      field: 'name',
+      isSearch: true
    },
-    detail: {
-      show: false
-    }
-  },
-  {
-    label: '套餐名称',
-    field: 'name',
-    search: {
-      show: true
-    }
-  },
-  {
-    label: t('common.status'),
-    field: 'status',
-    dictType: DICT_TYPE.COMMON_STATUS,
-    dictClass: 'number',
-    search: {
-      show: true
-    }
-  },
-  {
-    label: '菜单权限',
-    field: 'menuIds',
-    table: {
-      show: false
-    }
-  },
-  {
-    label: t('form.remark'),
-    field: 'remark',
-    form: {
-      component: 'Input',
-      componentProps: {
-        type: 'textarea',
-        rows: 4
-      },
-      colProps: {
-        span: 24
+    {
+      title: t('common.status'),
+      field: 'status',
+      dictType: DICT_TYPE.COMMON_STATUS,
+      dictClass: 'number',
+      isSearch: true
+    },
+    {
+      title: '菜单权限',
+      field: 'menuIds',
+      isTable: false
+    },
+    {
+      title: t('form.remark'),
+      field: 'remark',
+      isTable: false,
+      form: {
+        component: 'Input',
+        componentProps: {
+          type: 'textarea',
+          rows: 4
+        },
+        colProps: {
+          span: 24
+        }
      }
    },
-    table: {
-      show: false
+    {
+      title: '创建时间',
+      field: 'createTime',
+      formatter: 'formatDate',
+      isForm: false
    }
-  },
-  {
-    label: '创建时间',
-    field: 'createTime',
-    form: {
-      show: false
-    }
-  },
-  {
-    label: t('table.action'),
-    field: 'action',
-    width: '240px',
-    form: {
-      show: false
-    },
-    detail: {
-      show: false
-    }
-  }
-])
-export const { allSchemas } = useCrudSchemas(crudSchemas)
+  ]
+})
+export const { allSchemas } = useVxeCrudSchemas(crudSchemas)