go-zero工具安装
go install github.com/zeromicro/go-zero/tools/goctl@latest
goctl env check --install --verbose --force
vim .bashrc
export PATH=$GOROOT/bin:$GOPATH/bin:$PATH
api命令
生成文档
goctl api doc --o docs --dir ../
根据api文件生成项目结构
goctl api go --api user.api --dir ../
验证api文件是否有效
goctl api validate --api user.api
根据api文档生成响应的前端ts文件
goctl api ts --api user.api --dir ../ts
格式化api文件
goctl api format --dir .
构建dockerfile
goctl docker -go user.go
rpc
构建rpc服务
goctl rpc protoc *.proto --go_out=../ --go-grpc_out=../ --zrpc_out=../
–go_out=…/:主要目的: 根据你在 .proto 文件中定义的消息(message,例如请求和响应),生成基础的 Go 结构体(struct)定义。
–go-grpc_out=…/:主要目的: 根据你在 .proto 文件中定义的 service(服务),生成 gRPC 通信所需的 Go 接口、客户端存根(client stub)和服务器存根(server stub)。
–zrpc_out=…/:主要目的: 生成 Go-Zero 框架特定的、用于构建和运行 RPC 服务的骨架代码 (boilerplate code)。这包括了服务的主入口点、配置加载、服务器设置、服务上下文 (Service Context)、逻辑处理文件的骨架、以及适配 Go-Zero 的客户端调用代码等。