unmarshaler.go 26 KB

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