unmarshaler.go 24 KB

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