go-zero goctl常用命令简介

goctl是go-zero微服务框架下的代码生成工具。使用 goctl 可显著提升开发效率，让开发人员将时间重点放在业务开发上，其功能有：

• api服务生成
• rpc服务生成
• model代码生成
• 模板管理

其实还有其他功能，但比较少用或是可由其他方式代替（如docker）

model指令

goctl model 为go-zero下的工具模块中的组件之一，目前支持识别mysql ddl进行model层代码生成，通过命令行或者idea插件（即将支持）可以有选择地生成带redis cache或者不带redis cache的代码逻辑。

常用的生成方式有：

• 根据连接的数据库生成生成
• 根据sql文件生成（本文章主讲）

常用参考命令：

goctl model mysql ddl -src="./rpc/desc/sql/ums*.sql" -dir="./rpc/model"

说明：读取rpc/desc/sql目录下所有匹配ums*.sql的文件，生成model单元文件，到rpc/model目录下

其他命令项目说明：

子命令选项	说明
mysql	生成mysql的model
mysql ddl	根据文件生成mysql的model
mysql ddl -src=value	源文件路径加名称 可使用*批量生成
mysql ddl -dir=value	生成mysql的model目录
mysql datasource	根据数据库直接生成mysql的model

补充：postgresql 的生成命令

goctl model pg datasource --url="postgres://user:123@localhost:5432/testDB?sslmode=disable" --table="*"

user	用户名
123	密码
testDB	数据库名
--table	表或表名通配符，即可过滤本次生成数据库中的哪些表。如 --table="users" --table="t_*"         注：因pg不能使用sql语句生成，在这里做单儿处理。

 

rpc指令

Goctl Rpc是goctl脚手架下的一个rpc服务代码生成模块，支持proto模板生成和rpc服务代码生成，通过此工具生成代码你只需要关注业务逻辑编写而不用去编写一些重复性的代码。这使得我们把精力重心放在业务上，从而加快了开发效率且降低了代码出错率。

常用的创建模板命令：

goctl rpc template -o ums.proto

说明：当前目录下创建一个ums.proto的参考模板文件

也可以使用goctl插件安装后的快捷方式

常用生成rpc项目代码命令：

goctl rpc protoc ums.proto --go_out=. --go-grpc_out=. --zrpc_out=.

 说明：读取当前目录下的ums.proto文件，生成rpc项目代码，生成到当前目录下

其他命令项说明：

子命令选项	说明
new	在当前目录下，快速创建一个rpc服务
template	创建一个带模板的proto文件
template -o value	创建一个指定路径的proto文件
protoc	生成rpc代码项目代码
protoc --go_out=value	生成pb代码路径
protoc --go-grpc_out=value	生成grpc代码路径
protoc --zrpc_out=value	zrpc生成的主目录

api指令

goctl api是goctl中的核心模块之一，其可以通过.api文件一键快速生成一个api服务，如果仅仅是启动一个go-zero的api演示项目， 你甚至都不用编码，就可以完成一个api服务开发及正常运行。在传统的api项目中，我们要创建各级目录，编写结构体， 定义路由，添加logic文件，这一系列操作，如果按照一条协议的业务需求计算，整个编码下来大概需要5～6分钟才能真正进入业务逻辑的编写， 这还不考虑编写过程中可能产生的各种错误，而随着服务的增多，随着协议的增多，这部分准备工作的时间将成正比上升， 而goctl api则可以完全替代你去做这一部分工作，不管你的协议要定多少个，最终来说，只需要花费10秒不到即可完成。

常用创建模板命令：

goctl api -o ./desc/index.api

说明：在文件夹desc下创建一个index.api的模板文件

 也可以使用goctl插件安装后的快捷方式

常用生成api项目命令：

goctl api go -api ./desc/index.api -dir .

说明：读取desc/index.api文件，生成api项目代码，生成到当前目录下

其他命令项说明：

子命令选项	说明
new	在当前目录下，快速创建一个api服务
-o value	快速初始化一个api文件 value:为需要创建的api文件路径加名称   例：./desc/index.api
go	生成go代码的api服务
go -api value	根据对应api文件生成 value:api源文件（路径加名称）
go -dir value	生成的go代码目录 value:目录

api项目开发中通常都需要与前端交互对接，此时有个文档会方便开发，goctl也带swagger功能，可直接生成swagger文件

api生成swagger文件命令：

goctl api plugin -plugin goctl-swagger="swagger -filename api.json" -api index.api -dir .

说明：读取当前目录下的index.api文件，根据swagger规则，生成api.jso文件，生成到当前目录下

swagger相关命令说明：

子命令选项	说明
plugin	执行插件
plugin -plugin value	执行的插件文件路径
plugin -api value	api文件
plugin -dir value	生成的目标目录

template指令

模板（Template）是数据驱动生成的基础，所有的代码（rest api、rpc、model、docker、kube）生成都会依赖模板， 默认情况下，模板生成器会选择内存中的模板进行生成，而对于有模板修改需求的开发者来讲，则需要将模板进行落盘， 从而进行模板修改，在下次代码生成时会加载指定路径下的模板进行生成。

模板初始化命令：

goctl template init --home=./goctl

说明：根据当前goctl版本，下载所有默认模板文件到goctl文件夹下

将下载.tpl模板文件，复制到你需要使用的项目相应目录下，即可根据使用项目，对模板进行自定义更改。

模板的更改除了部分可通用久，目前建议每个项目的模板单独使用。究其原因有以下几点问题：

• 每个模板文件中可定义的参数是单独，不是全局都可引用参数
• 模板中未提供包名称的参数，致使项目有些类型common包的引用，只能根据项目名称写死包路径

其他命令项说明：

子命令选项	说明
init	初始化
init --home value	将所有的默认模板文件下载到指定目录下

其他通用命令

子命令选项	说明
--style=goZero	适用大部分生成文件的命令；对生成的文件大小写进行格式化（如api、rpc项目生成,model文件生成） GoZero：大驼峰  goZero:小驼峰  gozero:全小写（默认值）
--home=value	使用自定义模板格式化自动生成的代码，（如api、rpc项目生成,model文件生成） 模板包含：api、docker、kube、model、mongo、newapi、rpc

这些命令几乎可用于模板命令外的其他命令

如生成文件为小驼峰，且根据模板生成：

goctl model mysql ddl -src="./rpc/desc/sql/ums*.sql" -dir="./rpc/model" --home=./deploy/goctl/template --style=goZero

goctl rpc protoc ums.proto --go_out=. --go-grpc_out=. --zrpc_out=. --home=../../deploy/goctl/template --style=goZero

goctl api -o ./desc/index.api --home=../deploy/goctl/template