https://github.com/protocolbuffers/protobuf/releases
解压,将bin目录加入环境变量
用于生成Go代码
https://github.com/protocolbuffers/protobuf-go/releases
解压,将可执行文件加入到环境变量内
或使用go install github.com/protocolbuffers/protobuf-go@latest
直接安装
创建项目example
并且执行 go mod init example
syntax = "proto3"; // 指定该文件 proto语法版本,目前有2,3// option go_package = "path;name"; path 表示生成的go文件的存放地址,会自动生成目录
// name 表示生成的文件所属的包名
option go_package = "./service";// 指定文件生成后的package
package service;// 通信用的消息
message User {string name = 1;int32 aga = 2;
}
输入 protoc --go_out=./ ./user.proto
为user.proto生成Go代码
此时目录结构为:
user.pb.go文件为生成文件
// Code generated by protoc-gen-go. DO NOT EDIT.
// versions:
// protoc-gen-go v1.28.1
// protoc v3.21.12
// source: user.proto// 指定文件生成后的packagepackage serviceimport (protoreflect "google.golang.org/protobuf/reflect/protoreflect"protoimpl "google.golang.org/protobuf/runtime/protoimpl"reflect "reflect"sync "sync"
)const (// Verify that this generated code is sufficiently up-to-date._ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)// Verify that runtime/protoimpl is sufficiently up-to-date._ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)// 通信用的消息
type User struct {state protoimpl.MessageStatesizeCache protoimpl.SizeCacheunknownFields protoimpl.UnknownFieldsName string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`Aga int32 `protobuf:"varint,2,opt,name=aga,proto3" json:"aga,omitempty"`
}func (x *User) Reset() {*x = User{}if protoimpl.UnsafeEnabled {mi := &file_user_proto_msgTypes[0]ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))ms.StoreMessageInfo(mi)}
}func (x *User) String() string {return protoimpl.X.MessageStringOf(x)
}func (*User) ProtoMessage() {}func (x *User) ProtoReflect() protoreflect.Message {mi := &file_user_proto_msgTypes[0]if protoimpl.UnsafeEnabled && x != nil {ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))if ms.LoadMessageInfo() == nil {ms.StoreMessageInfo(mi)}return ms}return mi.MessageOf(x)
}// Deprecated: Use User.ProtoReflect.Descriptor instead.
func (*User) Descriptor() ([]byte, []int) {return file_user_proto_rawDescGZIP(), []int{0}
}func (x *User) GetName() string {if x != nil {return x.Name}return ""
}func (x *User) GetAga() int32 {if x != nil {return x.Aga}return 0
}var File_user_proto protoreflect.FileDescriptorvar file_user_proto_rawDesc = []byte{0x0a, 0x0a, 0x75, 0x73, 0x65, 0x72, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x12, 0x07, 0x73, 0x65,0x72, 0x76, 0x69, 0x63, 0x65, 0x22, 0x2c, 0x0a, 0x04, 0x55, 0x73, 0x65, 0x72, 0x12, 0x12, 0x0a,0x04, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, 0x61, 0x6d,0x65, 0x12, 0x10, 0x0a, 0x03, 0x61, 0x67, 0x61, 0x18, 0x02, 0x20, 0x01, 0x28, 0x05, 0x52, 0x03,0x61, 0x67, 0x61, 0x42, 0x0b, 0x5a, 0x09, 0x2e, 0x2f, 0x73, 0x65, 0x72, 0x76, 0x69, 0x63, 0x65,0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33,
}var (file_user_proto_rawDescOnce sync.Oncefile_user_proto_rawDescData = file_user_proto_rawDesc
)func file_user_proto_rawDescGZIP() []byte {file_user_proto_rawDescOnce.Do(func() {file_user_proto_rawDescData = protoimpl.X.CompressGZIP(file_user_proto_rawDescData)})return file_user_proto_rawDescData
}var file_user_proto_msgTypes = make([]protoimpl.MessageInfo, 1)
var file_user_proto_goTypes = []interface{}{(*User)(nil), // 0: service.User
}
var file_user_proto_depIdxs = []int32{0, // [0:0] is the sub-list for method output_type0, // [0:0] is the sub-list for method input_type0, // [0:0] is the sub-list for extension type_name0, // [0:0] is the sub-list for extension extendee0, // [0:0] is the sub-list for field type_name
}func init() { file_user_proto_init() }
func file_user_proto_init() {if File_user_proto != nil {return}if !protoimpl.UnsafeEnabled {file_user_proto_msgTypes[0].Exporter = func(v interface{}, i int) interface{} {switch v := v.(*User); i {case 0:return &v.statecase 1:return &v.sizeCachecase 2:return &v.unknownFieldsdefault:return nil}}}type x struct{}out := protoimpl.TypeBuilder{File: protoimpl.DescBuilder{GoPackagePath: reflect.TypeOf(x{}).PkgPath(),RawDescriptor: file_user_proto_rawDesc,NumEnums: 0,NumMessages: 1,NumExtensions: 0,NumServices: 0,},GoTypes: file_user_proto_goTypes,DependencyIndexes: file_user_proto_depIdxs,MessageInfos: file_user_proto_msgTypes,}.Build()File_user_proto = out.Filefile_user_proto_rawDesc = nilfile_user_proto_goTypes = nilfile_user_proto_depIdxs = nil
}
执行go mod tidy
拉取依赖
user.pb.go很显然,不让我们手动编辑
创建main.go文件
package mainimport ("example/service""fmt""google.golang.org/protobuf/proto"
)func main() {user := &service.User{Name: "张三",Age: 20,}// 序列化bys, err := proto.Marshal(user)if err != nil {panic(err)}// 反序列化user1 := &service.User{}err = proto.Unmarshal(bys, user1)if err != nil {panic(err)}fmt.Println(user1)}
详情请查看文末链接
Reference
https://developers.google.cn/protocol-buffers/docs/proto3?hl=zh-cn#simple