unmarshaler.go 25 KB

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