unmarshaler.go 28 KB

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