gRPC

Note#

  • guides/concepts
    • 服务定义
    • 使用方式
    • RPC 生命周期
      • 单向 RPC
      • 服务端流
      • 客户端流
      • 双向流
      • 超时
      • 终端
      • 取消
      • 元数据
      • 通道
  • 实现
    • 使用 HTTP2 协议
    • 使用 HTTP2 Trailler 来标识是否还有后续包
      • Web 无法获取到该信息, 所以无法实现和使用 gRPC

Docker#

  • 避免安装编译等繁杂的过程
  • Dockerfile
  • AlpineLinux Packages grpc
  • grpc
  • grpc-java
  • grpc-go
    • protowrap
  • grpc-swift
  • grpc-slate
# 假设 api 位于当前目录下的 apis
docker run --rm -it -v $PWD:/host --workdir /host wener/grpc
# 创建目标目录
# 注意: 如果删除了 proto 文件, 目录下之前生成的的文件不会被删除, 此时建议删除目录从新生成
# 注意: 文件生成在了当前目录, 需要同步到项目中. 也可以直接生成到项目中
mkdir java javanano php go objc js ruby python csharp node slatedoc
# 定义常用参数
# 注意: 如果文件列表发生了变化需要从新执行
COMMON_ARGS="$(echo -I . apis/**/*.proto)"
# Generate Java
protoc $COMMON_ARGS --plugin=$(which protoc-gen-grpc-java) --java_out=./java --grpc-java_out=./java
# Generate Java Nano
protoc $COMMON_ARGS --plugin=$(which protoc-gen-grpc-java) --java_out=nano:./javanano --grpc-java_out=./javanano
# Generate Go by protowrap
# The last -I apis is required
protowrap $COMMON_ARGS --go_out=plugins=grpc:$HOME/go/src -I apis/
# Generate slate document
protowrap $COMMON_ARGS --slate_out=./slatedoc -I apis/
# Generate Swift
protoc $COMMON_ARGS --swift_out=./swift --swiftgrpc_out=./swift
# Generate PHP
protoc $COMMON_ARGS --plugin=protoc-gen-grpc=$(which grpc_php_plugin) --php_out=./php --grpc_out=./php
# Generate CXX
protoc $COMMON_ARGS --plugin=protoc-gen-grpc=$(which grpc_cpp_plugin) --cpp_out=./cpp --grpc_out=./cpp
# Generate C#
protoc $COMMON_ARGS --plugin=protoc-gen-grpc=$(which grpc_csharp_plugin) --csharp_out=./csharp --grpc_out=./csharp
# Generate ObjC
protoc $COMMON_ARGS --plugin=protoc-gen-grpc=$(which grpc_objective_c_plugin) --objc_out=./objc --grpc_out=./objc
# Generate Ruby
protoc $COMMON_ARGS --plugin=protoc-gen-grpc=$(which grpc_ruby_plugin) --ruby_out=./ruby --grpc_out=./ruby
# Generate Python
protoc $COMMON_ARGS --plugin=protoc-gen-grpc=$(which grpc_python_plugin) --python_out=./objc --grpc_out=./python
# Generate Node
protoc $COMMON_ARGS --plugin=protoc-gen-grpc=$(which grpc_node_plugin) --js_out=import_style=commonjs,binary:./node --grpc_out=./node

安装#

# grpc_cli
# grpc_cpp_plugin
# grpc_csharp_plugin
# grpc_node_plugin
# grpc_objective_c_plugin
# grpc_php_plugin
# grpc_python_plugin
# grpc_ruby_plugin
brew install grpc
# 不 link 则使用绝对路径
brew link grpc
# 变量定义简化操作
# =========
# 安装 gRPC 后会包含很多插件
# # 生成 cpp, node, php, c#, ruby, python, objc 的方式是一样的
GRPC_BIN=$(brew --prefix grpc)/bin
# 定义 pb 路径
PROTO_PATH=./apis/
# 对路径进行展开
PROTO_FILES=(apis/**/*.proto)
PROTO_ARGS="-I $PROTO_PATH ${PROTO_FILES[*]}"
# 覆盖 protoc
alias protoc="protoc $PROTO_ARGS"
# gRPC 生成
# =========
# --js_out=./node 生成 protobuf
# --grpc_out=./node 生成 grpc
# --plugin=protoc-gen-grpc=$GRPC_BIN/grpc_node_plugin 使用 grpc_node_plugin 来生成 node 的 grpc
# -I . 包从当前目录查找
# apis/**/*.proto 生成所有 apis 下的 proto
protoc --js_out=./node --grpc_out=./node --plugin=protoc-gen-grpc=$GRPC_BIN/grpc_node_plugin -I . apis/**/*.proto
# Golang
# =========
# 不支持一次性生成多个包
# https://github.com/golang/protobuf/pull/40
# 可以使用 https://github.com/square/goprotowrap 规避
go get -u github.com/golang/protobuf/{proto,protoc-gen-go}
go get -u google.golang.org/grpc
# Golang 可直接生成 gRPC 和 Protobuf
protoc --go_out=plugins=grpc:$HOME/go/src -I . apis/**/*.proto
# 使用 protowrap
go get -u github.com/square/goprotowrap/cmd/protowrap
# -I apis/ 是必须的, 要有有一个前缀
protowrap --go_out=plugins=grpc:$HOME/go/src -I . -I apis/ apis/**/*.proto
# https://github.com/gogo/protobuf
# gogoprotobuf is a fork of golang/protobuf with extra code generation features.
# 扩展 https://github.com/gogo/protobuf/blob/master/extensions.md
#
# protoc-gen-gogofast (same as gofast, but imports gogoprotobuf)
# protoc-gen-gogofaster (same as gogofast, without XXX_unrecognized, less pointer fields)
# protoc-gen-gogoslick (same as gogofaster, but with generated string, gostring and equal methods)
go get -u github.com/gogo/protobuf/protoc-gen-gofast
protowrap --gofast_out=plugins=grpc:$HOME/go/src -I . -I apis/ apis/**/*.proto
# Java
# =========
# Java 插件需要自己编译
git clone https://github.com/grpc/grpc-java
cd grpc-java/compiler
../gradlew java_pluginExecutable
# 插件完整路径
realpath build/exe/java_plugin/protoc-gen-grpc-java
GEN_JAVA="$(realpath build/exe/java_plugin/protoc-gen-grpc-java)"
# 生成 gRPC
protoc --plugin=protoc-gen-grpc-java=$GEN_JAVA --grpc-java_out=$PWD/java -I . proto/**/*.proto
# 生成 protobuf
protoc -I . --java_out=./java proto/**/*.proto
# 生成 nano 的 pb
protoc -I . --javanano_out=./java proto/**/*.proto
# 生成 gRPC lite
protoc --plugin=protoc-gen-grpc-java=$GEN_JAVA --grpc-java_out=lite:$PWD/java -I . proto/**/*.proto
# 生成 gRPC nano
protoc --plugin=protoc-gen-grpc-java=$GEN_JAVA --grpc-java_out=nano:$PWD/java -I . proto/**/*.proto
# Swift
# =========
# https://github.com/grpc/grpc-swift
git clone https://github.com/grpc/grpc-swift
cd grpc-swift/Plugin
make
GEN_SWIFT=$(realpath .)
# 生成 pb 和 grpc
protoc --plugin=$GEN_SWIFT/protoc-gen-swift --swift_out=./swift -I . proto/**/*.proto
protoc --plugin=$GEN_SWIFT/protoc-gen-swiftgrpc --swiftgrpc_out=./swift -I . proto/**/*.proto
# Node
# =========
protoc --js_out=./node --grpc_out=./node --plugin=protoc-gen-grpc=$GRPC_BIN/grpc_node_plugin -I . proto/**/*.proto
# 使用 grpc-tools 生成
yarn global add grpc-tools
protoc -I=. ./protos/product.proto \
--js_out=import_style=commonjs,binary:./server \
--grpc_out=./server \
--plugin=protoc-gen-grpc=`which grpc_tools_node_protoc_plugin`
# ts-protoc-gen
# =========
# https://github.com/improbable-eng/ts-protoc-gen
# 生成 Typescript 定义 .d.ts
# Gateway
# =========
# Web <-> gRPC
# 生成网关代码和 Swagger 配置
go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway
go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger
# 生成 stub
protoc --go_out=plugins=grpc:. -I proto/ proto/hello.proto
# 生成反向代理
protoc --grpc-gateway_out=logtostderr=true:. -I proto/ proto/hello.proto
# 生成 swagger
protoc --swagger_out=logtostderr=true:. -I proto/ proto/hello.proto
# prototools
# =========
# 生成文档, json, dump
# https://github.com/sourcegraph/prototools
go get -u sourcegraph.com/sourcegraph/prototools/cmd/protoc-gen-doc
# 如果找不到文件可以考虑指定 filemap=./tmpl/filemap.xml
protowrap --doc_out=./apidoc -I . -I apis/ apis/**/*.proto
# pseudomuto/protoc-gen-doc
# =========
# 生成文档, 支持生成 HTML, JSON, DocBook, Markdown
# 默认模板比 prototools 好看
# https://github.com/pseudomuto/protoc-gen-doc
go get -u github.com/pseudomuto/protoc-gen-doc/cmd/...

Java#

class Tests{
// TLS 服务端
@Test
public void testTLSSvr() throws IOException, InterruptedException {
java.security.Security.addProvider(
new org.bouncycastle.jce.provider.BouncyCastleProvider()
);
int port = 8443;
Server server = NettyServerBuilder
.forPort(port)
.sslContext(GrpcSslContexts
.forServer(new File("localhost.pem"),new File("localhost-key.pem"))
.trustManager(new File("ca.pem"))
// 要求客户端认证
.clientAuth(ClientAuth.REQUIRE).build())
.addService(new MyServiceImpl())
.build();
log.info("Server started, listening on " + port);
server.start().awaitTermination();
}
// TLS 客户端
@Test
public void testTLSCli() throws Exception {
java.security.Security.addProvider(
new org.bouncycastle.jce.provider.BouncyCastleProvider()
);
// 使用 Netty 实现, 也可以使用 OkHttp 实现
ManagedChannel channel = NettyChannelBuilder
.forAddress("localhost", 8443)
.sslContext(GrpcSslContexts
.forClient()
.trustManager(new File("ca.pem"))
// 双向认证才需要
.keyManager(
new File("cli.pem"),
new File("cli-key.pem")
)
.build())
.build();
// 创建阻塞客户端
MyServiceGrpcBlockingStub stub = MyServiceGrpc.newBlockingStub(channel);
GetInfoResponse info = stub.getInfo(GetInfoRequest.newBuilder().build());
System.out.println(info.getName());
}
}

PHP#

<?php
require __DIR__ . '/vendor/autoload.php';
$creds =
// 无 TLS
Grpc\ChannelCredentials::createInsecure()
// 只配置 CA 如果服务端不要求客户端认证
// \Grpc\ChannelCredentials::createSsl(file_get_contents("ca.pem"))
// 双向认证, 服务端要求客户端认证
// \Grpc\ChannelCredentials::createSsl(file_get_contents("ca.pem"),file_get_contents("cli-key.pem"),file_get_contents("cli.pem"))
;
$client = new \Wener\Service\V1\InfoServiceClient("localhost:5002", [
'credentials' => $creds,
]);
/**
* @var \Wener\Service\V1\GetInfoResponse $reply
* @var \Wener\Api\GrpcStatus $status Customized type for ide to hint type
*/
list($reply, $status) = $client->GetInfo(new \Wener\Service\V1\GetInfoRequest())->wait();
echo $status->code . PHP_EOL;
echo $reply->getName() . PHP_EOL;
// All Status
print_r($status);
// JSON
// 再次解码编码是为了方便调试
echo json_encode(json_decode($reply->serializeToJsonString()), JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) . PHP_EOL;

Node#

# 最基本的只需要这两个依赖
yarn add google-protobuf
yarn add grpc
# 调试相关的环境变量
GRPC_TRACE=all
GRPC_VERBOSITY=DEBUG
const grpc = require('grpc');
const fs = require('fs');
// 生成的 pb 对象
const messages = require('./service_pb');
// 生成 grpc 客户端和服务端
const services = require('./service_grpc_pb');
let client = new services.ServiceClient('service.wener.me:443',
// 无 TLS
// grpc.credentials.createInsecure(),
// 使用 self-signed 证书
grpc.credentials.createSsl(fs.readFileSync('ca.pem'), fs.readFileSync('cli-key.pem'), fs.readFileSync('cli.pem'))
);
// 发起请求
let request = new messages.GetInfoRequest();
client.getInfo(request, (err, response) => {
console.log('Service name', response.getName())
})

Golang#

# http2 相关的环境变量
GODEBUG=http2client=0 # disable HTTP/2 client support
GODEBUG=http2server=0 # disable HTTP/2 server support
GODEBUG=http2debug=1 # enable verbose HTTP/2 debug logs
GODEBUG=http2debug=2 # ... even more verbose, with frame dumps

Client#

package main
func main(){
}

Server#

package main
var (
ServerCert string
ServerKey string
RootCA string
Addr string
)
func main() {
flag.StringVar(&ServerCert, "cert", "", "")
flag.StringVar(&ServerKey, "key", "", "")
flag.StringVar(&RootCA, "ca", "", "")
flag.StringVar(&Addr, "addr", "", "")
flag.Parse()
var srv *grpc.Server
lis, err := net.Listen("tcp", Addr)
if err != nil {
panic(fmt.Errorf("could not list on %s: %s", Addr, err))
}
if ServerCert == "" {
srv = grpc.NewServer()
} else {
logrus.WithField("cert", ServerCert).Info("With TLS")
// 读取证书信息
certificate, err := tls.LoadX509KeyPair(ServerCert, ServerKey)
if err != nil {
panic(fmt.Errorf("could not load client key pair: %s", err))
}
// Create a certificate pool from the certificate authority
certPool := x509.NewCertPool()
ca, err := ioutil.ReadFile(RootCA)
if err != nil {
panic(fmt.Errorf("could not read ca certificate: %s", err))
}
// Append the certificates from the CA
if ok := certPool.AppendCertsFromPEM(ca); !ok {
panic(errors.New("failed to append ca certs"))
}
creds := credentials.NewTLS(&tls.Config{
// 如何对客户端进行认证, 可进行双向认证
ClientAuth: tls.VerifyClientCertIfGiven,
Certificates: []tls.Certificate{certificate},
ClientCAs: certPool,
})
srv = grpc.NewServer(grpc.Creds(creds))
}
// Create the gRPC server with the credentials
service.RegisterInfoServiceServer(srv, &DemoStatus{})
logrus.WithField("addr", Addr).Info("Serving")
// Serve and Listen
if err := srv.Serve(lis); err != nil {
panic(fmt.Errorf("grpc serve error: %s", err))
}
}
type DemoStatus struct {
service.InfoServiceServer
}
func (DemoStatus) GetInfo(context.Context, *service.GetInfoRequest) (*service.GetInfoResponse, error) {
logrus.Info("Handle request")
return &service.GetInfoResponse{Name: "Demo Service"}, nil
}

Web#

Typescript#

https://www.npmjs.com/package/ts-protoc-gen

grpc-gateway#

  • grpc-gateway
    • gRPC to JSON proxy generator
  • 支持 googleapis 中的 http 定义
  • Features
    • Generating JSON API handlers
    • Method parameters in request body
    • Method parameters in request path
    • Method parameters in query string
    • Enum fields in path parameter (including repeated enum fields).
    • Mapping streaming APIs to newline-delimited JSON streams
    • Mapping HTTP headers with Grpc-Metadata- prefix to gRPC metadata (prefixed with grpcgateway-)
    • Optionally emitting API definition for Swagger.
    • Setting gRPC timeouts through inbound HTTP Grpc-Timeout header.
  • 可以只拷贝需要的导入文件
    • google/api/annotations.proto
    • google/api/http.proto
  • 然后在 rpc 中添加 http 定义即可
rpc SayHello (HelloRequest) returns (HelloReply) {
option (google.api.http) = {
post:"/v1/greeter/hello"
body:"*"
};
}
# 安装
go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway
go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger
go get -u github.com/golang/protobuf/protoc-gen-go
# 生成 stub
protoc --go_out=plugins=grpc:. -I proto/ proto/hello.proto
# 生成反向代理
protoc --grpc-gateway_out=logtostderr=true:. -I proto/ proto/hello.proto
# 生成 swagger
protoc --swagger_out=logtostderr=true:. -I proto/ proto/hello.proto
# 拉取相关依赖
go get .
# 添加 main, 启动时调用注册

Auth#

  • grpc/grpc-java/SECURITY.md
  • guides/auth
    • SSL/TLS 双向认证
    • 基于 Token
  • 授权分为整个通道和单次请求
  • gRPC 可以自带元数据头, 因此也可以自定义授权

案例#

GCP#

  • googleapis/googleapis

  • googleapis/toolkit

  • googleapis/artman

  • GAPIC

  • selector

    • 逗号分隔
    • 可以使用 * 做匹配, 但是只能放在最后
      • 例如 foo.*, 但不能写 foo.*b, foo.*.abc
      • 可以使用 * 匹配所有
  • 服务结构

    • api
      • 接口相关的定义
      • backend.proto
        • 定义服务的后端
      • service.proto
        • 对服务的定义
      • servicecontrol
        • 服务控制
        • 对服务的检查报告
      • servicemanagement
        • 服务管理
        • 对服务的 CRUD, 启用停用
    • appengine
# artman
# 包含了 grpc 生成个个语言的环境
docker pull googleapis/artman
docker run -it --rm -v $PWD/googleapis:/googleapis -v $PWD/artman:/artman -w /googleapis googleapis/artman
# artman --api pubsub --language python

Service Control#

  • Google Service Control
  • How to control access to your service.
  • How to validate API keys.
  • How to send logging and monitoring data to both consumers and producers.
  • How to create and manage dashboards to visualize such data.
  • How to scale the control plane components with your service.

Architecture

  • Managed services
    • Google Service Management 管理每个服务和其配置, 用于定制化 Google Service Control 的行为. 服务配置也被用于 Google Cloud Platform Console 显示其配置, 启用/禁用 等.
    • For example:
      • Google Cloud Pub/Sub (pubsub.googleapis.com)
      • Google Cloud Vision (vision.googleapis.com)
      • Google Cloud Bigtable (bigtable.googleapis.com)
      • Google Cloud Datastore (datastore.googleapis.com)
  • Operations
    • 表示被管理服务的活动, 例如接口调用或资源使用
    • 每个操作都关联一个被管理的服务,和调用者, 也包含调用的相关信息, 例如调用方法, 资源使用量等
  • Check
    • Check if the consumer is still active.
    • Check if the consumer has enabled the service.
    • Check if the API key is still valid.
    • 对接口进行检测以保证更好的性能, 更高的可用性
  • Report

Service Management#

  • Google Service Management
  • Service producer
    • 由谷歌开发者负责发布维护被管理的服务. 每个被管理的服务都由一个服务生产者所有
  • Service consumers
    • 启用了接口调用的管理服务, 一个被管理的服务可以有很多服务消费者
  • Service configurations
    • 每个被管理的服务都有自己的配置描述, 包括名字, 标题, RPC 接口定义, REST 接口定义, 文档, 授权等
  • Service rollouts
    • 流量控制

源码和使用分析#

  • PB 附带了所有解析后的消息格式定义
  • PB 3 增加了 java-util, 可以进行 JSON 序列化
    • JsonFormat 打印时需要使用 com.google.protobuf.util.JsonFormat.TypeRegistry 来反查具体类
  • 优化模式
    • SPEED
      • Generate complete code for parsing, serialization, etc.
    • CODE_SIZE
      • Use ReflectionOps to implement these methods.
    • LITE_RUNTIME
      • Generate code using MessageLite and the lite runtime.
  • 命名空间
    • 与 Java 命名空间的概念相似
    • 生成的类的包名可以不同于 proto 的包
    • 所有定义的消息都有自己的类型和命名空间
    • 因此 Any 消息才能根据一个 url 和数据来还原消息
    • 类型的引用也是基于该命名空间

Java#

  • 服务端支持 Netty
  • 客户端支持 OkHttp 和 Netty
  • 传输层解析出请求的方法
    • 方法名实际包含了请求类 foo.bar.Greeter/SayHello
  • 实际方法触发位置为 io.grpc.ServerCall.Listener 的不同实现
  • ServerServiceDefinition
    • 服务定义
  • ServiceDescriptor
    • 服务描述
  • MethodDescriptor
    • 方法描述
    • 类型
      • UNARY - 请求 -> 响应
      • CLIENT_STREAMING - 流请求 -> 响应
      • SERVER_STREAMING - 请求 -> 流响应
      • BIDI_STREAMING - 流请求 -> 流响应
  • HandlerRegistry
    • 服务注册中心
  • ServerInterceptor
    • 服务端拦截器
    • 常见用例
      • 授权认证
      • 日志监控
      • 代理
  • ServerCallHandler
    • 实际请求处理的方法
  • Stream
    • 客户端和服务端的通讯流
  • io.grpc.Context
    • 跨线程的处理上下文
  • 速度优化
    • 会生成 MethodHandlers
    • 统一方法调用
    • 实现所有类型的方法调用接口
      • io.grpc.stub.ServerCalls.UnaryMethod
      • io.grpc.stub.ServerCalls.ServerStreamingMethod
      • io.grpc.stub.ServerCalls.ClientStreamingMethod
      • io.grpc.stub.ServerCalls.BidiStreamingMethod
    • 实际调用时使用 switch 和事先给定的方法 id 进行请求, 避免使用反射
  • io.grpc.Server
    • 服务端
    • InternalServer
      • 用于不同链接层实现的接口
      • 建立新的链接时回调 ServerListener#transportCreated
  • io.grpc.Status
    • 表达异常和状态
  • 基础
    • Stream
    • StreamListener
    • 基本流程
      • 方法 -> Call -> Stream
      • 生成 Call 时会创建对应的 Feature
      • 同步请求是循环等待 Feature 完成
    • 完整方法名的命名规则为
      • 完整的服务名/方法名
      • wener.scel.v1.Scel/Search
  • 客户端
    • ClientCall
      • ClientCall.Listener
        • onHeaders(Metadata)
        • onMessage(RespT)
        • onClose(Status,Metadata)
      • 处理流程
      • 职责
    • ManagedChannelBuilder
    • ClientTransport
      • ManagedClientTransport
        • 有生命周期管理
        • ConnectionClientTransport
          • 基于链接
          • 有属性
    • ClientStream
    • ClientStreamListener
    • 生成的客户端分为三种类型
      • Stub
        • 有所有的方法
        • 响应均为 io.grpc.stub.StreamObserver
      • BlockingStub
        • 阻塞接口
        • 响应为直接的对象
        • 流响应为 Iterator
        • 不生成流请求
      • FeatureStub
        • 以 Feature 作为返回状态
  • 服务端
    • ServerCall
      • 处理流程
        • ServerStream -> ServerStreamListener
        • ServerStreamListener#messageRead
          • 会对请求对象进行解析
        • ServerCall.Listener#onMessage
          • 拦截处理在这一层发生
          • ServerCallHandler 负责从 ServerCall 创建 ServerCall.Listener
          • 即实际的方法处理发生在这里
      • ServerCalls
        • 提供 ServerCallServerCallHandler 的适配
        • 主要用于简化实现
        • ServerCall -> ServerCall.Listener
        • 一个方法 MethodDescriptor 对应一个 ServerCallHandler
      • 职责
        • ServerCall.Listener 用于接收消息
        • ServerCall 用于发送和向客户端请求消息
        • ServerCallHandler 方法处理
    • ServerBuilder
    • ServerTransport
    • ServerStream
    • ServerStreamListener
  • Netty
    • NettyServerProvider
    • NettyChannelProvider
    • NettyServer
    • NettyServerHandler
      • 服务端 GRPC 处理
      • 执行上下文
    • 服务端
      • NettyServerTransport
      • NettyServerStream
    • 客户端
      • NettyClientTransport
      • NettyClientStream

protoc --help

$ protoc --help
Usage: protoc [OPTION] PROTO_FILES
Parse PROTO_FILES and generate output based on the options given:
-IPATH, --proto_path=PATH Specify the directory in which to search for
imports. May be specified multiple times;
directories will be searched in order. If not
given, the current working directory is used.
--version Show version info and exit.
-h, --help Show this text and exit.
--encode=MESSAGE_TYPE Read a text-format message of the given type
from standard input and write it in binary
to standard output. The message type must
be defined in PROTO_FILES or their imports.
--decode=MESSAGE_TYPE Read a binary message of the given type from
standard input and write it in text format
to standard output. The message type must
be defined in PROTO_FILES or their imports.
--decode_raw Read an arbitrary protocol message from
standard input and write the raw tag/value
pairs in text format to standard output. No
PROTO_FILES should be given when using this
flag.
-oFILE, Writes a FileDescriptorSet (a protocol buffer,
--descriptor_set_out=FILE defined in descriptor.proto) containing all of
the input files to FILE.
--include_imports When using --descriptor_set_out, also include
all dependencies of the input files in the
set, so that the set is self-contained.
--include_source_info When using --descriptor_set_out, do not strip
SourceCodeInfo from the FileDescriptorProto.
This results in vastly larger descriptors that
include information about the original
location of each decl in the source file as
well as surrounding comments.
--dependency_out=FILE Write a dependency output file in the format
expected by make. This writes the transitive
set of input file paths to FILE
--error_format=FORMAT Set the format in which to print errors.
FORMAT may be 'gcc' (the default) or 'msvs'
(Microsoft Visual Studio format).
--print_free_field_numbers Print the free field numbers of the messages
defined in the given proto files. Groups share
the same field number space with the parent
message. Extension ranges are counted as
occupied fields numbers.
--plugin=EXECUTABLE Specifies a plugin executable to use.
Normally, protoc searches the PATH for
plugins, but you may specify additional
executables not in the path using this flag.
Additionally, EXECUTABLE may be of the form
NAME=PATH, in which case the given plugin name
is mapped to the given executable even if
the executable's own name differs.
--cpp_out=OUT_DIR Generate C++ header and source.
--csharp_out=OUT_DIR Generate C# source file.
--java_out=OUT_DIR Generate Java source file.
--javanano_out=OUT_DIR Generate Java Nano source file.
--js_out=OUT_DIR Generate JavaScript source.
--objc_out=OUT_DIR Generate Objective C header and source.
--php_out=OUT_DIR Generate PHP source file.
--python_out=OUT_DIR Generate Python source file.
--ruby_out=OUT_DIR Generate Ruby source file.

聊天#

syntax = "proto3";
// https://github.com/yafithekid/grpc-chat/blob/master/src/main/proto/rpcchat.proto
option java_package = "com.if4031.proto";
option objc_class_prefix = "HLW";
service ChatService {
rpc join (JoinRequest) returns (Response);
rpc leave (LeaveRequest) returns (Response);
rpc send (SendRequest) returns (Response);
rpc sendAll (SendAllRequest) returns (Response);
rpc recvAll (RecvAllRequest) returns (ChatResponse);
}
message Message {
string nickname = 1;
string channel = 2;
string content = 3;
int64 timestamp = 4;
}
message Response {
string status = 1;
string message = 2;
}
message ChatResponse {
string status = 1;
string message = 2;
repeated Message chats = 3;
}
message JoinRequest {
string nickname = 1;
string channel = 2;
}
message LeaveRequest {
string nickname = 1;
string channel = 2;
}
message SendRequest {
string nickname = 1;
string channel = 2;
string message = 3;
}
message SendAllRequest {
string nickname = 1;
string message = 2;
}
message RecvAllRequest {
string nickname = 1;
}
syntax = "proto3";
service Chat {
rpc Authorize(RequestAuthorize) returns (ResponseAuthorize);
rpc Connect(RequestConnect) returns (stream Event);
rpc Say(CommandSay) returns (None);
}
message None {}
message RequestAuthorize {
string name = 1;
}
message ResponseAuthorize {
bytes session_id = 1;
}
message RequestConnect {
bytes session_id = 1;
}
message CommandSay {
bytes session_id = 1;
string message = 2;
}
message Event {
oneof event {
EventNone none = 1;
EventJoin join = 2;
EventLeave leave = 3;
EventLog log = 4;
}
}
message EventNone {}
message EventJoin {
string name = 1;
}
message EventLeave {
string name = 1;
}
message EventLog {
string name = 1;
string message = 2;
}
syntax = "proto3";
option java_package = "com.chat";
package Chat;
service MyChat{
rpc login (Username) returns (LoginSuccess){}
rpc join (ChannelName) returns (IsSuccess){}
rpc leave (ChannelName) returns (IsSuccess){}
rpc sendMessage (Message) returns (IsSuccess) {}
rpc broadcastMessage (BroadcastMsg) returns (IsSuccess) {}
rpc getMessages (Username) returns (Messages) {}
}
message Username {
string username = 1;
}
message LoginSuccess{
bool success = 1;
string username = 2;
}
message ChannelName {
string username = 1;
string channel = 2;
}
message IsSuccess {
bool success = 1;
}
message Message {
string username = 1;
string channel = 2;
string msg = 3;
}
message Messages {
bool success = 1;
repeated string messages = 2;
}
message BroadcastMsg {
string username = 1;
string msg = 2;
}

FAQ#

all SubConns are in TransientFailure#