unmarshaler.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910
  1. package mapping
  2. import (
  3. "encoding"
  4. "encoding/json"
  5. "errors"
  6. "fmt"
  7. "reflect"
  8. "strings"
  9. "sync"
  10. "time"
  11. "github.com/zeromicro/go-zero/core/jsonx"
  12. "github.com/zeromicro/go-zero/core/lang"
  13. "github.com/zeromicro/go-zero/core/stringx"
  14. )
  15. const (
  16. defaultKeyName = "key"
  17. delimiter = '.'
  18. )
  19. var (
  20. errTypeMismatch = errors.New("type mismatch")
  21. errValueNotSettable = errors.New("value is not settable")
  22. errValueNotStruct = errors.New("value type is not struct")
  23. keyUnmarshaler = NewUnmarshaler(defaultKeyName)
  24. durationType = reflect.TypeOf(time.Duration(0))
  25. cacheKeys = make(map[string][]string)
  26. cacheKeysLock sync.Mutex
  27. defaultCache = make(map[string]interface{})
  28. defaultCacheLock sync.Mutex
  29. emptyMap = map[string]interface{}{}
  30. emptyValue = reflect.ValueOf(lang.Placeholder)
  31. )
  32. type (
  33. // Unmarshaler is used to unmarshal with given tag key.
  34. Unmarshaler struct {
  35. key string
  36. opts unmarshalOptions
  37. }
  38. // UnmarshalOption defines the method to customize an Unmarshaler.
  39. UnmarshalOption func(*unmarshalOptions)
  40. unmarshalOptions struct {
  41. fromString bool
  42. canonicalKey func(key string) string
  43. }
  44. )
  45. // NewUnmarshaler returns an Unmarshaler.
  46. func NewUnmarshaler(key string, opts ...UnmarshalOption) *Unmarshaler {
  47. unmarshaler := Unmarshaler{
  48. key: key,
  49. }
  50. for _, opt := range opts {
  51. opt(&unmarshaler.opts)
  52. }
  53. return &unmarshaler
  54. }
  55. // UnmarshalKey unmarshals m into v with tag key.
  56. func UnmarshalKey(m map[string]interface{}, v interface{}) error {
  57. return keyUnmarshaler.Unmarshal(m, v)
  58. }
  59. // Unmarshal unmarshals m into v.
  60. func (u *Unmarshaler) Unmarshal(m map[string]interface{}, v interface{}) error {
  61. return u.UnmarshalValuer(mapValuer(m), v)
  62. }
  63. // UnmarshalValuer unmarshals m into v.
  64. func (u *Unmarshaler) UnmarshalValuer(m Valuer, v interface{}) error {
  65. return u.unmarshalWithFullName(simpleValuer{current: m}, v, "")
  66. }
  67. func (u *Unmarshaler) unmarshalWithFullName(m valuerWithParent, v interface{}, fullName string) error {
  68. rv := reflect.ValueOf(v)
  69. if err := ValidatePtr(&rv); err != nil {
  70. return err
  71. }
  72. rte := reflect.TypeOf(v).Elem()
  73. if rte.Kind() != reflect.Struct {
  74. return errValueNotStruct
  75. }
  76. rve := rv.Elem()
  77. numFields := rte.NumField()
  78. for i := 0; i < numFields; i++ {
  79. field := rte.Field(i)
  80. if err := u.processField(field, rve.Field(i), m, fullName); err != nil {
  81. return err
  82. }
  83. }
  84. return nil
  85. }
  86. func (u *Unmarshaler) processAnonymousField(field reflect.StructField, value reflect.Value,
  87. m valuerWithParent, fullName string) error {
  88. key, options, err := u.parseOptionsWithContext(field, m, fullName)
  89. if err != nil {
  90. return err
  91. }
  92. if _, hasValue := getValue(m, key); hasValue {
  93. return fmt.Errorf("fields of %s can't be wrapped inside, because it's anonymous", key)
  94. }
  95. if options.optional() {
  96. return u.processAnonymousFieldOptional(field, value, key, m, fullName)
  97. }
  98. return u.processAnonymousFieldRequired(field, value, m, fullName)
  99. }
  100. func (u *Unmarshaler) processAnonymousFieldOptional(field reflect.StructField, value reflect.Value,
  101. key string, m valuerWithParent, fullName string) error {
  102. var filled bool
  103. var required int
  104. var requiredFilled int
  105. var indirectValue reflect.Value
  106. fieldType := Deref(field.Type)
  107. for i := 0; i < fieldType.NumField(); i++ {
  108. subField := fieldType.Field(i)
  109. fieldKey, fieldOpts, err := u.parseOptionsWithContext(subField, m, fullName)
  110. if err != nil {
  111. return err
  112. }
  113. _, hasValue := getValue(m, fieldKey)
  114. if hasValue {
  115. if !filled {
  116. filled = true
  117. maybeNewValue(field, value)
  118. indirectValue = reflect.Indirect(value)
  119. }
  120. if err = u.processField(subField, indirectValue.Field(i), m, fullName); err != nil {
  121. return err
  122. }
  123. }
  124. if !fieldOpts.optional() {
  125. required++
  126. if hasValue {
  127. requiredFilled++
  128. }
  129. }
  130. }
  131. if filled && required != requiredFilled {
  132. return fmt.Errorf("%s is not fully set", key)
  133. }
  134. return nil
  135. }
  136. func (u *Unmarshaler) processAnonymousFieldRequired(field reflect.StructField, value reflect.Value,
  137. m valuerWithParent, fullName string) error {
  138. maybeNewValue(field, value)
  139. fieldType := Deref(field.Type)
  140. indirectValue := reflect.Indirect(value)
  141. for i := 0; i < fieldType.NumField(); i++ {
  142. if err := u.processField(fieldType.Field(i), indirectValue.Field(i), m, fullName); err != nil {
  143. return err
  144. }
  145. }
  146. return nil
  147. }
  148. func (u *Unmarshaler) processField(field reflect.StructField, value reflect.Value,
  149. m valuerWithParent, fullName string) error {
  150. if usingDifferentKeys(u.key, field) {
  151. return nil
  152. }
  153. if field.Anonymous {
  154. return u.processAnonymousField(field, value, m, fullName)
  155. }
  156. return u.processNamedField(field, value, m, fullName)
  157. }
  158. func (u *Unmarshaler) processFieldNotFromString(field reflect.StructField, value reflect.Value,
  159. vp valueWithParent, opts *fieldOptionsWithContext, fullName string) error {
  160. fieldType := field.Type
  161. derefedFieldType := Deref(fieldType)
  162. typeKind := derefedFieldType.Kind()
  163. valueKind := reflect.TypeOf(vp.value).Kind()
  164. mapValue := vp.value
  165. switch {
  166. case valueKind == reflect.Map && typeKind == reflect.Struct:
  167. if mv, ok := mapValue.(map[string]interface{}); ok {
  168. return u.processFieldStruct(field, value, &simpleValuer{
  169. current: mapValuer(mv),
  170. parent: vp.parent,
  171. }, fullName)
  172. } else {
  173. return errTypeMismatch
  174. }
  175. case valueKind == reflect.Map && typeKind == reflect.Map:
  176. return u.fillMap(field, value, mapValue)
  177. case valueKind == reflect.String && typeKind == reflect.Map:
  178. return u.fillMapFromString(value, mapValue)
  179. case valueKind == reflect.String && typeKind == reflect.Slice:
  180. return u.fillSliceFromString(fieldType, value, mapValue)
  181. case valueKind == reflect.String && derefedFieldType == durationType:
  182. return fillDurationValue(fieldType.Kind(), value, mapValue.(string))
  183. default:
  184. return u.processFieldPrimitive(field, value, mapValue, opts, fullName)
  185. }
  186. }
  187. func (u *Unmarshaler) processFieldPrimitive(field reflect.StructField, value reflect.Value,
  188. mapValue interface{}, opts *fieldOptionsWithContext, fullName string) error {
  189. fieldType := field.Type
  190. typeKind := Deref(fieldType).Kind()
  191. valueKind := reflect.TypeOf(mapValue).Kind()
  192. switch {
  193. case typeKind == reflect.Slice && valueKind == reflect.Slice:
  194. return u.fillSlice(fieldType, value, mapValue)
  195. case typeKind == reflect.Map && valueKind == reflect.Map:
  196. return u.fillMap(field, value, mapValue)
  197. default:
  198. switch v := mapValue.(type) {
  199. case json.Number:
  200. return u.processFieldPrimitiveWithJSONNumber(field, value, v, opts, fullName)
  201. default:
  202. if typeKind == valueKind {
  203. if err := validateValueInOptions(mapValue, opts.options()); err != nil {
  204. return err
  205. }
  206. return fillWithSameType(field, value, mapValue, opts)
  207. }
  208. }
  209. }
  210. return newTypeMismatchError(fullName)
  211. }
  212. func (u *Unmarshaler) processFieldPrimitiveWithJSONNumber(field reflect.StructField, value reflect.Value,
  213. v json.Number, opts *fieldOptionsWithContext, fullName string) error {
  214. fieldType := field.Type
  215. fieldKind := fieldType.Kind()
  216. typeKind := Deref(fieldType).Kind()
  217. if err := validateJsonNumberRange(v, opts); err != nil {
  218. return err
  219. }
  220. if err := validateValueInOptions(v, opts.options()); err != nil {
  221. return err
  222. }
  223. if fieldKind == reflect.Ptr {
  224. value = value.Elem()
  225. }
  226. switch typeKind {
  227. case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
  228. iValue, err := v.Int64()
  229. if err != nil {
  230. return err
  231. }
  232. value.SetInt(iValue)
  233. case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
  234. iValue, err := v.Int64()
  235. if err != nil {
  236. return err
  237. }
  238. if iValue < 0 {
  239. return fmt.Errorf("unmarshal %q with bad value %q", fullName, v.String())
  240. }
  241. value.SetUint(uint64(iValue))
  242. case reflect.Float32, reflect.Float64:
  243. fValue, err := v.Float64()
  244. if err != nil {
  245. return err
  246. }
  247. value.SetFloat(fValue)
  248. default:
  249. return newTypeMismatchError(fullName)
  250. }
  251. return nil
  252. }
  253. func (u *Unmarshaler) processFieldStruct(field reflect.StructField, value reflect.Value,
  254. m valuerWithParent, fullName string) error {
  255. if field.Type.Kind() == reflect.Ptr {
  256. baseType := Deref(field.Type)
  257. target := reflect.New(baseType).Elem()
  258. if err := u.unmarshalWithFullName(m, target.Addr().Interface(), fullName); err != nil {
  259. return err
  260. }
  261. value.Set(target.Addr())
  262. } else if err := u.unmarshalWithFullName(m, value.Addr().Interface(), fullName); err != nil {
  263. return err
  264. }
  265. return nil
  266. }
  267. func (u *Unmarshaler) processFieldTextUnmarshaler(field reflect.StructField, value reflect.Value,
  268. mapValue interface{}) (bool, error) {
  269. var tval encoding.TextUnmarshaler
  270. var ok bool
  271. if field.Type.Kind() == reflect.Ptr {
  272. tval, ok = value.Interface().(encoding.TextUnmarshaler)
  273. } else {
  274. tval, ok = value.Addr().Interface().(encoding.TextUnmarshaler)
  275. }
  276. if ok {
  277. switch mv := mapValue.(type) {
  278. case string:
  279. return true, tval.UnmarshalText([]byte(mv))
  280. case []byte:
  281. return true, tval.UnmarshalText(mv)
  282. }
  283. }
  284. return false, nil
  285. }
  286. func (u *Unmarshaler) processNamedField(field reflect.StructField, value reflect.Value,
  287. m valuerWithParent, fullName string) error {
  288. key, opts, err := u.parseOptionsWithContext(field, m, fullName)
  289. if err != nil {
  290. return err
  291. }
  292. fullName = join(fullName, key)
  293. canonicalKey := key
  294. if u.opts.canonicalKey != nil {
  295. canonicalKey = u.opts.canonicalKey(key)
  296. }
  297. valuer := createValuer(m, opts)
  298. mapValue, hasValue := getValue(valuer, canonicalKey)
  299. if !hasValue {
  300. return u.processNamedFieldWithoutValue(field, value, opts, fullName)
  301. }
  302. return u.processNamedFieldWithValue(field, value, valueWithParent{
  303. value: mapValue,
  304. parent: valuer,
  305. }, key, opts, fullName)
  306. }
  307. func (u *Unmarshaler) processNamedFieldWithValue(field reflect.StructField, value reflect.Value,
  308. vp valueWithParent, key string, opts *fieldOptionsWithContext, fullName string) error {
  309. mapValue := vp.value
  310. if mapValue == nil {
  311. if opts.optional() {
  312. return nil
  313. }
  314. return fmt.Errorf("field %s mustn't be nil", key)
  315. }
  316. if !value.CanSet() {
  317. return fmt.Errorf("field %s is not settable", key)
  318. }
  319. maybeNewValue(field, value)
  320. if yes, err := u.processFieldTextUnmarshaler(field, value, mapValue); yes {
  321. return err
  322. }
  323. fieldKind := Deref(field.Type).Kind()
  324. switch fieldKind {
  325. case reflect.Array, reflect.Map, reflect.Slice, reflect.Struct:
  326. return u.processFieldNotFromString(field, value, vp, opts, fullName)
  327. default:
  328. if u.opts.fromString || opts.fromString() {
  329. valueKind := reflect.TypeOf(mapValue).Kind()
  330. if valueKind != reflect.String {
  331. return fmt.Errorf("error: the value in map is not string, but %s", valueKind)
  332. }
  333. options := opts.options()
  334. if len(options) > 0 {
  335. if !stringx.Contains(options, mapValue.(string)) {
  336. return fmt.Errorf(`error: value "%s" for field "%s" is not defined in options "%v"`,
  337. mapValue, key, options)
  338. }
  339. }
  340. return fillPrimitive(field.Type, value, mapValue, opts, fullName)
  341. }
  342. return u.processFieldNotFromString(field, value, vp, opts, fullName)
  343. }
  344. }
  345. func (u *Unmarshaler) processNamedFieldWithoutValue(field reflect.StructField, value reflect.Value,
  346. opts *fieldOptionsWithContext, fullName string) error {
  347. derefedType := Deref(field.Type)
  348. fieldKind := derefedType.Kind()
  349. if defaultValue, ok := opts.getDefault(); ok {
  350. if field.Type.Kind() == reflect.Ptr {
  351. maybeNewValue(field, value)
  352. value = value.Elem()
  353. }
  354. if derefedType == durationType {
  355. return fillDurationValue(fieldKind, value, defaultValue)
  356. }
  357. switch fieldKind {
  358. case reflect.Array, reflect.Slice:
  359. return u.fillSliceWithDefault(derefedType, value, defaultValue)
  360. default:
  361. return setValue(fieldKind, value, defaultValue)
  362. }
  363. }
  364. switch fieldKind {
  365. case reflect.Array, reflect.Map, reflect.Slice:
  366. if !opts.optional() {
  367. return u.processFieldNotFromString(field, value, valueWithParent{
  368. value: emptyMap,
  369. }, opts, fullName)
  370. }
  371. case reflect.Struct:
  372. if !opts.optional() {
  373. required, err := structValueRequired(u.key, derefedType)
  374. if err != nil {
  375. return err
  376. }
  377. if required {
  378. return fmt.Errorf("%q is not set", fullName)
  379. }
  380. return u.processFieldNotFromString(field, value, valueWithParent{
  381. value: emptyMap,
  382. }, opts, fullName)
  383. }
  384. default:
  385. if !opts.optional() {
  386. return newInitError(fullName)
  387. }
  388. }
  389. return nil
  390. }
  391. func (u *Unmarshaler) fillMap(field reflect.StructField, value reflect.Value, mapValue interface{}) error {
  392. if !value.CanSet() {
  393. return errValueNotSettable
  394. }
  395. fieldKeyType := field.Type.Key()
  396. fieldElemType := field.Type.Elem()
  397. targetValue, err := u.generateMap(fieldKeyType, fieldElemType, mapValue)
  398. if err != nil {
  399. return err
  400. }
  401. value.Set(targetValue)
  402. return nil
  403. }
  404. func (u *Unmarshaler) fillMapFromString(value reflect.Value, mapValue interface{}) error {
  405. if !value.CanSet() {
  406. return errValueNotSettable
  407. }
  408. switch v := mapValue.(type) {
  409. case fmt.Stringer:
  410. if err := jsonx.UnmarshalFromString(v.String(), value.Addr().Interface()); err != nil {
  411. return err
  412. }
  413. case string:
  414. if err := jsonx.UnmarshalFromString(v, value.Addr().Interface()); err != nil {
  415. return err
  416. }
  417. default:
  418. return errUnsupportedType
  419. }
  420. return nil
  421. }
  422. func (u *Unmarshaler) fillSlice(fieldType reflect.Type, value reflect.Value, mapValue interface{}) error {
  423. if !value.CanSet() {
  424. return errValueNotSettable
  425. }
  426. baseType := fieldType.Elem()
  427. baseKind := baseType.Kind()
  428. dereffedBaseType := Deref(baseType)
  429. dereffedBaseKind := dereffedBaseType.Kind()
  430. refValue := reflect.ValueOf(mapValue)
  431. if refValue.IsNil() {
  432. return nil
  433. }
  434. conv := reflect.MakeSlice(reflect.SliceOf(baseType), refValue.Len(), refValue.Cap())
  435. if refValue.Len() == 0 {
  436. value.Set(conv)
  437. return nil
  438. }
  439. var valid bool
  440. for i := 0; i < refValue.Len(); i++ {
  441. ithValue := refValue.Index(i).Interface()
  442. if ithValue == nil {
  443. continue
  444. }
  445. valid = true
  446. switch dereffedBaseKind {
  447. case reflect.Struct:
  448. target := reflect.New(dereffedBaseType)
  449. if err := u.Unmarshal(ithValue.(map[string]interface{}), target.Interface()); err != nil {
  450. return err
  451. }
  452. if baseKind == reflect.Ptr {
  453. conv.Index(i).Set(target)
  454. } else {
  455. conv.Index(i).Set(target.Elem())
  456. }
  457. case reflect.Slice:
  458. if err := u.fillSlice(dereffedBaseType, conv.Index(i), ithValue); err != nil {
  459. return err
  460. }
  461. default:
  462. if err := u.fillSliceValue(conv, i, dereffedBaseKind, ithValue); err != nil {
  463. return err
  464. }
  465. }
  466. }
  467. if valid {
  468. value.Set(conv)
  469. }
  470. return nil
  471. }
  472. func (u *Unmarshaler) fillSliceFromString(fieldType reflect.Type, value reflect.Value,
  473. mapValue interface{}) error {
  474. var slice []interface{}
  475. switch v := mapValue.(type) {
  476. case fmt.Stringer:
  477. if err := jsonx.UnmarshalFromString(v.String(), &slice); err != nil {
  478. return err
  479. }
  480. case string:
  481. if err := jsonx.UnmarshalFromString(v, &slice); err != nil {
  482. return err
  483. }
  484. default:
  485. return errUnsupportedType
  486. }
  487. baseFieldType := Deref(fieldType.Elem())
  488. baseFieldKind := baseFieldType.Kind()
  489. conv := reflect.MakeSlice(reflect.SliceOf(baseFieldType), len(slice), cap(slice))
  490. for i := 0; i < len(slice); i++ {
  491. if err := u.fillSliceValue(conv, i, baseFieldKind, slice[i]); err != nil {
  492. return err
  493. }
  494. }
  495. value.Set(conv)
  496. return nil
  497. }
  498. func (u *Unmarshaler) fillSliceValue(slice reflect.Value, index int,
  499. baseKind reflect.Kind, value interface{}) error {
  500. ithVal := slice.Index(index)
  501. switch v := value.(type) {
  502. case fmt.Stringer:
  503. return setValue(baseKind, ithVal, v.String())
  504. case string:
  505. return setValue(baseKind, ithVal, v)
  506. default:
  507. // don't need to consider the difference between int, int8, int16, int32, int64,
  508. // uint, uint8, uint16, uint32, uint64, because they're handled as json.Number.
  509. if ithVal.Kind() == reflect.Ptr {
  510. baseType := Deref(ithVal.Type())
  511. if baseType.Kind() != reflect.TypeOf(value).Kind() {
  512. return errTypeMismatch
  513. }
  514. target := reflect.New(baseType).Elem()
  515. target.Set(reflect.ValueOf(value))
  516. ithVal.Set(target.Addr())
  517. return nil
  518. }
  519. if ithVal.Kind() != reflect.TypeOf(value).Kind() {
  520. return errTypeMismatch
  521. }
  522. ithVal.Set(reflect.ValueOf(value))
  523. return nil
  524. }
  525. }
  526. func (u *Unmarshaler) fillSliceWithDefault(derefedType reflect.Type, value reflect.Value,
  527. defaultValue string) error {
  528. baseFieldType := Deref(derefedType.Elem())
  529. baseFieldKind := baseFieldType.Kind()
  530. defaultCacheLock.Lock()
  531. slice, ok := defaultCache[defaultValue]
  532. defaultCacheLock.Unlock()
  533. if !ok {
  534. if baseFieldKind == reflect.String {
  535. slice = parseGroupedSegments(defaultValue)
  536. } else if err := jsonx.UnmarshalFromString(defaultValue, &slice); err != nil {
  537. return err
  538. }
  539. defaultCacheLock.Lock()
  540. defaultCache[defaultValue] = slice
  541. defaultCacheLock.Unlock()
  542. }
  543. return u.fillSlice(derefedType, value, slice)
  544. }
  545. func (u *Unmarshaler) generateMap(keyType, elemType reflect.Type, mapValue interface{}) (reflect.Value, error) {
  546. mapType := reflect.MapOf(keyType, elemType)
  547. valueType := reflect.TypeOf(mapValue)
  548. if mapType == valueType {
  549. return reflect.ValueOf(mapValue), nil
  550. }
  551. refValue := reflect.ValueOf(mapValue)
  552. targetValue := reflect.MakeMapWithSize(mapType, refValue.Len())
  553. fieldElemKind := elemType.Kind()
  554. dereffedElemType := Deref(elemType)
  555. dereffedElemKind := dereffedElemType.Kind()
  556. for _, key := range refValue.MapKeys() {
  557. keythValue := refValue.MapIndex(key)
  558. keythData := keythValue.Interface()
  559. switch dereffedElemKind {
  560. case reflect.Slice:
  561. target := reflect.New(dereffedElemType)
  562. if err := u.fillSlice(elemType, target.Elem(), keythData); err != nil {
  563. return emptyValue, err
  564. }
  565. targetValue.SetMapIndex(key, target.Elem())
  566. case reflect.Struct:
  567. keythMap, ok := keythData.(map[string]interface{})
  568. if !ok {
  569. return emptyValue, errTypeMismatch
  570. }
  571. target := reflect.New(dereffedElemType)
  572. if err := u.Unmarshal(keythMap, target.Interface()); err != nil {
  573. return emptyValue, err
  574. }
  575. if fieldElemKind == reflect.Ptr {
  576. targetValue.SetMapIndex(key, target)
  577. } else {
  578. targetValue.SetMapIndex(key, target.Elem())
  579. }
  580. case reflect.Map:
  581. keythMap, ok := keythData.(map[string]interface{})
  582. if !ok {
  583. return emptyValue, errTypeMismatch
  584. }
  585. innerValue, err := u.generateMap(elemType.Key(), elemType.Elem(), keythMap)
  586. if err != nil {
  587. return emptyValue, err
  588. }
  589. targetValue.SetMapIndex(key, innerValue)
  590. default:
  591. switch v := keythData.(type) {
  592. case bool:
  593. targetValue.SetMapIndex(key, reflect.ValueOf(v))
  594. case string:
  595. targetValue.SetMapIndex(key, reflect.ValueOf(v))
  596. case json.Number:
  597. target := reflect.New(dereffedElemType)
  598. if err := setValue(dereffedElemKind, target.Elem(), v.String()); err != nil {
  599. return emptyValue, err
  600. }
  601. targetValue.SetMapIndex(key, target.Elem())
  602. default:
  603. targetValue.SetMapIndex(key, keythValue)
  604. }
  605. }
  606. }
  607. return targetValue, nil
  608. }
  609. func (u *Unmarshaler) parseOptionsWithContext(field reflect.StructField, m Valuer, fullName string) (
  610. string, *fieldOptionsWithContext, error) {
  611. key, options, err := parseKeyAndOptions(u.key, field)
  612. if err != nil {
  613. return "", nil, err
  614. } else if options == nil {
  615. return key, nil, nil
  616. }
  617. optsWithContext, err := options.toOptionsWithContext(key, m, fullName)
  618. if err != nil {
  619. return "", nil, err
  620. }
  621. return key, optsWithContext, nil
  622. }
  623. // WithStringValues customizes an Unmarshaler with number values from strings.
  624. func WithStringValues() UnmarshalOption {
  625. return func(opt *unmarshalOptions) {
  626. opt.fromString = true
  627. }
  628. }
  629. // WithCanonicalKeyFunc customizes an Unmarshaler with Canonical Key func
  630. func WithCanonicalKeyFunc(f func(string) string) UnmarshalOption {
  631. return func(opt *unmarshalOptions) {
  632. opt.canonicalKey = f
  633. }
  634. }
  635. func createValuer(v valuerWithParent, opts *fieldOptionsWithContext) valuerWithParent {
  636. if opts.inherit() {
  637. return recursiveValuer{
  638. current: v,
  639. parent: v.Parent(),
  640. }
  641. }
  642. return simpleValuer{
  643. current: v,
  644. parent: v.Parent(),
  645. }
  646. }
  647. func fillDurationValue(fieldKind reflect.Kind, value reflect.Value, dur string) error {
  648. d, err := time.ParseDuration(dur)
  649. if err != nil {
  650. return err
  651. }
  652. if fieldKind == reflect.Ptr {
  653. value.Elem().Set(reflect.ValueOf(d))
  654. } else {
  655. value.Set(reflect.ValueOf(d))
  656. }
  657. return nil
  658. }
  659. func fillPrimitive(fieldType reflect.Type, value reflect.Value, mapValue interface{},
  660. opts *fieldOptionsWithContext, fullName string) error {
  661. if !value.CanSet() {
  662. return errValueNotSettable
  663. }
  664. baseType := Deref(fieldType)
  665. if fieldType.Kind() == reflect.Ptr {
  666. target := reflect.New(baseType).Elem()
  667. switch mapValue.(type) {
  668. case string, json.Number:
  669. value.Set(target.Addr())
  670. value = target
  671. }
  672. }
  673. switch v := mapValue.(type) {
  674. case string:
  675. return validateAndSetValue(baseType.Kind(), value, v, opts)
  676. case json.Number:
  677. if err := validateJsonNumberRange(v, opts); err != nil {
  678. return err
  679. }
  680. return setValue(baseType.Kind(), value, v.String())
  681. default:
  682. return newTypeMismatchError(fullName)
  683. }
  684. }
  685. func fillWithSameType(field reflect.StructField, value reflect.Value, mapValue interface{},
  686. opts *fieldOptionsWithContext) error {
  687. if !value.CanSet() {
  688. return errValueNotSettable
  689. }
  690. if err := validateValueRange(mapValue, opts); err != nil {
  691. return err
  692. }
  693. if field.Type.Kind() == reflect.Ptr {
  694. baseType := Deref(field.Type)
  695. target := reflect.New(baseType).Elem()
  696. setSameKindValue(baseType, target, mapValue)
  697. value.Set(target.Addr())
  698. } else {
  699. setSameKindValue(field.Type, value, mapValue)
  700. }
  701. return nil
  702. }
  703. // getValue gets the value for the specific key, the key can be in the format of parentKey.childKey
  704. func getValue(m valuerWithParent, key string) (interface{}, bool) {
  705. keys := readKeys(key)
  706. return getValueWithChainedKeys(m, keys)
  707. }
  708. func getValueWithChainedKeys(m valuerWithParent, keys []string) (interface{}, bool) {
  709. switch len(keys) {
  710. case 0:
  711. return nil, false
  712. case 1:
  713. v, ok := m.Value(keys[0])
  714. return v, ok
  715. default:
  716. if v, ok := m.Value(keys[0]); ok {
  717. if nextm, ok := v.(map[string]interface{}); ok {
  718. return getValueWithChainedKeys(recursiveValuer{
  719. current: mapValuer(nextm),
  720. parent: m,
  721. }, keys[1:])
  722. }
  723. }
  724. return nil, false
  725. }
  726. }
  727. func join(elem ...string) string {
  728. var builder strings.Builder
  729. var fillSep bool
  730. for _, e := range elem {
  731. if len(e) == 0 {
  732. continue
  733. }
  734. if fillSep {
  735. builder.WriteByte(delimiter)
  736. } else {
  737. fillSep = true
  738. }
  739. builder.WriteString(e)
  740. }
  741. return builder.String()
  742. }
  743. func newInitError(name string) error {
  744. return fmt.Errorf("field %s is not set", name)
  745. }
  746. func newTypeMismatchError(name string) error {
  747. return fmt.Errorf("error: type mismatch for field %s", name)
  748. }
  749. func readKeys(key string) []string {
  750. cacheKeysLock.Lock()
  751. keys, ok := cacheKeys[key]
  752. cacheKeysLock.Unlock()
  753. if ok {
  754. return keys
  755. }
  756. keys = strings.FieldsFunc(key, func(c rune) bool {
  757. return c == delimiter
  758. })
  759. cacheKeysLock.Lock()
  760. cacheKeys[key] = keys
  761. cacheKeysLock.Unlock()
  762. return keys
  763. }
  764. func setSameKindValue(targetType reflect.Type, target reflect.Value, value interface{}) {
  765. if reflect.ValueOf(value).Type().AssignableTo(targetType) {
  766. target.Set(reflect.ValueOf(value))
  767. } else {
  768. target.Set(reflect.ValueOf(value).Convert(targetType))
  769. }
  770. }