找回密码
 立即注册
查看: 202|回复: 0

Kratos项目组件——序列化

[复制链接]
发表于 2024-7-15 18:12 | 显示全部楼层 |阅读模式
我们抽象出了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
  3. import (
  4. ”encoding/json”
  5. ”reflect”
  6. ”github.com/go-kratos/kratos/v2/encoding”
  7. ”google.golang.org/protobuf/encoding/protojson”
  8. ”google.golang.org/protobuf/proto”
  9. )
  10. // Name is the name registered for the json codec.
  11. const Name = ”json”
  12. var (
  13. // MarshalOptions is a configurable JSON format marshaller.
  14.     MarshalOptions = protojson.MarshalOptions{
  15.         EmitUnpopulated: true,
  16. }
  17. // UnmarshalOptions is a configurable JSON format parser.
  18.     UnmarshalOptions = protojson.UnmarshalOptions{
  19.         DiscardUnknown: true,
  20. }
  21. )
  22. func init() {
  23.     encoding.RegisterCodec(codec{})
  24. }
  25. // codec is a Codec implementation with json.
  26. type codec struct{}
  27. func (codec) Marshal(v interface{}) ([]byte, error) {
  28. switch m := v.(type) {
  29. case json.Marshaler:
  30. return m.MarshalJSON()
  31. case proto.Message:
  32. return MarshalOptions.Marshal(m)
  33. default:
  34. return json.Marshal(m)
  35. }
  36. }
  37. func (codec) Unmarshal(data []byte, v interface{}) error {
  38. switch m := v.(type) {
  39. case json.Unmarshaler:
  40. return m.UnmarshalJSON(data)
  41. case proto.Message:
  42. return UnmarshalOptions.Unmarshal(data, m)
  43. default:
  44.         rv := reflect.ValueOf(v)
  45. for rv := rv; rv.Kind() == reflect.Ptr; {
  46. if rv.IsNil() {
  47.                 rv.Set(reflect.New(rv.Type().Elem()))
  48. }
  49.             rv = rv.Elem()
  50. }
  51. if m, ok := reflect.Indirect(rv).Interface().(proto.Message); ok {
  52. return UnmarshalOptions.Unmarshal(data, m)
  53. }
  54. return json.Unmarshal(data, m)
  55. }
  56. }
  57. func (codec) Name() string {
  58. return Name
  59. }
复制代码
使用方式​

注册 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}
复制代码
懒得打字嘛,点击右侧快捷回复 【右侧内容,后台自定义】
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

小黑屋|手机版|Unity开发者联盟 ( 粤ICP备20003399号 )

GMT+8, 2024-12-4 16:40 , Processed in 0.102014 second(s), 27 queries .

Powered by Discuz! X3.5 Licensed

© 2001-2024 Discuz! Team.

快速回复 返回顶部 返回列表