使用说明
启动方式
工具是一个独立的客户端程序(无需安装任何依赖),拿到可执行文件后直接运行即可。
Windows
双击 go-tool.exe(程序名以实际拿到为准)。启动后会弹出命令行窗口并开始运行,使用期间请保持窗口开启,关闭窗口即退出工具。
Linux / macOS
在终端中运行:
chmod +x go-tool # 首次使用先赋予执行权限(macOS)
./go-tool
修改端口与演示模式(可选)
程序同目录下有 config.yaml 配置文件,可按需修改:
server:
port: 8001 # 服务端口,默认 8001
打开控制台
启动成功后,用浏览器访问(端口以你的配置为准):
http://127.0.0.1:8001
快速上手
第一次使用建议按下面顺序操作,几分钟即可生成第一个模块:
创建项目
首页点击「创建」:选择技术栈(语言 / 框架 / 前端 UI),填写项目路径与项目名称(即代码要生成到哪个目录、叫什么名字),并选择一个数据库连接。
添加数据库连接
在「数据库管理」中录入 MySQL / PostgreSQL / MongoDB 的地址、账号与库名;库不存在时可勾选自动创建。保存时会自动校验能否连上。
创建应用
进入项目后创建应用:选 API 应用(或定时/异步任务应用),填写应用目录名,按需配置后台登录表(默认即可)。
导入数据表
在「菜单管理」输入数据表名点击「生成」,工具会读取表结构,自动生成菜单与字段配置;表不存在时会按配置自动建表。
生成代码
选中菜单点击「生成代码」,接口、后台页面、菜单数据一次性生成到你的项目目录;点击「打包应用」可直接打包出可部署的程序。
功能简介
控制台左侧各菜单的作用:
| 模块 | 作用 |
|---|---|
| 首页(项目管理) | 管理项目:技术栈、代码生成目录、默认数据库 |
| 数据库管理 | 维护数据库连接,支持自动建库 |
| 应用管理 | 项目下创建应用、配置登录表、打包应用 |
| 菜单管理 | 导入数据表生成菜单,触发「生成代码」 |
| 字段管理 | 调整字段的显示、搜索方式与排序(支持拖动排序) |
| 方法管理 | 控制每个菜单生成哪些操作按钮 |
| 生成日志 | 查看每次生成 / 打包的完整记录,失败时先看这里 |
| 秘钥管理 | 填写 apipost 的 api-token 等第三方凭证 |
| AI 代码助手 | 对话说出需求(如"生成一个 CMS 系统"),AI 直接生成完整业务模块;「模型管理」中可添加自己的模型 |
生成器详解 · 主要流程
一个业务模块从数据表到可部署程序,核心流程如下:
导入数据表
在「菜单管理」输入数据表名点击「生成」:工具读取表结构,自动生成菜单、字段与方法配置,并自动补上主键「编号」字段;表不存在时会按字段配置自动建表。
配置字段
在「字段管理」为每个字段选择表单控件类型、列表显示方式、搜索模式、验证规则等,支持拖动调整字段顺序。
配置方法
在「方法管理」决定该模块生成哪些接口与操作按钮:列表、添加、修改、删除、导入导出等,均可调整按钮样式、弹窗尺寸与生效字段。
生成代码
点击「生成代码」,后端接口、后台管理页面、菜单数据一次性生成到项目目录;重新生成不会覆盖手写代码。
生成 API 文档(可选)
API 应用可一键把模块内全部接口推送到 apipost,参数与响应示例按字段配置自动生成,详见下文「API 文档生成」。
打包应用
生成完毕后点击「打包应用」,构建输出实时显示,打包产物可直接部署运行。
生成器详解 · 支持的表单字段类型
「字段管理」中可为每个字段选择表单控件类型,共 39 种,按用途分为七类:
基础输入
| 类型 | 说明 |
|---|---|
| 文本框 | 可配置前后缀、前置图标、最大输入长度、行内编辑、数据脱敏 |
| 文本域 | 多行文本,可配置显示行数 |
| 密码框 | 密码输入,录入后加密存储 |
| 数字输入框 | 仅允许数字,支持区间(between)搜索、字段汇总求和 |
| 隐藏域 | 表单中不可见的字段 |
选择类
| 类型 | 说明 |
|---|---|
| 下拉框 | 选项可手工配置或使用 SQL 数据源,支持二级联动字段 |
| 下拉框(多选) | 同上,可同时选择多个值 |
| 下拉框(带分页) | 选项远程分页加载,适合大数据量选项 |
| 单选框 | 默认 / 按钮样式 / 带边框三种展现 |
| 多选框 | 复选多个值 |
| 开关按钮 | 开(1)/ 关(0)两种状态 |
| 标签 | 多个标签值录入 |
日期时间
| 类型 | 说明 |
|---|---|
| 日期框 | 年月日时分秒 / 年月日 / 年月 / 年 / 月 / 时分秒六种格式,可默认当前时间 |
| 日期范围 | 区间日期选择,可作为时间范围搜索 |
| 创建时间(后端自动) | 新增数据时后端自动写入 |
| 修改时间(后端自动) | 数据变动时后端自动更新 |
上传类
| 类型 | 说明 |
|---|---|
| 单图上传 | 两种上传样式,支持设置裁剪尺寸 |
| 多图上传 | 批量图片上传 |
| 单文件 / 多文件上传 | 可限制允许的后缀格式(如 doc,xls,xlsx),上传文件可重命名或保留原名 |
富文本编辑器
| 类型 | 说明 |
|---|---|
| wangeditor | 默认富文本编辑器 |
| tinymce | 可选富文本编辑器 |
| mdeditor | Markdown 编辑器,仅 Vue3 项目可选 |
高级控件
| 类型 | 说明 |
|---|---|
| 键值对 | 动态键值录入 |
| 键值对(增强版) | 商品规格式配置,每行可为文本框、下拉框、图片、日期等控件 |
| 省市区联动 | 省 / 省市 / 省市区三级可选 |
| 地图坐标选择器 | 百度、高德、腾讯三种地图选点 |
| 颜色选择器 | 取色板选择颜色值 |
| 进度条滑块 | 拖动设置数值,列表以长条或圆形进度展示 |
| 评分 | 星级评分 |
自动 / 系统字段
| 类型 | 说明 |
|---|---|
| 排序号 | 拖动排序用的权重字段 |
| token 解码值 | 自动取当前登录者信息(Vue2 后台应用中显示为「session 值」) |
| 随机数 | 按设定长度与字符规则自动生成 |
| 订单号 | 自动生成订单编号 |
| uuid(V7) | 自动生成 UUID V7 |
| 请求 ip | 后端自动记录客户端 IP |
| 权限节点 | 存储权限规则,可关联指定应用 |
字段的通用配置
无论选择哪种控件类型,字段都支持以下配置:
- 数据结构:varchar、int、bigint、smallint、tinyint、decimal、text、longtext、datetime,并可设置字段长度与索引(普通 / 唯一)
- 显示状态:列表中不显示,或显示并居中 / 居左 / 居右
- 搜索模式:
=(精确)、like(模糊)、between(区间,数字输入框专用),可启用时间范围搜索模板 - 验证规则:必填、唯一值、邮箱、手机号、url、货币、数字、值区间、长度、字母、字母数字、纯汉字、汉字字母、身份证号、正则验证
- 列表属性:tooltip 提示、表头排序、字段汇总求和、列表选项卡、数据显示反转、行内编辑、编辑只读、数据脱敏
- 多表关联:字段可归属于其它数据表,生成联表查询
生成器详解 · 生成的方法类型
「方法管理」决定每个模块生成哪些接口与操作按钮。导入数据表时会自动创建 6 个默认方法:数据列表、修改排序开关、添加、修改、删除、查看详情,其余方法按下表按需添加。
| 方法 | 生成内容 | 默认 |
|---|---|---|
| 数据列表 | 分页列表查询,支持联表查询、树形表格 | ✓ |
| 修改排序开关 | 列表行内修改排序值、切换开关状态 | ✓ |
| 添加 | 弹窗表单新增数据 | ✓ |
| 修改 | 编辑单条数据 | ✓ |
| 删除 | 物理删除数据 | ✓ |
| 查看详情 | 查看单条数据完整信息 | ✓ |
| 导入 | Excel 批量导入数据 | — |
| 导出 | 导出列表数据,可勾选导出字段 | — |
| 复制单条数据 | 复制一条数据为新记录 | — |
| 软删除 | 假删除,数据进入回收站 | — |
| 软删除回收站 | 查看并恢复被软删除的数据 | — |
| 重置密码 | 重置记录的密码字段 | — |
| 设置指定值 | 批量把某字段设为指定值(如修改状态) | — |
| 数值加 / 数值减 | 对数字字段加减(库存、积分等场景) | — |
| 配置表单 | form 表单页,适合配置管理类页面 | — |
| 跳转链接 | 后台按钮跳转到自定义链接 | — |
| 弹窗连接 | 后台按钮打开内嵌弹窗页面 | — |
| 批量添加 | 一次提交多条数据(API 应用) | — |
| 用户登录 | 登录接口(API 应用) | — |
| 发送验证码 | 短信验证码接口(API 应用) | — |
| 空方法 | 生成空白方法,自行填充业务逻辑 | — |
每个方法还可以细化配置:方法名与操作名称、弹窗尺寸、按钮图标与颜色、按钮出现位置(顶部工具栏 / 行内)、参与的表单字段范围、前置 / 后置 hook 等。后台应用与 API 应用可启用的方法范围不同,界面中会自动过滤。
生成器详解 · API 文档生成方式(apipost)
接口文档通过 apipost 开放接口自动同步,无需手写。该功能面向 API 应用,整体分两步:先建文档项目,再按模块推送接口。
第一步:配置凭证并创建文档项目(每个应用一次)
- 在 apipost 客户端获取 api-token:
项目设置 → openapi → 新建; - 在生成器「秘钥管理」中填入该 api-token;
- 在「应用管理」中对 API 应用执行「生成apipost接口文档项目」:工具会在 apipost 中创建对应项目,并预置 3 个通用接口 —— 获取图片验证码、刷新 token、基础文件上传。
第二步:按模块推送接口文档
在「菜单管理」「字段管理」或「方法管理」中点击「生成apipost接口文档」,该模块下所有方法会一次性推送到 apipost 项目:
- 接口地址按
应用域名/控制器名/方法名规则生成; - 请求参数、参数类型、默认值、必填说明、响应示例均按字段与方法配置自动生成;
- 之后修改了字段或方法,再次点击生成即可自动更新文档,无需删除重建。
生成器详解 · AI 代码生成
不想逐个配置字段?用「AI 代码助手」一句话说出需求(如「生成一个会员管理模块」),AI 会自动设计数据表结构与字段配置,确认后直接生成完整业务模块 —— 建表、菜单、字段、方法、后台代码一次完成。
使用前的准备
- 添加 AI 模型:AI 功能使用你自己的模型账号,需先在「模型管理」中添加并启用(见下方第 1 步);
- 配置工具秘钥:在「秘钥管理」中填好代码生成器的 appid / secret —— AI 生成的代码与手动生成走同一套生成服务;
- 创建好项目与应用:AI 生成的代码会写入你选中的目标应用。
操作步骤
添加模型
进入「AI 代码助手 → 模型管理」,点击「添加模型」,填写显示名称(可选,如 DeepSeek Chat)、提供商、模型名(如 deepseek-chat)与 API Key,保持启用状态即可。支持 DeepSeek、OpenAI、智谱 AI、字节跳动、阿里云、MiniMax、月之暗面、Anthropic、Google、Groq、xAI 共 11 家提供商,有任意一家的 API Key 即可使用。
创建会话并选择生成目标
在「AI 会话」中点击「创建会话」进入对话页,在左侧「生成目标」中依次选择项目与应用。生成的代码将写入选中的应用;同一会话中可随时切换目标,把模块生成到不同项目。
描述需求
在底部选择模型,然后在输入框中用自然语言描述需求,例如「生成一个会员管理模块,包含昵称、手机号、等级、注册时间」。也可以点击回形针按钮上传需求文档或界面图片(支持 doc、docx、txt、md、json、csv 等格式,单文件 10MB 以内),让 AI 按文档内容设计。需求较大时(如「生成一个 CMS 系统」),AI 会先输出模块清单,再逐个生成详细设计。
确认并生成代码
AI 会流式输出模块设计方案(数据表、字段、控件类型、验证规则等),确认无误后点击消息下方的「确认生成」:工具自动建表、创建菜单与字段方法配置,并把代码文件生成到目标应用目录。已生成过的消息会标注「已生成」,历史消息也可随时点击「生成代码」再次生成。
生成测试数据(可选)
模块生成后,继续在对话中说「生成 10 条 mock 数据」,AI 会按字段规则造出测试数据,确认后直接写入数据表,方便联调。
常见报错与处理
| 提示 | 原因与处理 |
|---|---|
| 请选择模型 / 获取模型配置失败 | 未选择模型,或模型已停用;到「模型管理」确认模型已启用 |
| 请先在左侧选择目标项目与应用 | 生成代码前必须先选定写入的项目与应用 |
| 请先配置秘钥 / 请先生成应用 | 生成器秘钥未配置,或目标应用尚未生成,按提示补齐后再试 |
| 检测到 SQL 中存在禁止使用的函数 | AI 设计的下拉数据源使用了 concat 等禁用函数,点击「重新生成」让 AI 换方案 |
| 控制器名已存在 | 同一应用下已有同名控制器,换个模块名重试 |
生成程序说明 · Go 版(编写中)
文档编写中,敬请期待
将介绍生成的 Go 程序如何运行、配置与部署
生成程序说明 · PHP 版(编写中)
文档编写中,敬请期待
将介绍生成的 PHP 程序如何运行、配置与部署
常见问题
双击 exe 后窗口一闪而过?
一般是端口被占用。用命令行运行程序查看报错信息,改掉 config.yaml 里的端口再启动。
重新生成会覆盖我改过的代码吗?
不会。手写修改过的代码在重新生成时原样保留,只有生成器管理的部分会更新。
生成失败了怎么办?
到「生成日志」查看失败记录的详情,常见原因:数据库连不上、项目目录无写权限、字段配置有误。
最后更新:2026-10-16