Go语言使用protobuf

最新推荐文章于 2025-06-20 14:17:58 发布

原创最新推荐文章于 2025-06-20 14:17:58 发布 · 3.7k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#Go #protobuf

Go 专栏收录该内容

0 篇文章

订阅专栏

本文详细介绍如何在Go语言中使用protobuf进行消息序列化和反序列化的全过程，包括从下载protobuf源代码、配置环境变量、编译.proto文件到最终编写Go代码实现数据的读写操作。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

下载安装

1、源代码下载

https://github.com/protocolbuffers/protobuf/releases

2、将解压后的protoc.exe文件放到$GoPath$/bin目录下

3、配置环境变量，将 F:\GoPath\bin 添加到Path路径后面

4、

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

`编写代码`

1、创建一个Go工程

2、创建一个test.proto文件

syntax = "proto3"; //版本

package pro;

enum PhoneType { 
    HOME = 0;
    WORK = 1;
}

message Phone{   //每个message名都要大写
    PhoneType type = 1;
    string number = 2;
}

message Person{
    int32 id = 1;
    string name = 2;
    repeated Phone phones = 3;  //定义数组类型
}

message ContactBook{
    repeated Person persons = 1;
}

3、在该文件目录下，使用命令行（go_out为输出路径，中间空格，后面跟文件名）

protoc --go_out=. test.proto

4、得到编译后生成的go文件

// Code generated by protoc-gen-go. DO NOT EDIT.
// source: test.proto

package pro

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

// Reference imports to suppress errors if they are not otherwise used.
var _ = proto.Marshal
var _ = fmt.Errorf
var _ = math.Inf

// This is a compile-time assertion to ensure that this generated file
// is compatible with the proto package it is being compiled against.
// A compilation error at this line likely means your copy of the
// proto package needs to be updated.
const _ = proto.ProtoPackageIsVersion3 // please upgrade the proto package

type PhoneType int32

const (
	PhoneType_HOME PhoneType = 0
	PhoneType_WORK PhoneType = 1
)

var PhoneType_name = map[int32]string{
	0: "HOME",
	1: "WORK",
}

var PhoneType_value = map[string]int32{
	"HOME": 0,
	"WORK": 1,
}

func (x PhoneType) String() string {
	return proto.EnumName(PhoneType_name, int32(x))
}

func (PhoneType) EnumDescriptor() ([]byte, []int) {
	return fileDescriptor_c161fcfdc0c3ff1e, []int{0}
}

type Phone struct {
	Type                 PhoneType `protobuf:"varint,1,opt,name=type,proto3,enum=pro.PhoneType" json:"type,omitempty"`
	Number               string    `protobuf:"bytes,2,opt,name=number,proto3" json:"number,omitempty"`
	XXX_NoUnkeyedLiteral struct{}  `json:"-"`
	XXX_unrecognized     []byte    `json:"-"`
	XXX_sizecache        int32     `json:"-"`
}

func (m *Phone) Reset()         { *m = Phone{} }
func (m *Phone) String() string { return proto.CompactTextString(m) }
func (*Phone) ProtoMessage()    {}
func (*Phone) Descriptor() ([]byte, []int) {
	return fileDescriptor_c161fcfdc0c3ff1e, []int{0}
}

func (m *Phone) XXX_Unmarshal(b []byte) error {
	return xxx_messageInfo_Phone.Unmarshal(m, b)
}
func (m *Phone) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) {
	return xxx_messageInfo_Phone.Marshal(b, m, deterministic)
}
func (m *Phone) XXX_Merge(src proto.Message) {
	xxx_messageInfo_Phone.Merge(m, src)
}
func (m *Phone) XXX_Size() int {
	return xxx_messageInfo_Phone.Size(m)
}
func (m *Phone) XXX_DiscardUnknown() {
	xxx_messageInfo_Phone.DiscardUnknown(m)
}

var xxx_messageInfo_Phone proto.InternalMessageInfo

func (m *Phone) GetType() PhoneType {
	if m != nil {
		return m.Type
	}
	return PhoneType_HOME
}

func (m *Phone) GetNumber() string {
	if m != nil {
		return m.Number
	}
	return ""
}

type Person struct {
	Id                   int32    `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	Name                 string   `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Phones               []*Phone `protobuf:"bytes,3,rep,name=phones,proto3" json:"phones,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (m *Person) Reset()         { *m = Person{} }
func (m *Person) String() string { return proto.CompactTextString(m) }
func (*Person) ProtoMessage()    {}
func (*Person) Descriptor() ([]byte, []int) {
	return fileDescriptor_c161fcfdc0c3ff1e, []int{1}
}

func (m *Person) XXX_Unmarshal(b []byte) error {
	return xxx_messageInfo_Person.Unmarshal(m, b)
}
func (m *Person) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) {
	return xxx_messageInfo_Person.Marshal(b, m, deterministic)
}
func (m *Person) XXX_Merge(src proto.Message) {
	xxx_messageInfo_Person.Merge(m, src)
}
func (m *Person) XXX_Size() int {
	return xxx_messageInfo_Person.Size(m)
}
func (m *Person) XXX_DiscardUnknown() {
	xxx_messageInfo_Person.DiscardUnknown(m)
}

var xxx_messageInfo_Person proto.InternalMessageInfo

func (m *Person) GetId() int32 {
	if m != nil {
		return m.Id
	}
	return 0
}

func (m *Person) GetName() string {
	if m != nil {
		return m.Name
	}
	return ""
}

func (m *Person) GetPhones() []*Phone {
	if m != nil {
		return m.Phones
	}
	return nil
}

type ContactBook struct {
	Persons              []*Person `protobuf:"bytes,1,rep,name=persons,proto3" json:"persons,omitempty"`
	XXX_NoUnkeyedLiteral struct{}  `json:"-"`
	XXX_unrecognized     []byte    `json:"-"`
	XXX_sizecache        int32     `json:"-"`
}

func (m *ContactBook) Reset()         { *m = ContactBook{} }
func (m *ContactBook) String() string { return proto.CompactTextString(m) }
func (*ContactBook) ProtoMessage()    {}
func (*ContactBook) Descriptor() ([]byte, []int) {
	return fileDescriptor_c161fcfdc0c3ff1e, []int{2}
}

func (m *ContactBook) XXX_Unmarshal(b []byte) error {
	return xxx_messageInfo_ContactBook.Unmarshal(m, b)
}
func (m *ContactBook) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) {
	return xxx_messageInfo_ContactBook.Marshal(b, m, deterministic)
}
func (m *ContactBook) XXX_Merge(src proto.Message) {
	xxx_messageInfo_ContactBook.Merge(m, src)
}
func (m *ContactBook) XXX_Size() int {
	return xxx_messageInfo_ContactBook.Size(m)
}
func (m *ContactBook) XXX_DiscardUnknown() {
	xxx_messageInfo_ContactBook.DiscardUnknown(m)
}

var xxx_messageInfo_ContactBook proto.InternalMessageInfo

func (m *ContactBook) GetPersons() []*Person {
	if m != nil {
		return m.Persons
	}
	return nil
}

func init() {
	proto.RegisterEnum("pro.PhoneType", PhoneType_name, PhoneType_value)
	proto.RegisterType((*Phone)(nil), "pro.Phone")
	proto.RegisterType((*Person)(nil), "pro.Person")
	proto.RegisterType((*ContactBook)(nil), "pro.ContactBook")
}

func init() { proto.RegisterFile("test.proto", fileDescriptor_c161fcfdc0c3ff1e) }

var fileDescriptor_c161fcfdc0c3ff1e = []byte{
	// 213 bytes of a gzipped FileDescriptorProto
	0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x44, 0x8f, 0xcf, 0x4a, 0xc4, 0x30,
	0x10, 0xc6, 0x4d, 0xdb, 0x8d, 0xee, 0x14, 0xca, 0x32, 0x07, 0xc9, 0xcd, 0x12, 0x10, 0x8a, 0x87,
	0x3d, 0xac, 0x3e, 0x81, 0x8b, 0x20, 0x88, 0x6c, 0x09, 0x82, 0xe7, 0xd6, 0x06, 0x2c, 0xd2, 0x4c,
	0x48, 0xe2, 0xa1, 0x6f, 0x2f, 0x1d, 0xab, 0x7b, 0xfb, 0x92, 0xdf, 0xf7, 0x27, 0x01, 0x48, 0x36,
	0xa6, 0xbd, 0x0f, 0x94, 0x08, 0x73, 0x1f, 0x48, 0x1f, 0x61, 0xd3, 0x7e, 0x92, 0xb3, 0xa8, 0xa1,
	0x48, 0xb3, 0xb7, 0x4a, 0xd4, 0xa2, 0xa9, 0x0e, 0xd5, 0xe2, 0xd9, 0x33, 0x79, 0x9b, 0xbd, 0x35,
	0xcc, 0xf0, 0x1a, 0xa4, 0xfb, 0x9e, 0x7a, 0x1b, 0x54, 0x56, 0x8b, 0x66, 0x6b, 0xd6, 0x93, 0x6e,
	0x41, 0xb6, 0x36, 0x44, 0x72, 0x58, 0x41, 0x36, 0x0e, 0xdc, 0xb1, 0x31, 0xd9, 0x38, 0x20, 0x42,
	0xe1, 0xba, 0xc9, 0xae, 0x7e, 0xd6, 0xa8, 0x41, 0xfa, 0xa5, 0x38, 0xaa, 0xbc, 0xce, 0x9b, 0xf2,
	0x00, 0xe7, 0x2d, 0xb3, 0x12, 0xfd, 0x00, 0xe5, 0x91, 0x5c, 0xea, 0x3e, 0xd2, 0x23, 0xd1, 0x17,
	0xde, 0xc2, 0xa5, 0xe7, 0x81, 0xa8, 0x04, 0x67, 0xca, 0xdf, 0x0c, 0xdf, 0x99, 0x3f, 0x76, 0x77,
	0x03, 0xdb, 0xff, 0x27, 0xe3, 0x15, 0x14, 0xcf, 0xa7, 0xd7, 0xa7, 0xdd, 0xc5, 0xa2, 0xde, 0x4f,
	0xe6, 0x65, 0x27, 0x7a, 0xc9, 0x3f, 0xbf, 0xff, 0x09, 0x00, 0x00, 0xff, 0xff, 0x25, 0x00, 0x9c,
	0x6d, 0x07, 0x01, 0x00, 0x00,
}

5、编写main

package main

import (
	"fmt"
	"github.com/golang/protobuf/proto"
	"io/ioutil"
	"os"
	"protobuf/pro"
)

func write()  {
	p1 := &pro.Person{  //实例对象要&
		Id:1,
		Name:"张三",
		Phones:[]*pro.Phone{  //数组前面要加*
			{
				Type:pro.PhoneType_HOME,  //赋值是key : value
				Number:"123",
			},
			{
				Type:pro.PhoneType_WORK,
				Number:"321",
			},
		},
	}

	book := &pro.ContactBook{}
	book.Persons = append(book.Persons,p1)

	data,_ := proto.Marshal(book)

	ioutil.WriteFile("./test.txt",data,os.ModePerm)

}

func read()  {

	data,_ := ioutil.ReadFile("./test.txt");
	book := &pro.ContactBook{};

	proto.Unmarshal(data,book);
	for _,v := range book.Persons{
		fmt.Println(v.Id,v.Name)
		for _,vv := range v.Phones{
			fmt.Println(vv.Type,vv.Number)
		}
	}
}

func main()  {
	write()
	read()
}

6、运行


1 张三
HOME 123
WORK 321

Process finished with exit code 0

参考博客：

https://www.cnblogs.com/jkko123/p/7161843.html