快捷導(dǎo)航

golang中protobuf的使用詳解

更新時(shí)間：2023年10月20日 10:26:57 作者：碼說AI

protobuf是Google公司提出的一種輕便高效的結(jié)構(gòu)化數(shù)據(jù)存儲(chǔ)格式,常用于結(jié)構(gòu)化數(shù)據(jù)的序列化,具有語言無關(guān)、平臺(tái)無關(guān)、可擴(kuò)展性特性,常用于通訊協(xié)議、服務(wù)端數(shù)據(jù)交換場(chǎng)景,下面我們就來看看golang中protobuf的具體使用吧

前言

protobuf是Google公司提出的一種輕便高效的結(jié)構(gòu)化數(shù)據(jù)存儲(chǔ)格式，常用于結(jié)構(gòu)化數(shù)據(jù)的序列化，具有語言無關(guān)、平臺(tái)無關(guān)、可擴(kuò)展性特性，常用于通訊協(xié)議、服務(wù)端數(shù)據(jù)交換場(chǎng)景。

protobuf的核心內(nèi)容包括：

定義消息：消息的結(jié)構(gòu)體，以message標(biāo)識(shí)。
定義接口：接口路徑和參數(shù)，以service標(biāo)識(shí)。

通過protobuf提供的機(jī)制，服務(wù)端與服務(wù)端之間只需要關(guān)注接口方法名（service）和參數(shù)（message）即可通信，而不需關(guān)注繁瑣的鏈路協(xié)議和字段解析，極大降低了服務(wù)端的設(shè)計(jì)開發(fā)成本。

1、protobuf配置

（1）https://github.com/protocolbuffers/protobuf/releases

（2）選擇適合的版本：protoc-3.8.0-win64.zip

（3）解壓后將文件 protoc.exe 所在目錄添加到環(huán)境變量 Path

（4）檢查protobuf版本，CMD命令窗口執(zhí)行：protoc --version

2、proto文件處理

（1）獲取相關(guān)庫

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;
}
//學(xué)生
message Student{
    int32 id = 1;
    string name = 2;
    repeated Course courses = 3;
}

（3）生成文件命令：protoc --go_out=. test.proto

命令執(zhí)行完，會(huì)在test.proto同級(jí)目錄下生成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出現(xiàn)"go_package"錯(cuò)誤

在使用protobuf2升到protobuf3時(shí)，更新了proto-gen-go，編譯proto文件進(jìn)報(bào)了錯(cuò)誤

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;
 
// 長(zhǎng)連接Token驗(yàn)證請(qǐng)求
message GameAuthReq {
    string authToken = 1;   // Token
    string serverId = 2;    // 登錄服務(wù)器ID
}
 
...

編譯命令為：

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

原因是protoc-gen-go版本過高，對(duì)源proto文件需要添加包名。在proto文件中添加option go_package = "/ipc";就可以解決了。

syntax = "proto3";
 
package ipc;
option go_package = "/ipc";
 
// 長(zhǎng)連接Token驗(yàn)證請(qǐng)求
message GameAuthReq {
    string authToken = 1;   // Token
    string serverId = 2;    // 登錄服務(wù)器ID
}
 
...

還有一種解決辦法就是把protoc-gen-go版本退回到1.3.2及以下也可以解決。

到此這篇關(guān)于golang中protobuf的使用詳解的文章就介紹到這了,更多相關(guān)go protobuf內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: