feature_config.go 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348
  1. package jsoniter
  2. import (
  3. "encoding/json"
  4. "errors"
  5. "io"
  6. "reflect"
  7. "sync/atomic"
  8. "unsafe"
  9. )
  10. // Config customize how the API should behave.
  11. // The API is created from Config by Froze.
  12. type Config struct {
  13. IndentionStep int
  14. MarshalFloatWith6Digits bool
  15. EscapeHTML bool
  16. SortMapKeys bool
  17. UseNumber bool
  18. TagKey string
  19. ValidateJsonRawMessage bool
  20. ObjectFieldMustBeSimpleString bool
  21. }
  22. type frozenConfig struct {
  23. configBeforeFrozen Config
  24. sortMapKeys bool
  25. indentionStep int
  26. objectFieldMustBeSimpleString bool
  27. decoderCache unsafe.Pointer
  28. encoderCache unsafe.Pointer
  29. extensions []Extension
  30. streamPool chan *Stream
  31. iteratorPool chan *Iterator
  32. }
  33. // API the public interface of this package.
  34. // Primary Marshal and Unmarshal.
  35. type API interface {
  36. IteratorPool
  37. StreamPool
  38. MarshalToString(v interface{}) (string, error)
  39. Marshal(v interface{}) ([]byte, error)
  40. MarshalIndent(v interface{}, prefix, indent string) ([]byte, error)
  41. UnmarshalFromString(str string, v interface{}) error
  42. Unmarshal(data []byte, v interface{}) error
  43. Get(data []byte, path ...interface{}) Any
  44. NewEncoder(writer io.Writer) *Encoder
  45. NewDecoder(reader io.Reader) *Decoder
  46. Valid(data []byte) bool
  47. RegisterExtension(extension Extension)
  48. }
  49. // ConfigDefault the default API
  50. var ConfigDefault = Config{
  51. EscapeHTML: true,
  52. }.Froze()
  53. // ConfigCompatibleWithStandardLibrary tries to be 100% compatible with standard library behavior
  54. var ConfigCompatibleWithStandardLibrary = Config{
  55. EscapeHTML: true,
  56. SortMapKeys: true,
  57. ValidateJsonRawMessage: true,
  58. }.Froze()
  59. // ConfigFastest marshals float with only 6 digits precision
  60. var ConfigFastest = Config{
  61. EscapeHTML: false,
  62. MarshalFloatWith6Digits: true, // will lose precession
  63. ObjectFieldMustBeSimpleString: true, // do not unescape object field
  64. }.Froze()
  65. // Froze forge API from config
  66. func (cfg Config) Froze() API {
  67. // TODO: cache frozen config
  68. frozenConfig := &frozenConfig{
  69. sortMapKeys: cfg.SortMapKeys,
  70. indentionStep: cfg.IndentionStep,
  71. objectFieldMustBeSimpleString: cfg.ObjectFieldMustBeSimpleString,
  72. streamPool: make(chan *Stream, 16),
  73. iteratorPool: make(chan *Iterator, 16),
  74. }
  75. atomic.StorePointer(&frozenConfig.decoderCache, unsafe.Pointer(&map[string]ValDecoder{}))
  76. atomic.StorePointer(&frozenConfig.encoderCache, unsafe.Pointer(&map[string]ValEncoder{}))
  77. if cfg.MarshalFloatWith6Digits {
  78. frozenConfig.marshalFloatWith6Digits()
  79. }
  80. if cfg.EscapeHTML {
  81. frozenConfig.escapeHTML()
  82. }
  83. if cfg.UseNumber {
  84. frozenConfig.useNumber()
  85. }
  86. if cfg.ValidateJsonRawMessage {
  87. frozenConfig.validateJsonRawMessage()
  88. }
  89. frozenConfig.configBeforeFrozen = cfg
  90. return frozenConfig
  91. }
  92. func (cfg *frozenConfig) validateJsonRawMessage() {
  93. encoder := &funcEncoder{func(ptr unsafe.Pointer, stream *Stream) {
  94. rawMessage := *(*json.RawMessage)(ptr)
  95. iter := cfg.BorrowIterator([]byte(rawMessage))
  96. iter.Read()
  97. if iter.Error != nil {
  98. stream.WriteRaw("null")
  99. } else {
  100. cfg.ReturnIterator(iter)
  101. stream.WriteRaw(string(rawMessage))
  102. }
  103. }, func(ptr unsafe.Pointer) bool {
  104. return false
  105. }}
  106. cfg.addEncoderToCache(reflect.TypeOf((*json.RawMessage)(nil)).Elem(), encoder)
  107. cfg.addEncoderToCache(reflect.TypeOf((*RawMessage)(nil)).Elem(), encoder)
  108. }
  109. func (cfg *frozenConfig) useNumber() {
  110. cfg.addDecoderToCache(reflect.TypeOf((*interface{})(nil)).Elem(), &funcDecoder{func(ptr unsafe.Pointer, iter *Iterator) {
  111. if iter.WhatIsNext() == NumberValue {
  112. *((*interface{})(ptr)) = json.Number(iter.readNumberAsString())
  113. } else {
  114. *((*interface{})(ptr)) = iter.Read()
  115. }
  116. }})
  117. }
  118. func (cfg *frozenConfig) getTagKey() string {
  119. tagKey := cfg.configBeforeFrozen.TagKey
  120. if tagKey == "" {
  121. return "json"
  122. }
  123. return tagKey
  124. }
  125. func (cfg *frozenConfig) RegisterExtension(extension Extension) {
  126. cfg.extensions = append(cfg.extensions, extension)
  127. }
  128. type lossyFloat32Encoder struct {
  129. }
  130. func (encoder *lossyFloat32Encoder) Encode(ptr unsafe.Pointer, stream *Stream) {
  131. stream.WriteFloat32Lossy(*((*float32)(ptr)))
  132. }
  133. func (encoder *lossyFloat32Encoder) EncodeInterface(val interface{}, stream *Stream) {
  134. WriteToStream(val, stream, encoder)
  135. }
  136. func (encoder *lossyFloat32Encoder) IsEmpty(ptr unsafe.Pointer) bool {
  137. return *((*float32)(ptr)) == 0
  138. }
  139. type lossyFloat64Encoder struct {
  140. }
  141. func (encoder *lossyFloat64Encoder) Encode(ptr unsafe.Pointer, stream *Stream) {
  142. stream.WriteFloat64Lossy(*((*float64)(ptr)))
  143. }
  144. func (encoder *lossyFloat64Encoder) EncodeInterface(val interface{}, stream *Stream) {
  145. WriteToStream(val, stream, encoder)
  146. }
  147. func (encoder *lossyFloat64Encoder) IsEmpty(ptr unsafe.Pointer) bool {
  148. return *((*float64)(ptr)) == 0
  149. }
  150. // EnableLossyFloatMarshalling keeps 10**(-6) precision
  151. // for float variables for better performance.
  152. func (cfg *frozenConfig) marshalFloatWith6Digits() {
  153. // for better performance
  154. cfg.addEncoderToCache(reflect.TypeOf((*float32)(nil)).Elem(), &lossyFloat32Encoder{})
  155. cfg.addEncoderToCache(reflect.TypeOf((*float64)(nil)).Elem(), &lossyFloat64Encoder{})
  156. }
  157. type htmlEscapedStringEncoder struct {
  158. }
  159. func (encoder *htmlEscapedStringEncoder) Encode(ptr unsafe.Pointer, stream *Stream) {
  160. str := *((*string)(ptr))
  161. stream.WriteStringWithHTMLEscaped(str)
  162. }
  163. func (encoder *htmlEscapedStringEncoder) EncodeInterface(val interface{}, stream *Stream) {
  164. WriteToStream(val, stream, encoder)
  165. }
  166. func (encoder *htmlEscapedStringEncoder) IsEmpty(ptr unsafe.Pointer) bool {
  167. return *((*string)(ptr)) == ""
  168. }
  169. func (cfg *frozenConfig) escapeHTML() {
  170. cfg.addEncoderToCache(reflect.TypeOf((*string)(nil)).Elem(), &htmlEscapedStringEncoder{})
  171. }
  172. func (cfg *frozenConfig) addDecoderToCache(cacheKey reflect.Type, decoder ValDecoder) {
  173. done := false
  174. for !done {
  175. ptr := atomic.LoadPointer(&cfg.decoderCache)
  176. cache := *(*map[reflect.Type]ValDecoder)(ptr)
  177. copied := map[reflect.Type]ValDecoder{}
  178. for k, v := range cache {
  179. copied[k] = v
  180. }
  181. copied[cacheKey] = decoder
  182. done = atomic.CompareAndSwapPointer(&cfg.decoderCache, ptr, unsafe.Pointer(&copied))
  183. }
  184. }
  185. func (cfg *frozenConfig) addEncoderToCache(cacheKey reflect.Type, encoder ValEncoder) {
  186. done := false
  187. for !done {
  188. ptr := atomic.LoadPointer(&cfg.encoderCache)
  189. cache := *(*map[reflect.Type]ValEncoder)(ptr)
  190. copied := map[reflect.Type]ValEncoder{}
  191. for k, v := range cache {
  192. copied[k] = v
  193. }
  194. copied[cacheKey] = encoder
  195. done = atomic.CompareAndSwapPointer(&cfg.encoderCache, ptr, unsafe.Pointer(&copied))
  196. }
  197. }
  198. func (cfg *frozenConfig) getDecoderFromCache(cacheKey reflect.Type) ValDecoder {
  199. ptr := atomic.LoadPointer(&cfg.decoderCache)
  200. cache := *(*map[reflect.Type]ValDecoder)(ptr)
  201. return cache[cacheKey]
  202. }
  203. func (cfg *frozenConfig) getEncoderFromCache(cacheKey reflect.Type) ValEncoder {
  204. ptr := atomic.LoadPointer(&cfg.encoderCache)
  205. cache := *(*map[reflect.Type]ValEncoder)(ptr)
  206. return cache[cacheKey]
  207. }
  208. func (cfg *frozenConfig) cleanDecoders() {
  209. typeDecoders = map[string]ValDecoder{}
  210. fieldDecoders = map[string]ValDecoder{}
  211. *cfg = *(cfg.configBeforeFrozen.Froze().(*frozenConfig))
  212. }
  213. func (cfg *frozenConfig) cleanEncoders() {
  214. typeEncoders = map[string]ValEncoder{}
  215. fieldEncoders = map[string]ValEncoder{}
  216. *cfg = *(cfg.configBeforeFrozen.Froze().(*frozenConfig))
  217. }
  218. func (cfg *frozenConfig) MarshalToString(v interface{}) (string, error) {
  219. stream := cfg.BorrowStream(nil)
  220. defer cfg.ReturnStream(stream)
  221. stream.WriteVal(v)
  222. if stream.Error != nil {
  223. return "", stream.Error
  224. }
  225. return string(stream.Buffer()), nil
  226. }
  227. func (cfg *frozenConfig) Marshal(v interface{}) ([]byte, error) {
  228. stream := cfg.BorrowStream(nil)
  229. defer cfg.ReturnStream(stream)
  230. stream.WriteVal(v)
  231. if stream.Error != nil {
  232. return nil, stream.Error
  233. }
  234. result := stream.Buffer()
  235. copied := make([]byte, len(result))
  236. copy(copied, result)
  237. return copied, nil
  238. }
  239. func (cfg *frozenConfig) MarshalIndent(v interface{}, prefix, indent string) ([]byte, error) {
  240. if prefix != "" {
  241. panic("prefix is not supported")
  242. }
  243. for _, r := range indent {
  244. if r != ' ' {
  245. panic("indent can only be space")
  246. }
  247. }
  248. newCfg := cfg.configBeforeFrozen
  249. newCfg.IndentionStep = len(indent)
  250. return newCfg.Froze().Marshal(v)
  251. }
  252. func (cfg *frozenConfig) UnmarshalFromString(str string, v interface{}) error {
  253. data := []byte(str)
  254. data = data[:lastNotSpacePos(data)]
  255. iter := cfg.BorrowIterator(data)
  256. defer cfg.ReturnIterator(iter)
  257. iter.ReadVal(v)
  258. if iter.head == iter.tail {
  259. iter.loadMore()
  260. }
  261. if iter.Error == io.EOF {
  262. return nil
  263. }
  264. if iter.Error == nil {
  265. iter.ReportError("UnmarshalFromString", "there are bytes left after unmarshal")
  266. }
  267. return iter.Error
  268. }
  269. func (cfg *frozenConfig) Get(data []byte, path ...interface{}) Any {
  270. iter := cfg.BorrowIterator(data)
  271. defer cfg.ReturnIterator(iter)
  272. return locatePath(iter, path)
  273. }
  274. func (cfg *frozenConfig) Unmarshal(data []byte, v interface{}) error {
  275. data = data[:lastNotSpacePos(data)]
  276. iter := cfg.BorrowIterator(data)
  277. defer cfg.ReturnIterator(iter)
  278. typ := reflect.TypeOf(v)
  279. if typ.Kind() != reflect.Ptr {
  280. // return non-pointer error
  281. return errors.New("the second param must be ptr type")
  282. }
  283. iter.ReadVal(v)
  284. if iter.head == iter.tail {
  285. iter.loadMore()
  286. }
  287. if iter.Error == io.EOF {
  288. return nil
  289. }
  290. if iter.Error == nil {
  291. iter.ReportError("Unmarshal", "there are bytes left after unmarshal")
  292. }
  293. return iter.Error
  294. }
  295. func (cfg *frozenConfig) NewEncoder(writer io.Writer) *Encoder {
  296. stream := NewStream(cfg, writer, 512)
  297. return &Encoder{stream}
  298. }
  299. func (cfg *frozenConfig) NewDecoder(reader io.Reader) *Decoder {
  300. iter := Parse(cfg, reader, 512)
  301. return &Decoder{iter}
  302. }
  303. func (cfg *frozenConfig) Valid(data []byte) bool {
  304. iter := cfg.BorrowIterator(data)
  305. defer cfg.ReturnIterator(iter)
  306. iter.Skip()
  307. return iter.Error == nil
  308. }