unmarshaler.go 27 KB

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