unmarshaler.go 27 KB

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