encoder.go 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161
  1. package schema
  2. import (
  3. "errors"
  4. "fmt"
  5. "reflect"
  6. "strconv"
  7. )
  8. type encoderFunc func(reflect.Value) string
  9. // Encoder encodes values from a struct into url.Values.
  10. type Encoder struct {
  11. cache *cache
  12. regenc map[reflect.Type]encoderFunc
  13. }
  14. // NewEncoder returns a new Encoder with defaults.
  15. func NewEncoder() *Encoder {
  16. return &Encoder{cache: newCache(), regenc: make(map[reflect.Type]encoderFunc)}
  17. }
  18. // Encode encodes a struct into map[string][]string.
  19. //
  20. // Intended for use with url.Values.
  21. func (e *Encoder) Encode(src interface{}, dst map[string][]string) error {
  22. v := reflect.ValueOf(src)
  23. return e.encode(v, dst)
  24. }
  25. // RegisterEncoder registers a converter for encoding a custom type.
  26. func (e *Encoder) RegisterEncoder(value interface{}, encoder func(reflect.Value) string) {
  27. e.regenc[reflect.TypeOf(value)] = encoder
  28. }
  29. // SetAliasTag changes the tag used to locate custom field aliases.
  30. // The default tag is "schema".
  31. func (e *Encoder) SetAliasTag(tag string) {
  32. e.cache.tag = tag
  33. }
  34. func (e *Encoder) encode(v reflect.Value, dst map[string][]string) error {
  35. if v.Kind() == reflect.Ptr {
  36. v = v.Elem()
  37. }
  38. if v.Kind() != reflect.Struct {
  39. return errors.New("schema: interface must be a struct")
  40. }
  41. t := v.Type()
  42. errors := MultiError{}
  43. for i := 0; i < v.NumField(); i++ {
  44. name, opts := fieldAlias(t.Field(i), e.cache.tag)
  45. if name == "-" {
  46. continue
  47. }
  48. if v.Field(i).Type().Kind() == reflect.Struct {
  49. e.encode(v.Field(i), dst)
  50. continue
  51. }
  52. encFunc := typeEncoder(v.Field(i).Type(), e.regenc)
  53. // Encode non-slice types and custom implementations immediately.
  54. if encFunc != nil {
  55. value := encFunc(v.Field(i))
  56. if opts.Contains("omitempty") && v.Field(i).Interface() == reflect.Zero(reflect.TypeOf(v.Field(i).Interface())).Interface() {
  57. continue
  58. }
  59. dst[name] = append(dst[name], value)
  60. continue
  61. }
  62. if v.Field(i).Type().Kind() == reflect.Slice {
  63. encFunc = typeEncoder(v.Field(i).Type().Elem(), e.regenc)
  64. }
  65. if encFunc == nil {
  66. errors[v.Field(i).Type().String()] = fmt.Errorf("schema: encoder not found for %v", v.Field(i))
  67. continue
  68. }
  69. // Encode a slice.
  70. if v.Field(i).Len() == 0 && opts.Contains("omitempty") {
  71. continue
  72. }
  73. dst[name] = []string{}
  74. for j := 0; j < v.Field(i).Len(); j++ {
  75. dst[name] = append(dst[name], encFunc(v.Field(i).Index(j)))
  76. }
  77. }
  78. if len(errors) > 0 {
  79. return errors
  80. }
  81. return nil
  82. }
  83. func typeEncoder(t reflect.Type, reg map[reflect.Type]encoderFunc) encoderFunc {
  84. if f, ok := reg[t]; ok {
  85. return f
  86. }
  87. switch t.Kind() {
  88. case reflect.Bool:
  89. return encodeBool
  90. case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
  91. return encodeInt
  92. case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
  93. return encodeUint
  94. case reflect.Float32:
  95. return encodeFloat32
  96. case reflect.Float64:
  97. return encodeFloat64
  98. case reflect.Ptr:
  99. f := typeEncoder(t.Elem(), reg)
  100. return func(v reflect.Value) string {
  101. if v.IsNil() {
  102. return "null"
  103. }
  104. return f(v.Elem())
  105. }
  106. case reflect.String:
  107. return encodeString
  108. default:
  109. return nil
  110. }
  111. }
  112. func encodeBool(v reflect.Value) string {
  113. return strconv.FormatBool(v.Bool())
  114. }
  115. func encodeInt(v reflect.Value) string {
  116. return strconv.FormatInt(int64(v.Int()), 10)
  117. }
  118. func encodeUint(v reflect.Value) string {
  119. return strconv.FormatUint(uint64(v.Uint()), 10)
  120. }
  121. func encodeFloat(v reflect.Value, bits int) string {
  122. return strconv.FormatFloat(v.Float(), 'f', 6, bits)
  123. }
  124. func encodeFloat32(v reflect.Value) string {
  125. return encodeFloat(v, 32)
  126. }
  127. func encodeFloat64(v reflect.Value) string {
  128. return encodeFloat(v, 64)
  129. }
  130. func encodeString(v reflect.Value) string {
  131. return v.String()
  132. }