unmarshaler.go 26 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051
  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. refValue := reflect.ValueOf(mapValue)
  249. targetValue := reflect.MakeMapWithSize(mapType, refValue.Len())
  250. dereffedElemType := Deref(elemType)
  251. dereffedElemKind := dereffedElemType.Kind()
  252. for _, key := range refValue.MapKeys() {
  253. keythValue := refValue.MapIndex(key)
  254. keythData := keythValue.Interface()
  255. switch dereffedElemKind {
  256. case reflect.Slice:
  257. target := reflect.New(dereffedElemType)
  258. if err := u.fillSlice(elemType, target.Elem(), keythData); err != nil {
  259. return emptyValue, err
  260. }
  261. targetValue.SetMapIndex(key, target.Elem())
  262. case reflect.Struct:
  263. keythMap, ok := keythData.(map[string]any)
  264. if !ok {
  265. return emptyValue, errTypeMismatch
  266. }
  267. target := reflect.New(dereffedElemType)
  268. if err := u.Unmarshal(keythMap, target.Interface()); err != nil {
  269. return emptyValue, err
  270. }
  271. SetMapIndexValue(elemType, targetValue, key, target.Elem())
  272. case reflect.Map:
  273. keythMap, ok := keythData.(map[string]any)
  274. if !ok {
  275. return emptyValue, errTypeMismatch
  276. }
  277. innerValue, err := u.generateMap(elemType.Key(), elemType.Elem(), keythMap)
  278. if err != nil {
  279. return emptyValue, err
  280. }
  281. targetValue.SetMapIndex(key, innerValue)
  282. default:
  283. switch v := keythData.(type) {
  284. case bool:
  285. if dereffedElemKind != reflect.Bool {
  286. return emptyValue, errTypeMismatch
  287. }
  288. targetValue.SetMapIndex(key, reflect.ValueOf(v))
  289. case string:
  290. if dereffedElemKind != reflect.String {
  291. return emptyValue, errTypeMismatch
  292. }
  293. targetValue.SetMapIndex(key, reflect.ValueOf(v))
  294. case json.Number:
  295. target := reflect.New(dereffedElemType)
  296. if err := setValueFromString(dereffedElemKind, target.Elem(), v.String()); err != nil {
  297. return emptyValue, err
  298. }
  299. targetValue.SetMapIndex(key, target.Elem())
  300. default:
  301. if dereffedElemKind != keythValue.Kind() {
  302. return emptyValue, errTypeMismatch
  303. }
  304. targetValue.SetMapIndex(key, keythValue)
  305. }
  306. }
  307. }
  308. return targetValue, nil
  309. }
  310. func (u *Unmarshaler) parseOptionsWithContext(field reflect.StructField, m Valuer, fullName string) (
  311. string, *fieldOptionsWithContext, error) {
  312. key, options, err := parseKeyAndOptions(u.key, field)
  313. if err != nil {
  314. return "", nil, err
  315. } else if options == nil {
  316. return key, nil, nil
  317. }
  318. if u.opts.canonicalKey != nil {
  319. key = u.opts.canonicalKey(key)
  320. if len(options.OptionalDep) > 0 {
  321. // need to create a new fieldOption, because the original one is shared through cache.
  322. options = &fieldOptions{
  323. fieldOptionsWithContext: fieldOptionsWithContext{
  324. Inherit: options.Inherit,
  325. FromString: options.FromString,
  326. Optional: options.Optional,
  327. Options: options.Options,
  328. Default: options.Default,
  329. EnvVar: options.EnvVar,
  330. Range: options.Range,
  331. },
  332. OptionalDep: u.opts.canonicalKey(options.OptionalDep),
  333. }
  334. }
  335. }
  336. optsWithContext, err := options.toOptionsWithContext(key, m, fullName)
  337. if err != nil {
  338. return "", nil, err
  339. }
  340. return key, optsWithContext, nil
  341. }
  342. func (u *Unmarshaler) processAnonymousField(field reflect.StructField, value reflect.Value,
  343. m valuerWithParent, fullName string) error {
  344. key, options, err := u.parseOptionsWithContext(field, m, fullName)
  345. if err != nil {
  346. return err
  347. }
  348. if options.optional() {
  349. return u.processAnonymousFieldOptional(field, value, key, m, fullName)
  350. }
  351. return u.processAnonymousFieldRequired(field, value, m, fullName)
  352. }
  353. func (u *Unmarshaler) processAnonymousFieldOptional(field reflect.StructField, value reflect.Value,
  354. key string, m valuerWithParent, fullName string) error {
  355. derefedFieldType := Deref(field.Type)
  356. switch derefedFieldType.Kind() {
  357. case reflect.Struct:
  358. return u.processAnonymousStructFieldOptional(field.Type, value, key, m, fullName)
  359. default:
  360. return u.processNamedField(field, value, m, fullName)
  361. }
  362. }
  363. func (u *Unmarshaler) processAnonymousFieldRequired(field reflect.StructField, value reflect.Value,
  364. m valuerWithParent, fullName string) error {
  365. fieldType := field.Type
  366. maybeNewValue(fieldType, value)
  367. derefedFieldType := Deref(fieldType)
  368. indirectValue := reflect.Indirect(value)
  369. switch derefedFieldType.Kind() {
  370. case reflect.Struct:
  371. for i := 0; i < derefedFieldType.NumField(); i++ {
  372. if err := u.processField(derefedFieldType.Field(i), indirectValue.Field(i),
  373. m, fullName); err != nil {
  374. return err
  375. }
  376. }
  377. default:
  378. if err := u.processNamedField(field, indirectValue, m, fullName); err != nil {
  379. return err
  380. }
  381. }
  382. return nil
  383. }
  384. func (u *Unmarshaler) processAnonymousStructFieldOptional(fieldType reflect.Type,
  385. value reflect.Value, key string, m valuerWithParent, fullName string) error {
  386. var filled bool
  387. var required int
  388. var requiredFilled int
  389. var indirectValue reflect.Value
  390. derefedFieldType := Deref(fieldType)
  391. for i := 0; i < derefedFieldType.NumField(); i++ {
  392. subField := derefedFieldType.Field(i)
  393. fieldKey, fieldOpts, err := u.parseOptionsWithContext(subField, m, fullName)
  394. if err != nil {
  395. return err
  396. }
  397. _, hasValue := getValue(m, fieldKey)
  398. if hasValue {
  399. if !filled {
  400. filled = true
  401. maybeNewValue(fieldType, value)
  402. indirectValue = reflect.Indirect(value)
  403. }
  404. if err = u.processField(subField, indirectValue.Field(i), m, fullName); err != nil {
  405. return err
  406. }
  407. }
  408. if !fieldOpts.optional() {
  409. required++
  410. if hasValue {
  411. requiredFilled++
  412. }
  413. }
  414. }
  415. if filled && required != requiredFilled {
  416. return fmt.Errorf("%s is not fully set", key)
  417. }
  418. return nil
  419. }
  420. func (u *Unmarshaler) processField(field reflect.StructField, value reflect.Value,
  421. m valuerWithParent, fullName string) error {
  422. if usingDifferentKeys(u.key, field) {
  423. return nil
  424. }
  425. if field.Anonymous {
  426. return u.processAnonymousField(field, value, m, fullName)
  427. }
  428. return u.processNamedField(field, value, m, fullName)
  429. }
  430. func (u *Unmarshaler) processFieldNotFromString(fieldType reflect.Type, value reflect.Value,
  431. vp valueWithParent, opts *fieldOptionsWithContext, fullName string) error {
  432. derefedFieldType := Deref(fieldType)
  433. typeKind := derefedFieldType.Kind()
  434. valueKind := reflect.TypeOf(vp.value).Kind()
  435. mapValue := vp.value
  436. switch {
  437. case valueKind == reflect.Map && typeKind == reflect.Struct:
  438. mv, ok := mapValue.(map[string]any)
  439. if !ok {
  440. return errTypeMismatch
  441. }
  442. return u.processFieldStruct(fieldType, value, &simpleValuer{
  443. current: mapValuer(mv),
  444. parent: vp.parent,
  445. }, fullName)
  446. case valueKind == reflect.Map && typeKind == reflect.Map:
  447. return u.fillMap(fieldType, value, mapValue)
  448. case valueKind == reflect.String && typeKind == reflect.Map:
  449. return u.fillMapFromString(value, mapValue)
  450. case valueKind == reflect.String && typeKind == reflect.Slice:
  451. return u.fillSliceFromString(fieldType, value, mapValue)
  452. case valueKind == reflect.String && derefedFieldType == durationType:
  453. return fillDurationValue(fieldType, value, mapValue.(string))
  454. default:
  455. return u.processFieldPrimitive(fieldType, value, mapValue, opts, fullName)
  456. }
  457. }
  458. func (u *Unmarshaler) processFieldPrimitive(fieldType reflect.Type, value reflect.Value,
  459. mapValue any, opts *fieldOptionsWithContext, fullName string) error {
  460. typeKind := Deref(fieldType).Kind()
  461. valueKind := reflect.TypeOf(mapValue).Kind()
  462. switch {
  463. case typeKind == reflect.Slice && valueKind == reflect.Slice:
  464. return u.fillSlice(fieldType, value, mapValue)
  465. case typeKind == reflect.Map && valueKind == reflect.Map:
  466. return u.fillMap(fieldType, value, mapValue)
  467. default:
  468. switch v := mapValue.(type) {
  469. case json.Number:
  470. return u.processFieldPrimitiveWithJSONNumber(fieldType, value, v, opts, fullName)
  471. default:
  472. if typeKind == valueKind {
  473. if err := validateValueInOptions(mapValue, opts.options()); err != nil {
  474. return err
  475. }
  476. return fillWithSameType(fieldType, value, mapValue, opts)
  477. }
  478. }
  479. }
  480. return newTypeMismatchError(fullName)
  481. }
  482. func (u *Unmarshaler) processFieldPrimitiveWithJSONNumber(fieldType reflect.Type, value reflect.Value,
  483. v json.Number, opts *fieldOptionsWithContext, fullName string) error {
  484. baseType := Deref(fieldType)
  485. typeKind := baseType.Kind()
  486. if err := validateJsonNumberRange(v, opts); err != nil {
  487. return err
  488. }
  489. if err := validateValueInOptions(v, opts.options()); err != nil {
  490. return err
  491. }
  492. target := reflect.New(Deref(fieldType)).Elem()
  493. switch typeKind {
  494. case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
  495. iValue, err := v.Int64()
  496. if err != nil {
  497. return err
  498. }
  499. target.SetInt(iValue)
  500. case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
  501. iValue, err := v.Int64()
  502. if err != nil {
  503. return err
  504. }
  505. if iValue < 0 {
  506. return fmt.Errorf("unmarshal %q with bad value %q", fullName, v.String())
  507. }
  508. target.SetUint(uint64(iValue))
  509. case reflect.Float32, reflect.Float64:
  510. fValue, err := v.Float64()
  511. if err != nil {
  512. return err
  513. }
  514. target.SetFloat(fValue)
  515. default:
  516. return newTypeMismatchError(fullName)
  517. }
  518. SetValue(fieldType, value, target)
  519. return nil
  520. }
  521. func (u *Unmarshaler) processFieldStruct(fieldType reflect.Type, value reflect.Value,
  522. m valuerWithParent, fullName string) error {
  523. if fieldType.Kind() == reflect.Ptr {
  524. baseType := Deref(fieldType)
  525. target := reflect.New(baseType).Elem()
  526. if err := u.unmarshalWithFullName(m, target.Addr().Interface(), fullName); err != nil {
  527. return err
  528. }
  529. SetValue(fieldType, value, target)
  530. } else if err := u.unmarshalWithFullName(m, value.Addr().Interface(), fullName); err != nil {
  531. return err
  532. }
  533. return nil
  534. }
  535. func (u *Unmarshaler) processFieldTextUnmarshaler(fieldType reflect.Type, value reflect.Value,
  536. mapValue any) (bool, error) {
  537. var tval encoding.TextUnmarshaler
  538. var ok bool
  539. if fieldType.Kind() == reflect.Ptr {
  540. if value.Elem().Kind() == reflect.Ptr {
  541. target := reflect.New(Deref(fieldType))
  542. SetValue(fieldType.Elem(), value, target)
  543. tval, ok = target.Interface().(encoding.TextUnmarshaler)
  544. } else {
  545. tval, ok = value.Interface().(encoding.TextUnmarshaler)
  546. }
  547. } else {
  548. tval, ok = value.Addr().Interface().(encoding.TextUnmarshaler)
  549. }
  550. if ok {
  551. switch mv := mapValue.(type) {
  552. case string:
  553. return true, tval.UnmarshalText([]byte(mv))
  554. case []byte:
  555. return true, tval.UnmarshalText(mv)
  556. }
  557. }
  558. return false, nil
  559. }
  560. func (u *Unmarshaler) processFieldWithEnvValue(fieldType reflect.Type, value reflect.Value,
  561. envVal string, opts *fieldOptionsWithContext, fullName string) error {
  562. if err := validateValueInOptions(envVal, opts.options()); err != nil {
  563. return err
  564. }
  565. fieldKind := fieldType.Kind()
  566. switch fieldKind {
  567. case reflect.Bool:
  568. val, err := strconv.ParseBool(envVal)
  569. if err != nil {
  570. return fmt.Errorf("unmarshal field %q with environment variable, %w", fullName, err)
  571. }
  572. value.SetBool(val)
  573. return nil
  574. case durationType.Kind():
  575. if err := fillDurationValue(fieldType, value, envVal); err != nil {
  576. return fmt.Errorf("unmarshal field %q with environment variable, %w", fullName, err)
  577. }
  578. return nil
  579. case reflect.String:
  580. value.SetString(envVal)
  581. return nil
  582. default:
  583. return u.processFieldPrimitiveWithJSONNumber(fieldType, value, json.Number(envVal), opts, fullName)
  584. }
  585. }
  586. func (u *Unmarshaler) processNamedField(field reflect.StructField, value reflect.Value,
  587. m valuerWithParent, fullName string) error {
  588. key, opts, err := u.parseOptionsWithContext(field, m, fullName)
  589. if err != nil {
  590. return err
  591. }
  592. fullName = join(fullName, key)
  593. if opts != nil && len(opts.EnvVar) > 0 {
  594. envVal := proc.Env(opts.EnvVar)
  595. if len(envVal) > 0 {
  596. return u.processFieldWithEnvValue(field.Type, value, envVal, opts, fullName)
  597. }
  598. }
  599. canonicalKey := key
  600. if u.opts.canonicalKey != nil {
  601. canonicalKey = u.opts.canonicalKey(key)
  602. }
  603. valuer := createValuer(m, opts)
  604. mapValue, hasValue := getValue(valuer, canonicalKey)
  605. if !hasValue || u.opts.fillDefault {
  606. return u.processNamedFieldWithoutValue(field.Type, value, opts, fullName)
  607. }
  608. return u.processNamedFieldWithValue(field.Type, value, valueWithParent{
  609. value: mapValue,
  610. parent: valuer,
  611. }, key, opts, fullName)
  612. }
  613. func (u *Unmarshaler) processNamedFieldWithValue(fieldType reflect.Type, value reflect.Value,
  614. vp valueWithParent, key string, opts *fieldOptionsWithContext, fullName string) error {
  615. mapValue := vp.value
  616. if mapValue == nil {
  617. if opts.optional() {
  618. return nil
  619. }
  620. return fmt.Errorf("field %s mustn't be nil", key)
  621. }
  622. if !value.CanSet() {
  623. return fmt.Errorf("field %s is not settable", key)
  624. }
  625. maybeNewValue(fieldType, value)
  626. if yes, err := u.processFieldTextUnmarshaler(fieldType, value, mapValue); yes {
  627. return err
  628. }
  629. fieldKind := Deref(fieldType).Kind()
  630. switch fieldKind {
  631. case reflect.Array, reflect.Map, reflect.Slice, reflect.Struct:
  632. return u.processFieldNotFromString(fieldType, value, vp, opts, fullName)
  633. default:
  634. if u.opts.fromString || opts.fromString() {
  635. return u.processNamedFieldWithValueFromString(fieldType, value, mapValue,
  636. key, opts, fullName)
  637. }
  638. return u.processFieldNotFromString(fieldType, value, vp, opts, fullName)
  639. }
  640. }
  641. func (u *Unmarshaler) processNamedFieldWithValueFromString(fieldType reflect.Type, value reflect.Value,
  642. mapValue any, key string, opts *fieldOptionsWithContext, fullName string) error {
  643. valueKind := reflect.TypeOf(mapValue).Kind()
  644. if valueKind != reflect.String {
  645. return fmt.Errorf("the value in map is not string, but %s", valueKind)
  646. }
  647. options := opts.options()
  648. if len(options) > 0 {
  649. var checkValue string
  650. switch mt := mapValue.(type) {
  651. case string:
  652. checkValue = mt
  653. case fmt.Stringer:
  654. checkValue = mt.String()
  655. default:
  656. return fmt.Errorf("the value in map is not string or json.Number, but %s",
  657. valueKind.String())
  658. }
  659. if !stringx.Contains(options, checkValue) {
  660. return fmt.Errorf(`value "%s" for field "%s" is not defined in options "%v"`,
  661. mapValue, key, options)
  662. }
  663. }
  664. return fillPrimitive(fieldType, value, mapValue, opts, fullName)
  665. }
  666. func (u *Unmarshaler) processNamedFieldWithoutValue(fieldType reflect.Type, value reflect.Value,
  667. opts *fieldOptionsWithContext, fullName string) error {
  668. derefedType := Deref(fieldType)
  669. fieldKind := derefedType.Kind()
  670. if defaultValue, ok := opts.getDefault(); ok {
  671. if derefedType == durationType {
  672. return fillDurationValue(fieldType, value, defaultValue)
  673. }
  674. switch fieldKind {
  675. case reflect.Array, reflect.Slice:
  676. return u.fillSliceWithDefault(derefedType, value, defaultValue)
  677. default:
  678. return setValueFromString(fieldKind, value, defaultValue)
  679. }
  680. }
  681. if u.opts.fillDefault {
  682. return nil
  683. }
  684. switch fieldKind {
  685. case reflect.Array, reflect.Map, reflect.Slice:
  686. if !opts.optional() {
  687. return u.processFieldNotFromString(fieldType, value, valueWithParent{
  688. value: emptyMap,
  689. }, opts, fullName)
  690. }
  691. case reflect.Struct:
  692. if !opts.optional() {
  693. required, err := structValueRequired(u.key, derefedType)
  694. if err != nil {
  695. return err
  696. }
  697. if required {
  698. return fmt.Errorf("%q is not set", fullName)
  699. }
  700. return u.processFieldNotFromString(fieldType, value, valueWithParent{
  701. value: emptyMap,
  702. }, opts, fullName)
  703. }
  704. default:
  705. if !opts.optional() {
  706. return newInitError(fullName)
  707. }
  708. }
  709. return nil
  710. }
  711. func (u *Unmarshaler) unmarshalWithFullName(m valuerWithParent, v any, fullName string) error {
  712. rv := reflect.ValueOf(v)
  713. if err := ValidatePtr(&rv); err != nil {
  714. return err
  715. }
  716. valueType := reflect.TypeOf(v)
  717. baseType := Deref(valueType)
  718. if baseType.Kind() != reflect.Struct {
  719. return errValueNotStruct
  720. }
  721. valElem := rv.Elem()
  722. if valElem.Kind() == reflect.Ptr {
  723. target := reflect.New(baseType).Elem()
  724. SetValue(valueType.Elem(), valElem, target)
  725. valElem = target
  726. }
  727. numFields := baseType.NumField()
  728. for i := 0; i < numFields; i++ {
  729. field := baseType.Field(i)
  730. if !field.IsExported() {
  731. continue
  732. }
  733. if err := u.processField(field, valElem.Field(i), m, fullName); err != nil {
  734. return err
  735. }
  736. }
  737. return nil
  738. }
  739. // WithStringValues customizes an Unmarshaler with number values from strings.
  740. func WithStringValues() UnmarshalOption {
  741. return func(opt *unmarshalOptions) {
  742. opt.fromString = true
  743. }
  744. }
  745. // WithCanonicalKeyFunc customizes an Unmarshaler with Canonical Key func.
  746. func WithCanonicalKeyFunc(f func(string) string) UnmarshalOption {
  747. return func(opt *unmarshalOptions) {
  748. opt.canonicalKey = f
  749. }
  750. }
  751. // WithDefault customizes an Unmarshaler with fill default values.
  752. func WithDefault() UnmarshalOption {
  753. return func(opt *unmarshalOptions) {
  754. opt.fillDefault = true
  755. }
  756. }
  757. func createValuer(v valuerWithParent, opts *fieldOptionsWithContext) valuerWithParent {
  758. if opts.inherit() {
  759. return recursiveValuer{
  760. current: v,
  761. parent: v.Parent(),
  762. }
  763. }
  764. return simpleValuer{
  765. current: v,
  766. parent: v.Parent(),
  767. }
  768. }
  769. func fillDurationValue(fieldType reflect.Type, value reflect.Value, dur string) error {
  770. d, err := time.ParseDuration(dur)
  771. if err != nil {
  772. return err
  773. }
  774. SetValue(fieldType, value, reflect.ValueOf(d))
  775. return nil
  776. }
  777. func fillPrimitive(fieldType reflect.Type, value reflect.Value, mapValue any,
  778. opts *fieldOptionsWithContext, fullName string) error {
  779. if !value.CanSet() {
  780. return errValueNotSettable
  781. }
  782. baseType := Deref(fieldType)
  783. if fieldType.Kind() == reflect.Ptr {
  784. target := reflect.New(baseType).Elem()
  785. switch mapValue.(type) {
  786. case string, json.Number:
  787. SetValue(fieldType, value, target)
  788. value = target
  789. }
  790. }
  791. switch v := mapValue.(type) {
  792. case string:
  793. return validateAndSetValue(baseType.Kind(), value, v, opts)
  794. case json.Number:
  795. if err := validateJsonNumberRange(v, opts); err != nil {
  796. return err
  797. }
  798. return setValueFromString(baseType.Kind(), value, v.String())
  799. default:
  800. return newTypeMismatchError(fullName)
  801. }
  802. }
  803. func fillWithSameType(fieldType reflect.Type, value reflect.Value, mapValue any,
  804. opts *fieldOptionsWithContext) error {
  805. if !value.CanSet() {
  806. return errValueNotSettable
  807. }
  808. if err := validateValueRange(mapValue, opts); err != nil {
  809. return err
  810. }
  811. if fieldType.Kind() == reflect.Ptr {
  812. baseType := Deref(fieldType)
  813. target := reflect.New(baseType).Elem()
  814. setSameKindValue(baseType, target, mapValue)
  815. SetValue(fieldType, value, target)
  816. } else {
  817. setSameKindValue(fieldType, value, mapValue)
  818. }
  819. return nil
  820. }
  821. // getValue gets the value for the specific key, the key can be in the format of parentKey.childKey
  822. func getValue(m valuerWithParent, key string) (any, bool) {
  823. keys := readKeys(key)
  824. return getValueWithChainedKeys(m, keys)
  825. }
  826. func getValueWithChainedKeys(m valuerWithParent, keys []string) (any, bool) {
  827. switch len(keys) {
  828. case 0:
  829. return nil, false
  830. case 1:
  831. v, ok := m.Value(keys[0])
  832. return v, ok
  833. default:
  834. if v, ok := m.Value(keys[0]); ok {
  835. if nextm, ok := v.(map[string]any); ok {
  836. return getValueWithChainedKeys(recursiveValuer{
  837. current: mapValuer(nextm),
  838. parent: m,
  839. }, keys[1:])
  840. }
  841. }
  842. return nil, false
  843. }
  844. }
  845. func join(elem ...string) string {
  846. var builder strings.Builder
  847. var fillSep bool
  848. for _, e := range elem {
  849. if len(e) == 0 {
  850. continue
  851. }
  852. if fillSep {
  853. builder.WriteByte(delimiter)
  854. } else {
  855. fillSep = true
  856. }
  857. builder.WriteString(e)
  858. }
  859. return builder.String()
  860. }
  861. func newInitError(name string) error {
  862. return fmt.Errorf("field %s is not set", name)
  863. }
  864. func newTypeMismatchError(name string) error {
  865. return fmt.Errorf("type mismatch for field %s", name)
  866. }
  867. func readKeys(key string) []string {
  868. cacheKeysLock.Lock()
  869. keys, ok := cacheKeys[key]
  870. cacheKeysLock.Unlock()
  871. if ok {
  872. return keys
  873. }
  874. keys = strings.FieldsFunc(key, func(c rune) bool {
  875. return c == delimiter
  876. })
  877. cacheKeysLock.Lock()
  878. cacheKeys[key] = keys
  879. cacheKeysLock.Unlock()
  880. return keys
  881. }
  882. func setSameKindValue(targetType reflect.Type, target reflect.Value, value any) {
  883. if reflect.ValueOf(value).Type().AssignableTo(targetType) {
  884. target.Set(reflect.ValueOf(value))
  885. } else {
  886. target.Set(reflect.ValueOf(value).Convert(targetType))
  887. }
  888. }