该功能特性从v2.4版本开始提供。

基本介绍

该命令用于编译proto文件，生成对应的protobuf go文件以及对应的控制器文件。

命令使用

$ gf gen pb -h
USAGE
    gf gen pb [OPTION]

OPTION
    -p, --path   protobuf file folder path
    -a, --api    output folder path storing generated go files of api
    -c, --ctrl   output folder path storing generated go files of controller
    -h, --help   more information about this command

EXAMPLE
    gf gen pb
    gf gen pb -p . -a . -p .

如果使用框架推荐的项目工程脚手架，并且系统安装了make工具，也可以使用make pb快捷指令。

参数说明：

名称必须默认值含义
path否manifest/protobuf指向proto协议定义文件
api否api指向生成的接口文件存放目录
ctrl否internal/controller指向生成的控制器文件存放目录

注意事项

  • 在生成控制器文件时，会自动识别是否已经存在对应的接口实现方法，如果已经存在则不再重复生成对应的接口方法，防止覆盖。
  • 如果在proto目录执行该命令，并且指定的path目录不存在时，那么将会自动编译本地proto文件，且编译后的文件生成到当前目录，并自动关闭控制器文件的生成功能。



Content Menu

  • No labels

2 Comments

  1. Cyberhan123

    尝试了一下这个工具，发现一些小问题：

    1. 需要将protobuf文件放在xxx/v1下controller层生成才可以正确生效（因为我这里需要共享协议，将protobuf作为

      git submodule，而且还因为一些原因需要支持http协议）

          2. path 参数不在mainfest的规定目录下，生成的文件会出现目录错乱，比如：

    gf gen pb -p proto/xxxservice/a.proto -a api/proto


          3.因为生成的时候会有改写文件的逻辑，而如果携带类似

    gRPC-Gateway这样的结构则会出现报错：

    https://grpc-ecosystem.github.io/grpc-gateway/docs/tutorials/adding_annotations/#using-protoc

    比如，如下protobuf

    syntax = "proto3";

package helloworld;

import "google/api/annotations.proto";

// Here is the overall greeting service definition where we define all our endpoints
service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply) {
    option (google.api.http) = {
      post: "/v1/example/echo"
      body: "*"
    };
  }
}

// The request message containing the user's name
message HelloRequest {
  string name = 1;
}

// The response message containing the greetings
message HelloReply {
  string message = 1;
}

  2. 朱华 Hunk

    我同时使用了 gf gen pb的三个参数：-a -c -p ，我发现 只有 -p生效了，-a 与 -c 根本就没生效，依然是采用的api及internal/controller。而不是我自定义的值。下面是我的用法，看看有没有问题？


    gf gen pb  -a "app/platform-service/api" -c "app/platform-service/internal/controller" -p "protocol/platform"

    一直在提示我api不存在，我在执行目录 下新建了api目录后，就换成一直提示我internal/controller不存在了。很明显api及controller一直是用的默认值api及internal/controller


    我Debug了下gf，发现问题出在 CGenPbInput的定义上，Api与Ctrl用的OutputApi及OutputCtrl，导致进行mergeDefaultStructValue时匹配不到OutputApi及OutputCtrl。我自己先把CGenPbInput的字段名改成了Api及Ctrl。暂时能用了。不过我这个修改应该只是一个应急的方式，还是需要调整mergeDefaultStructValue，采用tag:name进行匹配才合适。