Browse Source

[add] protocol 整理

bvbej 1 year ago
parent
commit
794e468012

+ 3 - 0
README.md

@@ -1 +1,4 @@
 ## Golang公共包
+
+* pb协议文件生成命令
+`protoc --proto_path=pkg/websocket/codec/protobuf/protocol --go_out=pkg/websocket/codec/protobuf/protocol --go_opt=paths=source_relative base.proto`

+ 4 - 4
pkg/websocket/codec/json/json.go

@@ -22,6 +22,10 @@ type jsonAck struct {
 	Error  string `json:"error,omitempty"`
 }
 
+func init() {
+	codec.RegisterCodec("json_codec", new(jsonCodec))
+}
+
 func (*jsonCodec) Marshal(router string, dataPtr any, retErr error) ([]byte, error) {
 
 	if router == "" {
@@ -90,7 +94,3 @@ func (*jsonCodec) ToString(data any) string {
 	}
 	return string(ab)
 }
-
-func init() {
-	codec.RegisterCodec("json_codec", new(jsonCodec))
-}

+ 0 - 137
pkg/websocket/codec/protobuf/baseproto/baseproto.pb.go

@@ -1,137 +0,0 @@
-// Code generated by protoc-gen-go. DO NOT EDIT.
-// source: baseproto.proto
-
-package baseproto
-
-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 TransPack struct {
-	Id                   string   `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
-	Data                 []byte   `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
-	Error                string   `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
-	XXX_NoUnkeyedLiteral struct{} `json:"-"`
-	XXX_unrecognized     []byte   `json:"-"`
-	XXX_sizecache        int32    `json:"-"`
-}
-
-func (m *TransPack) Reset()         { *m = TransPack{} }
-func (m *TransPack) String() string { return proto.CompactTextString(m) }
-func (*TransPack) ProtoMessage()    {}
-func (*TransPack) Descriptor() ([]byte, []int) {
-	return fileDescriptor_822e52c9a4a56588, []int{0}
-}
-
-func (m *TransPack) XXX_Unmarshal(b []byte) error {
-	return xxx_messageInfo_TransPack.Unmarshal(m, b)
-}
-func (m *TransPack) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) {
-	return xxx_messageInfo_TransPack.Marshal(b, m, deterministic)
-}
-func (m *TransPack) XXX_Merge(src proto.Message) {
-	xxx_messageInfo_TransPack.Merge(m, src)
-}
-func (m *TransPack) XXX_Size() int {
-	return xxx_messageInfo_TransPack.Size(m)
-}
-func (m *TransPack) XXX_DiscardUnknown() {
-	xxx_messageInfo_TransPack.DiscardUnknown(m)
-}
-
-var xxx_messageInfo_TransPack proto.InternalMessageInfo
-
-func (m *TransPack) GetId() string {
-	if m != nil {
-		return m.Id
-	}
-	return ""
-}
-
-func (m *TransPack) GetData() []byte {
-	if m != nil {
-		return m.Data
-	}
-	return nil
-}
-
-func (m *TransPack) GetError() string {
-	if m != nil {
-		return m.Error
-	}
-	return ""
-}
-
-//连接检测
-type PingPang struct {
-	Timestamp            int64    `protobuf:"varint,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
-	XXX_NoUnkeyedLiteral struct{} `json:"-"`
-	XXX_unrecognized     []byte   `json:"-"`
-	XXX_sizecache        int32    `json:"-"`
-}
-
-func (m *PingPang) Reset()         { *m = PingPang{} }
-func (m *PingPang) String() string { return proto.CompactTextString(m) }
-func (*PingPang) ProtoMessage()    {}
-func (*PingPang) Descriptor() ([]byte, []int) {
-	return fileDescriptor_822e52c9a4a56588, []int{1}
-}
-
-func (m *PingPang) XXX_Unmarshal(b []byte) error {
-	return xxx_messageInfo_PingPang.Unmarshal(m, b)
-}
-func (m *PingPang) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) {
-	return xxx_messageInfo_PingPang.Marshal(b, m, deterministic)
-}
-func (m *PingPang) XXX_Merge(src proto.Message) {
-	xxx_messageInfo_PingPang.Merge(m, src)
-}
-func (m *PingPang) XXX_Size() int {
-	return xxx_messageInfo_PingPang.Size(m)
-}
-func (m *PingPang) XXX_DiscardUnknown() {
-	xxx_messageInfo_PingPang.DiscardUnknown(m)
-}
-
-var xxx_messageInfo_PingPang proto.InternalMessageInfo
-
-func (m *PingPang) GetTimestamp() int64 {
-	if m != nil {
-		return m.Timestamp
-	}
-	return 0
-}
-
-func init() {
-	proto.RegisterType((*TransPack)(nil), "baseproto.TransPack")
-	proto.RegisterType((*PingPang)(nil), "baseproto.PingPang")
-}
-
-func init() { proto.RegisterFile("baseproto.proto", fileDescriptor_822e52c9a4a56588) }
-
-var fileDescriptor_822e52c9a4a56588 = []byte{
-	// 138 bytes of a gzipped FileDescriptorProto
-	0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0xe2, 0xe2, 0x4f, 0x4a, 0x2c, 0x4e,
-	0x2d, 0x28, 0xca, 0x2f, 0xc9, 0xd7, 0x03, 0x93, 0x42, 0x9c, 0x70, 0x01, 0x25, 0x57, 0x2e, 0xce,
-	0x90, 0xa2, 0xc4, 0xbc, 0xe2, 0x80, 0xc4, 0xe4, 0x6c, 0x21, 0x3e, 0x2e, 0xa6, 0xcc, 0x14, 0x09,
-	0x46, 0x05, 0x46, 0x0d, 0xce, 0x20, 0xa6, 0xcc, 0x14, 0x21, 0x21, 0x2e, 0x96, 0x94, 0xc4, 0x92,
-	0x44, 0x09, 0x26, 0x05, 0x46, 0x0d, 0x9e, 0x20, 0x30, 0x5b, 0x48, 0x84, 0x8b, 0x35, 0xb5, 0xa8,
-	0x28, 0xbf, 0x48, 0x82, 0x19, 0xac, 0x0c, 0xc2, 0x51, 0xd2, 0xe0, 0xe2, 0x08, 0xc8, 0xcc, 0x4b,
-	0x0f, 0x48, 0xcc, 0x4b, 0x17, 0x92, 0xe1, 0xe2, 0x2c, 0xc9, 0xcc, 0x4d, 0x2d, 0x2e, 0x49, 0xcc,
-	0x2d, 0x00, 0x1b, 0xc6, 0x1c, 0x84, 0x10, 0x48, 0x62, 0x03, 0xdb, 0x6b, 0x0c, 0x08, 0x00, 0x00,
-	0xff, 0xff, 0xf9, 0xc6, 0xa2, 0xc1, 0x95, 0x00, 0x00, 0x00,
-}

+ 9 - 9
pkg/websocket/codec/protobuf/protobuf.go

@@ -5,12 +5,16 @@ import (
 	"fmt"
 
 	"git.bvbej.com/bvbej/base-golang/pkg/websocket/codec"
-	"git.bvbej.com/bvbej/base-golang/pkg/websocket/codec/protobuf/baseproto"
+	"git.bvbej.com/bvbej/base-golang/pkg/websocket/codec/protobuf/protocol"
 	"github.com/golang/protobuf/proto"
 )
 
 type protobufCodec struct{}
 
+func init() {
+	codec.RegisterCodec("protobuf_codec", new(protobufCodec))
+}
+
 func (*protobufCodec) Marshal(router string, dataPtr any, retErr error) ([]byte, error) {
 	if router == "" {
 		return nil, fmt.Errorf("marshal: empty router")
@@ -18,8 +22,8 @@ func (*protobufCodec) Marshal(router string, dataPtr any, retErr error) ([]byte,
 	if dataPtr == nil && retErr == nil {
 		return nil, fmt.Errorf("marshal: empty data")
 	}
-	ack := &baseproto.TransPack{
-		Id: router,
+	ack := &protocol.TransPack{
+		Router: router,
 	}
 	if dataPtr != nil {
 		pbMsg, ok := dataPtr.(proto.Message)
@@ -46,12 +50,12 @@ func (*protobufCodec) Marshal(router string, dataPtr any, retErr error) ([]byte,
 
 func (*protobufCodec) Unmarshal(msg []byte) (int, *codec.MsgPack, error) {
 	var l = len(msg)
-	req := &baseproto.TransPack{}
+	req := &protocol.TransPack{}
 	err := proto.Unmarshal(msg, req)
 	if err != nil {
 		return l, nil, errors.New("unmarshal split message id failed.")
 	}
-	var router = req.Id
+	var router = req.Router
 	msgPack := &codec.MsgPack{Router: router}
 	dt := codec.GetMessage(router)
 	if dt == nil {
@@ -78,7 +82,3 @@ func (*protobufCodec) ToString(data any) string {
 	}
 	return pbMsg.String()
 }
-
-func init() {
-	codec.RegisterCodec("protobuf_codec", new(protobufCodec))
-}

+ 226 - 0
pkg/websocket/codec/protobuf/protocol/base.pb.go

@@ -0,0 +1,226 @@
+// Code generated by protoc-gen-go. DO NOT EDIT.
+// versions:
+// 	protoc-gen-go v1.26.0
+// 	protoc        v3.21.1
+// source: base.proto
+
+package protocol
+
+import (
+	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 TransPack struct {
+	state         protoimpl.MessageState
+	sizeCache     protoimpl.SizeCache
+	unknownFields protoimpl.UnknownFields
+
+	Router string `protobuf:"bytes,1,opt,name=router,proto3" json:"router,omitempty"`
+	Data   []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
+	Error  string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
+}
+
+func (x *TransPack) Reset() {
+	*x = TransPack{}
+	if protoimpl.UnsafeEnabled {
+		mi := &file_base_proto_msgTypes[0]
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		ms.StoreMessageInfo(mi)
+	}
+}
+
+func (x *TransPack) String() string {
+	return protoimpl.X.MessageStringOf(x)
+}
+
+func (*TransPack) ProtoMessage() {}
+
+func (x *TransPack) ProtoReflect() protoreflect.Message {
+	mi := &file_base_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 TransPack.ProtoReflect.Descriptor instead.
+func (*TransPack) Descriptor() ([]byte, []int) {
+	return file_base_proto_rawDescGZIP(), []int{0}
+}
+
+func (x *TransPack) GetRouter() string {
+	if x != nil {
+		return x.Router
+	}
+	return ""
+}
+
+func (x *TransPack) GetData() []byte {
+	if x != nil {
+		return x.Data
+	}
+	return nil
+}
+
+func (x *TransPack) GetError() string {
+	if x != nil {
+		return x.Error
+	}
+	return ""
+}
+
+//连接检测
+type PingPang struct {
+	state         protoimpl.MessageState
+	sizeCache     protoimpl.SizeCache
+	unknownFields protoimpl.UnknownFields
+
+	Timestamp int64 `protobuf:"varint,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"` //时间戳
+}
+
+func (x *PingPang) Reset() {
+	*x = PingPang{}
+	if protoimpl.UnsafeEnabled {
+		mi := &file_base_proto_msgTypes[1]
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		ms.StoreMessageInfo(mi)
+	}
+}
+
+func (x *PingPang) String() string {
+	return protoimpl.X.MessageStringOf(x)
+}
+
+func (*PingPang) ProtoMessage() {}
+
+func (x *PingPang) ProtoReflect() protoreflect.Message {
+	mi := &file_base_proto_msgTypes[1]
+	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 PingPang.ProtoReflect.Descriptor instead.
+func (*PingPang) Descriptor() ([]byte, []int) {
+	return file_base_proto_rawDescGZIP(), []int{1}
+}
+
+func (x *PingPang) GetTimestamp() int64 {
+	if x != nil {
+		return x.Timestamp
+	}
+	return 0
+}
+
+var File_base_proto protoreflect.FileDescriptor
+
+var file_base_proto_rawDesc = []byte{
+	0x0a, 0x0a, 0x62, 0x61, 0x73, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x12, 0x08, 0x70, 0x72,
+	0x6f, 0x74, 0x6f, 0x63, 0x6f, 0x6c, 0x22, 0x4d, 0x0a, 0x09, 0x54, 0x72, 0x61, 0x6e, 0x73, 0x50,
+	0x61, 0x63, 0x6b, 0x12, 0x16, 0x0a, 0x06, 0x72, 0x6f, 0x75, 0x74, 0x65, 0x72, 0x18, 0x01, 0x20,
+	0x01, 0x28, 0x09, 0x52, 0x06, 0x72, 0x6f, 0x75, 0x74, 0x65, 0x72, 0x12, 0x12, 0x0a, 0x04, 0x64,
+	0x61, 0x74, 0x61, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x04, 0x64, 0x61, 0x74, 0x61, 0x12,
+	0x14, 0x0a, 0x05, 0x65, 0x72, 0x72, 0x6f, 0x72, 0x18, 0x03, 0x20, 0x01, 0x28, 0x09, 0x52, 0x05,
+	0x65, 0x72, 0x72, 0x6f, 0x72, 0x22, 0x28, 0x0a, 0x08, 0x50, 0x69, 0x6e, 0x67, 0x50, 0x61, 0x6e,
+	0x67, 0x12, 0x1c, 0x0a, 0x09, 0x74, 0x69, 0x6d, 0x65, 0x73, 0x74, 0x61, 0x6d, 0x70, 0x18, 0x01,
+	0x20, 0x01, 0x28, 0x03, 0x52, 0x09, 0x74, 0x69, 0x6d, 0x65, 0x73, 0x74, 0x61, 0x6d, 0x70, 0x42,
+	0x27, 0x5a, 0x25, 0x70, 0x6b, 0x67, 0x2f, 0x77, 0x65, 0x62, 0x73, 0x6f, 0x63, 0x6b, 0x65, 0x74,
+	0x2f, 0x63, 0x6f, 0x64, 0x65, 0x63, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2f,
+	0x70, 0x72, 0x6f, 0x74, 0x6f, 0x63, 0x6f, 0x6c, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33,
+}
+
+var (
+	file_base_proto_rawDescOnce sync.Once
+	file_base_proto_rawDescData = file_base_proto_rawDesc
+)
+
+func file_base_proto_rawDescGZIP() []byte {
+	file_base_proto_rawDescOnce.Do(func() {
+		file_base_proto_rawDescData = protoimpl.X.CompressGZIP(file_base_proto_rawDescData)
+	})
+	return file_base_proto_rawDescData
+}
+
+var file_base_proto_msgTypes = make([]protoimpl.MessageInfo, 2)
+var file_base_proto_goTypes = []interface{}{
+	(*TransPack)(nil), // 0: protocol.TransPack
+	(*PingPang)(nil),  // 1: protocol.PingPang
+}
+var file_base_proto_depIdxs = []int32{
+	0, // [0:0] is the sub-list for method output_type
+	0, // [0:0] is the sub-list for method input_type
+	0, // [0:0] is the sub-list for extension type_name
+	0, // [0:0] is the sub-list for extension extendee
+	0, // [0:0] is the sub-list for field type_name
+}
+
+func init() { file_base_proto_init() }
+func file_base_proto_init() {
+	if File_base_proto != nil {
+		return
+	}
+	if !protoimpl.UnsafeEnabled {
+		file_base_proto_msgTypes[0].Exporter = func(v interface{}, i int) interface{} {
+			switch v := v.(*TransPack); i {
+			case 0:
+				return &v.state
+			case 1:
+				return &v.sizeCache
+			case 2:
+				return &v.unknownFields
+			default:
+				return nil
+			}
+		}
+		file_base_proto_msgTypes[1].Exporter = func(v interface{}, i int) interface{} {
+			switch v := v.(*PingPang); i {
+			case 0:
+				return &v.state
+			case 1:
+				return &v.sizeCache
+			case 2:
+				return &v.unknownFields
+			default:
+				return nil
+			}
+		}
+	}
+	type x struct{}
+	out := protoimpl.TypeBuilder{
+		File: protoimpl.DescBuilder{
+			GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
+			RawDescriptor: file_base_proto_rawDesc,
+			NumEnums:      0,
+			NumMessages:   2,
+			NumExtensions: 0,
+			NumServices:   0,
+		},
+		GoTypes:           file_base_proto_goTypes,
+		DependencyIndexes: file_base_proto_depIdxs,
+		MessageInfos:      file_base_proto_msgTypes,
+	}.Build()
+	File_base_proto = out.File
+	file_base_proto_rawDesc = nil
+	file_base_proto_goTypes = nil
+	file_base_proto_depIdxs = nil
+}

+ 3 - 2
pkg/websocket/codec/protobuf/baseproto/baseproto.proto → pkg/websocket/codec/protobuf/protocol/base.proto

@@ -1,9 +1,10 @@
 syntax = "proto3";
-package baseproto;
+package protocol;
+option go_package = "pkg/websocket/codec/protobuf/protocol";
 
 //通信包装
 message TransPack {
-  string id = 1;
+  string router = 1;
   bytes data = 2;
   string error = 3;
 }