feat：角色 role 的实现 50%（crud + export 功能）

apps/web-antd/src/api/system/role/index.ts

@@ -0,0 +1,54 @@
+import { requestClient } from '#/api/request';
+import type { PageParam } from '@vben/request';
+
+export namespace SystemRoleApi {
+  /** 角色信息 */
+  export interface SystemRole {
+    id?: number;
+    name: string;
+    code: string;
+    sort: number;
+    status: number;
+    type: number;
+    dataScope: number;
+    dataScopeDeptIds: number[];
+    createTime?: Date;
+  }
+}
+
+/** 查询角色列表 */
+export function getRolePage(params: PageParam) {
+  return requestClient.get('/system/role/page', { params });
+}
+
+/** 查询角色（精简)列表 */
+export function getSimpleRoleList(): Promise<SystemRoleApi.SystemRole[]> {
+  return requestClient.get('/system/role/simple-list');
+}
+
+/** 查询角色详情 */
+export function getRole(id: number) {
+  return requestClient.get(`/system/role/get?id=${id}`);
+}
+
+/** 新增角色 */
+export function createRole(data: SystemRoleApi.SystemRole) {
+  return requestClient.post('/system/role/create', data);
+}
+
+/** 修改角色 */
+export function updateRole(data: SystemRoleApi.SystemRole) {
+  return requestClient.put('/system/role/update', data);
+}
+
+/** 删除角色 */
+export function deleteRole(id: number) {
+  return requestClient.delete(`/system/role/delete?id=${id}`);
+}
+
+/** 导出角色 */
+export function exportRole(params: any) {
+  return requestClient.download('/system/role/export-excel', {
+    params,
+  });
+}

apps/web-antd/src/api/system/user/index.ts

@@ -1,4 +1,5 @@
 import { requestClient } from '#/api/request';
+import type { PageParam } from '@vben/request';
 
 export namespace SystemUserApi {
   /** 用户信息 */
@@ -20,7 +21,7 @@ export namespace SystemUserApi {
 }
 
 /** 查询用户管理列表 */
-export function getUserPage(params: any) {
+export function getUserPage(params: PageParam) {
   return requestClient.get('/system/user/page', { params });
 }
 

apps/web-antd/src/views/system/dept/index.vue

@@ -50,7 +50,7 @@ async function onDelete(row: SystemDeptApi.SystemDept) {
       content: $t('ui.actionMessage.deleteSuccess', [row.name]),
       key: 'action_process_msg',
     });
-    refreshGrid();
+    onRefresh();
   } catch (error) {
     hideLoading();
   }
@@ -109,7 +109,7 @@ const [Grid, gridApi] = useVbenVxeGrid({
 });
 
 /** 刷新表格 */
-function refreshGrid() {
+function onRefresh() {
   gridApi.query();
 }
 
@@ -122,7 +122,7 @@ function toggleExpand() {
 </script>
 <template>
   <Page auto-content-height>
-    <FormModal @success="refreshGrid" />
+    <FormModal @success="onRefresh" />
     <Grid table-title="部门列表">
       <template #toolbar-tools>
         <Button type="primary" @click="onCreate">

apps/web-antd/src/views/system/post/data.ts

@@ -118,7 +118,7 @@ export function useGridColumns<T = SystemPostApi.SystemPost>(
         props: { type: DICT_TYPE.COMMON_STATUS },
       },
       field: 'status',
-      title: '状态',
+      title: '岗位状态',
       minWidth: 100,
     },
     {

apps/web-antd/src/views/system/post/index.vue

@@ -15,7 +15,7 @@ import { Plus, Download } from '@vben/icons';
 
 import { useGridColumns, useGridFormSchema } from './data';
 import Form from './modules/form.vue';
-import {downloadByData} from '#/utils/download';
+import { downloadByData } from '#/utils/download';
 
 const [FormModal, formModalApi] = useVbenModal({
   connectedComponent: Form,
@@ -45,7 +45,7 @@ async function onDelete(row: SystemPostApi.SystemPost) {
       content: $t('ui.actionMessage.deleteSuccess', [row.name]),
       key: 'action_process_msg',
     });
-    refreshGrid();
+    onRefresh();
   } catch (error) {
     hideLoading();
   }
@@ -98,19 +98,19 @@ const [Grid, gridApi] = useVbenVxeGrid({
 });
 
 /** 刷新表格 */
-function refreshGrid() {
+function onRefresh() {
   gridApi.query();
 }
 
 /** 导出表格 */
 async function onExport() {
   const data = await exportPost(await gridApi.formApi.getValues());
-  downloadByData(data, '导出岗位.xls');
+  downloadByData(data, '岗位.xls');
 }
 </script>
 <template>
   <Page auto-content-height>
-    <FormModal @success="refreshGrid" />
+    <FormModal @success="onRefresh" />
     <Grid table-title="岗位列表">
       <template #toolbar-tools>
         <Button type="primary" @click="onCreate">

apps/web-antd/src/views/system/role/data.ts

@@ -0,0 +1,163 @@
+import {type VbenFormSchema, z} from '#/adapter/form';
+import type { OnActionClickFn, VxeTableGridOptions } from '#/adapter/vxe-table';
+import type { SystemRoleApi } from '#/api/system/role';
+
+import { DICT_TYPE, getDictOptions } from '#/utils/dict';
+import { CommonStatusEnum } from '#/utils/constants';
+
+export function useFormSchema(): VbenFormSchema[] {
+  return [
+    {
+      component: 'Input',
+      fieldName: 'id',
+      label: 'id',
+      dependencies: {
+        triggerFields: [''],
+        show: () => false,
+      },
+    },
+    {
+      component: 'Input',
+      fieldName: 'name',
+      label: '角色名称',
+      rules: 'required',
+    },
+    {
+      component: 'Input',
+      fieldName: 'code',
+      label: '角色标识',
+      rules:'required',
+    },
+    {
+      component: 'InputNumber',
+      componentProps: {
+        min: 0,
+        class: 'w-full',
+        controlsPosition: 'right',
+        placeholder: '请输入角色顺序',
+      },
+      fieldName: 'sort',
+      label: '角色顺序',
+      rules: 'required',
+    },
+    {
+      component: 'RadioGroup',
+      componentProps: {
+        options: getDictOptions(DICT_TYPE.COMMON_STATUS, 'number'),
+        buttonStyle: 'solid',
+        optionType: 'button',
+      },
+      fieldName: 'status',
+      label: '角色状态',
+      rules: z.number().default(CommonStatusEnum.ENABLE),
+    },
+    {
+      component: 'Textarea',
+      fieldName: 'remark',
+      label: '角色备注',
+    }
+  ];
+}
+
+export function useGridFormSchema(): VbenFormSchema[] {
+  return [
+    {
+      component: 'Input',
+      fieldName: 'name',
+      label: '角色名称',
+    },
+    {
+      component: 'Input',
+      fieldName: 'code',
+      label: '角色标识',
+    },
+    {
+      component: 'Select',
+      componentProps: {
+        allowClear: true,
+        options: getDictOptions(DICT_TYPE.COMMON_STATUS, 'number'),
+      },
+      fieldName: 'status',
+      label: '角色状态',
+    },
+    {
+      component: 'RangePicker',
+      fieldName: 'createTime',
+      label: '创建时间',
+    },
+  ];
+}
+
+export function useGridColumns<T = SystemRoleApi.SystemRole>(
+  onActionClick: OnActionClickFn<T>,
+): VxeTableGridOptions['columns'] {
+  return [
+    {
+      field: 'id',
+      title: '角色编号',
+      minWidth: 200,
+    },
+    {
+      field: 'name',
+      title: '角色名称',
+      minWidth: 200,
+    },
+    {
+      cellRender: {
+        name: 'CellDict',
+        props: { type: DICT_TYPE.SYSTEM_ROLE_TYPE },
+      },
+      field: 'type',
+      title: '角色类型',
+      minWidth: 100,
+    },
+    {
+      field: 'code',
+      title: '角色标识',
+      minWidth: 200,
+    },
+    {
+      field: 'sort',
+      title: '角色顺序',
+      minWidth: 100,
+    },
+    {
+      field: 'remark',
+      minWidth: 100,
+      title: '角色备注',
+    },
+    {
+      cellRender: {
+        name: 'CellDict',
+        props: { type: DICT_TYPE.COMMON_STATUS },
+      },
+      field: 'status',
+      title: '角色状态',
+      minWidth: 100,
+    },
+    {
+      field: 'createTime',
+      title: '创建时间',
+      minWidth: 180,
+      formatter: 'formatDateTime',
+    },
+    {
+      align: 'center',
+      cellRender: {
+        attrs: {
+          nameField: 'name',
+          nameTitle: '角色',
+          onClick: onActionClick,
+        },
+        name: 'CellOperation',
+      },
+      field: 'operation',
+      fixed: 'right',
+      title: '操作',
+      width: 130,
+    },
+  ];
+}
+
+// TODO @芋艿：角色分配
+// TODO @芋艿：数据权限

apps/web-antd/src/views/system/role/index.vue

@@ -0,0 +1,126 @@
+<script lang="ts" setup>
+import type {
+  OnActionClickParams,
+  VxeTableGridOptions,
+} from '#/adapter/vxe-table';
+import type { SystemRoleApi } from '#/api/system/role';
+
+import { $t } from '#/locales';
+import { useVbenVxeGrid } from '#/adapter/vxe-table';
+import { getRolePage, deleteRole, exportRole } from '#/api/system/role';
+
+import { Page, useVbenModal } from '@vben/common-ui';
+import { Button, message } from 'ant-design-vue';
+import { Plus, Download } from '@vben/icons';
+
+import { useGridColumns, useGridFormSchema } from './data';
+import Form from './modules/form.vue';
+import { downloadByData } from '#/utils/download';
+
+const [FormModal, formModalApi] = useVbenModal({
+  connectedComponent: Form,
+  destroyOnClose: true,
+});
+
+/** 编辑角色 */
+function onEdit(row: SystemRoleApi.SystemRole) {
+  formModalApi.setData(row).open();
+}
+
+/** 创建角色 */
+function onCreate() {
+  formModalApi.setData(null).open();
+}
+
+/** 删除角色 */
+async function onDelete(row: SystemRoleApi.SystemRole) {
+  const hideLoading = message.loading({
+    content: $t('ui.actionMessage.deleting', [row.name]),
+    duration: 0,
+    key: 'action_process_msg',
+  });
+  try {
+    await deleteRole(row.id as number);
+    message.success({
+      content: $t('ui.actionMessage.deleteSuccess', [row.name]),
+      key: 'action_process_msg',
+    });
+    onRefresh();
+  } catch (error) {
+    hideLoading();
+  }
+}
+
+/** 表格操作按钮的回调函数 */
+function onActionClick(e: OnActionClickParams<SystemRoleApi.SystemRole>) {
+  switch (e.code) {
+    case 'delete': {
+      onDelete(e.row);
+      break;
+    }
+    case 'edit': {
+      onEdit(e.row);
+      break;
+    }
+  }
+}
+
+const [Grid, gridApi] = useVbenVxeGrid({
+  formOptions: {
+    // TODO @芋艿：时间范围的检索
+    fieldMappingTime: [['createTime', ['startTime', 'endTime']]],
+    schema: useGridFormSchema(),
+  },
+  gridOptions: {
+    columns: useGridColumns(onActionClick),
+    height: 'auto',
+    keepSource: true,
+    proxyConfig: {
+      ajax: {
+        query: async ({ page }, formValues) => {
+          return await getRolePage({
+            page: page.currentPage,
+            pageSize: page.pageSize,
+            ...formValues,
+          });
+        },
+      },
+    },
+    rowConfig: {
+      keyField: 'id',
+    },
+    toolbarConfig: {
+      refresh: { code: 'query' },
+      search: true,
+    },
+  } as VxeTableGridOptions<SystemRoleApi.SystemRole>,
+});
+
+/** 刷新表格 */
+function onRefresh() {
+  gridApi.query();
+}
+
+/** 导出表格 */
+async function onExport() {
+  const data = await exportRole(await gridApi.formApi.getValues());
+  downloadByData(data, '角色.xls');
+}
+</script>
+<template>
+  <Page auto-content-height>
+    <FormModal @success="onRefresh" />
+    <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/role/modules/form.vue

@@ -0,0 +1,86 @@
+<script lang="ts" setup>
+import type { SystemRoleApi } from '#/api/system/role';
+
+import { computed, ref } from 'vue';
+
+import { useVbenModal } from '@vben/common-ui';
+import { Button, message } from 'ant-design-vue';
+
+import { useVbenForm } from '#/adapter/form';
+import { createRole, updateRole, getRole } from '#/api/system/role';
+import { $t } from '#/locales';
+
+import { useFormSchema } from '../data';
+
+const emit = defineEmits(['success']);
+const formData = ref<SystemRoleApi.SystemRole>();
+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,
+});
+
+function resetForm() {
+  formApi.resetForm();
+  formApi.setValues(formData.value || {});
+}
+
+const [Modal, modalApi] = useVbenModal({
+  async onConfirm() {
+    const { valid } = await formApi.validate();
+    if (!valid) {
+      return;
+    }
+    modalApi.lock();
+    const data = (await formApi.getValues()) as SystemRoleApi.SystemRole;
+    try {
+      await (formData.value?.id
+        ? updateRole(data)
+        : createRole(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<SystemRoleApi.SystemRole>();
+    if (!data || !data.id) {
+      return;
+    }
+    modalApi.lock();
+    try {
+      formData.value = await getRole(data.id as number);
+      await formApi.setValues(formData.value);
+    } finally {
+      modalApi.lock(false);
+    }
+  },
+});
+</script>
+
+<template>
+  <Modal :title="getTitle">
+    <Form class="mx-4" />
+    <template #prepend-footer>
+      <div class="flex-auto">
+        <Button type="primary" danger @click="resetForm">
+          {{ $t('common.reset') }}
+        </Button>
+      </div>
+    </template>
+  </Modal>
+</template>