grpc

相关网站

#mac系统中采用brew,很可能已安装过
brew list | grep protobuf
brew info protobuf

golang使用图示

sequenceDiagram actor u as user actor pf as proto文件 actor pc as protoc actor pgg as protoc-gen-go actor pb as .pb.go文件 u->>pf: 编写message u->>pc: 启动 pc->>pf: 读取 pc->>pgg: 调用 pgg->>pb: 生成 u->>pb: 使用
  • 生成文件
sequenceDiagram actor u as user actor pf as proto文件 actor pc as protoc actor pgg as protoc-gen-go actor pb as .pb.go文件 actor pggg as protoc-gen-go-grpc actor gpb as grpc.pb.go文件 u->>pf: 编写message,service u->>pc: 启动 pc->>pf: 读取 pc->>pgg: 调用 pgg->>pb: 生成 pc->>pggg: 调用 pggg->>gpb: 生成 u->>pb: 使用 u->>gpb: 使用
  • 客户端使用
sequenceDiagram actor u as user actor gpb as grpc.pb.go文件 actor r as rpc服务器 u->>r: Dial()conn u->>gpb: Newclient(conn) u->>gpb: client.XXX() gpb->>+r: conn发送请求 r-->>-gpb: return gpb-->>u: return
  • 服务端使用
sequenceDiagram actor u as user actor t as tcp actor g as grpc actor gpb as grpc.pb.go文件 u->>t: Listen()conn u->>g: NewServer u->>gpb: NewService u->>g: RegService u->>+g: Serve(conn) g->>g: 等待客户端

实践示例

protoc --proto_path=IMPORT_PATH \
--cpp_out=DST_DIR \
--java_out=DST_DIR \
--python_out=DST_DIR \ 
--go_out=DST_DIR \
--ruby_out=DST_DIR \ 
--objc_out=DST_DIR \
--csharp_out=DST_DIR \
path/to/file.proto

#--go_out表示启动protoc-gen-go插件
#proto文件和本脚本在同一目录,执行前要cd到本目录,防止出现各种相对路径找不到
#Could not make proto path relative: *.proto: No such file or directory
protoc --cpp_out=../cpp --python_out=../python --go_out=../event *.proto

#--go-grpc_out表示启动protoc-gen-go-grpc插件
protoc --go_out=../event --go-grpc_out=../event *.proto
  • user.proto内容
syntax = "proto3";

option go_package = "./;event";

import "person.proto";

service User {
    rpc Reg(Person)returns(Person){}
}
  • example.proto内容
syntax = "proto3";

package example;

//protoc-gen-go The import path must contain at least one period ('.') or forward slash ('/') character.
//https://developers.google.com/protocol-buffers/docs/reference/go-generated
//表示直接生成文件到go_out目录
option go_package = "./;event";

//vscode中vscode-proto3插件import提示无法找到other.proto
//vscode直接打开other.proto所在目录,不要打开父目录
import "other.proto";

//单行注释
message Person {
    string name = 1;
    int32 id = 2;
    repeated string emails = 3;
    map<string, int32> dict = 4;
    repeated Order orders = 5;
  }
  
  /*
  多行注释
  */
  message SearchResponse {
    message Result {
      string url = 1;
      string title = 2;
      repeated string snippets = 3;
    }
    repeated Result results = 1;
  }
  • other.proto内容
syntax = "proto3";

package example;

option go_package = "./;event";

message Order {
    int64 id = 1;
    uint64 date = 2;
    string customer = 3;
    double price = 4;
    string goods = 5;
    string remark = 6;
}

数据类型

类型1 类型2 默认值

更多

  • gRPC + Opentracing + Zipkin 分布式链路追踪系统