CRUD 代码生成

XYGo Admin 2025-02-20 292 次阅读

使用内置代码生成器快速创建完整的增删改查功能

CRUD 代码生成

代码生成器是 XYGo Admin 的核心功能之一,可以从数据库表一键生成完整的前后端 CRUD 代码。

功能概览

  • 📋 表选择:从数据库中选择已有表
  • 🎨 建表设计器:可视化设计新表结构
  • ⚙️ 字段配置:配置每个字段的展示方式、验证规则
  • 👁️ 代码预览:生成前预览所有代码文件
  • 🚀 一键生成:自动生成并注册到项目中

使用步骤

第一步:进入代码生成器

在后台管理系统中,导航到 开发工具 → 代码生成

第二步:选择或创建表

方式一:选择已有表

点击「选择数据表」,从下拉列表中选择要生成代码的表。系统会自动读取表结构和字段信息。

方式二:可视化建表

点击「新建表」,打开建表设计器:

  • 设置表名、表注释
  • 添加字段,配置字段名、类型、长度、默认值、注释
  • 设置索引
  • 点击「创建」,系统会自动执行 DDL 并同步字段

第三步:配置字段

系统会智能推断每个字段的展示类型(designType),你也可以手动调整:

展示类型 说明 适用场景
input 文本输入框 普通文本字段
textarea 多行文本 备注、描述
number 数字输入 数量、金额
select 下拉选择 状态、类型
switch 开关 是/否字段
date 日期选择 日期字段
timestamp 时间戳 created_at 等
editor 富文本编辑器 内容字段
image 图片上传 头像、封面
remoteSelect 远程搜索选择 关联表字段

第四步:预览与生成

点击「预览」可以查看将要生成的所有文件:

后端文件:

  • api/admin/xxx.go — API 接口定义
  • controller/admin/xxx.go — 控制器
  • model/input/adminin/xxx.go — 输入/输出结构体
  • logic/xxx/xxx.go — 业务逻辑

前端文件:

  • api/backend/xxx.ts — API 请求
  • views/backend/xxx/index.vue — 列表页
  • views/backend/xxx/modules/xxx-dialog.vue — 编辑弹窗

其他:

  • 菜单 SQL — 自动插入菜单和权限数据
  • logic.go — 自动注册 Logic 导入

确认无误后点击「生成」,代码会自动写入项目目录。

第五步:重启服务

bash 复制代码
# 生成 DAO
gf gen dao

# 生成 Service
gf gen service

# 重启后端
gf run main.go

前端代码会在「发布前端」操作后写入 web/src/ 目录,热更新会自动生效。

高级功能

树表支持

如果表中包含 parent_id 字段,生成器会自动识别为树形结构,生成树表相关代码。

字段同步

当你修改了数据库表结构后,可以使用「同步字段」功能,系统会对比差异并提示 ADD / DROP / MODIFY 操作。

关联表

支持配置关联表查询,在列表和表单中展示关联数据。