build.go 6.6 KB

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