:::info 在使用代码生成器遇到问题时解决思路:
- 请先检查
./scripts/gormgen.sh
和./scripts/handlergen.sh
文件,是否有可执行权限; - 如果是 docker 环境,请检测是否支持执行
bash
命令; - Linux 和 Mac 执行的是
.sh
文件,Windows 执行的是.bat
文件,脚本比较简单也可自行排查; 可根据错误提示信息,自行定位问题,目前 Linux 、Mac、Windows 都用执行成功的案例; :::
生成数据表 CURD
:::warning 在哪些场景下使用:
当表字段发生调整时;
- 当新增数据表时;
警告⚠️:
- 生成的
gen_
开头的文件,不可编辑,否则下次生成时会被覆盖! - 生成的
gen_
开头的文件,不可编辑,否则下次生成时会被覆盖! - 生成的
gen_
开头的文件,不可编辑,否则下次生成时会被覆盖!
目前生成的方法是对单表的增删改查操作,如果需要更加复杂的逻辑查询,自行去实现!
:::
生成控制器方法
:::warning 在哪些场景下使用:
- 在项目开发初期,刚刚定义出模块需要实现的空接口时;
例如,是实现一个用户管理的控制器:
- 在
./internal/api
目录中,创建user
目录; - 在
user
目录中,创建handler.go
文件; - 在
handler.go
文件中定义需要实现的接口,具体可参考其他handler.go
文件; - 在后台输入框中,输入
user
即可;
意义:
- 根据注释生成 Swagger 接口文档;
- 根据研发负责人定义好的 interface ,生成待实现的方法,研发人员只需实现具体方法即可,便于方法分工和代码管理; :::