golang中protobuf的使用详解

 更新时间:2023年10月20日 10:26:57   作者:码说AI  
protobuf是Google公司提出的一种轻便高效的结构化数据存储格式,常用于结构化数据的序列化,具有语言无关、平台无关、可扩展性特性,常用于通讯协议、服务端数据交换场景,下面我们就来看看golang中protobuf的具体使用吧

前言

protobuf是Google公司提出的一种轻便高效的结构化数据存储格式,常用于结构化数据的序列化,具有语言无关、平台无关、可扩展性特性,常用于通讯协议、服务端数据交换场景。

protobuf的核心内容包括:

  • 定义消息:消息的结构体,以message标识。
  • 定义接口:接口路径和参数,以service标识。

通过protobuf提供的机制,服务端与服务端之间只需要关注接口方法名(service)和参数(message)即可通信,而不需关注繁琐的链路协议和字段解析,极大降低了服务端的设计开发成本。

1、protobuf配置

(1)https://github.com/protocolbuffers/protobuf/releases

(2)选择适合的版本:protoc-3.8.0-win64.zip

(3)解压后将文件 protoc.exe 所在目录添加到环境变量 Path

(4)检查protobuf版本,CMD命令窗口执行:protoc --version

2、proto文件处理

(1)获取相关库

go get -u github.com/golang/protobuf/protoc-gen-go

(2)编写test.proto文件

//指定版本
syntax = "proto3";
//包名
package pb;
//课程
message Course{
    int32 id = 1;
    string name = 2;
}
//学生
message Student{
    int32 id = 1;
    string name = 2;
    repeated Course courses = 3;
}

(3)生成文件命令:protoc --go_out=. test.proto

命令执行完,会在test.proto同级目录下生成test.pb.go文件

3、使用

package main
 
import (
    "fmt"
    "log"
    "test/protobuf/pb"
 
    "github.com/golang/protobuf/proto"
)
 
func main() {
    course1 := pb.Course{
        Id:   *proto.Int32(1),
        Name: *proto.String("Golang"),
    }
    course2 := pb.Course{
        Id:   *proto.Int32(2),
        Name: *proto.String("Python3"),
    }
    stu := pb.Student{
        Id:      *proto.Int32(1),
        Name:    *proto.String("笃志弘毅"),
        Courses: []*pb.Course{&course1, &course2},
    }
    //序列化
    data, err := proto.Marshal(&stu)
    if err != nil {
        log.Fatalln("proto.Marshal err:", err)
    }
    fmt.Println(data)
    //反序列化
    var stuNew pb.Student
    err = proto.Unmarshal(data, &stuNew)
    if err != nil {
        log.Fatalln("proto.Unmarshal err:", err)
    }
    fmt.Println(stuNew)
}

问题解决:编译go版本proto3出现"go_package"错误

在使用protobuf2升到protobuf3时,更新了proto-gen-go,编译proto文件进报了错误

protoc-gen-go: unable to determine Go import path for "proto/ipc.proto"
 
Please specify either:
        • a "go_package" option in the .proto source file, or
        • a "M" argument on the command line.
 
See https://developers.google.com/protocol-buffers/docs/reference/go-generated#package for more information.
 
--go_out: protoc-gen-go: Plugin failed with status code 1.

源文件为:

syntax = "proto3";
 
package ipc;
 
// 长连接Token验证请求
message GameAuthReq {
    string authToken = 1;   // Token
    string serverId = 2;    // 登录服务器ID
}
 
...

编译命令为:

protoc --go_out=. proto/ipc.proto
protoc-gen-go v1.27.1
protoc v3.12.3

原因是protoc-gen-go版本过高,对源proto文件需要添加包名。在proto文件中添加option go_package = "/ipc";就可以解决了。

syntax = "proto3";
 
package ipc;
option go_package = "/ipc";
 
// 长连接Token验证请求
message GameAuthReq {
    string authToken = 1;   // Token
    string serverId = 2;    // 登录服务器ID
}
 
...

还有一种解决办法就是把protoc-gen-go版本退回到1.3.2及以下也可以解决。

到此这篇关于golang中protobuf的使用详解的文章就介绍到这了,更多相关go protobuf内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • golang time包做时间转换操作

    golang time包做时间转换操作

    这篇文章主要介绍了golang time包做时间转换操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • Go log库的使用示例详解

    Go log库的使用示例详解

    Go语言内置的log库提供了基本的日志记录功能,支持日志的格式化输出、设置日志前缀、配置输出位置等,可以通过标准logger或创建新的Logger对象来使用,log库简单易用,但功能有限,可能需要配合第三方日志库如logrus、zap等来满足复杂需求
    2024-09-09
  • Go使用Google Gemini Pro API创建简单聊天机器人

    Go使用Google Gemini Pro API创建简单聊天机器人

    这篇文章主要为大家介绍了Go使用Google Gemini Pro API创建简单聊天机器人实现过程详解,本文将通过最新的gemini go sdk来实现命令行聊天机器人
    2023-12-12
  • Go利用ffmpeg进行视频和音频处理

    Go利用ffmpeg进行视频和音频处理

    ffmpeg 是一款功能强大的多媒体处理工具,支持视频和音频的编码、解码、转码,以及帧提取和流处理等功能,下面我们就来看看Go如何利用ffmpeg进行视频和音频处理吧
    2024-12-12
  • 深入理解 Go 中的字符串

    深入理解 Go 中的字符串

    这篇文章主要介绍了深入理解 Go 中的字符串,在编程语言中,字符串发挥着重要的角色。字符串背后的数据结构一般有两种类型,一种在编译时指定长度不能修改,一种具有动态的长度可以修改,下文更多相关资料需要的小伙伴可以参考一下
    2022-05-05
  • golang防止内存逃逸的方法小结

    golang防止内存逃逸的方法小结

    在Go语言中,内存逃逸是指在函数中分配的变量在函数结束后仍然被引用,防止内存逃逸有助于提高程序的性能,因为栈上分配的内存可以更快地被回收,本文给大家总结了一些防止内存逃逸的方法,需要的朋友可以参考下
    2024-02-02
  • golang接口实现调用修改(值接收者指针接收者)场景详解

    golang接口实现调用修改(值接收者指针接收者)场景详解

    这篇文章主要为大家介绍了golang接口实现调用修改值接收者指针接收者示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-08-08
  • Go语言实现定时器的原理及使用详解

    Go语言实现定时器的原理及使用详解

    这篇文章主要为大家详细介绍了Go语言实现定时器的两种方法:一次性定时器(Timer)和周期性定时器(Ticker),感兴趣的小伙伴可以跟随小编一起学习一下
    2022-12-12
  • 详解Golang如何在编译时注入版本信息

    详解Golang如何在编译时注入版本信息

    这篇文章主要为大家详细介绍了Golang如何在编译时实现注入版本信息,文中的示例代码讲解详细,具有一定的学习价值,感兴趣的可以了解一下
    2023-06-06
  • Go语言实现一个简单生产者消费者模型

    Go语言实现一个简单生产者消费者模型

    本文主要介绍了Go语言实现一个简单生产者消费者模型,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-12-12

最新评论