unmarshaler.go 27 KB

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