## 代码生成 目录 - 使用条件 - 模板配置 - CLI配置 - 生成CRUD表格 - 生成树形表格 - 多数据库使用 - 自定义生成模板 - 内置gf-cli - 指定gf-cli版本 - 指定数据库驱动 > 在HotGo中可以通过后台开发工具快速的一键生成CRUD，自动生成Api、控制器、业务逻辑、Web页面、表单组件、菜单权限等。 ### 使用条件 - hotgo 版本号 >= 2.13.1 - 使用前必须先看 [数据库](sys-db.md) ### 生成模板配置 - 配置路径：server/manifest/config/config.yaml ```yaml # 生成代码 hggen: allowedIPs: [ "127.0.0.1", "*" ] # 白名单，*代表所有，只有允许的IP后台才能使用生成代码功能 selectDbs: [ "default" ] # 可选生成表的数据库配置名称，支持多库 disableTables: [ "hg_sys_gen_codes","hg_admin_role_casbin" ] # 禁用的表，禁用以后将不会在选择表中看到 delimiters: [ "@{", "}" ] # 模板引擎变量分隔符号 # 生成应用模型，所有生成模板允许自定义，可以参考default模板进行改造 application: # CRUD和关系树列表模板 crud: templates: # 默认的主包模板 - group: "default" # 分组名称 isAddon: false # 是否为插件模板 false｜true masterPackage: "sys" # 主包名称，需和controllerPath、logicPath、inputPath保持关联 templatePath: "./resource/generate/default/curd" # 模板路径 apiPath: "./api/admin" # goApi生成路径 controllerPath: "./internal/controller/admin/sys" # 控制器生成路径 logicPath: "./internal/logic/sys" # 主要业务生成路径 inputPath: "./internal/model/input/sysin" # 表单过滤器生成路径 routerPath: "./internal/router/genrouter" # 生成路由表路径 sqlPath: "./storage/data/generate" # 生成sql语句路径 webApiPath: "../web/src/api" # webApi生成路径 webViewsPath: "../web/src/views" # web页面生成路径 # 默认的插件包模板，{$name}会自动替换成实际的插件名称 - group: "addon" # 分组名称 isAddon: true # 是否为插件模板 false｜true masterPackage: "sys" # 主包名称，需和controllerPath、logicPath、inputPath保持关联 templatePath: "./resource/generate/default/curd" # 模板路径 apiPath: "./addons/{$name}/api/admin" # goApi生成路径 controllerPath: "./addons/{$name}/controller/admin/sys" # 控制器生成路径 logicPath: "./addons/{$name}/logic/sys" # 主要业务生成路径 inputPath: "./addons/{$name}/model/input/sysin" # 表单过滤器生成路径 routerPath: "./addons/{$name}/router/genrouter" # 生成路由表路径 sqlPath: "./storage/data/generate/addons" # 生成sql语句路径 webApiPath: "../web/src/api/addons/{$name}" # webApi生成路径 webViewsPath: "../web/src/views/addons/{$name}" # web页面生成路径 # 消息队列模板 queue: templates: - group: "default" templatePath: "./resource/generate/default/queue" # 定时任务模板 cron: templates: - group: "default" templatePath: "./resource/generate/default/cron" # 生成插件模块，通过后台创建新插件时使用的模板，允许自定义，可以参考default模板进行改造 addon: srcPath: "./resource/generate/default/addon" # 生成模板路径 webApiPath: "../web/src/api/addons/{$name}" # webApi生成路径 webViewsPath: "../web/src/views/addons/{$name}" # web页面生成路径 ``` ### 生成CLI配置 - hotgo在生成dao、service配置时，默认了和gf官方一致的配置方式和代码生成规则。所以无论你是通过hotgo亦或gf命令生成，最终代码格式完全一致，遵循一致的代码规范。 - 配置路径：[server/hack/config.yaml](../../server/hack/config.yaml) ```yaml gfcli: build: name: "hotgo" # 编译后的可执行文件名称 # arch: "all" #不填默认当前系统架构，可选：386,amd64,arm,all # system: "all" #不填默认当前系统平台，可选：linux,darwin,windows,all mod: "none" cgo: 0 packSrc: "resource" # 将resource目录打包进可执行文件，静态资源无需单独部署 packDst: "internal/packed/packed.go" # 打包后生成的Go文件路径，一般使用相对路径指定到本项目目录中 version: "" output: "./temp/hotgo" # 可执行文件生成路径 extra: "" gen: dao: - link: "mysql:hotgo:hg123456.@tcp(127.0.0.1:3306)/hotgo?loc=Local&parseTime=true" group: "default" # 分组 使用hotgo代码生成功能时必须填 # tables: "" # 指定当前数据库中需要执行代码生成的数据表。如果为空，表示数据库的所有表都会生成。 tablesEx: "hg_sys_addons_install" # 指定当前数据库中需要排除代码生成的数据表。 removePrefix: "hg_" descriptionTag: true noModelComment: true jsonCase: "CamelLower" gJsonSupport: true clear: true service: # 生成业务配置 srcFolder: "internal/logic" dstFolder: "internal/service" dstFileNameCase: "CamelLower" clear: true ``` ### 生成CRUD表格 - 推荐使用热编译方式启动HotGo，这样生成完成页面自动刷新即可看到新生成内容，无需手动重启 - 服务端热编译启动：`gf run main.go`, web前端启动：`pnpm run dev` 或 `npm run dev` 1、创建数据表 1.1 创建测试表格表`hg_test_table` ```mysql CREATE TABLE `hg_test_table` ( `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'ID', `category_id` bigint(20) NOT NULL COMMENT '分类ID', `title` varchar(64) NOT NULL COMMENT '标题', `description` varchar(255) NOT NULL COMMENT '描述', `content` text NOT NULL COMMENT '内容', `image` varchar(255) DEFAULT NULL COMMENT '单图', `attachfile` varchar(255) DEFAULT NULL COMMENT '附件', `city_id` bigint(20) DEFAULT '0' COMMENT '所在城市', `switch` int(11) DEFAULT '1' COMMENT '显示开关', `sort` int(11) NOT NULL COMMENT '排序', `status` tinyint(1) DEFAULT '1' COMMENT '状态', `created_by` bigint(20) DEFAULT '0' COMMENT '创建者', `updated_by` bigint(20) DEFAULT '0' COMMENT '更新者', `created_at` datetime DEFAULT NULL COMMENT '创建时间', `updated_at` datetime DEFAULT NULL COMMENT '修改时间', `deleted_at` datetime DEFAULT NULL COMMENT '删除时间', PRIMARY KEY (`id`) ) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8 COMMENT='测试表格'; ``` 1.2 测试分类表`hg_test_category`: - 注意：该表为了方便功能演示已经内置无需再次创建，此处提示表结构只是为了方便大家梳理关联表关系 ```mysql CREATE TABLE `hg_test_category` ( `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '分类ID', `name` varchar(255) NOT NULL COMMENT '分类名称', `description` varchar(255) DEFAULT NULL COMMENT '描述', `sort` int(11) NOT NULL COMMENT '排序', `remark` varchar(255) DEFAULT NULL COMMENT '备注', `status` tinyint(1) DEFAULT '1' COMMENT '状态', `created_at` datetime DEFAULT NULL COMMENT '创建时间', `updated_at` datetime DEFAULT NULL COMMENT '修改时间', `deleted_at` datetime DEFAULT NULL COMMENT '删除时间', PRIMARY KEY (`id`) ) ENGINE=InnoDB AUTO_INCREMENT=10 DEFAULT CHARSET=utf8 COMMENT='测试分类'; ``` 1.3 插入测试数据 ```mysql INSERT INTO `hg_test_table` (`id`, `category_id`, `title`, `description`, `content`, `image`, `attachfile`, `city_id`, `switch`, `sort`, `status`, `created_by`, `updated_by`, `created_at`, `updated_at`, `deleted_at`) VALUES (1, 1, '测试标题', '描述', '

不知道写点啥！



', 'https://bufanyun.cn-bj.ufileos.com/hotgo/logo.sig.png', 'http://bufanyun.cn-bj.ufileos.com/hotgo/attachment/2022-12-30/cpf1x44idoycrtajf2.xlsx', 110102, 1, 10, 1, 0, 1, '2022-12-15 19:30:14', '2023-02-23 13:55:32', NULL); ``` 2、创建生成配置 - 登录HotGo后台 -> 开发工具 -> 代码生成 -> 找到立即生成按钮并打开，选择和填写如下参数： ![生成添加演示图](images/sys-code-add.png) 3、自定义配置 - 确认配置无误后，点击生成配置会自动跳转到生成配置页面，如下： ![生成配置页面](images/sys-code-config-init.png) - 你可以在该页面点击`预览代码`查看生成的内容，如果无需调整亦可以直接点击`提交生成`，以下是预览代码效果： ![生成预览](images/sys-code-preview.png) - 如果你对默认的生成配置不满意，可以根据页面表单提示，自定义表格属性和字段属性 - 这里假设我们要一个关联表，让表`hg_test_table`字段`category_id`去关联 表`hg_test_category`字段`id`，我们可以这样做： ![生成关联配置](images/sys-code-config-join.png) - 如果你想调整主表每列字段的显示方式，可以点击上方导航栏中的 [主表字段] 进行调整 - 这里我们不做任何调整直接进入下一步。目的是为了后续演示对最终生成结果不满意的再次调整方案 ![生成关联配置](images/sys-code-master.png) 4、以上内容都已配置无误后，点击提交生成即可。 - 如果你使用的热编译，那么页面会在生成成功后立即刷新，刷新完成你即可在后台菜单栏中看到`测试表格`菜单。如果不是使用热编译启动，请手动重启服务后刷新。 - 注意：热编译环境下，web端往往会快于服务端重启并加载完成，此时访问新生成的菜单页面可能会存在某接口请求超时或404问题，这是服务端正在重启导致的，属于正常现象，一般稍等几秒再试即可。 - 接下来让我们看看生成的表格页面，效果如下： ![生成测试表格页面](images/sys-code-list.png) 5、假设我们对生成结果不满意，有新的优化需求如下： 1. 把`单图`、`附件`改换成上传组件 2. 把`创建者`、`更新者`隐藏 3. 把`分类ID`隐藏，然后把关联表中的`分类名称`显示出来 > 那么我们可以回到 开发工具 -> 代码生成 -> 找到刚刚生成的记录 -> 在右侧操作栏中点击生成配置，再次进入配置页面做如下操作即可： 1. 点击上方导航栏[主表字段]，调整字段选项： ![修改主表配置](images/sys-code-master-save.png) 2. 点击上方导航栏[关联表]，调整字段选项： ![修改关联表配置](images/sys-code-config-join-save.png) 3. 返回[基本信息]，勾选强制覆盖，然后点击`预览代码`，确认生成代码无误后点击`提交生成` ![强制覆盖并提交生成](images/sys-code-config-post.png) - 生成完成刷新页面后，再次来到`测试表格`，发现表格已经调整到了我们预期效果 1. 列表效果： ![最终列表效果](images/sys-code-list-ok.png) 2. 编辑表单效果 ![最终编辑表单效果](images/sys-code-list-edit-ok.png) - 至此生成增删改查列表示例结束！ ### 生成树形表格 待写。 ### 多数据库使用 - 假设我们要增加一个库名为`hotgo2`、分组为`default2`的数据库，并要为其生成代码 1. 配置[server/hack/config.yaml](../../server/hack/config.yaml) 如下： ```yaml gen: dao: - link: "mysql:hotgo:hg123456.@tcp(127.0.0.1:3306)/hotgo?loc=Local&parseTime=true" group: "default" # 分组 使用hotgo代码生成功能时必须填 tablesEx: "hg_sys_addons_install" # 指定当前数据库中需要排除代码生成的数据表。 removePrefix: "hg_" descriptionTag: true noModelComment: true jsonCase: "CamelLower" gJsonSupport: true clear: false - link: "mysql:hotgo2:hg123456.@tcp(127.0.0.1:3306)/hotgo2?loc=Local&parseTime=true" group: "default2" # 分组 使用hotgo代码生成功能时必须填 tablesEx: "hg_sys_addons_install" # 指定当前数据库中需要排除代码生成的数据表。 removePrefix: "" descriptionTag: true noModelComment: true jsonCase: "CamelLower" gJsonSupport: true clear: false ``` 2. 配置`server/manifest/config/config.yaml`, `database`配置如下： ```yaml database: logger: level: "all" stdout: true default: link: "mysql:hotgo:hg123456.@tcp(127.0.0.1:3306)/hotgo?loc=Local&parseTime=true" debug: true Prefix: "hg_" default2: link: "mysql:hotgo2:hg123456.@tcp(127.0.0.1:3306)/hotgo2?loc=Local&parseTime=true" debug: true Prefix: "" ``` `hggen`配置如下： ```yaml hggen: allowedIPs: ["127.0.0.1", "*"] # 白名单，*代表所有，只有允许的IP后台才能使用生成代码功能 selectDbs: [ "default", "default2" ] # 可选生成表的数据库配置名称，支持多库 disableTables : ["hg_sys_gen_codes","hg_admin_role_casbin"] # 禁用的表，禁用以后将不会在选择表中看到 delimiters: ["@{", "}"] # 模板引擎变量分隔符号 ``` 3. 登录HotGo后台 -> 开发工具 -> 代码生成 -> 找到立即生成按钮并打开，就会发现`数据库`选项增加了一个`default2`，后续生成步骤和生成例子完全一样 > 注意：上述的配置中所有的`default2`名称必须保持一致 ### 自定义生成模板 > 系统内置了两组CURD生成模板，请参考[生成模板配置](sys-code.md#生成模板配置)。default：是默认的生成到主模块下；addon：是默认生成到指定的插件下 - HotGo允许你新建新的模板分组来满足你的需求，模板可根据现有模板基础拷贝一份出来做改造，默认模板目录：[server/resource/generate/default](../../server/resource/generate/default) ### 内置gf-cli > 为了确保生成代码的依赖稳定性，在面对`gf`版本更新可能导致向下不兼容情况时，HotGo将`gf-cli`工具内置到系统中并进行在线执行调整，从而提供更可靠和一致的生成代码功能。 - 后续我们也将开放在线运行`gf gen ...`功能。在做插件开发时也会支持到在线生成插件下的service接口，这将会使得插件开发更加方便 ### 指定gf-cli版本 > HotGo多数情况下会和最新版本的gf-cli保持同步，如果更新不及时或你不想使用最新版本的gf-cli来生成代码，可以找到自己想要的版本进行替换即可。 - 下面大致做一些替换步骤说明： 1. 打开https://github.com/gogf/gf，找到你想要使用的版本`clone`下来 2. 将`clone`代码中`gf/cmd/gf/internal/`目录覆盖到`server/internal/library/hggen/internal` 3. 将覆盖过来的目录文件中引入包名`github.com/gogf/gf/cmd/gf/v2/`批量改为`hotgo/internal/library/hggen/` 4. 运行`go mod tidy` 5. 运行`go run main.go`，如果没有报错，那么恭喜你已经完成了。如果有报错一般都是版本差异带来的影响，需要根据情况自行调整 ### 指定数据库驱动 > HotGo默认使用mysql驱动，如果你想用其他数据库驱动打开下方文件中注释即可 修改文件路径：server/internal/library/hggen/internal/cmd/cmd_gen_dao.go ```go package cmd import ( //_ "github.com/gogf/gf/contrib/drivers/clickhouse/v2" //_ "github.com/gogf/gf/contrib/drivers/mssql/v2" _ "github.com/gogf/gf/contrib/drivers/mysql/v2" //_ "github.com/gogf/gf/contrib/drivers/oracle/v2" //_ "github.com/gogf/gf/contrib/drivers/pgsql/v2" //_ "github.com/gogf/gf/contrib/drivers/sqlite/v2" "hotgo/internal/library/hggen/internal/cmd/gendao" ) type ( cGenDao = gendao.CGenDao ) ``` 修改完成后运行`go mod tidy`