unmarshaler.go 28 KB

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