proto文件

1,message介绍

message:protobuf中定义一个消息类型是通过关键字message字段指定的。消息就算需要传输的数据格式的定义。message关键字类似于C++中的class,Java中的Class,go中的struct

例如:

在消息中承载的数据分别对应于每一个字段。

其中每个字段都有一个名字和一种类型。

2,字段规则

required:消息体中必填字段,不设置会导致编解码异常。一般不填就认为是必填字段了。
optional:消息体中可选字段。生成的是对应的指针。
repeated:消息体中可重复字段,重复的值的顺序会被保留,在go中重复的会被定义为切片。

这里我们来定义一下

然后我们生成一下

看下文件

这里就变成了一个切片

3,字段映射

4,默认值

protobuf3删除了protobuf2中用来设置默认值的default关键字,取而代之的是protobuf3为各类型定义的默认值,也就是约定的默认值,如下表:

5,标识号

标识号:在消息体的定义中,每个字段都必须要有一个唯一的标识号,标识号是[0.2^29-1]范围内的一个整数。

以Person为例,name=1,id=2,email=3,phones=4中的1-4就是标识号

6,定义多个消息类型

一个proto文件中可以定义多个消息类型

7,嵌套消息

可以在其他消息类型中定义,使用消息类型,在下面的例子中,Person消息就定义在PersonInfo消息内

如果你想在它的父消息类型的外部重用这个消息类型,你需要以PersonInfo.Person的形式来使用它,如:

当然,你也可以将消息嵌套任意多层,如:

8,定义服务

如果想要将消息类型用在RPC系统中,可以在.PROTO文件中定义一个RPC服务接口,protocolbuffer编译器会根据所选择的不同语言生成服务接口代码及存根。

上述代表表示,定义了一个RPC服务,该方法接收SearchRequest返回SearchResponse

 

回想我年轻的时候,在做一个项目时,需要计算斐波那契数列第 n 项的值。但是我只会使用递归来实现。众所周知,递归算法计算斐波那契数列的效率极差,速度极慢。

于是我求助于当时我的师父,问他有没有办法帮我解决这个问题。

我师父说:“有啊,我写过,但是代码是用C++ 写的,你估计看不懂。不过没关系,你用 Python 直接调用就可以了。”

我很惊讶:“用 Python 直接调用C++代码吗?看起来似乎很麻烦啊。”

师父说:“一点也不麻烦。我给你一个.proto 文件和一个地址,你拿去自动生成代码就能调用了。”

于是,我拿到了一个mentors_secret.proto文件,里面的内容非常简单:

syntax = "proto3";


message NumToCalc {
int32 num = 1;
}


message Result {
int32 result = 1;
string msg = 2;
bool success = 3;
}


service MentorsSecret {
rpc CalcFib(NumToCalc) returns (Result) {}
}

还有一个地址:122.51.39.219:8766

原来是使用 gRPC 啊。这样我就知道怎么做了。

安装环境

首先,我们先安装Python 版本的gRPC:

pip install grpcio grpcio-tools

生成代码

接下来,基于这个mentors_secret.proto文件,自动生成代码。cd进入mentors_secret.proto文件所在的文件,执行下面的命令:

python3 -m grpc_tools.protoc -I . --python_out=. --grpc_python_out=. ./mentors_secret.proto

此时,可以看到当前文件夹中生成了两个文件:mentors_secret_pb2.pymentors_secret_pb2_grpc.py

如下图所示:

图片

这两个文件的内容,不需要看

调用远程服务

接下来,创建一个新文件,叫做client.py,用来调用远程的函数:

import grpc
from mentors_secret_pb2 import NumToCalc
from mentors_secret_pb2_grpc import MentorsSecretStub


channel = grpc.insecure_channel('122.51.39.219:8766')
stub = MentorsSecretStub(channel)

result = stub.CalcFib(NumToCalc(num=36))
print('斐波那契数列第36像是:', result.result)

代码加上空行总共只有10行。1-3行导入模块,6,7行创建远程链接。第9行调用远程的函数。第10行打印结果。

我们来看看运行效果:

图片

运行结果秒出。

总结

当我们拿到一个.proto文件,需要去调用gRPC 服务时,我们一般有如下步骤:

  1. 自动生成mentors_secret_pb2.pymentors_secret_pb2_grpc.py文件。
  2. 查看.proto文件里面,service后面的名字MentorsSecret,如下图所示:
图片
  1. 编写固定的代码:
import grpc
from mentors_secret_pb2_grpc import MentorsSecretStub # service 名字后面加上 Stub


channel = grpc.insecure_channel('远程服务地址和 端口')
stub = MentorsSecretStub(channel)
  1. 调用远程函数。通过.proto文件,可以知道远程函数CalcFib接收一个参数NumToCalc,所以把它导入进来:from mentors_secret_pb2 import NumToCalc,它里面的参数为num,所以调用远程服务时赋值:
para = NumToCalc(num=36)
calc_result = stub.CalcFib(para)
  1. .proto知道返回的结果是Result里面的result属性。于是打印calc_result.result获得结果。

本文中的 gRPC 地址122.51.39.219:8766,我会给大家保留到2020-11-05。有兴趣的同学,可以自己测试一下。

posted @ 2023-03-31 10:36  分类DHCP  阅读(140)  评论(0编辑  收藏  举报