序列化

我们抽象出了Codec接口，用于统一处理请求的序列化/反序列化逻辑，您也可以实现您自己的Codec以便支持更多格式。具体源代码在encoding。

目前内置支持了如下格式：

  • form
  • json
  • protobuf
  • xml
  • yaml

接口实现

encoding 的 Codec 接口中,包含了 Marshal，Unmarshal，Name 三个方法，用户只需要实现 Codec 即可使用自定义的 encoding。

  1. // Codec 用于定义传输时用到的编码和解码接口，实现这个接口时必须注意，实现必须是线程安全的，可以并发协程调用。
  2. type Codec interface {
  3.     Marshal(v interface{}) ([]byte, error)
  4.     Unmarshal(data []byte, v interface{}) error
  5.     Name() string
  6. }

实现示例

在实现 Codec 时，可以参考 kratos 的内置实现, 如 json encoding，源代码如下。

  1. // https://github.com/go-kratos/kratos/blob/main/encoding/json/json.go
  2. package json
  4. import (
  5.     "encoding/json"
  6.     "reflect"
  8.     "github.com/go-kratos/kratos/v2/encoding"
  9.     "google.golang.org/protobuf/encoding/protojson"
  10.     "google.golang.org/protobuf/proto"
  11. )
  13. // Name is the name registered for the json codec.
  14. const Name = "json"
  16. var (
  17.     // MarshalOptions is a configurable JSON format marshaller.
  18.     MarshalOptions = protojson.MarshalOptions{
  19.         EmitUnpopulated: true,
  20.     }
  21.     // UnmarshalOptions is a configurable JSON format parser.
  22.     UnmarshalOptions = protojson.UnmarshalOptions{
  23.         DiscardUnknown: true,
  24.     }
  25. )
  27. func init() {
  28.     encoding.RegisterCodec(codec{})
  29. }
  31. // codec is a Codec implementation with json.
  32. type codec struct{}
  34. func (codec) Marshal(v interface{}) ([]byte, error) {
  35.     switch m := v.(type) {
  36.     case json.Marshaler:
  37.         return m.MarshalJSON()
  38.     case proto.Message:
  39.         return MarshalOptions.Marshal(m)
  40.     default:
  41.         return json.Marshal(m)
  42.     }
  43. }
  45. func (codec) Unmarshal(data []byte, v interface{}) error {
  46.     switch m := v.(type) {
  47.     case json.Unmarshaler:
  48.         return m.UnmarshalJSON(data)
  49.     case proto.Message:
  50.         return UnmarshalOptions.Unmarshal(data, m)
  51.     default:
  52.         rv := reflect.ValueOf(v)
  53.         for rv := rv; rv.Kind() == reflect.Ptr; {
  54.             if rv.IsNil() {
  55.                 rv.Set(reflect.New(rv.Type().Elem()))
  56.             }
  57.             rv = rv.Elem()
  58.         }
  59.         if m, ok := reflect.Indirect(rv).Interface().(proto.Message); ok {
  60.             return UnmarshalOptions.Unmarshal(data, m)
  61.         }
  62.         return json.Unmarshal(data, m)
  63.     }
  64. }
  66. func (codec) Name() string {
  67.     return Name
  68. }

使用方式

注册 Codec

  1. encoding.RegisterCodec(codec{})

获取 Codec

  1. jsonCodec := encoding.GetCodec("json")

序列化

  1. // 直接使用内置 Codec 时需要 import _ "github.com/go-kratos/kratos/v2/encoding/json"
  2. jsonCodec := encoding.GetCodec("json")
  3. type user struct {
  4.     Name string
  5.     Age string
  6.     state bool
  7. }
  8. u := &user{
  9.     Name:  "kratos",
  10.     Age:   "2",
  11.     state: false,
  12. }
  13. bytes, _ := jsonCodec.Marshal(u)
  14. fmt.Println(string(bytes))
  15. // 输出：{"Name":"kratos","Age":"2"}

反序列化

  1. // 直接使用内置 Codec 时需要 import _ "github.com/go-kratos/kratos/v2/encoding/json"
  2. jsonCodec := encoding.GetCodec("json")
  3. type user struct {
  4.     Name string
  5.     Age string
  6.     state bool
  7. }
  8. u := &user{}
  9. jsonCodec.Unmarshal([]byte(`{"Name":"kratos","Age":"2"}`), &u)
  10. fmt.Println(*u)
  11. // 输出：&{kratos 2 false}