proto3 需要注意的几个问题

最新推荐文章于 2024-07-18 15:51:57 发布
原创 最新推荐文章于 2024-07-18 15:51:57 发布 · 427 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#golang

博客指出使用Kratos框架搭配Golang时存在的问题。一是在proto中使用嵌套结构体，在http服务获取嵌套结构字段时只能得到默认值；二是返回数据时，若某个字段无值，该字段在返回结构中不可见。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

1、使用kratos框架时，proto中的结构体如果使用嵌套结构，http服务时，获取嵌套结构中的字段时获取不到，只能是该字段类型的默认值

//在请求的参数结构体中，只能使用这种最简单的方式，不能嵌套
message LoginRequest {
  string username = 1;
  string password = 2;
}

2、在返回数据时，如果某个字段没有值，则这个字段在返回结构中是看不到的

fbbqt
关注
1-Protocol Buffers语言特性 (proto 3)
搬砖人的自我修养
07-03 874
在前面的示例中，Result消息类型是在与SearchResponse相同的文件中定义的——如果您想要用作字段类型的消息类型已经在另一个.proto文件中定义了怎么办?您可以通过导入其他.proto文件来使用它们。
【protobuf】ProtoBuf——proto3语法详解、enum类型、enum类型的使用和注意事项、Any类型、通讯录录入号码类型和地址的功能实现
Crocodile1006的博客
08-17 1768
ProtoBuf、proto3语法详解、enum类型、enum类型的使用和注意事项、Any类型、通讯录录入号码类型和地址的功能实现
protoc-gen-lua message 嵌套 message 报错 message_type 为nil
xzben‘blog
11-16 351
这个问题主要是由于 嵌套message 没有在使用message 之前定义，导致生成 pb 文件的时候识别嵌套message时候不认识被嵌套message导致生成的message_type 为 未定义的值，只要注意将要使用的message先定义就行了。这个坑不注意是很难发现的。 ...
Protocol Buffer处理嵌套message
I_Moo的专栏
09-22 3434
Protocol Buffer处理嵌套message对于复杂结构（嵌套message） set_allocated_xx函数使用的必须是外部分配（堆）的变量，不能传递stack变量，否则会产生delete stack错误；传递堆变量后该变量由protobuf管理 一般使用mutable_xx函数，该函数内部开辟堆内存空间返回一个指针，通过该指针对message数据进行操作。 代码： sm3::m_
protobuf序列化
m0_60529319的博客
04-09 1169
协议的模板所有的message必须定义到一个文件中，且文件的后缀名为.proto。例如我们定义的bike.proto文件required:必须填发送的数据bike.proto// 使用的版本 package tutorial;// 生成一个包把类放进去 // 申请短信请求 message mobile_request {// 按顺序写编号 }
【Protobuf】Protobuf中的Message语法规范
十一月廿七风雨大作
06-09 8967
Protobuf快速使用 Java版、Python版。
protobuf
ZHAOJUNWEI08的专栏
04-30 817
Protocol Buffers，是Google公司开发的一种数据描述语言，类似于XML能够将结构化数据序列化，是一种轻便高效的结构化数据存储格式，它很适合做数据存储或 RPC 数据交换格式。可用于通讯协议、数据存储等领域的语言无关、平台无关、可扩展的序列化结构数据格式。它不依赖于语言和平台并且可扩展性极强。现阶段官方支持C++JAVAPython、Objective C、C#、Ruby、PHP、JavaScript八种编程语言，还可以找到大量的几乎涵盖所有语言的第三方拓展包。
使用Perl编写CGI时需要注意的几个问题
04-07
### 使用Perl编写CGI时需要注意的问题 #### 一、引言 Perl作为一种强大的脚本语言，在Web开发领域尤其是在CGI编程方面有着广泛的应用。随着Perl的发展，它已不仅仅局限于UNIX平台，也被成功移植到了诸如Windows这样...
【SpringBoot3】结合 gRpc 通过 proto文件生成Java代码
不积跬步无以至千里，不积小流无以成江海。一个喜欢学习分享的程序员
07-05 2661
Protobuf（Protocol Buffers）是由Google开发的一种灵活、高效、自动化的结构化数据序列化方法，类似于XML、JSON等，但更小、更快、更简单。它主要用于网络通信和数据存储等场景，广泛应用于各种编程语言中。
深入解析protobuf 1-proto3 使用及编解码原理介绍
白日梦程序员的博客
12-10 5297
前面已经讲了grpc基础使用，其中用到了Protocol buffers，这次先讲下Protocol Buffers的基本使用，和编解码原理。后面会有高级教程讲如何二次开发proto-gen-go ，protobuf 官方功能并不是很完善的，在日常项目中，常常有自定义需求，更多的是使用官方protoc-gen-go 这个项目fork 后自定义版本，或者是比较优秀的开源 fork 版本。目前使用最多的是gogo protobuf，后面都会出详细教程。本文章内容几乎翻译整理自官方文档，额外添加了go相关的例子,
Protobuf 3 语法规则
夏增明的博客
10-10 1321
Protocol Buffers 是 google 的一种数据交换的格式，它独立于语言，独立于平台。提供了多种语言的实现：java、c#、c++、go 和 python，每一种实现都包含了相应语言的编译器以及库文件。由于它是一种二进制的格式，比使用 xml 进行数据交换快许多。本文主要介绍proto3的使用语法。query：查询条件page_number：你想要哪一页数据result_per_page：每一页有多少条数据// 指定使用proto3，如果不指定的话，编译器会使用proto2去编译。
proto定义嵌套列表
weixin_42336835的博客
08-10 851
公司需要做数据增强，需要写grpc服务器接口。这个作者解释的比较清晰：引用一下。
python protobuf（嵌套的）的使用
qq_35975855的博客
03-04 818
注意这个protoc指令给proto文件名的时候前面不能带路径，所以需要额外加-I。
protobuffer的嵌套使用
yudelian的博客
06-11 1515
1、定义嵌套protobuffer message ***IpaddressPair{ bytes local_ip = 1; bytes remote_ip = 2; } message ***ConnectionStatus{ bool connected = 1; bytes peer_id = 2; ***IpaddressPair ipaddr_pair = 3; } 2、使用这个mutable_ipaddr_pair函数会在类里new一个***IpaddressPai
Kratos战神微服务框架（二）
qq_53267860的博客
06-30 1107
使用makefile 注：需要安装make指令 注：默认是linux命令,windwos需要修改路径service.go biz层 data层 data.go configs配置文件 注：是否需要修改config的makefile
Golang proto 类型
qq_29744347的博客
01-05 526
常见的基本类型就不讲了。
【ProtoBuf】proto 3 语法 -- 详解
Elena's Blog
07-18 2767
（2）情况 2：不同级枚举类型包含相同枚举值名称。
golang：如何在proto3中用上golang对应的interface{}类型
OceanStar的博客
05-12 1973
首先，我希望所有golang中用于http请求响应的结构，都使用proto3来定义。麻烦的是，有的情况下某个字段的类型可能是动态的，对应的JSON类型可能是number/string/boolean/null中的其中一种。使用protoc生成代码后，发现这玩意儿完全没办法做json的encode/decode。理想的办法是让生成golang代码中的 user_input 成为 interface{} 类型。但如何才能让proto3生成golang的interface类型呢？
gRPC之嵌套的message
源滚滚编程
10-06 1924
目录结构 go.mod module grpc_demo go 1.16 require ( github.com/golang/protobuf v1.5.2 // indirect google.golang.org/grpc v1.39.0 google.golang.org/protobuf v1.26.0 ) base.proto syntax = "proto3"; option go_package = "../proto"; message Pong{ st
src/eventinfo/event_proto/common/下存在event.proto，event.proto中有一个共通的message CommonData src/eventinfo/event_proto/event_display下存在event_display.proto，需要使用event.proto的CommonData src/eventinfo/event_proto/event_info下存在event_info.proto，需要使用event.proto的CommonData 这几个proto文件应该怎么写，option go_package和package，应该怎么写，编译命令应该怎么执行
最新发布
03-18
<think>嗯，用户的问题是关于如何组织几个Protocol Buffers文件，特别是关于package和go_package选项的设置，以及编译命令的使用。我需要仔细分析用户提供的目录结构和需求，确保给出的答案正确且符合Protocol Buffers的最佳实践。 首先，用户提到有三个.proto文件：event.proto在common目录下，而event_display.proto和event_info.proto分别位于event_display和event_info子目录中。后两个文件需要导入common目录下的event.proto中的CommonData消息。 接下来，我需要确定每个.proto文件的package声明和option go_package的设置。对于Go语言来说，go_package选项决定了生成的Go代码的包名和导入路径。同时，package在proto中用于防止命名冲突，而导入其他proto文件时需要正确指定路径。 对于event.proto，它的路径是src/eventinfo/event_proto/common/，所以合理的package可能是eventinfo.event_proto.common。go_package应该对应到Go模块的路径，例如github.com/your-project/eventinfo/event_proto/common。 然后，event_display.proto和event_info.proto需要导入event.proto。在Proto中，导入路径是相对于项目根目录的，所以应该使用import "eventinfo/event_proto/common/event.proto";。它们的package应该分别是eventinfo.event_proto.event_display和eventinfo.event_proto.event_info，对应的go_package也要调整到相应的子目录。 编译命令方面，用户需要使用protoc命令，指定正确的导入路径（-I），以及Go相关的插件和输出目录。需要确保所有依赖的.proto文件都能被找到，生成的Go代码放在正确的目录下。 还需要检查是否有遗漏的细节，比如是否所有文件的目录结构都正确，导入路径是否有错别字，以及go_package的路径是否符合项目的实际模块名称。此外，提醒用户确保protoc-gen-go插件已安装，并且Go模块已初始化，可能也是必要的。 最后，结构化的回答应该分步骤说明每个文件的配置，并给出编译命令示例，确保用户能够逐步执行。同时，注意使用中文，保持清晰易懂，避免专业术语的混淆。</think>根据您的文件结构需求，我将分步骤说明proto文件配置和编译方法： 一、文件结构说明 ``` src/ └─ eventinfo/ └─ event_proto/ ├─ common/ │ └─ event.proto # 基础公共message ├─ event_display/ │ └─ event_display.proto # 需要引用common └─ event_info/ └─ event_info.proto # 需要引用common ``` 二、proto文件配置 1. common/event.proto ```protobuf syntax = "proto3"; package eventinfo.event_proto.common; // 完整包路径 option go_package = "github.com/your-project/eventinfo/event_proto/common"; // Go模块路径 message CommonData { // 公共字段定义... } ``` 2. event_display/event_display.proto ```protobuf syntax = "proto3"; package eventinfo.event_proto.event_display; option go_package = "github.com/your-project/eventinfo/event_proto/event_display"; import "eventinfo/event_proto/common/event.proto"; // 相对项目根目录的路径 message DisplayEvent { eventinfo.event_proto.common.CommonData common = 1; // 其他字段... } ``` 3. event_info/event_info.proto ```protobuf syntax = "proto3"; package eventinfo.event_proto.event_info; option go_package = "github.com/your-project/eventinfo/event_proto/event_info"; import "eventinfo/event_proto/common/event.proto"; message InfoEvent { eventinfo.event_proto.common.CommonData common = 1; // 其他字段... } ``` 三、关键配置说明 1. package命名： - 采用反向域名命名风格 - 体现文件路径层次：`eventinfo.event_proto.子模块名` 2. go_package配置： - 遵循Go模块路径规范 - 对应生成的.pb.go文件路径 - 必须包含完整的Go模块基础路径 四、编译命令（在项目根目录执行） ```bash protoc -I=./src \ # 指定proto文件根目录 --go_out=./src \ # Go代码输出目录 --go_opt=module=github.com/your-project \ # Go模块名称 src/eventinfo/event_proto/common/event.proto \ src/eventinfo/event_proto/event_display/event_display.proto \ src/eventinfo/event_proto/event_info/event_info.proto ``` 五、验证要点 1. 确保所有.proto文件的import路径正确 2. go_package路径必须与项目go.mod中的模块名一致 3. 编译前需安装protoc-gen-go插件： ```bash go install google.golang.org/protobuf/cmd/protoc-gen-go@latest ``` 六、最佳实践建议 1. 在项目根目录维护一个总的buf.yaml文件（如果使用buf工具） 2. 建议使用proto版本管理工具（如buf） 3. 保持proto文件目录结构与生成的Go代码路径一致 4. 对公共proto文件考虑版本控制（如v1/，v2/目录） 注意：实际路径中的`github.com/your-project`需要替换为您的实际Go模块名称。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值