可视化代码生成平台(低代码)使用文档
适用于:带后台管理端的业务系统 · 可视化页面生成器 · 仅供后台管理员使用
一句话定位:它是内置在后台的「可视化页面生成器」。运营/开发在浏览器里拖一拖、填一填,就能生成一套标准的后台管理页(列表 + 表单 + 增删改查),无需打开外部编辑器、无需手写控制器和模板,页面定义存数据库、由通用引擎运行时渲染,可随时改、随时发布。
一、作用(为什么需要它)
业务系统里大量同质化的管理页——会员、订单、商品、财务、工单、文章/知识库……它们的形态几乎都是「一张表 + 列表 + 表单 + 增删改查」。代码生成工具把这种「页面」抽象成元数据:
t_codegen_page —— 页面定义;
t_codegen_field —— 字段定义。
二、核心优点
零代码上手 拖拽控件 + 属性面板配置,浏览器内完成页面搭建。
元数据驱动 页面与字段全部存库,改定义即改页面。
自动建表/加字段 发布时自动 CREATE TABLE,后续新增字段 ALTER ADD COLUMN。
通用 CRUD 引擎 列表/搜索/分页/字典翻译/多选标签/增改删统一处理。
版本快照与回滚 每次发布前自动快照,可一键回到任意历史版本。
可编辑列表 列表内新增/双击编辑/行内删除,底部统一保存。
导航自动挂载 发布后菜单自动挂到后台左侧(菜单数据源独立维护)。
权限隔离 仅特定管理员角色可访问,普通账号被拦截。
三、功能清单
3.1 已落地能力(基础阶段完成)
| 模块 | 能力 | 说明 |
| 路由兜底 | 四级解析 | 物理控制器→模板→引擎页→占位页,新增导航不再 404。 |
| 导航体系 | 数据库化 | 统一由菜单数据表驱动。 |
| 运行时引擎 | 自动列表/搜索/分页/字典翻译 | 引擎按元数据渲染。 |
| 通用保存 | 校验+增改删/批量删 | 字段白名单+系统字段保护。 |
| 发布联动 | 建表/加字段 | CREATE TABLE / ALTER ADD COLUMN(只增不删)。 |
| 可视化编辑器 | 三栏编辑 | 左控件库/中画布/右属性面板。 |
| 编辑器交互 | 拖拽排序/实时属性编辑 | 纯前端无 Ajax,保存草稿/发布并建表。 |
| 字段安全 | 停用不删列/路径/表名锁定 | 已发布页面路径与表名不可改。 |
3.2 增强能力(进阶阶段)
| 能力 | 状态 | 说明 |
| 历史版本与一键回滚 | ✅ 已落地 | 快照到版本表。 |
| 系统字段自动写入 | ✅ 已落地 | 主键/排序/启用/创建/修改时间自动进定义。 |
| 列表内启用/停用 | ✅ 已落地 | 0/1 字段无需进编辑页即可切换。 |
| 可编辑列表 | ✅ 已落地 | 列表内增行/双击编辑/行内删除,底部保存。 |
| 关联表取值(ref 字典) | 已可用 | ref:表名,id列,名称列,跨表下拉。 |
| 字段联动/简单公式 | 规划中 | 条件组合/联动运算控件已存在,业务联动待完善。 |
| 一键导出物理文件 | 规划中 | 导出控制器+模板物理文件。 |
3.3 控件库
- 基础输入:单行/多行文本、数字、开关、颜色、密码/密钥;
- 选择项:select、单选、多选(支持 ref 关联或 值=标签 字典);
- 日期时间:日期、日期时间;
- 富文本/地区:富文本、行政区划;
- 资源:图片、多图、视频、附件、远程资源;
- 高级:标签、滑块、评分、图标、只读、随机、导航菜单、分隔线;
- 多行数据:键值对、多行表格;
- 逻辑/价格:条件组合、联动运算、价格矩阵。
字典写法:静态 — 1=启用\n0=不启用;关联表 — ref:t_demo_category,id,name。
四、典型使用流程
1 进工具:后台「系统→开发工具→代码生成」(仅授权角色)。
3 配置字段:拖入控件,设字段名/类型/控件/字典/必填等。
5 发布并建表:upsert 定义 + CREATE/ALTER + 菜单挂载 + 快照。
6 使用:左侧菜单进入,增删改查即用,可随时重发(带回滚)。
五、用本工具产出的示例模块
| 页面 | 示例表 | 菜单 |
| 客户管理 | t_demo_customer | 客户中心→客户管理 |
| 商品分类 | t_demo_category | 商品中心→商品分类 |
| 商品管理 | t_demo_goods | 商品中心→商品管理 |
| 订单管理 | t_demo_order | 交易→订单管理 |
| 文章管理 | t_demo_article | 内容→文章管理 |
注:以上表名(t_demo_*)仅为文档示例,实际使用时由你在「新建页面」时自定义业务表名。
六、适用与不适用
✅ 适合
- 标准后台管理页(列表+表单+增删改查);
- 业务表稳定、键值型字段;
- 需快速搭建或频繁小改;
- 运营自助配置。
⚠️ 不适合(应手写)
- 强业务逻辑流程(支付/开通/计费);
- 复杂事务/跨表计算/外部 API 编排;
- 前台营销页(SEO/SSR)或会员中心定制页;
- 极致性能聚合报表。
七、访问与安全
- 入口:
/admin/codegen;页面运行在 /admin/<path>。
- 权限:仅指定角色可访问,普通账号 403。
- 导航数据源:统一菜单数据表。
八、技术结构速查(通用视角)
| 对象 | 职责 |
| 构建器入口 | 工具首页/路线图/权限校验 |
| 页面渲染引擎 | 运行时读取元数据渲染列表/表单/保存 |
| 页面管理模块 | 页面定义 CRUD/字段编辑 |
| 字段/控件服务 | 控件清单/字典解析/系统字段 |
| 可视化编辑器前端 | 三栏拖拽编辑器(控件库/画布/属性面板) |
| 元数据表 | 页面定义表/字段定义表(如 t_codegen_page / t_codegen_field) |
| 版本快照表 | 发布快照(如 t_codegen_rev),支撑回滚 |
注意:改定义=改页面;导出物理文件能力规划中;已发布页面 路径/表名 锁定。
|