小蚂蚁云

Appearance

Become a sponsor
企业级中台解决方案
企业级中台解决方案

前端页面视图 ​

前端页面视图是用户直接交互的界面。项目使用 Vue3 + NaiveUI + Vite 构建。一个完整的 CRUD 页面由 4 个文件组成：

ui/src/views/system/position/
├── index.vue          # 主页面：搜索 + 表格 + 操作
├── edit.vue           # 编辑弹窗：新增/编辑表单
├── columns.ts         # 表格列定义
└── querySchemas.ts    # 搜索表单 Schema

1. 主页面 index.vue ​

主页面是模块的入口页面，包含搜索表单、数据表格和操作按钮。

完整代码 ​

vue
<template>
  <div>
    <n-card :bordered="false" class="pt-3 mb-3 proCard">
      <BasicForm @register="register" @submit="handleSubmit" @reset="handleReset" />
    </n-card>
    <n-card :bordered="false" class="proCard">
      <BasicTable
        :columns="columns"
        :request="loadDataTable"
        :row-key="(row) => row.id"
        ref="basicTableRef"
        :actionColumn="actionColumn"
        @update:checked-row-keys="onCheckedRow"
        :autoScrollX="true"
      >
        <template #tableTitle>
          <n-space>
            <n-button type="primary" @click="handleAdd" v-perm="['sys:position:add']">
              <template #icon><n-icon><PlusOutlined /></n-icon></template>
              新建
            </n-button>
            <n-button
              type="error"
              @click="handleDelete"
              :disabled="!rowKeys.length"
              v-perm="['sys:position:batchDelete']"
            >
              <template #icon><n-icon><DeleteOutlined /></n-icon></template>
              删除
            </n-button>
          </n-space>
        </template>
      </BasicTable>
    </n-card>
    <editDialog
      ref="createModalRef"
      :positionId="positionId"
      v-if="editVisible"
      v-model:visible="editVisible"
      @success="reloadTable('noRefresh')"
    />
  </div>
</template>

<script lang="ts" setup>
  import { h, nextTick, reactive, ref } from 'vue';
  import { useMessage, useDialog } from 'naive-ui';
  import { TableAction } from '@/components/Table';
  import { BasicForm, useForm } from '@/components/Form/index';
  import { getPositionList, positionDelete, positionBatchDelete } from '@/api/system/position';
  import { columns } from './columns';
  import { PlusOutlined, DeleteOutlined, FormOutlined } from '@vicons/antd';
  import editDialog from './edit.vue';
  import { schemas } from './querySchemas';
  import { renderIcon } from '@/utils';

  const message = useMessage();
  const dialog = useDialog();
  const basicTableRef = ref();
  const createModalRef = ref();
  const editVisible = ref(false);
  const positionId = ref(0);
  const rowKeys = ref([]);

  const formParams = reactive({ name: '', status: '' });

  const actionColumn = reactive({
    width: 200,
    title: '操作',
    align: 'center',
    key: 'action',
    fixed: 'right',
    render(record) {
      return h(TableAction as any, {
        style: 'button',
        actions: [
          {
            label: '编辑',
            icon: renderIcon(FormOutlined),
            type: 'info',
            onClick: handleEdit.bind(null, record),
            auth: ['sys:position:update'],
          },
          {
            label: '删除',
            icon: renderIcon(DeleteOutlined),
            type: 'error',
            onClick: handleDelete.bind(null, record),
            auth: ['sys:position:delete'],
          },
        ],
      });
    },
  });

  const loadDataTable = async (res) => {
    rowKeys.value = [];
    const result = await getPositionList({ ...formParams, ...res });
    return result;
  };

  function onCheckedRow(keys) {
    rowKeys.value = keys;
  }

  function reloadTable(noRefresh = '') {
    basicTableRef.value.reload(noRefresh ? {} : { pageNo: 1 });
  }

  function handleSubmit(values: Recordable) {
    for (const key in formParams) { formParams[key] = ''; }
    for (const key in values) { formParams[key] = values[key]; }
    reloadTable();
  }

  function handleReset(values: Recordable) {
    for (const key in formParams) { formParams[key] = ''; }
    for (const key in values) { formParams[key] = values[key]; }
    reloadTable();
  }

  const [register, {}] = useForm({
    gridProps: { cols: '1 s:1 m:2 l:3 xl:4 2xl:4' },
    labelWidth: 80,
    schemas,
  });

  const handleAdd = async () => {
    positionId.value = 0;
    editVisible.value = true;
    await nextTick();
    createModalRef.value.openModal();
  };

  async function handleEdit(record) {
    positionId.value = record.id;
    editVisible.value = true;
    await nextTick();
    createModalRef.value.openModal();
  }

  async function handleDelete(record) {
    dialog.warning({
      title: '提示',
      content: '确定要删除？',
      positiveText: '确定',
      negativeText: '取消',
      onPositiveClick: async () => {
        record?.id ? await positionDelete(record.id) : await positionBatchDelete(rowKeys.value);
        message.success('删除成功');
        reloadTable();
      },
    });
  }
</script>

代码解析 ​

页面结构：div 包裹两个 n-card，上方是搜索表单，下方是数据表格。

搜索表单：通过 useForm 注册，Schema 从 querySchemas.ts 导入。submitOnReset: true 表示重置时自动触发查询。

数据表格：通过 BasicTable 组件渲染，request 属性绑定数据加载函数，columns 从 columns.ts 导入。

操作栏：通过 actionColumn 的 render 函数使用 h() 渲染 TableAction，支持权限控制（auth）。图标使用 renderIcon 工具函数渲染 @vicons/antd 图标。

编辑弹窗：使用 defineAsyncComponent 懒加载 edit.vue，通过 v-model:visible 控制显示，positionId 传入编辑记录 ID（0 表示新增）。

删除逻辑：使用 NaiveUI 的 useDialog 显示确认弹窗，单条删除传入 record，批量删除从 rowKeys 取已选 ID。

2. 编辑弹窗 edit.vue ​

编辑弹窗是独立组件，负责新增和编辑操作的表单展示与提交。

完整代码 ​

vue
<template>
  <basicModal
    @register="modalRegister"
    ref="modalRef"
    class="basicModal basicFormModal"
    @on-ok="handleSubmit"
    @on-close="handleClose"
  >
    <template #default>
      <n-form class="ls-form" ref="formRef" :model="formData" label-placement="left" label-width="85px">
        <n-form-item
          label="岗位名称"
          path="name"
          :rule="{ required: true, message: '请输入岗位名称', trigger: 'blur' }"
        >
          <n-input v-model:value="formData.name" placeholder="请输入岗位名称" clearable />
        </n-form-item>
        <n-form-item label="岗位状态" path="status">
          <n-radio-group v-model:value="formData.status" name="status">
            <n-radio :value="1">正常</n-radio>
            <n-radio :value="2">停用</n-radio>
          </n-radio-group>
        </n-form-item>
        <n-form-item label="排序" path="sort">
          <n-input-number v-model:value="formData.sort" />
        </n-form-item>
      </n-form>
    </template>
  </basicModal>
</template>

<script lang="ts" setup>
  import { getPositionDetail, positionAdd, positionUpdate } from '@/api/system/position';
  import { onMounted, reactive, ref } from 'vue';
  import { useMessage } from 'naive-ui';
  import { useModal } from '@/components/Modal';

  const emit = defineEmits(['success', 'update:visible']);
  const formRef = ref();
  const message = useMessage();

  const formData = reactive({ id: '', name: '', status: 1, sort: 0 });

  const props = defineProps({
    visible: { type: Boolean, required: true, default: false },
    positionId: { type: Number, required: true, default: 0 },
  });

  const [modalRegister, { openModal, setSubLoading }] = useModal({
    title: props.positionId ? '编辑岗位' : '添加岗位',
    subBtuText: '确定',
    width: 600,
  });

  const handleSubmit = async () => {
    formRef.value
      .validate()
      .then(async () => {
        props.positionId ? await positionUpdate(formData) : await positionAdd(formData);
        message.success('操作成功');
        setSubLoading(false);
        emit('update:visible', false);
        emit('success');
      })
      .catch(() => {
        setSubLoading(false);
      });
  };

  const handleClose = () => {
    emit('update:visible', false);
  };

  const setFormData = async () => {
    const data = await getPositionDetail(props.positionId);
    for (const key in formData) {
      if (data[key] != null && data[key] != undefined) {
        formData[key] = data[key];
      }
    }
  };

  onMounted(() => {
    if (props.positionId) setFormData();
  });

  defineExpose({ openModal });
</script>

代码解析 ​

Props 接收：

  • visible：控制弹窗显示/隐藏，通过 v-model:visible 双向绑定
  • positionId：编辑记录的 ID，为 0 时表示新增模式

表单数据：使用 reactive 定义，字段与后端 Schema 对应。

新增/编辑判断：props.positionId ? positionUpdate : positionAdd，通过 ID 是否为 0 区分。

防重复提交：useModal 提供 setSubLoading 控制提交按钮 loading 状态。

数据回填：onMounted 时判断如果是编辑模式，调用 getPositionDetail 获取数据并填充表单。

事件通信：

  • emit('update:visible', false)：关闭弹窗
  • emit('success')：通知父页面刷新表格

3. 表格列定义 columns.ts ​

定义表格的列配置，包括列名、字段名、宽度和自定义渲染。

完整代码 ​

typescript
import { h } from 'vue';
import { NTag } from 'naive-ui';

export const columns = [
  {
    type: 'selection',
    width: 50,
    fixed: 'left',
  },
  {
    title: 'ID',
    key: 'id',
    fixed: 'left',
    width: 50,
  },
  {
    title: '岗位名称',
    key: 'name',
    width: 100,
  },
  {
    title: '岗位状态',
    key: 'status',
    width: 100,
    render(record) {
      return h(
        NTag,
        {
          style: { marginRight: '6px' },
          bordered: false,
          type: record.status == 1 ? 'success' : 'error',
        },
        { default: () => (record.status == 1 ? '正常' : '停用') },
      );
    },
  },
  {
    title: '排序',
    key: 'sort',
    width: 100,
  },
  {
    title: '创建人',
    key: 'createUser',
    width: 100,
  },
  {
    title: '创建时间',
    key: 'createTime',
    width: 180,
  },
];

代码解析 ​

选择列：type: 'selection' 自动添加复选框列，配合 @update:checked-row-keys 事件实现批量选择。

固定列：fixed: 'left' 固定在左侧，fixed: 'right' 固定在右侧（操作列）。

自定义渲染：render(record) 使用 Vue 的 h() 函数创建虚拟 DOM。render 函数直接接收行数据对象，通过 record.key 访问字段值（如 record.status）。状态列将 1/2 渲染为绿色/红色标签。

宽度设置：

  • width：固定宽度
  • minWidth：最小宽度，可自适应拉伸

4. 搜索表单 querySchemas.ts ​

定义搜索表单的字段配置，使用项目封装的 FormSchema 类型。

完整代码 ​

typescript
import { FormSchema } from '@/components/Form/index';
export const schemas: FormSchema[] = [
  {
    field: 'name',
    component: 'NInput',
    label: '岗位名称',
    componentProps: {
      placeholder: '请输入岗位名称',
    },
  },
  {
    field: 'status',
    component: 'NSelect',
    label: '状态',
    componentProps: {
      placeholder: '请选择状态',
      clearable: true,
      options: [
        { label: '正常', value: '1' },
        { label: '禁用', value: '2' },
      ],
    },
  },
];

代码解析 ​

FormSchema 字段：

字段说明
field字段名，与后端查询参数对应
component表单组件类型：NInput / NSelect / NDatePicker 等
label标签文本
componentProps组件属性，透传给 NaiveUI 组件

Select 组件：options 定义下拉选项，clearable: true 允许清空选择。

文件关系图 ​

index.vue（主页面）
  ├── import schemas from './querySchemas'    ← 搜索表单配置
  ├── import columns from './columns'         ← 表格列配置
  ├── import editDialog from './edit.vue'     ← 编辑弹窗组件
  └── import API from '@/api/system/position' ← 接口请求

edit.vue（编辑弹窗）
  └── import API from '@/api/system/position' ← 接口请求

开发要点 ​

  1. 一个模块一个目录：放在 ui/src/views/{group}/{module}/ 下
  2. 4 个文件各司其职：主页面、编辑弹窗、列定义、搜索 Schema
  3. 编辑弹窗是独立组件：通过 Props 接收 ID，通过 Emit 通知父页面
  4. 列定义使用 h() 渲染复杂内容：如状态标签、操作按钮
  5. 搜索 Schema 使用 FormSchema 类型：配置化定义表单字段
  6. 新增/编辑通过 positionId 区分：0 为新增，非 0 为编辑
  7. 删除使用 useDialog 确认弹窗：NaiveUI 命令式对话框

总结 ​

前端页面统一使用 n-card + BasicForm + BasicTable + TableAction 四件套，分页由 BasicTable 内置处理。每个模块包含 index.vue（列表页）、edit.vue（编辑弹窗）、columns.ts（列定义）、querySchemas.ts（搜索配置）四个文件。

小蚂蚁云团队 · 提供技术支持

Copyright © 2021~2026 www.djangoadmin.cn. All rights reserved.