build.go 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279
  1. // Package jsonutil provides JSON serialization of AWS requests and responses.
  2. package jsonutil
  3. import (
  4. "bytes"
  5. "encoding/base64"
  6. "encoding/json"
  7. "fmt"
  8. "math"
  9. "reflect"
  10. "sort"
  11. "strconv"
  12. "time"
  13. "github.com/aws/aws-sdk-go/private/protocol"
  14. )
  15. var timeType = reflect.ValueOf(time.Time{}).Type()
  16. var byteSliceType = reflect.ValueOf([]byte{}).Type()
  17. // BuildJSON builds a JSON string for a given object v.
  18. func BuildJSON(v interface{}) ([]byte, error) {
  19. var buf bytes.Buffer
  20. err := buildAny(reflect.ValueOf(v), &buf, "")
  21. return buf.Bytes(), err
  22. }
  23. func buildAny(value reflect.Value, buf *bytes.Buffer, tag reflect.StructTag) error {
  24. origVal := value
  25. value = reflect.Indirect(value)
  26. if !value.IsValid() {
  27. return nil
  28. }
  29. vtype := value.Type()
  30. t := tag.Get("type")
  31. if t == "" {
  32. switch vtype.Kind() {
  33. case reflect.Struct:
  34. // also it can't be a time object
  35. if value.Type() != timeType {
  36. t = "structure"
  37. }
  38. case reflect.Slice:
  39. // also it can't be a byte slice
  40. if _, ok := value.Interface().([]byte); !ok {
  41. t = "list"
  42. }
  43. case reflect.Map:
  44. t = "map"
  45. }
  46. }
  47. switch t {
  48. case "structure":
  49. if field, ok := vtype.FieldByName("_"); ok {
  50. tag = field.Tag
  51. }
  52. return buildStruct(value, buf, tag)
  53. case "list":
  54. return buildList(value, buf, tag)
  55. case "map":
  56. return buildMap(value, buf, tag)
  57. default:
  58. return buildScalar(origVal, buf, tag)
  59. }
  60. }
  61. func buildStruct(value reflect.Value, buf *bytes.Buffer, tag reflect.StructTag) error {
  62. if !value.IsValid() {
  63. return nil
  64. }
  65. // unwrap payloads
  66. if payload := tag.Get("payload"); payload != "" {
  67. field, _ := value.Type().FieldByName(payload)
  68. tag = field.Tag
  69. value = elemOf(value.FieldByName(payload))
  70. if !value.IsValid() {
  71. return nil
  72. }
  73. }
  74. buf.WriteByte('{')
  75. t := value.Type()
  76. first := true
  77. for i := 0; i < t.NumField(); i++ {
  78. member := value.Field(i)
  79. // This allocates the most memory.
  80. // Additionally, we cannot skip nil fields due to
  81. // idempotency auto filling.
  82. field := t.Field(i)
  83. if field.PkgPath != "" {
  84. continue // ignore unexported fields
  85. }
  86. if field.Tag.Get("json") == "-" {
  87. continue
  88. }
  89. if field.Tag.Get("location") != "" {
  90. continue // ignore non-body elements
  91. }
  92. if field.Tag.Get("ignore") != "" {
  93. continue
  94. }
  95. if protocol.CanSetIdempotencyToken(member, field) {
  96. token := protocol.GetIdempotencyToken()
  97. member = reflect.ValueOf(&token)
  98. }
  99. if (member.Kind() == reflect.Ptr || member.Kind() == reflect.Slice || member.Kind() == reflect.Map) && member.IsNil() {
  100. continue // ignore unset fields
  101. }
  102. if first {
  103. first = false
  104. } else {
  105. buf.WriteByte(',')
  106. }
  107. // figure out what this field is called
  108. name := field.Name
  109. if locName := field.Tag.Get("locationName"); locName != "" {
  110. name = locName
  111. }
  112. writeString(name, buf)
  113. buf.WriteString(`:`)
  114. err := buildAny(member, buf, field.Tag)
  115. if err != nil {
  116. return err
  117. }
  118. }
  119. buf.WriteString("}")
  120. return nil
  121. }
  122. func buildList(value reflect.Value, buf *bytes.Buffer, tag reflect.StructTag) error {
  123. buf.WriteString("[")
  124. for i := 0; i < value.Len(); i++ {
  125. buildAny(value.Index(i), buf, "")
  126. if i < value.Len()-1 {
  127. buf.WriteString(",")
  128. }
  129. }
  130. buf.WriteString("]")
  131. return nil
  132. }
  133. type sortedValues []reflect.Value
  134. func (sv sortedValues) Len() int { return len(sv) }
  135. func (sv sortedValues) Swap(i, j int) { sv[i], sv[j] = sv[j], sv[i] }
  136. func (sv sortedValues) Less(i, j int) bool { return sv[i].String() < sv[j].String() }
  137. func buildMap(value reflect.Value, buf *bytes.Buffer, tag reflect.StructTag) error {
  138. buf.WriteString("{")
  139. sv := sortedValues(value.MapKeys())
  140. sort.Sort(sv)
  141. for i, k := range sv {
  142. if i > 0 {
  143. buf.WriteByte(',')
  144. }
  145. writeString(k.String(), buf)
  146. buf.WriteString(`:`)
  147. buildAny(value.MapIndex(k), buf, "")
  148. }
  149. buf.WriteString("}")
  150. return nil
  151. }
  152. func buildScalar(v reflect.Value, buf *bytes.Buffer, tag reflect.StructTag) error {
  153. // prevents allocation on the heap.
  154. scratch := [64]byte{}
  155. switch value := reflect.Indirect(v); value.Kind() {
  156. case reflect.String:
  157. writeString(value.String(), buf)
  158. case reflect.Bool:
  159. if value.Bool() {
  160. buf.WriteString("true")
  161. } else {
  162. buf.WriteString("false")
  163. }
  164. case reflect.Int64:
  165. buf.Write(strconv.AppendInt(scratch[:0], value.Int(), 10))
  166. case reflect.Float64:
  167. f := value.Float()
  168. if math.IsInf(f, 0) || math.IsNaN(f) {
  169. return &json.UnsupportedValueError{Value: v, Str: strconv.FormatFloat(f, 'f', -1, 64)}
  170. }
  171. buf.Write(strconv.AppendFloat(scratch[:0], f, 'f', -1, 64))
  172. default:
  173. switch value.Type() {
  174. case timeType:
  175. converted := v.Interface().(*time.Time)
  176. buf.Write(strconv.AppendInt(scratch[:0], converted.UTC().Unix(), 10))
  177. case byteSliceType:
  178. if !value.IsNil() {
  179. converted := value.Interface().([]byte)
  180. buf.WriteByte('"')
  181. if len(converted) < 1024 {
  182. // for small buffers, using Encode directly is much faster.
  183. dst := make([]byte, base64.StdEncoding.EncodedLen(len(converted)))
  184. base64.StdEncoding.Encode(dst, converted)
  185. buf.Write(dst)
  186. } else {
  187. // for large buffers, avoid unnecessary extra temporary
  188. // buffer space.
  189. enc := base64.NewEncoder(base64.StdEncoding, buf)
  190. enc.Write(converted)
  191. enc.Close()
  192. }
  193. buf.WriteByte('"')
  194. }
  195. default:
  196. return fmt.Errorf("unsupported JSON value %v (%s)", value.Interface(), value.Type())
  197. }
  198. }
  199. return nil
  200. }
  201. var hex = "0123456789abcdef"
  202. func writeString(s string, buf *bytes.Buffer) {
  203. buf.WriteByte('"')
  204. for i := 0; i < len(s); i++ {
  205. if s[i] == '"' {
  206. buf.WriteString(`\"`)
  207. } else if s[i] == '\\' {
  208. buf.WriteString(`\\`)
  209. } else if s[i] == '\b' {
  210. buf.WriteString(`\b`)
  211. } else if s[i] == '\f' {
  212. buf.WriteString(`\f`)
  213. } else if s[i] == '\r' {
  214. buf.WriteString(`\r`)
  215. } else if s[i] == '\t' {
  216. buf.WriteString(`\t`)
  217. } else if s[i] == '\n' {
  218. buf.WriteString(`\n`)
  219. } else if s[i] < 32 {
  220. buf.WriteString("\\u00")
  221. buf.WriteByte(hex[s[i]>>4])
  222. buf.WriteByte(hex[s[i]&0xF])
  223. } else {
  224. buf.WriteByte(s[i])
  225. }
  226. }
  227. buf.WriteByte('"')
  228. }
  229. // Returns the reflection element of a value, if it is a pointer.
  230. func elemOf(value reflect.Value) reflect.Value {
  231. for value.Kind() == reflect.Ptr {
  232. value = value.Elem()
  233. }
  234. return value
  235. }