unmarshaler.go 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883
  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 a Unmarshaler.
  39. UnmarshalOption func(*unmarshalOptions)
  40. unmarshalOptions struct {
  41. fromString bool
  42. canonicalKey func(key string) string
  43. }
  44. )
  45. // NewUnmarshaler returns a 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(m, v, "")
  66. }
  67. func (u *Unmarshaler) unmarshalWithFullName(m Valuer, 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 Valuer, 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 Valuer, 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 Valuer, 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, m Valuer,
  149. 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. mapValue interface{}, opts *fieldOptionsWithContext, fullName string) error {
  160. fieldType := field.Type
  161. derefedFieldType := Deref(fieldType)
  162. typeKind := derefedFieldType.Kind()
  163. valueKind := reflect.TypeOf(mapValue).Kind()
  164. switch {
  165. case valueKind == reflect.Map && typeKind == reflect.Struct:
  166. return u.processFieldStruct(field, value, mapValue, fullName)
  167. case valueKind == reflect.Map && typeKind == reflect.Map:
  168. return u.fillMap(field, value, mapValue)
  169. case valueKind == reflect.String && typeKind == reflect.Map:
  170. return u.fillMapFromString(value, mapValue)
  171. case valueKind == reflect.String && typeKind == reflect.Slice:
  172. return u.fillSliceFromString(fieldType, value, mapValue)
  173. case valueKind == reflect.String && derefedFieldType == durationType:
  174. return fillDurationValue(fieldType.Kind(), value, mapValue.(string))
  175. default:
  176. return u.processFieldPrimitive(field, value, mapValue, opts, fullName)
  177. }
  178. }
  179. func (u *Unmarshaler) processFieldPrimitive(field reflect.StructField, value reflect.Value,
  180. mapValue interface{}, opts *fieldOptionsWithContext, fullName string) error {
  181. fieldType := field.Type
  182. typeKind := Deref(fieldType).Kind()
  183. valueKind := reflect.TypeOf(mapValue).Kind()
  184. switch {
  185. case typeKind == reflect.Slice && valueKind == reflect.Slice:
  186. return u.fillSlice(fieldType, value, mapValue)
  187. case typeKind == reflect.Map && valueKind == reflect.Map:
  188. return u.fillMap(field, value, mapValue)
  189. default:
  190. switch v := mapValue.(type) {
  191. case json.Number:
  192. return u.processFieldPrimitiveWithJSONNumber(field, value, v, opts, fullName)
  193. default:
  194. if typeKind == valueKind {
  195. if err := validateValueInOptions(mapValue, opts.options()); err != nil {
  196. return err
  197. }
  198. return fillWithSameType(field, value, mapValue, opts)
  199. }
  200. }
  201. }
  202. return newTypeMismatchError(fullName)
  203. }
  204. func (u *Unmarshaler) processFieldPrimitiveWithJSONNumber(field reflect.StructField, value reflect.Value,
  205. v json.Number, opts *fieldOptionsWithContext, fullName string) error {
  206. fieldType := field.Type
  207. fieldKind := fieldType.Kind()
  208. typeKind := Deref(fieldType).Kind()
  209. if err := validateJsonNumberRange(v, opts); err != nil {
  210. return err
  211. }
  212. if err := validateValueInOptions(v, opts.options()); err != nil {
  213. return err
  214. }
  215. if fieldKind == reflect.Ptr {
  216. value = value.Elem()
  217. }
  218. switch typeKind {
  219. case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
  220. iValue, err := v.Int64()
  221. if err != nil {
  222. return err
  223. }
  224. value.SetInt(iValue)
  225. case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
  226. iValue, err := v.Int64()
  227. if err != nil {
  228. return err
  229. }
  230. if iValue < 0 {
  231. return fmt.Errorf("unmarshal %q with bad value %q", fullName, v.String())
  232. }
  233. value.SetUint(uint64(iValue))
  234. case reflect.Float32, reflect.Float64:
  235. fValue, err := v.Float64()
  236. if err != nil {
  237. return err
  238. }
  239. value.SetFloat(fValue)
  240. default:
  241. return newTypeMismatchError(fullName)
  242. }
  243. return nil
  244. }
  245. func (u *Unmarshaler) processFieldStruct(field reflect.StructField, value reflect.Value,
  246. mapValue interface{}, fullName string) error {
  247. convertedValue, ok := mapValue.(map[string]interface{})
  248. if !ok {
  249. valueKind := reflect.TypeOf(mapValue).Kind()
  250. return fmt.Errorf("error: field: %s, expect map[string]interface{}, actual %v", fullName, valueKind)
  251. }
  252. return u.processFieldStructWithMap(field, value, MapValuer(convertedValue), fullName)
  253. }
  254. func (u *Unmarshaler) processFieldStructWithMap(field reflect.StructField, value reflect.Value,
  255. m Valuer, fullName string) error {
  256. if field.Type.Kind() == reflect.Ptr {
  257. baseType := Deref(field.Type)
  258. target := reflect.New(baseType).Elem()
  259. if err := u.unmarshalWithFullName(m, target.Addr().Interface(), fullName); err != nil {
  260. return err
  261. }
  262. value.Set(target.Addr())
  263. } else if err := u.unmarshalWithFullName(m, value.Addr().Interface(), fullName); err != nil {
  264. return err
  265. }
  266. return nil
  267. }
  268. func (u *Unmarshaler) processFieldTextUnmarshaler(field reflect.StructField, value reflect.Value,
  269. mapValue interface{}) (bool, error) {
  270. var tval encoding.TextUnmarshaler
  271. var ok bool
  272. if field.Type.Kind() == reflect.Ptr {
  273. tval, ok = value.Interface().(encoding.TextUnmarshaler)
  274. } else {
  275. tval, ok = value.Addr().Interface().(encoding.TextUnmarshaler)
  276. }
  277. if ok {
  278. switch mv := mapValue.(type) {
  279. case string:
  280. return true, tval.UnmarshalText([]byte(mv))
  281. case []byte:
  282. return true, tval.UnmarshalText(mv)
  283. }
  284. }
  285. return false, nil
  286. }
  287. func (u *Unmarshaler) processNamedField(field reflect.StructField, value reflect.Value,
  288. m Valuer, fullName string) error {
  289. key, opts, err := u.parseOptionsWithContext(field, m, fullName)
  290. if err != nil {
  291. return err
  292. }
  293. fullName = join(fullName, key)
  294. canonicalKey := key
  295. if u.opts.canonicalKey != nil {
  296. canonicalKey = u.opts.canonicalKey(key)
  297. }
  298. mapValue, hasValue := getValue(m, canonicalKey)
  299. if hasValue {
  300. return u.processNamedFieldWithValue(field, value, mapValue, key, opts, fullName)
  301. }
  302. return u.processNamedFieldWithoutValue(field, value, opts, fullName)
  303. }
  304. func (u *Unmarshaler) processNamedFieldWithValue(field reflect.StructField, value reflect.Value,
  305. mapValue interface{}, key string, opts *fieldOptionsWithContext, fullName string) error {
  306. if mapValue == nil {
  307. if opts.optional() {
  308. return nil
  309. }
  310. return fmt.Errorf("field %s mustn't be nil", key)
  311. }
  312. if !value.CanSet() {
  313. return fmt.Errorf("field %s is not settable", key)
  314. }
  315. maybeNewValue(field, value)
  316. if yes, err := u.processFieldTextUnmarshaler(field, value, mapValue); yes {
  317. return err
  318. }
  319. fieldKind := Deref(field.Type).Kind()
  320. switch fieldKind {
  321. case reflect.Array, reflect.Map, reflect.Slice, reflect.Struct:
  322. return u.processFieldNotFromString(field, value, mapValue, opts, fullName)
  323. default:
  324. if u.opts.fromString || opts.fromString() {
  325. valueKind := reflect.TypeOf(mapValue).Kind()
  326. if valueKind != reflect.String {
  327. return fmt.Errorf("error: the value in map is not string, but %s", valueKind)
  328. }
  329. options := opts.options()
  330. if len(options) > 0 {
  331. if !stringx.Contains(options, mapValue.(string)) {
  332. return fmt.Errorf(`error: value "%s" for field "%s" is not defined in options "%v"`,
  333. mapValue, key, options)
  334. }
  335. }
  336. return fillPrimitive(field.Type, value, mapValue, opts, fullName)
  337. }
  338. return u.processFieldNotFromString(field, value, mapValue, opts, fullName)
  339. }
  340. }
  341. func (u *Unmarshaler) processNamedFieldWithoutValue(field reflect.StructField, value reflect.Value,
  342. opts *fieldOptionsWithContext, fullName string) error {
  343. derefedType := Deref(field.Type)
  344. fieldKind := derefedType.Kind()
  345. if defaultValue, ok := opts.getDefault(); ok {
  346. if field.Type.Kind() == reflect.Ptr {
  347. maybeNewValue(field, value)
  348. value = value.Elem()
  349. }
  350. if derefedType == durationType {
  351. return fillDurationValue(fieldKind, value, defaultValue)
  352. }
  353. switch fieldKind {
  354. case reflect.Array, reflect.Slice:
  355. return u.fillSliceWithDefault(derefedType, value, defaultValue)
  356. default:
  357. return setValue(fieldKind, value, defaultValue)
  358. }
  359. }
  360. switch fieldKind {
  361. case reflect.Array, reflect.Map, reflect.Slice:
  362. if !opts.optional() {
  363. return u.processFieldNotFromString(field, value, emptyMap, opts, fullName)
  364. }
  365. case reflect.Struct:
  366. if !opts.optional() {
  367. required, err := structValueRequired(u.key, derefedType)
  368. if err != nil {
  369. return err
  370. }
  371. if required {
  372. return fmt.Errorf("%q is not set", fullName)
  373. }
  374. return u.processFieldNotFromString(field, value, emptyMap, opts, fullName)
  375. }
  376. default:
  377. if !opts.optional() {
  378. return newInitError(fullName)
  379. }
  380. }
  381. return nil
  382. }
  383. func (u *Unmarshaler) fillMap(field reflect.StructField, value reflect.Value, mapValue interface{}) error {
  384. if !value.CanSet() {
  385. return errValueNotSettable
  386. }
  387. fieldKeyType := field.Type.Key()
  388. fieldElemType := field.Type.Elem()
  389. targetValue, err := u.generateMap(fieldKeyType, fieldElemType, mapValue)
  390. if err != nil {
  391. return err
  392. }
  393. value.Set(targetValue)
  394. return nil
  395. }
  396. func (u *Unmarshaler) fillMapFromString(value reflect.Value, mapValue interface{}) error {
  397. if !value.CanSet() {
  398. return errValueNotSettable
  399. }
  400. switch v := mapValue.(type) {
  401. case fmt.Stringer:
  402. if err := jsonx.UnmarshalFromString(v.String(), value.Addr().Interface()); err != nil {
  403. return err
  404. }
  405. case string:
  406. if err := jsonx.UnmarshalFromString(v, value.Addr().Interface()); err != nil {
  407. return err
  408. }
  409. default:
  410. return errUnsupportedType
  411. }
  412. return nil
  413. }
  414. func (u *Unmarshaler) fillSlice(fieldType reflect.Type, value reflect.Value, mapValue interface{}) error {
  415. if !value.CanSet() {
  416. return errValueNotSettable
  417. }
  418. baseType := fieldType.Elem()
  419. baseKind := baseType.Kind()
  420. dereffedBaseType := Deref(baseType)
  421. dereffedBaseKind := dereffedBaseType.Kind()
  422. refValue := reflect.ValueOf(mapValue)
  423. if refValue.IsNil() {
  424. return nil
  425. }
  426. conv := reflect.MakeSlice(reflect.SliceOf(baseType), refValue.Len(), refValue.Cap())
  427. if refValue.Len() == 0 {
  428. value.Set(conv)
  429. return nil
  430. }
  431. var valid bool
  432. for i := 0; i < refValue.Len(); i++ {
  433. ithValue := refValue.Index(i).Interface()
  434. if ithValue == nil {
  435. continue
  436. }
  437. valid = true
  438. switch dereffedBaseKind {
  439. case reflect.Struct:
  440. target := reflect.New(dereffedBaseType)
  441. if err := u.Unmarshal(ithValue.(map[string]interface{}), target.Interface()); err != nil {
  442. return err
  443. }
  444. if baseKind == reflect.Ptr {
  445. conv.Index(i).Set(target)
  446. } else {
  447. conv.Index(i).Set(target.Elem())
  448. }
  449. case reflect.Slice:
  450. if err := u.fillSlice(dereffedBaseType, conv.Index(i), ithValue); err != nil {
  451. return err
  452. }
  453. default:
  454. if err := u.fillSliceValue(conv, i, dereffedBaseKind, ithValue); err != nil {
  455. return err
  456. }
  457. }
  458. }
  459. if valid {
  460. value.Set(conv)
  461. }
  462. return nil
  463. }
  464. func (u *Unmarshaler) fillSliceFromString(fieldType reflect.Type, value reflect.Value,
  465. mapValue interface{}) error {
  466. var slice []interface{}
  467. switch v := mapValue.(type) {
  468. case fmt.Stringer:
  469. if err := jsonx.UnmarshalFromString(v.String(), &slice); err != nil {
  470. return err
  471. }
  472. case string:
  473. if err := jsonx.UnmarshalFromString(v, &slice); err != nil {
  474. return err
  475. }
  476. default:
  477. return errUnsupportedType
  478. }
  479. baseFieldType := Deref(fieldType.Elem())
  480. baseFieldKind := baseFieldType.Kind()
  481. conv := reflect.MakeSlice(reflect.SliceOf(baseFieldType), len(slice), cap(slice))
  482. for i := 0; i < len(slice); i++ {
  483. if err := u.fillSliceValue(conv, i, baseFieldKind, slice[i]); err != nil {
  484. return err
  485. }
  486. }
  487. value.Set(conv)
  488. return nil
  489. }
  490. func (u *Unmarshaler) fillSliceValue(slice reflect.Value, index int,
  491. baseKind reflect.Kind, value interface{}) error {
  492. ithVal := slice.Index(index)
  493. switch v := value.(type) {
  494. case fmt.Stringer:
  495. return setValue(baseKind, ithVal, v.String())
  496. case string:
  497. return setValue(baseKind, ithVal, v)
  498. default:
  499. // don't need to consider the difference between int, int8, int16, int32, int64,
  500. // uint, uint8, uint16, uint32, uint64, because they're handled as json.Number.
  501. if ithVal.Kind() == reflect.Ptr {
  502. baseType := Deref(ithVal.Type())
  503. if baseType.Kind() != reflect.TypeOf(value).Kind() {
  504. return errTypeMismatch
  505. }
  506. target := reflect.New(baseType).Elem()
  507. target.Set(reflect.ValueOf(value))
  508. ithVal.Set(target.Addr())
  509. return nil
  510. }
  511. if ithVal.Kind() != reflect.TypeOf(value).Kind() {
  512. return errTypeMismatch
  513. }
  514. ithVal.Set(reflect.ValueOf(value))
  515. return nil
  516. }
  517. }
  518. func (u *Unmarshaler) fillSliceWithDefault(derefedType reflect.Type, value reflect.Value,
  519. defaultValue string) error {
  520. baseFieldType := Deref(derefedType.Elem())
  521. baseFieldKind := baseFieldType.Kind()
  522. defaultCacheLock.Lock()
  523. slice, ok := defaultCache[defaultValue]
  524. defaultCacheLock.Unlock()
  525. if !ok {
  526. if baseFieldKind == reflect.String {
  527. slice = parseGroupedSegments(defaultValue)
  528. } else if err := jsonx.UnmarshalFromString(defaultValue, &slice); err != nil {
  529. return err
  530. }
  531. defaultCacheLock.Lock()
  532. defaultCache[defaultValue] = slice
  533. defaultCacheLock.Unlock()
  534. }
  535. return u.fillSlice(derefedType, value, slice)
  536. }
  537. func (u *Unmarshaler) generateMap(keyType, elemType reflect.Type, mapValue interface{}) (reflect.Value, error) {
  538. mapType := reflect.MapOf(keyType, elemType)
  539. valueType := reflect.TypeOf(mapValue)
  540. if mapType == valueType {
  541. return reflect.ValueOf(mapValue), nil
  542. }
  543. refValue := reflect.ValueOf(mapValue)
  544. targetValue := reflect.MakeMapWithSize(mapType, refValue.Len())
  545. fieldElemKind := elemType.Kind()
  546. dereffedElemType := Deref(elemType)
  547. dereffedElemKind := dereffedElemType.Kind()
  548. for _, key := range refValue.MapKeys() {
  549. keythValue := refValue.MapIndex(key)
  550. keythData := keythValue.Interface()
  551. switch dereffedElemKind {
  552. case reflect.Slice:
  553. target := reflect.New(dereffedElemType)
  554. if err := u.fillSlice(elemType, target.Elem(), keythData); err != nil {
  555. return emptyValue, err
  556. }
  557. targetValue.SetMapIndex(key, target.Elem())
  558. case reflect.Struct:
  559. keythMap, ok := keythData.(map[string]interface{})
  560. if !ok {
  561. return emptyValue, errTypeMismatch
  562. }
  563. target := reflect.New(dereffedElemType)
  564. if err := u.Unmarshal(keythMap, target.Interface()); err != nil {
  565. return emptyValue, err
  566. }
  567. if fieldElemKind == reflect.Ptr {
  568. targetValue.SetMapIndex(key, target)
  569. } else {
  570. targetValue.SetMapIndex(key, target.Elem())
  571. }
  572. case reflect.Map:
  573. keythMap, ok := keythData.(map[string]interface{})
  574. if !ok {
  575. return emptyValue, errTypeMismatch
  576. }
  577. innerValue, err := u.generateMap(elemType.Key(), elemType.Elem(), keythMap)
  578. if err != nil {
  579. return emptyValue, err
  580. }
  581. targetValue.SetMapIndex(key, innerValue)
  582. default:
  583. switch v := keythData.(type) {
  584. case bool:
  585. targetValue.SetMapIndex(key, reflect.ValueOf(v))
  586. case string:
  587. targetValue.SetMapIndex(key, reflect.ValueOf(v))
  588. case json.Number:
  589. target := reflect.New(dereffedElemType)
  590. if err := setValue(dereffedElemKind, target.Elem(), v.String()); err != nil {
  591. return emptyValue, err
  592. }
  593. targetValue.SetMapIndex(key, target.Elem())
  594. default:
  595. targetValue.SetMapIndex(key, keythValue)
  596. }
  597. }
  598. }
  599. return targetValue, nil
  600. }
  601. func (u *Unmarshaler) parseOptionsWithContext(field reflect.StructField, m Valuer, fullName string) (
  602. string, *fieldOptionsWithContext, error) {
  603. key, options, err := parseKeyAndOptions(u.key, field)
  604. if err != nil {
  605. return "", nil, err
  606. } else if options == nil {
  607. return key, nil, nil
  608. }
  609. optsWithContext, err := options.toOptionsWithContext(key, m, fullName)
  610. if err != nil {
  611. return "", nil, err
  612. }
  613. return key, optsWithContext, nil
  614. }
  615. // WithStringValues customizes a Unmarshaler with number values from strings.
  616. func WithStringValues() UnmarshalOption {
  617. return func(opt *unmarshalOptions) {
  618. opt.fromString = true
  619. }
  620. }
  621. // WithCanonicalKeyFunc customizes a Unmarshaler with Canonical Key func
  622. func WithCanonicalKeyFunc(f func(string) string) UnmarshalOption {
  623. return func(opt *unmarshalOptions) {
  624. opt.canonicalKey = f
  625. }
  626. }
  627. func fillDurationValue(fieldKind reflect.Kind, value reflect.Value, dur string) error {
  628. d, err := time.ParseDuration(dur)
  629. if err != nil {
  630. return err
  631. }
  632. if fieldKind == reflect.Ptr {
  633. value.Elem().Set(reflect.ValueOf(d))
  634. } else {
  635. value.Set(reflect.ValueOf(d))
  636. }
  637. return nil
  638. }
  639. func fillPrimitive(fieldType reflect.Type, value reflect.Value, mapValue interface{},
  640. opts *fieldOptionsWithContext, fullName string) error {
  641. if !value.CanSet() {
  642. return errValueNotSettable
  643. }
  644. baseType := Deref(fieldType)
  645. if fieldType.Kind() == reflect.Ptr {
  646. target := reflect.New(baseType).Elem()
  647. switch mapValue.(type) {
  648. case string, json.Number:
  649. value.Set(target.Addr())
  650. value = target
  651. }
  652. }
  653. switch v := mapValue.(type) {
  654. case string:
  655. return validateAndSetValue(baseType.Kind(), value, v, opts)
  656. case json.Number:
  657. if err := validateJsonNumberRange(v, opts); err != nil {
  658. return err
  659. }
  660. return setValue(baseType.Kind(), value, v.String())
  661. default:
  662. return newTypeMismatchError(fullName)
  663. }
  664. }
  665. func fillWithSameType(field reflect.StructField, value reflect.Value, mapValue interface{},
  666. opts *fieldOptionsWithContext) error {
  667. if !value.CanSet() {
  668. return errValueNotSettable
  669. }
  670. if err := validateValueRange(mapValue, opts); err != nil {
  671. return err
  672. }
  673. if field.Type.Kind() == reflect.Ptr {
  674. baseType := Deref(field.Type)
  675. target := reflect.New(baseType).Elem()
  676. setSameKindValue(baseType, target, mapValue)
  677. value.Set(target.Addr())
  678. } else {
  679. setSameKindValue(field.Type, value, mapValue)
  680. }
  681. return nil
  682. }
  683. // getValue gets the value for the specific key, the key can be in the format of parentKey.childKey
  684. func getValue(m Valuer, key string) (interface{}, bool) {
  685. keys := readKeys(key)
  686. return getValueWithChainedKeys(m, keys)
  687. }
  688. func getValueWithChainedKeys(m Valuer, keys []string) (interface{}, bool) {
  689. if len(keys) == 1 {
  690. v, ok := m.Value(keys[0])
  691. return v, ok
  692. }
  693. if len(keys) > 1 {
  694. if v, ok := m.Value(keys[0]); ok {
  695. if nextm, ok := v.(map[string]interface{}); ok {
  696. return getValueWithChainedKeys(MapValuer(nextm), keys[1:])
  697. }
  698. }
  699. }
  700. return nil, false
  701. }
  702. func join(elem ...string) string {
  703. var builder strings.Builder
  704. var fillSep bool
  705. for _, e := range elem {
  706. if len(e) == 0 {
  707. continue
  708. }
  709. if fillSep {
  710. builder.WriteByte(delimiter)
  711. } else {
  712. fillSep = true
  713. }
  714. builder.WriteString(e)
  715. }
  716. return builder.String()
  717. }
  718. func newInitError(name string) error {
  719. return fmt.Errorf("field %s is not set", name)
  720. }
  721. func newTypeMismatchError(name string) error {
  722. return fmt.Errorf("error: type mismatch for field %s", name)
  723. }
  724. func readKeys(key string) []string {
  725. cacheKeysLock.Lock()
  726. keys, ok := cacheKeys[key]
  727. cacheKeysLock.Unlock()
  728. if ok {
  729. return keys
  730. }
  731. keys = strings.FieldsFunc(key, func(c rune) bool {
  732. return c == delimiter
  733. })
  734. cacheKeysLock.Lock()
  735. cacheKeys[key] = keys
  736. cacheKeysLock.Unlock()
  737. return keys
  738. }
  739. func setSameKindValue(targetType reflect.Type, target reflect.Value, value interface{}) {
  740. if reflect.ValueOf(value).Type().AssignableTo(targetType) {
  741. target.Set(reflect.ValueOf(value))
  742. } else {
  743. target.Set(reflect.ValueOf(value).Convert(targetType))
  744. }
  745. }