unmarshaler.go 27 KB

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