proto3语法笔记(解决import标签生成go文件中导入路径问题)

请搭配go-grpc笔记食用

一个简单的示例

syntax="proto3";// 指定proto语法版本
package chat_proto;// 这个packege指定的是proto文件的包名,与go的package没关系
option go_package="./chat;chat";// 若没有此项会报错,格式为<生成的文件存放位置;生成文件的包名>,注意此标签分号后面的一项是go的包名
message Message{ //message标签指定参数格式
  string body=1; //格式:<类型 参数名=唯一编码> 唯一编码的含义参见官方文档
}
message AddParams{
  int32 firstNum=1;
  int32 secondNum=2;
}
message AddRes{
  int32 addRet=1;
}
service ChatService{ //定义服务名及其方法
  rpc SayHello(Message) returns (Message){} //这个函数将在服务端把客户端调用时传入的string参数打印出来
  rpc DoAdd(AddParams) returns (AddRes){} //这个函数将把客户端传入的数字加起来
}

标签们

• syntax：一般指proto3
• package：proto文件的包名
• option：对于go来说需要设置go_package,如 option go_package="./chat;chat";
  格式为<生成的文件存放位置;生成文件的包名>,前面一项则是必须的。若后一项与package标签有冲突，以option指定为准，若option指定的与package一样或者option没指定，以package为准
• service：定义服务及其方法，其中的函数以rpc开头，返回值以returns开头
• message：message定义了参数的类型和名称

import标签的使用

• import标签可以在一个proto文件中使用另一个proto文件的message标签或者其中的元素
• 使用import标签的文件结构

loubw@loubw-ThinkCentre-M920t-N000:~/grpcRe/serv$ tree
.
├── go.mod
├── go.sum
├── main.go
└── protos
    ├── chat.proto
    ├── pbs
    │   ├── chat.go
    │   ├── chat_grpc.pb.go
    │   ├── chat.pb.go
    │   ├── talk_grpc.pb.go
    │   └── talk.pb.go
    └── talk.proto

2 directories, 10 files

此处chat.proto引用了talk.proto的message(后文有文件内容)，把chat.proto和talk.proto生成的文件放到同一个目录下的原因是为了避免生成的go文件中的导入包错误。若两个proto文件指定的go package不一致或者两个proto文件指定的go文件生成路径不一致，就极可能会出现go的导入路径错误，因为proto生成go文件时并不能找到正确的导入目录位置而且对于go来说一个目录只能有一个包名。

• talk.proto文件

syntax="proto3";// 指定proto语法版本
package talk;
option go_package="protos/pbs;proto";
message MultiplyParams{
  int32 firstNum=1;
  int32 secondNum=2;
}
message MultiplyRes{
  int32 addRet=1;
}
service TalkService{ 
  rpc DoMultiply(MultiplyParams) returns (MultiplyRes){}
}

• chat.proto文件

syntax="proto3";// 指定proto语法版本
package chat;
option go_package="protos/pbs;proto";

import "protos/talk.proto";

message Message{ //message标签指定参数格式
  string body=1; //格式:<类型 参数名=唯一编码> 唯一编码的含义参见官方文档
}
message AddParams{
  int32 firstNum=1;
  int32 secondNum=2;
}
message AddRes{
  int32 addRet=1;
}
service ChatService{ //定义服务名及其方法
  rpc SayHello(Message) returns (Message){} //这个函数将在服务端把客户端调用时传入的string参数打印出来
  rpc DoAdd(AddParams) returns (AddRes){} //这个函数将把客户端传入的数字加起来
  rpc DoMultiply(talk.MultiplyParams) returns (talk.MultiplyRes){}
}

• protoc命令
  • 执行位置
    protoc要在~/grpcRe/serv下执行，因为上面的proto文件中，import和option的路径都是从此目录开始的。
  • protoc执行语句

protoc --proto_path=. --go_out=. --go-grpc_out=. ./protos/*.proto

其中–proto_path是指import标签查找proto文件的目录 --go_out和–go-grpc_out参数和proto文件中的option标签搭配用来指定文件生成位置 最后一个参数用于指定proto文件,*.proto用于指定其目录下的所有proto文件