feat: 新增 ele 功能权限模块

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

@@ -0,0 +1,283 @@
+import type { VbenFormSchema } from '#/adapter/form';
+import type { OnActionClickFn, VxeTableGridOptions } from '#/adapter/vxe-table';
+import type { SystemRoleApi } from '#/api/system/role';
+
+import { useAccess } from '@vben/access';
+
+import { z } from '#/adapter/form';
+import {
+  CommonStatusEnum,
+  DICT_TYPE,
+  getDictOptions,
+  getRangePickerDefaultProps,
+  SystemDataScopeEnum,
+} from '#/utils';
+
+const { hasAccessByCodes } = useAccess();
+
+/** 新增/修改的表单 */
+export function useFormSchema(): VbenFormSchema[] {
+  return [
+    {
+      fieldName: 'id',
+      component: 'Input',
+      dependencies: {
+        triggerFields: [''],
+        show: () => false,
+      },
+    },
+    {
+      fieldName: 'name',
+      label: '角色名称',
+      component: 'Input',
+      rules: 'required',
+    },
+    {
+      fieldName: 'code',
+      label: '角色标识',
+      component: 'Input',
+      rules: 'required',
+    },
+    {
+      fieldName: 'sort',
+      label: '显示顺序',
+      component: 'InputNumber',
+      componentProps: {
+        min: 0,
+        controlsPosition: 'right',
+        placeholder: '请输入显示顺序',
+      },
+      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),
+    },
+    {
+      fieldName: 'remark',
+      label: '角色备注',
+      component: 'Textarea',
+    },
+  ];
+}
+
+/** 分配数据权限的表单 */
+export function useAssignDataPermissionFormSchema(): VbenFormSchema[] {
+  return [
+    {
+      component: 'Input',
+      fieldName: 'id',
+      dependencies: {
+        triggerFields: [''],
+        show: () => false,
+      },
+    },
+    {
+      fieldName: 'name',
+      label: '角色名称',
+      component: 'Input',
+      componentProps: {
+        disabled: true,
+      },
+    },
+    {
+      component: 'Input',
+      fieldName: 'code',
+      label: '角色标识',
+      componentProps: {
+        disabled: true,
+      },
+    },
+    {
+      component: 'Select',
+      fieldName: 'dataScope',
+      label: '权限范围',
+      componentProps: {
+        options: getDictOptions(DICT_TYPE.SYSTEM_DATA_SCOPE, 'number'),
+      },
+    },
+    {
+      fieldName: 'dataScopeDeptIds',
+      label: '部门范围',
+      component: 'Input',
+      formItemClass: 'items-start',
+      dependencies: {
+        triggerFields: ['dataScope'],
+        show: (values) => {
+          return values.dataScope === SystemDataScopeEnum.DEPT_CUSTOM;
+        },
+      },
+    },
+  ];
+}
+
+/** 分配菜单的表单 */
+export function useAssignMenuFormSchema(): VbenFormSchema[] {
+  return [
+    {
+      fieldName: 'id',
+      component: 'Input',
+      dependencies: {
+        triggerFields: [''],
+        show: () => false,
+      },
+    },
+    {
+      fieldName: 'name',
+      label: '角色名称',
+      component: 'Input',
+      componentProps: {
+        disabled: true,
+      },
+    },
+    {
+      fieldName: 'code',
+      label: '角色标识',
+      component: 'Input',
+      componentProps: {
+        disabled: true,
+      },
+    },
+    {
+      fieldName: 'menuIds',
+      label: '菜单权限',
+      component: 'Input',
+      formItemClass: 'items-start',
+    },
+  ];
+}
+
+/** 列表的搜索表单 */
+export function useGridFormSchema(): VbenFormSchema[] {
+  return [
+    {
+      fieldName: 'name',
+      label: '角色名称',
+      component: 'Input',
+    },
+    {
+      fieldName: 'code',
+      label: '角色标识',
+      component: 'Input',
+    },
+    {
+      fieldName: 'status',
+      label: '角色状态',
+      component: 'Select',
+      componentProps: {
+        allowClear: true,
+        options: getDictOptions(DICT_TYPE.COMMON_STATUS, 'number'),
+      },
+    },
+    {
+      fieldName: 'createTime',
+      label: '创建时间',
+      component: 'RangePicker',
+      componentProps: {
+        ...getRangePickerDefaultProps(),
+        allowClear: true,
+      },
+    },
+  ];
+}
+
+/** 列表的字段 */
+export function useGridColumns<T = SystemRoleApi.Role>(
+  onActionClick: OnActionClickFn<T>,
+): VxeTableGridOptions['columns'] {
+  return [
+    {
+      field: 'id',
+      title: '角色编号',
+      minWidth: 200,
+    },
+    {
+      field: 'name',
+      title: '角色名称',
+      minWidth: 200,
+    },
+    {
+      field: 'type',
+      title: '角色类型',
+      minWidth: 100,
+      cellRender: {
+        name: 'CellDict',
+        props: { type: DICT_TYPE.SYSTEM_ROLE_TYPE },
+      },
+    },
+    {
+      field: 'code',
+      title: '角色标识',
+      minWidth: 200,
+    },
+    {
+      field: 'sort',
+      title: '显示顺序',
+      minWidth: 100,
+    },
+    {
+      field: 'remark',
+      title: '角色备注',
+      minWidth: 100,
+    },
+    {
+      field: 'status',
+      title: '角色状态',
+      minWidth: 100,
+      cellRender: {
+        name: 'CellDict',
+        props: { type: DICT_TYPE.COMMON_STATUS },
+      },
+    },
+    {
+      field: 'createTime',
+      title: '创建时间',
+      minWidth: 180,
+      formatter: 'formatDateTime',
+    },
+    {
+      field: 'operation',
+      title: '操作',
+      width: 240,
+      fixed: 'right',
+      align: 'center',
+      cellRender: {
+        attrs: {
+          nameField: 'name',
+          nameTitle: '角色',
+          onClick: onActionClick,
+        },
+        name: 'CellOperation',
+        options: [
+          {
+            code: 'edit',
+            show: hasAccessByCodes(['system:role:update']),
+          },
+          {
+            code: 'delete',
+            show: hasAccessByCodes(['system:role:delete']),
+          },
+          {
+            code: 'assign-data-permission',
+            text: '数据权限',
+            show: hasAccessByCodes([
+              'system:permission:assign-role-data-scope',
+            ]),
+          },
+          {
+            code: 'assign-menu',
+            text: '菜单权限',
+            show: hasAccessByCodes(['system:permission:assign-role-menu']),
+          },
+        ],
+      },
+    },
+  ];
+}

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

@@ -0,0 +1,175 @@
+<script lang="ts" setup>
+import type {
+  OnActionClickParams,
+  VxeTableGridOptions,
+} from '#/adapter/vxe-table';
+import type { SystemRoleApi } from '#/api/system/role';
+
+import { Page, useVbenModal } from '@vben/common-ui';
+import { Download, Plus } from '@vben/icons';
+import { downloadFileFromBlobPart } from '@vben/utils';
+
+import { ElButton, ElLoading, ElMessage } from 'element-plus';
+
+import { useVbenVxeGrid } from '#/adapter/vxe-table';
+import { deleteRole, exportRole, getRolePage } from '#/api/system/role';
+import { DocAlert } from '#/components/doc-alert';
+import { $t } from '#/locales';
+
+import { useGridColumns, useGridFormSchema } from './data';
+import AssignDataPermissionForm from './modules/assign-data-permission-form.vue';
+import AssignMenuForm from './modules/assign-menu-form.vue';
+import Form from './modules/form.vue';
+
+const [FormModal, formModalApi] = useVbenModal({
+  connectedComponent: Form,
+  destroyOnClose: true,
+});
+
+const [AssignDataPermissionFormModel, assignDataPermissionFormApi] =
+  useVbenModal({
+    connectedComponent: AssignDataPermissionForm,
+    destroyOnClose: true,
+  });
+
+const [AssignMenuFormModel, assignMenuFormApi] = useVbenModal({
+  connectedComponent: AssignMenuForm,
+  destroyOnClose: true,
+});
+
+/** 刷新表格 */
+function onRefresh() {
+  gridApi.query();
+}
+
+/** 导出表格 */
+async function onExport() {
+  const data = await exportRole(await gridApi.formApi.getValues());
+  downloadFileFromBlobPart({ fileName: '角色.xls', source: data });
+}
+
+/** 编辑角色 */
+function onEdit(row: SystemRoleApi.Role) {
+  formModalApi.setData(row).open();
+}
+
+/** 创建角色 */
+function onCreate() {
+  formModalApi.setData(null).open();
+}
+
+/** 删除角色 */
+async function onDelete(row: SystemRoleApi.Role) {
+  const loadingInstance = ElLoading.service({
+    text: $t('ui.actionMessage.deleting', [row.name]),
+    fullscreen: true,
+  });
+  try {
+    await deleteRole(row.id as number);
+    ElMessage.success($t('ui.actionMessage.deleteSuccess', [row.name]));
+    onRefresh();
+  } catch {
+    // 异常处理
+  } finally {
+    loadingInstance.close();
+  }
+}
+
+/** 分配角色的数据权限 */
+function onAssignDataPermission(row: SystemRoleApi.Role) {
+  assignDataPermissionFormApi.setData(row).open();
+}
+
+/** 分配角色的菜单权限 */
+function onAssignMenu(row: SystemRoleApi.Role) {
+  assignMenuFormApi.setData(row).open();
+}
+
+/** 表格操作按钮的回调函数 */
+function onActionClick({ code, row }: OnActionClickParams<SystemRoleApi.Role>) {
+  switch (code) {
+    case 'assign-data-permission': {
+      onAssignDataPermission(row);
+      break;
+    }
+    case 'assign-menu': {
+      onAssignMenu(row);
+      break;
+    }
+    case 'delete': {
+      onDelete(row);
+      break;
+    }
+    case 'edit': {
+      onEdit(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 getRolePage({
+            page: page.currentPage,
+            pageSize: page.pageSize,
+            ...formValues,
+          });
+        },
+      },
+    },
+    rowConfig: {
+      keyField: 'id',
+    },
+    toolbarConfig: {
+      refresh: { code: 'query' },
+      search: true,
+    },
+  } as VxeTableGridOptions<SystemRoleApi.Role>,
+});
+</script>
+
+<template>
+  <Page auto-content-height>
+    <template #doc>
+      <DocAlert
+        title="功能权限"
+        url="https://doc.iocoder.cn/resource-permission"
+      />
+      <DocAlert title="数据权限" url="https://doc.iocoder.cn/data-permission" />
+    </template>
+
+    <FormModal @success="onRefresh" />
+    <AssignDataPermissionFormModel @success="onRefresh" />
+    <AssignMenuFormModel @success="onRefresh" />
+    <Grid table-title="角色列表">
+      <template #toolbar-tools>
+        <ElButton
+          type="primary"
+          @click="onCreate"
+          v-access:code="['system:role:create']"
+        >
+          <Plus class="size-5" />
+          {{ $t('ui.actionTitle.create', ['角色']) }}
+        </ElButton>
+        <ElButton
+          type="primary"
+          class="ml-2"
+          @click="onExport"
+          v-access:code="['system:role:export']"
+        >
+          <Download class="size-5" />
+          {{ $t('ui.actionTitle.export') }}
+        </ElButton>
+      </template>
+    </Grid>
+  </Page>
+</template>

apps/web-ele/src/views/system/role/modules/assign-data-permission-form.vue

@@ -0,0 +1,171 @@
+<script lang="ts" setup>
+import type { SystemDeptApi } from '#/api/system/dept';
+import type { SystemRoleApi } from '#/api/system/role';
+
+import { ref } from 'vue';
+
+import { useVbenModal, VbenTree } from '@vben/common-ui';
+import { handleTree } from '@vben/utils';
+
+import { ElCheckbox, ElMessage } from 'element-plus';
+
+import { useVbenForm } from '#/adapter/form';
+import { getDeptList } from '#/api/system/dept';
+import { assignRoleDataScope } from '#/api/system/permission';
+import { getRole } from '#/api/system/role';
+import { $t } from '#/locales';
+import { SystemDataScopeEnum } from '#/utils';
+
+import { useAssignDataPermissionFormSchema } from '../data';
+
+const emit = defineEmits(['success']);
+
+const deptTree = ref<SystemDeptApi.Dept[]>([]); // 部门树
+const deptLoading = ref(false); // 加载部门列表
+const isAllSelected = ref(false); // 全选状态
+const isExpanded = ref(false); // 展开状态
+const isCheckStrictly = ref(true); // 父子联动状态
+const expandedKeys = ref<number[]>([]); // 展开的节点
+
+const [Form, formApi] = useVbenForm({
+  commonConfig: {
+    componentProps: {
+      class: 'w-full',
+    },
+    formItemClass: 'col-span-2',
+    labelWidth: 80,
+  },
+  layout: 'horizontal',
+  schema: useAssignDataPermissionFormSchema(),
+  showDefaultActions: false,
+});
+
+const [Modal, modalApi] = useVbenModal({
+  async onConfirm() {
+    const { valid } = await formApi.validate();
+    if (!valid) {
+      return;
+    }
+    modalApi.lock();
+    const data = await formApi.getValues();
+    try {
+      await assignRoleDataScope({
+        roleId: data.id,
+        dataScope: data.dataScope,
+        dataScopeDeptIds:
+          data.dataScope === SystemDataScopeEnum.DEPT_CUSTOM
+            ? data.dataScopeDeptIds
+            : undefined,
+      });
+      await modalApi.close();
+      emit('success');
+      ElMessage.success($t('ui.actionMessage.operationSuccess'));
+    } finally {
+      modalApi.unlock();
+    }
+  },
+  async onOpenChange(isOpen: boolean) {
+    if (!isOpen) {
+      return;
+    }
+    const data = modalApi.getData<SystemRoleApi.Role>();
+    if (!data || !data.id) {
+      return;
+    }
+    modalApi.lock();
+    try {
+      await formApi.setValues(await getRole(data.id as number));
+
+      // 加载部门列表
+      await loadDeptTree();
+      toggleExpandAll();
+    } finally {
+      modalApi.unlock();
+    }
+  },
+});
+
+/** 加载部门树 */
+async function loadDeptTree() {
+  deptLoading.value = true;
+  try {
+    const data = await getDeptList();
+    deptTree.value = handleTree(data) as SystemDeptApi.Dept[];
+  } finally {
+    deptLoading.value = false;
+  }
+}
+
+/** 全选/全不选 */
+function toggleSelectAll() {
+  isAllSelected.value = !isAllSelected.value;
+  if (isAllSelected.value) {
+    const allIds = getAllNodeIds(deptTree.value);
+    formApi.setFieldValue('dataScopeDeptIds', allIds);
+  } else {
+    formApi.setFieldValue('dataScopeDeptIds', []);
+  }
+}
+
+/** 展开/折叠所有节点 */
+function toggleExpandAll() {
+  isExpanded.value = !isExpanded.value;
+  // 获取所有节点的 ID
+  expandedKeys.value = isExpanded.value ? getAllNodeIds(deptTree.value) : [];
+}
+
+/** 切换父子联动 */
+function toggleCheckStrictly() {
+  isCheckStrictly.value = !isCheckStrictly.value;
+}
+
+/** 递归获取所有节点 ID */
+function getAllNodeIds(nodes: any[], ids: number[] = []): number[] {
+  nodes.forEach((node: any) => {
+    ids.push(node.id);
+    if (node.children && node.children.length > 0) {
+      getAllNodeIds(node.children, ids);
+    }
+  });
+  return ids;
+}
+</script>
+
+<template>
+  <Modal title="数据权限" class="w-[40%]">
+    <Form class="mx-4">
+      <template #dataScopeDeptIds="slotProps">
+        <!-- <Spin :spinning="deptLoading"> -->
+        <!-- TODO @芋艿：可优化，使用 antd 的 tree？原因是，更原生 -->
+        <VbenTree
+          :tree-data="deptTree"
+          multiple
+          bordered
+          :expanded="expandedKeys"
+          v-bind="slotProps"
+          value-field="id"
+          label-field="name"
+          :auto-check-parent="false"
+          :check-strictly="!isCheckStrictly"
+        />
+        <!-- </Spin> -->
+      </template>
+    </Form>
+    <template #prepend-footer>
+      <div class="flex flex-auto items-center">
+        <ElCheckbox :model-value="isAllSelected" @change="toggleSelectAll">
+          全选
+        </ElCheckbox>
+        <ElCheckbox :model-value="isExpanded" @change="toggleExpandAll">
+          全部展开
+        </ElCheckbox>
+        <ElCheckbox
+          :model-value="isCheckStrictly"
+          @change="toggleCheckStrictly"
+        >
+          父子联动
+        </ElCheckbox>
+      </div>
+    </template>
+  </Modal>
+</template>

apps/web-ele/src/views/system/role/modules/assign-menu-form.vue

@@ -0,0 +1,155 @@
+<script lang="ts" setup>
+import type { SystemDeptApi } from '#/api/system/dept';
+import type { SystemRoleApi } from '#/api/system/role';
+
+import { ref } from 'vue';
+
+import { useVbenModal, VbenTree } from '@vben/common-ui';
+import { handleTree } from '@vben/utils';
+
+import { ElCheckbox, ElMessage } from 'element-plus';
+
+import { useVbenForm } from '#/adapter/form';
+import { getMenuList } from '#/api/system/menu';
+import { assignRoleMenu, getRoleMenuList } from '#/api/system/permission';
+import { $t } from '#/locales';
+
+import { useAssignMenuFormSchema } from '../data';
+
+const emit = defineEmits(['success']);
+
+const menuTree = ref<SystemDeptApi.Dept[]>([]); // 菜单树
+const menuLoading = ref(false); // 加载菜单列表
+const isAllSelected = ref(false); // 全选状态
+const isExpanded = ref(false); // 展开状态
+const expandedKeys = ref<number[]>([]); // 展开的节点
+
+const [Form, formApi] = useVbenForm({
+  commonConfig: {
+    componentProps: {
+      class: 'w-full',
+    },
+    formItemClass: 'col-span-2',
+    labelWidth: 80,
+  },
+  layout: 'horizontal',
+  schema: useAssignMenuFormSchema(),
+  showDefaultActions: false,
+});
+
+const [Modal, modalApi] = useVbenModal({
+  async onConfirm() {
+    const { valid } = await formApi.validate();
+    if (!valid) {
+      return;
+    }
+    modalApi.lock();
+    // 提交表单
+    const data = await formApi.getValues();
+    try {
+      await assignRoleMenu({
+        roleId: data.id,
+        menuIds: data.menuIds,
+      });
+      // 关闭并提示
+      await modalApi.close();
+      emit('success');
+      ElMessage.success($t('ui.actionMessage.operationSuccess'));
+    } finally {
+      modalApi.unlock();
+    }
+  },
+  async onOpenChange(isOpen: boolean) {
+    if (!isOpen) {
+      return;
+    }
+    const data = modalApi.getData<SystemRoleApi.Role>();
+    if (!data || !data.id) {
+      return;
+    }
+    modalApi.lock();
+    try {
+      await formApi.setValues(data);
+
+      // 加载角色菜单
+      const menuIds = await getRoleMenuList(data.id as number);
+      await formApi.setFieldValue('menuIds', menuIds);
+      // 加载菜单列表
+      await loadMenuTree();
+    } finally {
+      modalApi.unlock();
+    }
+  },
+});
+
+/** 加载菜单树 */
+async function loadMenuTree() {
+  menuLoading.value = true;
+  try {
+    const data = await getMenuList();
+    menuTree.value = handleTree(data) as SystemDeptApi.Dept[];
+  } finally {
+    menuLoading.value = false;
+  }
+}
+
+/** 全选/全不选 */
+function toggleSelectAll() {
+  isAllSelected.value = !isAllSelected.value;
+  if (isAllSelected.value) {
+    const allIds = getAllNodeIds(menuTree.value);
+    formApi.setFieldValue('menuIds', allIds);
+  } else {
+    formApi.setFieldValue('menuIds', []);
+  }
+}
+
+/** 展开/折叠所有节点 */
+function toggleExpandAll() {
+  isExpanded.value = !isExpanded.value;
+  // 获取所有节点的 ID
+  expandedKeys.value = isExpanded.value ? getAllNodeIds(menuTree.value) : [];
+}
+
+/** 递归获取所有节点 ID */
+function getAllNodeIds(nodes: any[], ids: number[] = []): number[] {
+  nodes.forEach((node: any) => {
+    ids.push(node.id);
+    if (node.children && node.children.length > 0) {
+      getAllNodeIds(node.children, ids);
+    }
+  });
+  return ids;
+}
+</script>
+
+<template>
+  <Modal title="数据权限" class="w-[40%]">
+    <Form class="mx-4">
+      <template #menuIds="slotProps">
+        <!-- <Spin :spinning="menuLoading" class="w-full"> -->
+        <!-- TODO @芋艿：可优化，使用 antd 的 tree？原因是，更原生 -->
+        <VbenTree
+          :tree-data="menuTree"
+          multiple
+          bordered
+          :expanded="expandedKeys"
+          v-bind="slotProps"
+          value-field="id"
+          label-field="name"
+        />
+        <!-- </Spin> -->
+      </template>
+    </Form>
+    <template #prepend-footer>
+      <div class="flex flex-auto items-center">
+        <ElCheckbox :model-value="isAllSelected" @change="toggleSelectAll">
+          全选
+        </ElCheckbox>
+        <ElCheckbox :model-value="isExpanded" @change="toggleExpandAll">
+          全部展开
+        </ElCheckbox>
+      </div>
+    </template>
+  </Modal>
+</template>

apps/web-ele/src/views/system/role/modules/form.vue

@@ -0,0 +1,82 @@
+<script lang="ts" setup>
+import type { SystemRoleApi } from '#/api/system/role';
+
+import { computed, ref } from 'vue';
+
+import { useVbenModal } from '@vben/common-ui';
+
+import { ElMessage } from 'element-plus';
+
+import { useVbenForm } from '#/adapter/form';
+import { createRole, getRole, updateRole } from '#/api/system/role';
+import { $t } from '#/locales';
+
+import { useFormSchema } from '../data';
+
+const emit = defineEmits(['success']);
+const formData = ref<SystemRoleApi.Role>();
+const getTitle = computed(() => {
+  return formData.value?.id
+    ? $t('ui.actionTitle.edit', ['角色'])
+    : $t('ui.actionTitle.create', ['角色']);
+});
+
+const [Form, formApi] = useVbenForm({
+  commonConfig: {
+    componentProps: {
+      class: 'w-full',
+    },
+    formItemClass: 'col-span-2',
+    labelWidth: 80,
+  },
+  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 SystemRoleApi.Role;
+    try {
+      await (formData.value?.id ? updateRole(data) : createRole(data));
+      // 关闭并提示
+      await modalApi.close();
+      emit('success');
+      ElMessage.success($t('ui.actionMessage.operationSuccess'));
+    } finally {
+      modalApi.unlock();
+    }
+  },
+  async onOpenChange(isOpen: boolean) {
+    if (!isOpen) {
+      formData.value = undefined;
+      return;
+    }
+    // 加载数据
+    const data = modalApi.getData<SystemRoleApi.Role>();
+    if (!data || !data.id) {
+      return;
+    }
+    modalApi.lock();
+    try {
+      formData.value = await getRole(data.id as number);
+      // 设置到 values
+      await formApi.setValues(formData.value);
+    } finally {
+      modalApi.unlock();
+    }
+  },
+});
+</script>
+
+<template>
+  <Modal :title="getTitle">
+    <Form class="mx-4" />
+  </Modal>
+</template>