unmarshaler.go 29 KB

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