当然,想必您已经猜到了,在对一些复杂类型(如struct)的转换时,gconv模块内部其实使用了反射的特性来实现的。这虽然为开发者提供了极大的便捷,但是这确实是以性能损耗为代价的。其实在对于struct转换时,如果开发者已经明确转换规则,并且对于其中的性能损耗比较在意,那么可以对特定的struct实现UnmarshalValue接口来实现自定义转换。当使用gconv模块对该struct进行转换时,无论该struct是直接作为转换对象或者作为转换对象的属性,gconv都将会自动识别其实现的UnmarshalValue接口并直接调用该接口实现类型转换,而不会使用反射特性来实现转换。

标准库的常用反序列化接口,如UnmarshalText(text []byte) error其实也是支持的哟,使用方式同UnmarshalValue,只是参数不同。

接口定义

  1. // apiUnmarshalValue is the interface for custom defined types customizing value assignment.
  2. // Note that only pointer can implement interface apiUnmarshalValue.
  3. type apiUnmarshalValue interface {
  4. UnmarshalValue(interface{}) error
  5. }

可以看到,自定义的类型可以通过定义UnmarshalValue方法来实现自定义的类型转换。这里的输入参数为interface{}类型,开发者可以在实际使用场景中通过 类型断言 或者其他方式进行类型转换。

需要特别注意,由于UnmarshalValue类型转换会修改当前对象的属性值,因此需要保证该接口实现的接受者(Receiver)是指针类型。

正确的接口实现定义示例(使用指针接受):

  1. func (c *Receiver) UnmarshalValue(interface{}) error

错误的接口实现定义示例(使用了值传递):

  1. func (c Receiver) UnmarshalValue(interface{}) error

使用示例

1、自定义数据表查询结果struct转换

数据表结构:

  1. CREATE TABLE `user` (
  2. id bigint unsigned NOT NULL AUTO_INCREMENT,
  3. passport varchar(45),
  4. password char(32) NOT NULL,
  5. nickname varchar(45) NOT NULL,
  6. create_time timestamp NOT NULL,
  7. PRIMARY KEY (id)
  8. ) ;

示例代码:

  1. package main
  2. import (
  3. "fmt"
  4. "github.com/gogf/gf/v2/container/garray"
  5. "github.com/gogf/gf/v2/database/gdb"
  6. "github.com/gogf/gf/v2/errors/gerror"
  7. "github.com/gogf/gf/v2/frame/g"
  8. "github.com/gogf/gf/v2/os/gtime"
  9. "reflect"
  10. )
  11. type User struct {
  12. Id int
  13. Passport string
  14. Password string
  15. Nickname string
  16. CreateTime *gtime.Time
  17. }
  18. // 实现UnmarshalValue接口,用于自定义结构体转换
  19. func (user *User) UnmarshalValue(value interface{}) error {
  20. if record, ok := value.(gdb.Record); ok {
  21. *user = User{
  22. Id: record["id"].Int(),
  23. Passport: record["passport"].String(),
  24. Password: "",
  25. Nickname: record["nickname"].String(),
  26. CreateTime: record["create_time"].GTime(),
  27. }
  28. return nil
  29. }
  30. return gerror.Newf(`unsupported value type for UnmarshalValue: %v`, reflect.TypeOf(value))
  31. }
  32. func main() {
  33. var (
  34. err error
  35. users []*User
  36. )
  37. array := garray.New(true)
  38. for i := 1; i <= 10; i++ {
  39. array.Append(g.Map{
  40. "id": i,
  41. "passport": fmt.Sprintf(`user_%d`, i),
  42. "password": fmt.Sprintf(`pass_%d`, i),
  43. "nickname": fmt.Sprintf(`name_%d`, i),
  44. "create_time": gtime.NewFromStr("2018-10-24 10:00:00").String(),
  45. })
  46. }
  47. // 写入数据
  48. _, err = g.Model("user").Data(array).Insert()
  49. if err != nil {
  50. panic(err)
  51. }
  52. // 查询数据
  53. err = g.Model("user").Order("id asc").Scan(&users)
  54. if err != nil {
  55. panic(err)
  56. }
  57. g.Dump(users)
  58. }

执行后,终端输出:

  1. [
  2. {
  3. Id: 1,
  4. Passport: "user_1",
  5. Password: "",
  6. Nickname: "name_1",
  7. CreateTime: "2018-10-24 10:00:00",
  8. },
  9. {
  10. Id: 2,
  11. Passport: "user_2",
  12. Password: "",
  13. Nickname: "name_2",
  14. CreateTime: "2018-10-24 10:00:00",
  15. },
  16. {
  17. Id: 3,
  18. Passport: "user_3",
  19. Password: "",
  20. Nickname: "name_3",
  21. CreateTime: "2018-10-24 10:00:00",
  22. },
  23. {
  24. Id: 4,
  25. Passport: "user_4",
  26. Password: "",
  27. Nickname: "name_4",
  28. CreateTime: "2018-10-24 10:00:00",
  29. },
  30. {
  31. Id: 5,
  32. Passport: "user_5",
  33. Password: "",
  34. Nickname: "name_5",
  35. CreateTime: "2018-10-24 10:00:00",
  36. },
  37. {
  38. Id: 6,
  39. Passport: "user_6",
  40. Password: "",
  41. Nickname: "name_6",
  42. CreateTime: "2018-10-24 10:00:00",
  43. },
  44. {
  45. Id: 7,
  46. Passport: "user_7",
  47. Password: "",
  48. Nickname: "name_7",
  49. CreateTime: "2018-10-24 10:00:00",
  50. },
  51. {
  52. Id: 8,
  53. Passport: "user_8",
  54. Password: "",
  55. Nickname: "name_8",
  56. CreateTime: "2018-10-24 10:00:00",
  57. },
  58. {
  59. Id: 9,
  60. Passport: "user_9",
  61. Password: "",
  62. Nickname: "name_9",
  63. CreateTime: "2018-10-24 10:00:00",
  64. },
  65. {
  66. Id: 10,
  67. Passport: "user_10",
  68. Password: "",
  69. Nickname: "name_10",
  70. CreateTime: "2018-10-24 10:00:00",
  71. },
  72. ]

可以看到自定义的UnmarshalValue类型转换方法中没有使用到反射特性,因此转换的性能会得到极大的提升。小伙伴们可以尝试着增加写入的数据量(例如100W),同时对比一下去掉UnmarshalValue后的类型转换所开销的时间。

2、自定义二进制TCP数据解包

一个TCP通信的数据包解包示例。

  1. package main
  2. import (
  3. "errors"
  4. "fmt"
  5. "github.com/gogf/gf/v2/crypto/gcrc32"
  6. "github.com/gogf/gf/v2/encoding/gbinary"
  7. "github.com/gogf/gf/v2/util/gconv"
  8. )
  9. type Pkg struct {
  10. Length uint16 // Total length.
  11. Crc32 uint32 // CRC32.
  12. Data []byte
  13. }
  14. // NewPkg creates and returns a package with given data.
  15. func NewPkg(data []byte) *Pkg {
  16. return &Pkg{
  17. Length: uint16(len(data) + 6),
  18. Crc32: gcrc32.Encrypt(data),
  19. Data: data,
  20. }
  21. }
  22. // Marshal encodes the protocol struct to bytes.
  23. func (p *Pkg) Marshal() []byte {
  24. b := make([]byte, 6+len(p.Data))
  25. copy(b, gbinary.EncodeUint16(p.Length))
  26. copy(b[2:], gbinary.EncodeUint32(p.Crc32))
  27. copy(b[6:], p.Data)
  28. return b
  29. }
  30. // UnmarshalValue decodes bytes to protocol struct.
  31. func (p *Pkg) UnmarshalValue(v interface{}) error {
  32. b := gconv.Bytes(v)
  33. if len(b) < 6 {
  34. return errors.New("invalid package length")
  35. }
  36. p.Length = gbinary.DecodeToUint16(b[:2])
  37. if len(b) < int(p.Length) {
  38. return errors.New("invalid data length")
  39. }
  40. p.Crc32 = gbinary.DecodeToUint32(b[2:6])
  41. p.Data = b[6:]
  42. if gcrc32.Encrypt(p.Data) != p.Crc32 {
  43. return errors.New("crc32 validation failed")
  44. }
  45. return nil
  46. }
  47. func main() {
  48. var p1, p2 *Pkg
  49. // Create a demo pkg as p1.
  50. p1 = NewPkg([]byte("123"))
  51. fmt.Println(p1)
  52. // Convert bytes from p1 to p2 using gconv.Struct.
  53. err := gconv.Struct(p1.Marshal(), &p2)
  54. if err != nil {
  55. panic(err)
  56. }
  57. fmt.Println(p2)
  58. }

执行后,终端输出:

  1. &{9 2286445522 [49 50 51]}
  2. &{9 2286445522 [49 50 51]}