设计器使用指南

掌握可视化设计器的使用方法，高效完成数据模型设计。

界面概览

设计器界面分为四个主要区域：

顶部工具栏

包含操作按钮：返回、添加实体、示例模板、SQL导入、视图切换、保存、生成代码等

中央画布

可视化建模区域，可拖拽实体、创建关系、缩放平移

右侧属性面板

选中实体后显示，用于编辑实体属性、字段、显示配置等

YAML编辑器

分屏或纯YAML视图中显示，可直接编辑YAML代码

基本操作

添加实体

点击工具栏添加实体按钮
在弹出的对话框中输入实体名称（英文，大驼峰命名）
点击确定，实体卡片出现在画布中央

命名规范

实体名称建议使用大驼峰命名法（PascalCase），如：User、Order、ProductCategory。系统会自动生成对应的表名（如 t_user、t_order）。

编辑实体

在画布中点击实体卡片选中
右侧显示属性编辑面板
在面板中编辑：
- 基本信息：名称、表名、描述
- 字段列表：添加/编辑/删除字段
- 显示配置：表格、表单、搜索等
- 功能配置：CRUD、分页、导出等

添加字段

选中实体后，切换到"字段"标签页
点击添加字段按钮
填写字段信息：
- 字段名：英文，小驼峰命名（如 userName、createdAt）
- 类型：选择数据类型
- 描述：字段的中文说明
- 必填：是否为必填字段

创建实体关系

在可视化视图中，将鼠标移到源实体边缘的连接点
按住鼠标拖拽到目标实体
释放后选择关系类型：
- OneToOne：一对一关系
- OneToMany：一对多关系
- ManyToOne：多对一关系
- ManyToMany：多对多关系

字段类型详解

类型	Java类型	数据库类型	说明
`string`	String	VARCHAR(255)	普通字符串，可指定长度
`text`	String	TEXT	长文本，无长度限制
`integer`	Integer	INT	32位整数
`long`	Long	BIGINT	64位长整数
`decimal`	BigDecimal	DECIMAL(10,2)	精确小数，用于金额等
`boolean`	Boolean	TINYINT(1)	布尔值
`date`	LocalDate	DATE	日期（不含时间）
`datetime`	LocalDateTime	DATETIME	日期时间
`enum`	String/Enum	VARCHAR	枚举类型

显示配置 (displayConfig)

displayConfig 用于控制字段在不同场景下的显示行为：

配置项	说明	示例
`table`	列表表格显示的字段	["name", "status", "createdAt"]
`form`	表单编辑的字段	["name", "description", "price"]
`search`	搜索条件字段	["name", "status"]
`detail`	详情页显示字段	["*"] 表示全部
`export`	导出包含的字段	["id", "name", "amount"]
`import`	导入需要的字段	["name", "price", "stock"]

功能配置 (featureConfig)

featureConfig 用于控制生成的功能模块：

配置项	说明	默认值
`crud`	增删改查功能	true
`search`	搜索功能	true
`pagination`	分页功能	true
`sorting`	排序功能	true
`batch`	批量操作	false
`export`	导出功能	false
`import`	导入功能	false
`audit`	审计日志	false
`versioning`	版本控制	false
`authorization`	权限控制	false

视图模式

设计器支持三种视图模式，可在工具栏中间切换：

可视化视图

纯图形化操作，拖拽实体和关系线，适合快速建模

分屏视图

左侧画布 + 右侧YAML编辑器，双向同步，适合精细调整

YAML视图

纯代码编辑，适合熟悉YAML语法的高级用户

快捷操作

画布操作

Ctrl + 滚轮 - 缩放画布
空格 + 拖拽 - 平移画布
点击空白处 - 取消选中
拖拽实体 - 移动位置

工具栏按钮

+ / - 按钮 - 放大/缩小
适配按钮 - 自动调整视图以显示所有实体

下一步

代码生成说明了解生成的代码内容

本页目录