introduce msgpack codec

Author: DarthPestilane

README.md

@@ -116,6 +116,7 @@ in [examples/tcp](./examples/tcp).
 | Benchmark_OneRouteJsonCodec-8     | 176893 | 6413 ns/op | 1618 B/op | 32 allocs/op | build with `encoding/json`    |
 | Benchmark_OneRouteJsonCodec-8     | 189723 | 5985 ns/op | 1347 B/op | 27 allocs/op | build with `json-jsoniter/go` |
 | Benchmark_OneRouteProtobufCodec-8 | 210532 | 6346 ns/op | 708 B/op  | 19 allocs/op |                               |
+| Benchmark_OneRouteMsgpackCodec-8  | 181495 | 6196 ns/op | 868 B/op  | 22 allocs/op |                               |
 
 ## Architecture
 

benchmarks_test.go

@@ -2,6 +2,7 @@ package easytcp
 
 import (
 	"github.com/DarthPestilane/easytcp/message"
+	"github.com/DarthPestilane/easytcp/test_data/msgpack"
 	"github.com/DarthPestilane/easytcp/test_data/pb"
 	"net"
 	"testing"
@@ -206,6 +207,37 @@ func Benchmark_OneRouteProtobufCodec(b *testing.B) {
 	}
 }
 
+func Benchmark_OneRouteMsgpackCodec(b *testing.B) {
+	s := NewServer(&ServerOption{
+		Codec:            &MsgpackCodec{},
+		DoNotPrintRoutes: true,
+	})
+	s.AddRoute(uint32(1), func(ctx *Context) (*message.Entry, error) {
+		var req msgpack.Sample
+		if err := ctx.Bind(&req); err != nil {
+			panic(err)
+		}
+		return ctx.Response(2, &msgpack.Sample{Foo: "test-resp", Bar: req.Bar + 1})
+	})
+	go s.Serve(":0") // nolint
+
+	<-s.accepting
+
+	// client
+	client, err := net.Dial("tcp", s.Listener.Addr().String())
+	if err != nil {
+		panic(err)
+	}
+	defer client.Close() // nolint
+
+	data, _ := s.Codec.Encode(&msgpack.Sample{Foo: "test", Bar: 1})
+	packedMsg, _ := s.Packer.Pack(&message.Entry{ID: uint32(1), Data: data})
+	beforeBench(b)
+	for i := 0; i < b.N; i++ {
+		_, _ = client.Write(packedMsg)
+	}
+}
+
 func beforeBench(b *testing.B) {
 	Log = &mutedLogger{}
 	b.ReportAllocs()

codec_msgpack.go

@@ -0,0 +1,18 @@
+package easytcp
+
+import (
+	"github.com/vmihailenco/msgpack/v5"
+)
+
+// MsgpackCodec implements the Codec interface.
+type MsgpackCodec struct{}
+
+// Encode implements the Codec Encode method.
+func (m *MsgpackCodec) Encode(v interface{}) ([]byte, error) {
+	return msgpack.Marshal(v)
+}
+
+// Decode implements the Codec Decode method.
+func (m *MsgpackCodec) Decode(data []byte, v interface{}) error {
+	return msgpack.Unmarshal(data, v)
+}

codec_pb.go

@@ -5,8 +5,10 @@ import (
 	"google.golang.org/protobuf/proto"
 )
 
+// ProtobufCodec implements the Codec interface.
 type ProtobufCodec struct{}
 
+// Encode implements the Codec Encode method.
 func (p *ProtobufCodec) Encode(v interface{}) ([]byte, error) {
 	m, ok := v.(proto.Message)
 	if !ok {
@@ -15,6 +17,7 @@ func (p *ProtobufCodec) Encode(v interface{}) ([]byte, error) {
 	return proto.Marshal(m)
 }
 
+// Decode implements the Codec Decode method.
 func (p *ProtobufCodec) Decode(data []byte, v interface{}) error {
 	m, ok := v.(proto.Message)
 	if !ok {

codec_test.go

@@ -1,6 +1,7 @@
 package easytcp
 
 import (
+	"github.com/DarthPestilane/easytcp/test_data/msgpack"
 	"github.com/DarthPestilane/easytcp/test_data/pb"
 	"github.com/stretchr/testify/assert"
 	"google.golang.org/protobuf/proto"
@@ -54,3 +55,19 @@ func TestProtobufCodec(t *testing.T) {
 		assert.True(t, proto.Equal(v, sample))
 	})
 }
+
+func TestMsgpackCodec(t *testing.T) {
+	item := msgpack.Sample{
+		Foo: "test",
+		Bar: 1,
+		Baz: map[int]string{2: "2"},
+	}
+	c := &MsgpackCodec{}
+	b, err := c.Encode(item)
+	assert.NoError(t, err)
+	assert.NotNil(t, b)
+
+	var itemDec msgpack.Sample
+	assert.NoError(t, c.Decode(b, &itemDec))
+	assert.Equal(t, item, itemDec)
+}

go.mod

@@ -12,6 +12,7 @@ require (
 	github.com/olekukonko/tablewriter v0.0.5
 	github.com/sirupsen/logrus v1.8.1
 	github.com/stretchr/testify v1.7.0
+	github.com/vmihailenco/msgpack/v5 v5.3.4
 	github.com/zhuangsirui/binpacker v1.0.0
 	golang.org/x/sys v0.0.0-20210423185535-09eb48e85fd7 // indirect
 	google.golang.org/protobuf v1.26.0

go.sum

@@ -36,8 +36,13 @@ github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+
 github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/vmihailenco/msgpack/v5 v5.3.4 h1:qMKAwOV+meBw2Y8k9cVwAy7qErtYCwBzZ2ellBfvnqc=
+github.com/vmihailenco/msgpack/v5 v5.3.4/go.mod h1:7xyJ9e+0+9SaZT0Wt1RGleJXzli6Q/V5KbhBonMG9jc=
+github.com/vmihailenco/tagparser/v2 v2.0.0 h1:y09buUbR+b5aycVFQs/g70pqKVZNBmxwAhO7/IwNM9g=
+github.com/vmihailenco/tagparser/v2 v2.0.0/go.mod h1:Wri+At7QHww0WTrCBeu4J6bNtoV6mEfg5OIWRZA9qds=
 github.com/zhuangsirui/binpacker v1.0.0 h1:kgziCOrgYftUXSwSqQDvXM42LRaEBDt0fqTj2BGZ1mQ=
 github.com/zhuangsirui/binpacker v1.0.0/go.mod h1:TdE7uEZ8Q7sMzbCpk2Y+ksFB8yA5AErPz0meDB612rU=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=

test_data/msgpack/sample.go

@@ -0,0 +1,8 @@
+package msgpack
+
+// Sample is a sample struct for test only.
+type Sample struct {
+	Foo string         `msgpack:"foo"`
+	Bar int64          `msgpack:"bar"`
+	Baz map[int]string `msgpack:"baz"`
+}