refactor(serializer): remove contract (#33)

* refactor(serializer): remove contract

* refactor(serializer): remove contract

cache/redis/store.go

@@ -4,16 +4,16 @@ import (
 	"context"
 	"time"
 
-	serializerContract "github.com/go-packagist/go-kratos-components/contract"
 	"github.com/go-packagist/go-kratos-components/contract/cache"
 	"github.com/go-packagist/go-kratos-components/serializer"
+	"github.com/go-packagist/go-kratos-components/serializer/json"
 	"github.com/redis/go-redis/v9"
 )
 
 type options struct {
 	prefix     string
 	redis      redis.Cmdable
-	serializer serializerContract.Serializable
+	serializer serializer.Serializable
 }
 
 func (o *options) setup() {
@@ -22,7 +22,7 @@ func (o *options) setup() {
 	}
 
 	if o.serializer == nil {
-		o.serializer = serializer.JsonSerializer
+		o.serializer = json.Serializer
 	}
 }
 
@@ -42,7 +42,7 @@ func Redis(redis redis.Cmdable) Option {
 	}
 }
 
-func Serializer(serializer serializerContract.Serializable) Option {
+func Serializer(serializer serializer.Serializable) Option {
 	return func(o *options) {
 		o.serializer = serializer
 	}

serializer/README.md

@@ -0,0 +1,30 @@
+# Serializer
+
+## Usage
+
+```go
+package serializer_test
+
+import (
+	"log"
+
+	"github.com/go-packagist/go-kratos-components/serializer/json"
+)
+
+var j = json.Serializer
+
+func ExampleJSON() {
+	bytes, err := j.Serialize(map[string]string{
+		"key": "value",
+	})
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	var dest map[string]string
+	err = j.Unserialize(bytes, &dest)
+	if err != nil {
+		log.Fatal(err)
+	}
+}
+```

serializer/example_test.go

@@ -0,0 +1,24 @@
+package serializer_test
+
+import (
+	"log"
+
+	"github.com/go-packagist/go-kratos-components/serializer/json"
+)
+
+var j = json.Serializer
+
+func ExampleJSON() {
+	bytes, err := j.Serialize(map[string]string{
+		"key": "value",
+	})
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	var dest map[string]string
+	err = j.Unserialize(bytes, &dest)
+	if err != nil {
+		log.Fatal(err)
+	}
+}

serializer/json.go → serializer/json/json.go

@@ -1,19 +1,15 @@
-package serializer
+package json
 
 import (
 	"encoding/json"
 
-	"github.com/go-packagist/go-kratos-components/contract"
+	"github.com/go-packagist/go-kratos-components/serializer"
 )
 
-var JsonSerializer = newJsonSerializer()
+var Serializer serializer.Serializable = &jsonSerializer{}
 
 type jsonSerializer struct{}
 
-func newJsonSerializer() contract.Serializable {
-	return &jsonSerializer{}
-}
-
 func (j *jsonSerializer) Serialize(data interface{}) ([]byte, error) {
 	return json.Marshal(data)
 }

serializer/json/json_test.go

@@ -0,0 +1,35 @@
+package json
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestSerializer(t *testing.T) {
+	var j1, j2 = Serializer, Serializer
+
+	assert.Same(t, j1, j2)
+
+	var data = map[string]interface{}{
+		"foo": "bar",
+	}
+
+	// marshal
+	bytes1, err := json.Marshal(data)
+	assert.NoError(t, err)
+
+	bytes2, err := j1.Serialize(data)
+	assert.NoError(t, err)
+
+	assert.Equal(t, bytes1, bytes2)
+
+	// unmarshal
+	var dest1, dest2 = make(map[string]interface{}), make(map[string]interface{})
+	assert.NoError(t, json.Unmarshal(bytes1, &dest1))
+	assert.NoError(t, j1.Unserialize(bytes1, &dest2))
+
+	assert.Equal(t, dest1, dest2)
+
+}

contract/serializable.go → serializer/serializable.go

@@ -1,6 +1,9 @@
-package contract
+package serializer
 
 type Serializable interface {
+	// Serialize the given data into bytes.
 	Serialize(data interface{}) ([]byte, error)
+
+	// Unserialize the given bytes into the given data.
 	Unserialize(src []byte, dest interface{}) error
 }