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中interface转string输出打印方法

    Golang中interface转string输出打印方法

    这篇文章主要给大家介绍了关于Golang中interface转string输出打印的相关资料,在go语言中interface转string可以直接使用fmt提供的fmt函数,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2024-02-02
  • 解决go 生成的exe不在bin文件夹里的问题

    解决go 生成的exe不在bin文件夹里的问题

    这篇文章主要介绍了解决go 生成的exe不在bin文件夹里的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • 浅谈Golang Slice切片如何扩容的实现

    浅谈Golang Slice切片如何扩容的实现

    本文主要介绍了浅谈Golang Slice切片如何扩容的实现,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-02-02
  • 一文读懂go中semaphore(信号量)源码

    一文读懂go中semaphore(信号量)源码

    这篇文章主要介绍了一文读懂go中semaphore(信号量)源码的相关知识,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-04-04
  • Go 语言垃圾回收机制从入门到理解

    Go 语言垃圾回收机制从入门到理解

    本文主要介绍了Go 语言垃圾回收机制从入门到理解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2025-09-09
  • golang RWMutex读写锁实现读共享写独占的功能示例

    golang RWMutex读写锁实现读共享写独占的功能示例

    在 Go 里除了互斥锁外,还有读写锁 RWMutex,它主要用来实现读共享,写独占的功能,今天我们也顺便分析下读写锁,加深对 Go 锁的理解
    2023-09-09
  • 如何在Go中使用Casbin进行访问控制

    如何在Go中使用Casbin进行访问控制

    这篇文章主要介绍了如何在Go中使用Casbin进行访问控制,Casbin是一个强大的、高效的开源访问控制框架,其权限管理机制支持多种访问控制模型,Casbin只负责访问控制
    2022-08-08
  • Go利用GJSON组件解锁JSON读取新姿势

    Go利用GJSON组件解锁JSON读取新姿势

    Go 标准库提供了 encoding/json 包用于处理 json 数据,同时第三方库 GJSON & SJSON 也在 json 处理方面表现出色,下面我们就来看看如何使用GJSON解锁JSON读取新方法吧
    2025-03-03
  • Go语言区别于其他语言的特性

    Go语言区别于其他语言的特性

    在本文中,今天这篇文章将给大家介绍一下 Go 与其他语言不同的 9 个特性,需要的朋友可以参考下面文章的具体内容
    2021-10-10
  • Go通道channel通过通信共享内存

    Go通道channel通过通信共享内存

    这篇文章主要为大家介绍了Go通道channel通过通信共享内存示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-07-07

最新评论