args.go 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. package kit
  2. import (
  3. "fmt"
  4. "strings"
  5. "time"
  6. )
  7. const (
  8. DateLayout = "2006-01-02"
  9. DateTimeLayout = time.DateTime // 2006-01-02 15:04:05
  10. MonthLayout = "2006-01"
  11. )
  12. // ArgError 参数错误:Handler 返回给模型的可读说明。
  13. type ArgError struct{ Msg string }
  14. func (e *ArgError) Error() string { return e.Msg }
  15. func argErrorf(format string, a ...any) error { return &ArgError{Msg: fmt.Sprintf(format, a...)} }
  16. // Required 必填字符串参数(去掉首尾空白)。
  17. func Required(name, v string) (string, error) {
  18. v = strings.TrimSpace(v)
  19. if v == "" {
  20. return "", argErrorf("参数 %s 必填", name)
  21. }
  22. return v, nil
  23. }
  24. // ParseDate 解析 yyyy-MM-dd;v 为空且 allowEmpty 时返回 nil。
  25. func ParseDate(name, v string, allowEmpty bool) (*time.Time, error) {
  26. v = strings.TrimSpace(v)
  27. if v == "" {
  28. if allowEmpty {
  29. return nil, nil
  30. }
  31. return nil, argErrorf("参数 %s 必填,格式 yyyy-MM-dd", name)
  32. }
  33. t, err := time.Parse(DateLayout, v)
  34. if err != nil {
  35. return nil, argErrorf("参数 %s 格式错误,需要 yyyy-MM-dd:%s", name, v)
  36. }
  37. return &t, nil
  38. }
  39. // ParseDateTime 解析 yyyy-MM-dd HH:mm:ss;只给日期时按当天 00:00:00 处理。
  40. func ParseDateTime(name, v string) (time.Time, error) {
  41. v = strings.TrimSpace(v)
  42. if v == "" {
  43. return time.Time{}, argErrorf("参数 %s 必填,格式 yyyy-MM-dd HH:mm:ss", name)
  44. }
  45. if t, err := time.Parse(DateTimeLayout, v); err == nil {
  46. return t, nil
  47. }
  48. if t, err := time.Parse(DateLayout, v); err == nil {
  49. return t, nil
  50. }
  51. return time.Time{}, argErrorf("参数 %s 格式错误,需要 yyyy-MM-dd HH:mm:ss:%s", name, v)
  52. }
  53. // ParseRange 解析时间范围并检查 from < to、跨度不超过 max。
  54. func ParseRange(from, to string, max time.Duration) (time.Time, time.Time, error) {
  55. f, err := ParseDateTime("from", from)
  56. if err != nil {
  57. return f, f, err
  58. }
  59. t, err := ParseDateTime("to", to)
  60. if err != nil {
  61. return f, t, err
  62. }
  63. if !t.After(f) {
  64. return f, t, argErrorf("结束时间必须晚于开始时间")
  65. }
  66. if max > 0 && t.Sub(f) > max {
  67. return f, t, argErrorf("时间范围不能超过 %s,请缩短范围后分段查询", humanDuration(max))
  68. }
  69. return f, t, nil
  70. }
  71. func humanDuration(d time.Duration) string {
  72. if d%(24*time.Hour) == 0 {
  73. return fmt.Sprintf("%d 天", int(d/(24*time.Hour)))
  74. }
  75. return d.String()
  76. }
  77. // Limit 归一化条数:<=0 取默认值,超过上限取上限。
  78. func Limit(v, def, max int) int {
  79. if v <= 0 {
  80. return def
  81. }
  82. if v > max {
  83. return max
  84. }
  85. return v
  86. }
  87. // Page 归一化页码(从 1 开始)。
  88. func Page(v int) int {
  89. if v <= 0 {
  90. return 1
  91. }
  92. return v
  93. }
  94. // Enum 校验枚举值;v 为空返回默认值。
  95. func Enum(name, v, def string, allowed ...string) (string, error) {
  96. v = strings.TrimSpace(v)
  97. if v == "" {
  98. return def, nil
  99. }
  100. for _, a := range allowed {
  101. if strings.EqualFold(v, a) {
  102. return a, nil
  103. }
  104. }
  105. return "", argErrorf("参数 %s 取值错误:%s,可选值:%s", name, v, strings.Join(allowed, " / "))
  106. }