golang如何使用protobuf序列化

最新推荐文章于 2024-08-24 09:39:01 发布

fwhezfwhez

最新推荐文章于 2024-08-24 09:39:01 发布

阅读量3.7k

点赞数

文章标签： protobuf

本文链接：https://blog.csdn.net/fwhezfwhez/article/details/92740978

版权

前言

protobuf是二进制协议，传输效率极高，传输体积很小，在tcp/rpc里的使用很普及。

使用须知

和json不同，protobuf没有被放入官方的基本库里，也就不能直接proto.Marshal().

使用protobuf前，需保证protoc.exe与proto-gen-go.exe在path里，命令行执行protoc --version 有正确输出即可。

安装前，续保证git正确安装，即输入git --version 有正确输出。

使用golang操作protobuf，须正确安装go, 输入go version 有正确输出

环境安装好了以后，需要知道如何书写proto文件。想要一概而精是不正常的，我们来通过需求来学习最佳。

安装protoc与proto-gen-go

protoc: https://github.com/golang/protobuf

proto-gen-go:https://github.com/golang/protobuf/tree/master/protoc-gen-go

cd %GOPATH%
cd /src/github.com/golang不存在的文件夹时，则创建.
git clone https://github.com/golang/protobuf.git protobuf

如果git clone太慢了或者失败了:
在 https://github.com/golang/protobuf 里，选择Download zip, 并将protobuf-master改名为protobuf，并放置到%GOPATH%/src/github.com/golang/protobuf即可

在https://github.com/protocolbuffers/protobuf/releases中，windows版的，ctrl+f,查找win64,可以快速定位到win版本的protoc,或者选择对应想要的版本的realse进行下载，解压，并将其中的protoc.exe放入%GOPATH%\bin
在 %GOPATH%\src\github.com\golang\protobuf\protoc-gen-go路径下，执行go build -o protoc-gen-go.exe
将4，5生成的protoc.exe与proto-gen-go.exe放入%GOPATH%\bin并将%GOPATH%\bin添加到环境变量path里。

生成go model

cd /x/x/m.proto
protoc --go_out=. m.proto

小试牛刀

需要注意的是，protobuf要想得到对应的结构体，必须先从proto文件开始，并自动生成，而不是手动输入。
mkdir pb
cd pb
hello.proto

syntax = "proto3";
package pb;

message User {
   int32 id = 1;
   string username = 2;
}

在hello.proto路径下
protoc --go_out=plugins=grpc:. hello.proto

至此，go file已经自动生成了

小试牛刀,使用marshal和unmarshal

package main

import (
	"fmt"
	"github.com/golang/protobuf/proto"
	"t/pb"
)

func main() {
    buf , e:= proto.Marshal(&pb.User{
    	Id: 1,
    	Username: "csdn",
	})

    if e!=nil {
    	panic(e)
	}

    fmt.Println(buf)
    var tmp pb.User
    e = proto.Unmarshal(buf, &tmp)
	if e!=nil {
		panic(e)
	}
    fmt.Println(tmp)
}

几个常用的protoc命令:

protoc --go_out=plugins=grpc:. example.proto 生成带有grpc服务端和测试端模块的代码
protoc --go_out=plugins=micro:. hello_world.proto 生成micro生态的代码
·
protoc --go_out=plugins=grpc:. -I=${GOPATH}/src -I=. xxx.proto 同时扫描了/.和GOPATH/src 两个路径，应对proto里存在import场景