unmarshaler.go 27 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063
  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. if !field.IsExported() {
  592. return nil
  593. }
  594. key, opts, err := u.parseOptionsWithContext(field, m, fullName)
  595. if err != nil {
  596. return err
  597. }
  598. fullName = join(fullName, key)
  599. if opts != nil && len(opts.EnvVar) > 0 {
  600. envVal := proc.Env(opts.EnvVar)
  601. if len(envVal) > 0 {
  602. return u.processFieldWithEnvValue(field.Type, value, envVal, opts, fullName)
  603. }
  604. }
  605. canonicalKey := key
  606. if u.opts.canonicalKey != nil {
  607. canonicalKey = u.opts.canonicalKey(key)
  608. }
  609. valuer := createValuer(m, opts)
  610. mapValue, hasValue := getValue(valuer, canonicalKey)
  611. // When fillDefault is used, m is a null value, hasValue must be false, all priority judgments fillDefault.
  612. if u.opts.fillDefault {
  613. if !value.IsZero() {
  614. return fmt.Errorf("set the default value, %s must be zero", fullName)
  615. }
  616. return u.processNamedFieldWithoutValue(field.Type, value, opts, fullName)
  617. } else if !hasValue {
  618. return u.processNamedFieldWithoutValue(field.Type, value, opts, fullName)
  619. }
  620. return u.processNamedFieldWithValue(field.Type, value, valueWithParent{
  621. value: mapValue,
  622. parent: valuer,
  623. }, key, opts, fullName)
  624. }
  625. func (u *Unmarshaler) processNamedFieldWithValue(fieldType reflect.Type, value reflect.Value,
  626. vp valueWithParent, key string, opts *fieldOptionsWithContext, fullName string) error {
  627. mapValue := vp.value
  628. if mapValue == nil {
  629. if opts.optional() {
  630. return nil
  631. }
  632. return fmt.Errorf("field %s mustn't be nil", key)
  633. }
  634. if !value.CanSet() {
  635. return fmt.Errorf("field %s is not settable", key)
  636. }
  637. maybeNewValue(fieldType, value)
  638. if yes, err := u.processFieldTextUnmarshaler(fieldType, value, mapValue); yes {
  639. return err
  640. }
  641. fieldKind := Deref(fieldType).Kind()
  642. switch fieldKind {
  643. case reflect.Array, reflect.Map, reflect.Slice, reflect.Struct:
  644. return u.processFieldNotFromString(fieldType, value, vp, opts, fullName)
  645. default:
  646. if u.opts.fromString || opts.fromString() {
  647. return u.processNamedFieldWithValueFromString(fieldType, value, mapValue,
  648. key, opts, fullName)
  649. }
  650. return u.processFieldNotFromString(fieldType, value, vp, opts, fullName)
  651. }
  652. }
  653. func (u *Unmarshaler) processNamedFieldWithValueFromString(fieldType reflect.Type, value reflect.Value,
  654. mapValue any, key string, opts *fieldOptionsWithContext, fullName string) error {
  655. valueKind := reflect.TypeOf(mapValue).Kind()
  656. if valueKind != reflect.String {
  657. return fmt.Errorf("the value in map is not string, but %s", valueKind)
  658. }
  659. options := opts.options()
  660. if len(options) > 0 {
  661. var checkValue string
  662. switch mt := mapValue.(type) {
  663. case string:
  664. checkValue = mt
  665. case fmt.Stringer:
  666. checkValue = mt.String()
  667. default:
  668. return fmt.Errorf("the value in map is not string or json.Number, but %s",
  669. valueKind.String())
  670. }
  671. if !stringx.Contains(options, checkValue) {
  672. return fmt.Errorf(`value "%s" for field "%s" is not defined in options "%v"`,
  673. mapValue, key, options)
  674. }
  675. }
  676. return fillPrimitive(fieldType, value, mapValue, opts, fullName)
  677. }
  678. func (u *Unmarshaler) processNamedFieldWithoutValue(fieldType reflect.Type, value reflect.Value,
  679. opts *fieldOptionsWithContext, fullName string) error {
  680. derefedType := Deref(fieldType)
  681. fieldKind := derefedType.Kind()
  682. if defaultValue, ok := opts.getDefault(); ok {
  683. if derefedType == durationType {
  684. return fillDurationValue(fieldType, value, defaultValue)
  685. }
  686. switch fieldKind {
  687. case reflect.Array, reflect.Slice:
  688. return u.fillSliceWithDefault(derefedType, value, defaultValue)
  689. default:
  690. return setValueFromString(fieldKind, value, defaultValue)
  691. }
  692. }
  693. if u.opts.fillDefault {
  694. return nil
  695. }
  696. switch fieldKind {
  697. case reflect.Array, reflect.Map, reflect.Slice:
  698. if !opts.optional() {
  699. return u.processFieldNotFromString(fieldType, value, valueWithParent{
  700. value: emptyMap,
  701. }, opts, fullName)
  702. }
  703. case reflect.Struct:
  704. if !opts.optional() {
  705. required, err := structValueRequired(u.key, derefedType)
  706. if err != nil {
  707. return err
  708. }
  709. if required {
  710. return fmt.Errorf("%q is not set", fullName)
  711. }
  712. return u.processFieldNotFromString(fieldType, value, valueWithParent{
  713. value: emptyMap,
  714. }, opts, fullName)
  715. }
  716. default:
  717. if !opts.optional() {
  718. return newInitError(fullName)
  719. }
  720. }
  721. return nil
  722. }
  723. func (u *Unmarshaler) unmarshalWithFullName(m valuerWithParent, v any, fullName string) error {
  724. rv := reflect.ValueOf(v)
  725. if err := ValidatePtr(&rv); err != nil {
  726. return err
  727. }
  728. valueType := reflect.TypeOf(v)
  729. baseType := Deref(valueType)
  730. if baseType.Kind() != reflect.Struct {
  731. return errValueNotStruct
  732. }
  733. valElem := rv.Elem()
  734. if valElem.Kind() == reflect.Ptr {
  735. target := reflect.New(baseType).Elem()
  736. SetValue(valueType.Elem(), valElem, target)
  737. valElem = target
  738. }
  739. numFields := baseType.NumField()
  740. for i := 0; i < numFields; i++ {
  741. typeField := baseType.Field(i)
  742. valueField := valElem.Field(i)
  743. if err := u.processField(typeField, valueField, m, fullName); err != nil {
  744. return err
  745. }
  746. }
  747. return nil
  748. }
  749. // WithStringValues customizes an Unmarshaler with number values from strings.
  750. func WithStringValues() UnmarshalOption {
  751. return func(opt *unmarshalOptions) {
  752. opt.fromString = true
  753. }
  754. }
  755. // WithCanonicalKeyFunc customizes an Unmarshaler with Canonical Key func.
  756. func WithCanonicalKeyFunc(f func(string) string) UnmarshalOption {
  757. return func(opt *unmarshalOptions) {
  758. opt.canonicalKey = f
  759. }
  760. }
  761. // WithDefault customizes an Unmarshaler with fill default values.
  762. func WithDefault() UnmarshalOption {
  763. return func(opt *unmarshalOptions) {
  764. opt.fillDefault = true
  765. }
  766. }
  767. func createValuer(v valuerWithParent, opts *fieldOptionsWithContext) valuerWithParent {
  768. if opts.inherit() {
  769. return recursiveValuer{
  770. current: v,
  771. parent: v.Parent(),
  772. }
  773. }
  774. return simpleValuer{
  775. current: v,
  776. parent: v.Parent(),
  777. }
  778. }
  779. func fillDurationValue(fieldType reflect.Type, value reflect.Value, dur string) error {
  780. d, err := time.ParseDuration(dur)
  781. if err != nil {
  782. return err
  783. }
  784. SetValue(fieldType, value, reflect.ValueOf(d))
  785. return nil
  786. }
  787. func fillPrimitive(fieldType reflect.Type, value reflect.Value, mapValue any,
  788. opts *fieldOptionsWithContext, fullName string) error {
  789. if !value.CanSet() {
  790. return errValueNotSettable
  791. }
  792. baseType := Deref(fieldType)
  793. if fieldType.Kind() == reflect.Ptr {
  794. target := reflect.New(baseType).Elem()
  795. switch mapValue.(type) {
  796. case string, json.Number:
  797. SetValue(fieldType, value, target)
  798. value = target
  799. }
  800. }
  801. switch v := mapValue.(type) {
  802. case string:
  803. return validateAndSetValue(baseType.Kind(), value, v, opts)
  804. case json.Number:
  805. if err := validateJsonNumberRange(v, opts); err != nil {
  806. return err
  807. }
  808. return setValueFromString(baseType.Kind(), value, v.String())
  809. default:
  810. return newTypeMismatchError(fullName)
  811. }
  812. }
  813. func fillWithSameType(fieldType reflect.Type, value reflect.Value, mapValue any,
  814. opts *fieldOptionsWithContext) error {
  815. if !value.CanSet() {
  816. return errValueNotSettable
  817. }
  818. if err := validateValueRange(mapValue, opts); err != nil {
  819. return err
  820. }
  821. if fieldType.Kind() == reflect.Ptr {
  822. baseType := Deref(fieldType)
  823. target := reflect.New(baseType).Elem()
  824. setSameKindValue(baseType, target, mapValue)
  825. SetValue(fieldType, value, target)
  826. } else {
  827. setSameKindValue(fieldType, value, mapValue)
  828. }
  829. return nil
  830. }
  831. // getValue gets the value for the specific key, the key can be in the format of parentKey.childKey
  832. func getValue(m valuerWithParent, key string) (any, bool) {
  833. keys := readKeys(key)
  834. return getValueWithChainedKeys(m, keys)
  835. }
  836. func getValueWithChainedKeys(m valuerWithParent, keys []string) (any, bool) {
  837. switch len(keys) {
  838. case 0:
  839. return nil, false
  840. case 1:
  841. v, ok := m.Value(keys[0])
  842. return v, ok
  843. default:
  844. if v, ok := m.Value(keys[0]); ok {
  845. if nextm, ok := v.(map[string]any); ok {
  846. return getValueWithChainedKeys(recursiveValuer{
  847. current: mapValuer(nextm),
  848. parent: m,
  849. }, keys[1:])
  850. }
  851. }
  852. return nil, false
  853. }
  854. }
  855. func join(elem ...string) string {
  856. var builder strings.Builder
  857. var fillSep bool
  858. for _, e := range elem {
  859. if len(e) == 0 {
  860. continue
  861. }
  862. if fillSep {
  863. builder.WriteByte(delimiter)
  864. } else {
  865. fillSep = true
  866. }
  867. builder.WriteString(e)
  868. }
  869. return builder.String()
  870. }
  871. func newInitError(name string) error {
  872. return fmt.Errorf("field %s is not set", name)
  873. }
  874. func newTypeMismatchError(name string) error {
  875. return fmt.Errorf("type mismatch for field %s", name)
  876. }
  877. func readKeys(key string) []string {
  878. cacheKeysLock.Lock()
  879. keys, ok := cacheKeys[key]
  880. cacheKeysLock.Unlock()
  881. if ok {
  882. return keys
  883. }
  884. keys = strings.FieldsFunc(key, func(c rune) bool {
  885. return c == delimiter
  886. })
  887. cacheKeysLock.Lock()
  888. cacheKeys[key] = keys
  889. cacheKeysLock.Unlock()
  890. return keys
  891. }
  892. func setSameKindValue(targetType reflect.Type, target reflect.Value, value any) {
  893. if reflect.ValueOf(value).Type().AssignableTo(targetType) {
  894. target.Set(reflect.ValueOf(value))
  895. } else {
  896. target.Set(reflect.ValueOf(value).Convert(targetType))
  897. }
  898. }