先说结论:
这是系列第七篇,也是核心操作的收尾篇。完成表格创建、字段配置、方法配置后,在插件主界面即可执行最终的代码生成操作。本文会拆解主界面的三大功能区域,逐一说明左侧导航、顶部工具栏与表格操作按钮的用途,帮你快速上手完整的生成流程。
执行代码生成的核心操作:
需点击顶部工具栏的「生成 Admin 代码」按钮(对应界面标注数字 16)。
点击 查看小泽代码在线演示
界面整体概览
插件主界面整体分为三大功能区域,界面标注数字对应不同功能入口:
- 左侧导航菜单区:对应数字 1-8,是插件全部功能模块的总入口
- 顶部工具栏区:对应数字 9-18,提供批量操作与代码生成的快捷按钮
- 表格操作列:对应数字 19-21,针对单条表配置提供精细化操作入口
一、左侧导航菜单区(数字 1-8)
左侧导航按业务模块划分功能边界,当前默认停留在「CURD 表格」模块(数字 1,蓝色高亮状态),各模块说明如下:
1. CURD 表格(数字 1)
插件的核心主页面,集中管理所有通过插件创建的数据表配置,可查看表结构、控制器信息、生成状态,支持批量或单条执行代码生成。所有与数据表绑定的 CURD 配置、生成记录都在此页面维护。
2. 控件类型(数字 2)
可配置代码生成时前端表单、列表的控件类型模板,例如文本框、下拉框、日期选择器、富文本编辑器等控件的渲染规则与默认属性。配置完成后,生成表单页面时会自动套用对应规则,减少重复修改模板的工作量。
3. 方法类型(数字 3)
用于自定义控制器的方法代码模板,可预设列表查询、详情、新增、编辑、删除、导出等常用业务方法的代码结构。生成控制器时会自动注入预设方法,减少重复编码的工作量。
4. 数据字典(数字 4)
管理项目全局数据字典,例如状态枚举、分类选项、固定码值映射等。配置后,在生成下拉框、单选框等控件时可直接绑定字典,自动生成选项列表,无需在多个页面重复配置相同选项。
5. 规则类型(数字 5)
配置表单验证、数据处理的规则模板,例如必填验证、长度限制、正则校验、数据脱敏规则等。给字段绑定验证规则时可直接复用预设配置,保障项目表单验证逻辑的统一规范。
6. 数据类型(数字 6)
定义数据库字段类型与 PHP、前端数据类型的映射关系,例如数据库 int 类型对应前端数字输入框、后端整数校验规则;也可自定义 JSON、时间戳、枚举等特殊数据类型的处理逻辑,适配复杂业务场景。
7. 颜色设置(数字 7)
自定义插件界面与生成代码的颜色主题,例如按钮配色、状态标签颜色、表格高亮色等,也可配置前端页面的默认配色风格,保持项目界面风格统一。
8. 回收站标题优先级配置(数字 8)
配置回收站模块中数据标题的显示优先级,例如删除数据后,回收站列表优先展示哪个字段作为标题,方便快速识别已删除数据,属于辅助管理功能。
二、顶部工具栏快捷按钮(数字 9-18)
CURD 表格列表顶部为批量操作与全局生成工具栏,支撑批量配置与代码生成流程,各按钮说明如下:
9. 添加(数字 9)
绿色加号图标,用于新建 CURD 配置。点击后可选择数据库已有数据表,或直接创建新表,配置表名、注释、控制器、菜单信息等,是新增业务模块的第一步。
10. 编辑(数字 10)
铅笔图标,勾选一条或多条配置后点击,可批量修改 CURD 配置信息,例如控制器名称、菜单名称、图标、生成规则等,无需逐一进入单条配置页面修改。
11. 删除(数字 11)
红色叉号图标,用于删除已有的 CURD 配置记录。
注意:该操作仅删除插件内的配置记录,不会自动删除已生成的代码文件与数据库表,清理文件需配合「移除生成文件」功能使用。
12. 移除生成文件(数字 12)
勾选配置后点击,可自动清理该配置已生成的控制器、模型、视图、接口等代码文件,方便重新生成或移除业务模块,减少冗余文件残留。
13. 代码生成日志(数字 13)
查看所有代码生成操作的历史记录,包含生成时间、操作人、生成结果等信息,方便排查生成失败、文件未更新、权限不足等问题。
14. SQL 生成(数字 14)
针对通过 SQL 创建的表配置,点击后可重新生成建表 SQL 语句,也可直接执行 SQL 同步到数据库,适合快速重建表结构、迁移表或批量初始化数据的场景。
注:SQL 生成相关功能仅高级授权版本支持
15. 数据表生成(数字 15)
从数据库同步数据表信息到插件中,自动读取表结构与字段信息,批量生成 CURD 配置,适合已有数据库表、快速搭建后台管理的场景,无需手动逐条配置表信息。
16. 生成 Admin 代码(数字 16)
蓝色背景按钮,勾选配置后点击,可批量生成后台管理端的核心代码,包含控制器、模型、视图、验证器、菜单配置等,生成后可对接后台框架使用。
17. 生成 Api 代码(数字 17)
生成 API 接口端代码,包含接口控制器、参数验证、返回格式配置等,适合前后端分离项目、提供数据接口的场景,生成的代码可对接前端应用、小程序或 H5 页面。
18. 生成 Api 文档(数字 18)
基于已生成的 API 代码自动生成接口文档,包含接口地址、请求参数、返回示例、说明注释等,方便前后端开发人员对接维护,减少沟通成本。
三、表格操作列核心按钮(数字 19-21)
表格每行末尾为单条配置的快捷操作按钮,三个核心按钮作用如下:
19. 字段(数字 19)
蓝色「字段」按钮,点击进入字段配置页面,可对当前数据表的每个字段做详细配置,例如显示名称、控件类型、验证规则、列表显隐、搜索条件、排序方式等,直接决定生成的表单与列表的交互效果。
20. 方法(数字 20)
绿色「方法」按钮,用于配置当前控制器需要生成的业务方法,例如列表查询、新增、编辑、删除、详情、导出等,可选择预设方法模板,也可添加自定义方法,生成控制器时会按配置生成对应代码。
21. API(数字 21)
蓝色「API」按钮,用于配置当前模块的 API 接口信息,例如接口路由、请求方式、权限验证、返回字段、响应码等,生成 API 代码与接口文档时会按配置生成对应逻辑,保障接口与后台配置一致。
至此,从创建表格、配置字段与方法,到最终生成代码的完整操作流程就介绍完毕。后续可以结合实际业务需求,在生成代码的基础上补充专属业务逻辑,完成项目开发。
演示地址:https://xzcurddemo.xiaozekeji.com/VRDJagoPKb.php 演示账号:demo / 123456
合规声明:本插件为基于 FastAdmin 框架的第三方插件,与 FastAdmin 官方无隶属、授权或认证关系;「小泽代码生成」为产品名称标识,尚未取得注册商标,不构成注册商标声明。