refine goctl rpc generator

This commit is contained in:
kevin
2020-08-28 21:22:35 +08:00
parent db16115037
commit 72132ce399
20 changed files with 193 additions and 154 deletions

View File

@@ -17,7 +17,7 @@ $ goctl rpc template -o=user.proto
```golang
syntax = "proto3";
package remoteuser;
package remote;
message Request {
// 用户名
@@ -33,7 +33,7 @@ message Response {
string gender = 2;
}
service User{
service User {
// 登录
rpc Login(Request)returns(Response);
}
@@ -82,17 +82,17 @@ user
### go mod 工程
对于`$ go version`不低于1.5版本的的工程,会优先寻找`$ go env GOMODCACHE`目录,如果没有则去`${GOPATH}`中查找(见下文),而低于1.5版本的则会优先从`${GOPATH}/pkg/mod`目录下查找,否则也从`% GOPATH`中查找(见下文)
### go path工程
对于没有使用go mod的工程则默认当作在`${GOPATH}`中处理暂不支持用户自定义的GOPATH而这种情况下则会默认从`${GOPATH}/src`中查找
> 注意:
* 对于以上两种工程如果没有在对应目录查找到`protoc-gen-go`则会提示相应错误,尽管`protoc-gen-go`可能在其他已经设置环境变量的目录中,这个将在后面版本进行优化。
* 对于go mod工程如果工程没有依赖`github.com/golang/protobuf`则需要提前引入。
### 好处
* 保证grpc代码生成规范的一致性
# 用法
```shell script
$ goctl rpc proto -h
@@ -126,11 +126,11 @@ OPTIONS:
```
则服务名称亦为user而非proto所在文件夹名称了这里推荐使用这种结构可以方便在同一个服务名下建立不同类型的服务(api、rpc、mq等),便于代码管理与维护。
* --shared 非必填,默认为$dir(xxx.proto)/sharedrpc client逻辑代码存放目录。
> 注意这里的shared文件夹名称将会是代码中的package名称。
* --idea 非必填是否为idea插件中执行保留字段终端执行可以忽略
# 开发人员需要做什么
关注业务代码编写将重复性、与业务无关的工作交给goctl生成好rpc服务代码后开饭人员仅需要修改
@@ -146,7 +146,7 @@ OPTIONS:
* proto不支持外部依赖包引入message不支持inline
* 目前main文件、shared文件、handler文件会被强制覆盖而和开发人员手动需要编写的则不会覆盖生成这一类在代码头部均有
```shell script
// Code generated by goctl. DO NOT EDIT.
// Code generated by goctl. DO NOT EDIT!
// Source: xxx.proto
```
的标识,请注意不要将也写业务性代码写在里面。