go-zero代码生成器助你高效开发

// 推荐使用 v3 版本。现在流行的 gRPC 框架也是使用 v3 版本。
syntax = "proto3";
// 每个 proto 文件需要定义自己的包名，类似 c++ 的名称空间。
package hello;
// 数据结构通过 message 定义
message Echo {
  // 每个 message 可以有多个 field。
  // 每个 field 需要指定类型、字段名和编号。
  // Protocol Buffers 在内部使用编号区分字段，一旦指定就不能更改。
  string msg = 1;
}
// 服务使用 servcie 定义
service Demo {
  // 每个 service 可以定义多个 rpc
  // 每个 rpc 需要指定接口名、传入消息和返回消息三部分。
  rpc Echo(Echo) returns (Echo);
}

{
  Name:        "protoc",
  Usage:       "generate grpc code",
  UsageText:   "example: goctl rpc protoc xx.proto --go_out=./pb --go-grpc_out=./pb --zrpc_out=.",
  Description: "for details, see https://go-zero.dev/cn/goctl-rpc.html",
  Action:      rpc.ZRPC,
  Flags:       []cli.Flag{
   ...
  },
}

// ZRPC generates grpc code directly by protoc and generates
// zrpc code by goctl.
func ZRPC(c *cli.Context) error {
  ...
  grpcOutList := c.StringSlice("go-grpc_out")
  goOutList := c.StringSlice("go_out")
  zrpcOut := c.String("zrpc_out")
  style := c.String("style")
  home := c.String("home")
  remote := c.String("remote")
  branch := c.String("branch")
  ...
  goOut := goOutList[len(goOutList)-1]
  grpcOut := grpcOutList[len(grpcOutList)-1]
  ...
 
  var ctx generator.ZRpcContext
  ...
  // 将args中的值逐个赋值给 ZRpcContext，作为env context注入 generator
  g, err := generator.NewDefaultRPCGenerator(style, generator.WithZRpcContext(&ctx))
  if err != nil {
   return err
  }
  return g.Generate(source, zrpcOut, nil)
}

func (g *RPCGenerator) Generate(src, target string, protoImportPath []string, goOptions ...string) error {
  ...
  // proto parser
  p := parser.NewDefaultProtoParser()
  proto, err := p.Parse(src)
  
  dirCtx, err := mkdir(projectCtx, proto, g.cfg, g.ctx)
  
  // generate Go code
  err = g.g.GenEtc(dirCtx, proto, g.cfg)
  err = g.g.GenPb(dirCtx, protoImportPath, proto, g.cfg, g.ctx, goOptions...)
  err = g.g.GenConfig(dirCtx, proto, g.cfg)
  err = g.g.GenSvc(dirCtx, proto, g.cfg)
  err = g.g.GenLogic(dirCtx, proto, g.cfg)
  err = g.g.GenServer(dirCtx, proto, g.cfg)
  err = g.g.GenMain(dirCtx, proto, g.cfg)
  err = g.g.GenCall(dirCtx, proto, g.cfg)
  ...
}

func (g *DefaultGenerator) GenPb(ctx DirContext, 
  protoImportPath []string, 
  proto parser.Proto, 
  _ *conf.Config, 
  c *ZRpcContext, 
  goOptions ...string) error {
 ...
 // protoc 命令string
 cw := new(bytes.Buffer)
 ...
 // cw.WriteString("protoc ")
 // cw.WriteString(some command shell)
 command := cw.String()
 g.log.Debug(command)
 _, err := execx.Run(command, "")
 if err != nil {
  if strings.Contains(err.Error(), googleProtocGenGoErr) {
   return errors.New(`unsupported plugin protoc-gen-go which installed from the following source:
google.golang.org/protobuf/cmd/protoc-gen-go, 
github.com/protocolbuffers/protobuf-go/cmd/protoc-gen-go;
Please replace it by the following command, we recommend to use version before v1.3.5:
go get -u github.com/golang/protobuf/protoc-gen-go`)
  }
  return err
 }
 return nil
}