unmarshaler.go 27 KB

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