protobuf的基本类型和默认值，python中的小坑

标量数值类型

标量消息字段可以具有以下类型之一——该表显示了。原型文件，以及自动生成类中的对应类型:

默认值

python操作的坑

  1. 目录结构

  2. helloworld.proto
  1. syntax = "proto3";
  3. option go_package = "../proto;";
  5. service Greeter {
  6.     rpc SayHello (HelloRequest) returns (HelloReply) {}
  7. }
  9. message HelloRequest {
  10.     string name = 1;
  11.     repeated int32 id = 2;
  12. }
  14. message HelloReply {
  15.     string message = 1;
  16. }

切换到proto目录下，执行命令 python -m grpc_tools.protoc --python_out=. --grpc_python_out=. -I. helloworld.proto

3. server.py

  1. from concurrent.futures import ThreadPoolExecutor
  3. import grpc
  5. from grpc_hello.proto import helloworld_pb2_grpc, helloworld_pb2
  7. class Greeter(helloworld_pb2_grpc.GreeterServicer):
  8.     def SayHello(self, request, context):
  9.         return helloworld_pb2.HelloReply(message=f"你好, [name: {request.name}, id: {request.id}]")
  11. if __name__ == '__main__':
  12.     # 1. 实例化server
  13.     server = grpc.server(ThreadPoolExecutor(max_workers=10))
  14.     # 2. 注册逻辑到server中
  15.     helloworld_pb2_grpc.add_GreeterServicer_to_server(Greeter(), server)
  16.     # 3. 运行server
  17.     server.add_insecure_port("127.0.0.1:50051")
  18.     server.start()
  19.     # 主线程等待所有子线程
  20.     server.wait_for_termination()
  1. client.py
  1. import grpc
  3. from grpc_hello.proto import helloworld_pb2, helloworld_pb2_grpc
  5. if __name__ == '__main__':
  6.     with grpc.insecure_channel("127.0.0.1:50051") as channel:
  7.         greeter = helloworld_pb2_grpc.GreeterStub(channel)
  8.         # 方法一：
  9.         """
  10.         hello_request = helloworld_pb2.HelloRequest(
  11.             name="张三",
  12.             id=[1, 22, 33],
  13.         )
  14.         """
  15.         # 方法二：
  16.         hello_request = helloworld_pb2.HelloRequest()
  17.         hello_request.name = "李四"
  18.         # 此处就是python操作时的坑所在，不能直接等于，因为创建实例时已经对id初始化了
  19.         hello_request.id.extend([11, 22, 33])
  20.         hello_request.id.append(44)
  21.         rsp: helloworld_pb2.HelloReply = greeter.SayHello(hello_request)
  23.         print(rsp.message)

option go_package的作用

option go_package = "../proto;proto";

第一个分号前面的代表生成的pb文件保存的目录路径，第一个分号后面的代表包名称

当proto文件不同步的时候容易出现的问题

go的客户端和服务端

  1. client.go
点击查看代码 
  1. package main
  3. import (
  4. 	"context"
  5. 	"fmt"
  6. 	"goRPC/grpc_proto_test/proto"
  7. 	"google.golang.org/grpc"
  8. 	"log"
  10. )
  12. func main() {
  13. 	// 创建链接
  14. 	clientConn, err := grpc.Dial("127.0.0.1:50053", grpc.WithInsecure())
  15. 	if err != nil {
  16. 		log.Fatalf("链接失败, %s\n", err.Error())
  17. 	}
  18. 	defer clientConn.Close()
  19. 	// 声明客户端
  20. 	client := proto.NewGreeterClient(clientConn)
  21. 	// 客户端调用服务器的方法
  22. 	helloReplay, _ := client.SayHello(context.Background(), &proto.HelloRequest{
  23. 		Name: "马亚南",
  24. 		Url: "mayanan.cn",
  25. 	})
  27. 	fmt.Println(helloReplay.Message)
  28. }

2. server.go

点击查看代码 
  1. package main
  3. import (
  4. 	"context"
  5. 	"fmt"
  6. 	"goRPC/grpc_proto_test/proto"
  7. 	"google.golang.org/grpc"
  8. 	"log"
  9. 	"net"
  10. )
  12. type Greeter struct{}
  14. func (g *Greeter) SayHello(ctx context.Context, request *proto.HelloRequest) (*proto.HelloReply, error) {
  15. 	return &proto.HelloReply{
  16. 		Message: fmt.Sprintf("hello name: %s, url: %s", request.Name, request.Url),
  17. 	}, nil
  18. }
  20. func main() {
  21. 	// 实例化一个server
  22. 	server := grpc.NewServer()
  24. 	// 注册逻辑到server中
  25. 	proto.RegisterGreeterServer(server, &Greeter{})
  27. 	// 启动server
  28. 	listener, err := net.Listen("tcp", "127.0.0.1:50053")
  29. 	if err != nil {
  30. 		log.Fatalln(err.Error())
  31. 	}
  32. 	server.Serve(listener)
  34. }

python的客户端和服务端

  1. client.py
点击查看代码 
  1. import grpc
  3. from proto import hello_pb2, hello_pb2_grpc
  5. if __name__ == '__main__':
  6.     # 链接server
  7.     with grpc.insecure_channel("127.0.0.1:50053") as channel:
  8.         greeter = hello_pb2_grpc.GreeterStub(channel)
  9.         rsp = greeter.SayHello(hello_pb2.HelloRequest(name="马艳娜", url="https://mayanan.cn"))
  11.         print(rsp.message)
  1. server.py
点击查看代码 
  1. from concurrent.futures import ThreadPoolExecutor
  3. import grpc
  5. from proto import hello_pb2, hello_pb2_grpc
  7. class Greeter(hello_pb2_grpc.GreeterServicer):
  8.     def SayHello(self, request, context):
  9.         return hello_pb2.HelloReply(message=f"hello 姓名：{request.name} url: {request.url}")
  11. if __name__ == '__main__':
  12.     # 实例化server
  13.     server = grpc.server(ThreadPoolExecutor(max_workers=10))
  15.     # 注册逻辑到server中
  16.     hello_pb2_grpc.add_GreeterServicer_to_server(Greeter(), server)
  18.     # 启动server
  19.     server.add_insecure_port("127.0.0.1:50053")
  20.     server.start()
  21.     server.wait_for_termination()

proto文件中引入其它的proto文件

  1. base.proto文件
  1. syntax = "proto3";
  3. message Pong {
  4.     string id = 1;
  5. }
  1. hello.proto文件
  1. syntax = "proto3";
  3. import "Lib/site-packages/grpc_tools/_proto/google/protobuf/empty.proto";
  4. import "base.proto";
  6. option go_package = "../proto;proto";
  8. service Greeter {
  9.     rpc SayHello(HelloRequest) returns (HelloReply);
  10.     rpc Ping(google.protobuf.Empty) returns (Pong);
  11. }
  13. message HelloRequest {
  14.     string name = 1;
  15.     string url = 2;
  16. }
  17. message HelloReply {
  18.     string message = 1;
  19. }

嵌套的message对象

python中的用法

  1. base.proto
  1. syntax = "proto3";
  3. message Pong {
  4.     string id = 1;
  5. }
  1. hello.proto文件
点击查看代码 
  1. syntax = "proto3";
  3. import "google/protobuf/empty.proto";
  4. import "base.proto";
  6. option go_package = "../proto;proto";
  8. service Greeter {
  9.     rpc SayHello(HelloRequest) returns (HelloReply);
  10.     rpc Ping(google.protobuf.Empty) returns (Pong);
  11. }
  13. message HelloRequest {
  14.     string name = 1;
  15.     string url = 2;
  16. }
  17. message HelloReply {
  18.     string message = 1;
  20.     // 嵌套的message对象
  21.     message Result {
  22.         string name = 1;
  23.         string url = 2;
  24.     }
  26.     repeated Result data = 2;
  27. }

3. server.py

点击查看代码 
  1. from concurrent.futures import ThreadPoolExecutor
  3. import grpc
  5. from proto import hello_pb2, hello_pb2_grpc
  6. from google.protobuf.empty_pb2 import Empty
  7. from proto.base_pb2 import Pong
  9. result = hello_pb2.HelloReply.Result()
  10. pong = hello_pb2.base__pb2.Pong()
  11. empty = hello_pb2.google_dot_protobuf_dot_empty__pb2.Empty()

go中的用法

  1. base.proto
  1. syntax = "proto3";
  2. option go_package = "../proto;proto";
  4. message Empty {}
  5. message Pong {
  6.     string id = 1;
  7. }
  1. hello.proto
点击查看代码 
  1. syntax = "proto3";
  3. import "base.proto";
  5. option go_package = "../proto;proto";
  7. service Greeter {
  8.     rpc SayHello(HelloRequest) returns (HelloReply);
  9.     rpc Ping(Empty) returns (Pong);
  10. }
  12. message HelloRequest {
  13.     string name = 1;
  14.     string url = 2;
  15. }
  16. message HelloReply {
  17.     string message = 1;
  19.     // 嵌套的message对象
  20.     message Result {
  21.         string name = 1;
  22.         string url = 2;
  23.     }
  25.     repeated Result data = 2;
  26. }
  1. client.go
  1. result := proto.HelloReply_Result{}
  2. pong := proto.Pong{}
  3. empty := proto.Empty{}
  4. fmt.Println(result, pong, empty)

protobuf中的enum枚举类型

  1. 枚举类型定义
  1. enum Gender {
  2.     MALE = 0;
  3.     FEMALE = 1;
  4. }
  6. message HelloRequest {
  7.     string name = 1;
  8.     string url = 2;
  9.     Gender g = 3;
  10. }
  1. 枚举类型使用
  1. 	// 客户端调用服务器的方法
  2. 	helloReplay, _ := client.SayHello(context.Background(), &proto_bak.HelloRequest{
  3. 		Name: "马亚南",
  4. 		Url: "mayanan.cn",
  5. 		G: proto_bak.Gender_MALE,
  6. 	})

protobuf中的map类型

  1. map类型的定义
  1. message HelloRequest {
  2.     string name = 1;
  3.     string url = 2;
  4.     Gender g = 3;
  5.     map <string, string> mp = 4;
  6. }
  1. map类型的使用
  1. 	// 客户端调用服务器的方法
  2. 	helloReplay, _ := client.SayHello(context.Background(), &proto_bak.HelloRequest{
  3. 		Name: "马亚南",
  4. 		Url: "mayanan.cn",
  5. 		G: proto_bak.Gender_MALE,
  6. 		Mp: map[string]string{"name2": "李四", "age": "28"},
  7. 	})

protobuf内置的timestamp类型

  1. 将protoc中的include目录复制到当前项目proto_bak目录下，然后导入timestamp.proto文件，定义时间戳类型
点击查看代码 
  1. syntax = "proto3";
  3. import "include/google/protobuf/timestamp.proto";
  5. option go_package = "../proto_bak;proto_bak";
  7. service Greeter {
  8.     rpc SayHello(HelloRequest) returns (HelloReply);
  9. }
  11. enum Gender {
  12.     MALE = 0;
  13.     FEMALE = 1;
  14. }
  16. message HelloRequest {
  17.     string name = 1;
  18.     string url = 2;
  19.     Gender g = 3;
  20.     map <string, string> mp = 4;
  21.     google.protobuf.Timestamp addTime = 5;
  22. }
  24. message HelloReply {
  25.     string message = 1;
  26. }
  1. go代码中使用proto中的时间戳类型
点击查看代码 
  1. package main
  3. import (
  4. 	"context"
  5. 	"fmt"
  6. 	"goRPC/grpc_proto_test/proto_bak"
  7. 	"google.golang.org/grpc"
  8. 	"google.golang.org/protobuf/types/known/timestamppb"
  9. 	"log"
  10. 	"time"
  11. )
  13. func main() {
  14. 	// 创建链接
  15. 	clientConn, err := grpc.Dial("127.0.0.1:50053", grpc.WithInsecure())
  16. 	if err != nil {
  17. 		log.Fatalf("链接失败, %s\n", err.Error())
  18. 	}
  19. 	defer clientConn.Close()
  20. 	// 声明客户端
  21. 	client := proto_bak.NewGreeterClient(clientConn)
  22. 	// 客户端调用服务器的方法
  23. 	helloReplay, _ := client.SayHello(context.Background(), &proto_bak.HelloRequest{
  24. 		Name:    "马亚南",
  25. 		Url:     "mayanan.cn",
  26. 		G:       proto_bak.Gender_MALE,
  27. 		Mp:      map[string]string{"name2": "李四", "age": "28"},
  28. 		AddTime: timestamppb.New(time.Now()),
  29. 	})
  31. 	fmt.Println(helloReplay.Message)
  32. }

至此，protobuf大致讲解完毕。

protobuf详解的更多相关文章

  1. 通讯协议序列化解读（一） Protobuf详解教程

    前言:说到JSON可能大家很熟悉,是目前应用最广泛的一种序列化格式,它使用起来简单方便,而且拥有超高的可读性.但是在越来越多的应用场景里,JSON冗长的缺点导致它并不是一种最优的选择. 一.常用序列化 ...

  2. grpc系列- protobuf详解

    Protocol Buffers 是一种与语言.平台无关,可扩展的序列化结构化数据的方法,常用于通信协议,数据存储等等.相较于 JSON.XML,它更小.更快.更简单,因此也更受开发人员的青眯. 基本 ...

  3. Protocol Buffers编码详解，例子，图解

    Protocol Buffers编码详解,例子,图解 本文不是让你掌握protobuf的使用,而是以超级细致的例子的方式分析protobuf的编码设计.通过此文你可以了解protobuf的数据压缩能力 ...

  4. Protobuf 文件生成工具 Prototool 命令详解

    Protobuf 文件生成工具 Prototool 命令详解 简介 Prototool 是 Protobuf 文件的生成工具, 目前支持go, php, java, c#, object c 五种语言 ...

  5. ProtoBuf格式详解

    - 数据结构 通过前面的例子,可以看到PB的数据结构就是每项数据独立编码,包含一个表示数据类型 - Varint Varint是一种对数字进行编码的方法,将数字编码成不定长的二进制数据,数值越小,编码 ...

  6. 理论经典：TCP协议的3次握手与4次挥手过程详解

    1.前言 尽管TCP和UDP都使用相同的网络层(IP),TCP却向应用层提供与UDP完全不同的服务.TCP提供一种面向连接的.可靠的字节流服务. 面向连接意味着两个使用TCP的应用(通常是一个客户和一 ...

  7. Protocol Buffer技术详解(Java实例)

    Protocol Buffer技术详解(Java实例) 该篇Blog和上一篇(C++实例)基本相同,只是面向于我们团队中的Java工程师,毕竟我们项目的前端部分是基于Android开发的,而且我们研发 ...

  8. Protocol Buffer技术详解(C++实例)

    Protocol Buffer技术详解(C++实例) 这篇Blog仍然是以Google的官方文档为主线,代码实例则完全取自于我们正在开发的一个Demo项目,通过前一段时间的尝试,感觉这种结合的方式比较 ...

  9. Redis协议详解

    smark Beetle可靠.高性能的.Net Socket Tcp通讯组件 支持flash amf3,protobuf,Silverlight,windows phone Redis协议详解 由于前 ...

随机推荐

  1. SPringBoot 配置类继承WebMvcConfigurationSupport和实现WebMvcConfigurer的使用

    个人习惯使用  实现的方式 public class WebMvcConfiguration implements WebMvcConfigurer {

  2. JS设置网站所有字体变为繁体字

    引入chinese.js var zh_default='n';var zh_choose='t';var zh_expires=7;var zh_class='zh_click';var zh_st ...

  3. 7、滑动窗口套路算法框架——Go语言版

    前情提示:Go语言学习者.本文参考https://labuladong.gitee.io/algo,代码自己参考抒写,若有不妥之处,感谢指正 关于golang算法文章,为了便于下载和整理,都已开源放在 ...

  4. 【LeetCode】163. Missing Ranges 解题报告 (C++)

    作者: 负雪明烛 id: fuxuemingzhu 个人博客:http://fuxuemingzhu.cn/ 目录 题目描述 题目大意 解题方法 遍历 日期 题目地址:https://leetcode ...

  5. 【LeetCode】529. Minesweeper 解题报告（Python & C++）

    作者: 负雪明烛 id: fuxuemingzhu 个人博客: http://fuxuemingzhu.cn/ 目录 题目描述 题目大意 解题方法 DFS 日期 题目地址:https://leetco ...

  6. CAS学习笔记一：CAS 授权服务器简易搭建

    什么是CAS CAS是Central Authentication Service的缩写,中央认证服务,一种独立开放指令协议.CAS 是 耶鲁大学(Yale University)发起的一个开源项目, ...

  7. python xlwt写Excel表

    1 xlwt第三方库 说明:xlwt是一个用于将数据和格式化信息写入并生成Excel文件的库. 注意:xlwt不支持写xlsx表,打开表文件报错. 官方文档:https://xlwt.readthed ...

  8. [数据结果]C语言 基础指令汇编

    数据结构 C语言核心操作集合 (1)预定义常量和类型 //函数结果状态代码 #define TRUE 1 #define FALSE 0 #define OK 1 #define ERROR 0 #d ...

  9. Java程序设计基础笔记 • 【第6章 循环结构进阶】

    全部章节   >>>> 本章目录 6.1 for循环 6.1.1 for循环的简介 6.1.2 for循环的使用 6.1.3 for循环的表达式 6.1.4 实践练习 6.2 ...

  10. unittest_认识unittest（1）

    unittest是python内置的单元测试框架,具备编写用例.组织用例.执行用例.输出报告等自动化框架的条件. 使用unittest前需要了解该框架的五个概念: 即test case,test su ...