Protocol Buffer命名空间冲突

protocol,buffer,命名,空间,冲突 · 浏览次数 : 73

小编点评

**Protocol Buffer命名空间冲突** Protocol Buffer 命名空间冲突是指在链接到同一 Go 二进制文件的两个 Protocol Buffer 声明时,两个声明具有相同的名称时,导致注册表无法正确解析该声明。 **解决方案:** 1. **避免 vendored 文件:**避免将 vendored 的 .proto 文件与所有其他 .proto 文件一起生成为 Go 包。 2. **命名命名空间为唯一:**为每个 .proto 文件选择一个独特的名字,以避免冲突。 3. **使用集中化的 Go 包:**如果多个用户依赖一个 .proto 文件,可以建立一个集中化的 Go 包,所有用户可以使用相同的名字。 4. **指定包名称:**在 .proto 文件中指定包名称,以避免与其他文件冲突。 5. **设置处理冲突的行为:**可以通过编译时设置 `go build -ldflags "-X google.golang.org/protobuf/reflect/protoregistry.conflictPolicy=warn"` 或环境变量 `GOLANG_PROTOBUF_REGISTRATION_CONFLICT=warn` 来指定处理冲突的行为。 6. **修复源头问题:**如果命名空间冲突源于多个 .proto 文件,请修复这些文件的包名称或命名空间。 7. **使用版本 1.26.0 或更高版本:**在启动 Go 程序时,如果链接到多个冲突的 Protocol Buffer 命名空间,将报告一个严重错误。

正文

原文在这里

什么是Protocol Buffer命名空间冲突?

所有链接到Go二进制文件的Protocol Buffer声明都被插入到一个全局注册表中。

每个Protocol Buffer声明(例如,枚举、枚举值或消息)都有一个绝对名称,该名称是包名称与.proto源文件中声明的相对名称的连接(例如,my.proto.package.MyMessage.NestedMessage)。Protocol Buffer语言假设所有声明都是普遍唯一的。

如果链接到Go二进制文件的两个Protocol Buffer声明具有相同的名称,那么这将导致命名空间冲突,注册表无法通过名称正确解析该声明。根据使用的Go protobuf版本不同,这可能会在初始化时引发panic,或者静默地忽略冲突,并在运行时可能导致潜在的错误。

如何解决Protocol Buffer命名空间冲突?

解决命名空间冲突的最佳方法取决于冲突发生的原因。

常见的命名空间冲突原因有:

  1. 存在vendored(供应商)的.proto文件。当一个单独的.proto文件被生成为两个或更多的Go包,并且链接到同一个Go二进制文件时,会在生成的Go包中的每个Protocol Buffer声明上发生冲突。这通常发生在一个.proto文件被vendored,并且从它生成了一个Go包,或者生成的Go包本身被vendored。用户应避免vendored,而是依赖于集中化的Go包来使用该.proto文件。

  2. 如果一个.proto文件由外部组织拥有,并且缺少go_package选项,则应与该.proto文件的所有者协调,以指定一个集中化的Go包,所有用户都可以依赖。

  3. 缺失或使用过于通用的proto包名称。如果一个.proto文件没有指定包名称或使用过于通用的包名称(例如,“my_service”),那么该文件内部的声明很可能与宇宙中的其他声明发生冲突。我们建议每个.proto文件都有一个包名称,该名称是经过深思熟虑选择的,具有普遍唯一性(例如,以公司名称为前缀)。

警告: 在.proto文件上后期更改包名称可能会导致使用扩展字段或存储在google.protobuf.Any中的消息停止正常工作。

从google.golang.org/protobuf模块的v1.26.0版本开始,当启动一个Go程序时,如果链接到其中多个冲突的Protocol Buffer名称,将报告一个严重错误。虽然最好是修复冲突的源头,但可以通过以下两种方式立即解决致命错误:

  • 在编译时设置。可以在编译时通过链接器初始化的变量来指定处理冲突的默认行为:go build -ldflags "-X google.golang.org/protobuf/reflect/protoregistry.conflictPolicy=warn"
  • 在程序执行时设置。可以通过环境变量来设置处理冲突的行为,当执行特定的Go二进制文件时:GOLANG_PROTOBUF_REGISTRATION_CONFLICT=warn ./main

孟斯特

声明:本作品采用署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0)进行许可,使用时请注明出处。
Author: mengbin
blog: mengbin
Github: mengbin92
cnblogs: 恋水无意


与Protocol Buffer命名空间冲突相似的内容:

Protocol Buffer命名空间冲突

原文在[这里](https://protobuf.dev/reference/go/faq/#namespace-conflict)。 ## 什么是Protocol Buffer命名空间冲突? 所有链接到Go二进制文件的Protocol Buffer声明都被插入到一个全局注册表中。 每个Protoc

Go with Protobuf

原文在这里。 本教程为 Go 程序员提供了使用Protocol buffer的基本介绍。 本教程使用proto3向 Go 程序员介绍如何使用 protobuf。通过创建一个简单的示例应用程序,它向你展示了如何: 在.proto中定义消息格式 使用protocol buffer编译器 使用Go pro

在Protocol Buffers中导入当前目录中的.proto文件

在protobuf中导入当前目录中的`.proto`文件时,可以使用相对路径。相对路径是相对于当前`.proto`文件所在的目录来引用其他`.proto`文件。 假设有以下目录结构: ``` my_project/ |-- proto/ | |-- person.proto |-- main.pro

Protobuf中如何指定json tag

在 Protocol Buffers (protobuf) 中,可以使用特定的选项来指定生成的 JSON 标签。通过在消息定义中使用 `[(json_name)]` 选项,可以控制生成的 JSON 字段名称。这样可以确保 Protocol Buffers 和 JSON 之间的互操作性。 下面是一个示

Protobuf vs JSON

Protobuf(Protocol Buffers)和 JSON 都是数据序列化格式,但它们在许多方面有着显著的不同。以下是对两者的一些主要比较: 1. 数据大小和速度: - Protobuf:由于 Protobuf 是二进制格式,因此它生成的数据通常比 JSON 小很多,这使得 Protobuf

protojson简介

`google.golang.org/protobuf/encoding/protojson` 是 Go 语言中的一个库,用于处理 Protocol Buffers(protobuf)和 JSON 之间的转换,遵循[https://protobuf.dev/programming-guides/pr

protolator简介

`github.com/hyperledger/fabric-config/protolator` 是 Hyperledger Fabric 中的一个 Go 包,用于将 Protocol Buffers(ProtoBuf)消息和 JSON 格式之间进行转换。它提供了一种方便的方式来将 Fabric

gRPC入门

1. gRPC简介 gRPC是一种高性能、开源和通用的远程过程调用(RPC)框架,由Google开源并维护。它使用Protocol Buffers(protobuf)作为接口定义语言(IDL),提供跨平台、跨语言的RPC调用支持。gRPC具有以下几个特点: 高性能:使用HTTP/2协议,支持多路复用

gRPC如何保障数据安全传输

## 什么是 gRPC? gRPC 是由 Google 开发的高性能、开源的 RPC(Remote Procedure Call)框架,用于在客户端和服务器之间进行通信。它基于 Protocol Buffers(protobuf)进行消息序列化和反序列化,支持多种通信协议,如 HTTP/2、TCP

Win环境安装Protobuf 2.0 版本

转载请注明出处: 安装步骤 下载 protobuf-2.5.0.zip 与 protoc-2.5.0-win32.zip 下载链接 : https://github.com/protocolbuffers/protobuf/releases/tag/v2.5.0 将protoc-2.5.0-win3