Annotation Interface RateLimit

@Target(METHOD) @Retention(RUNTIME) @Documented public @interface RateLimit
限流注解，用于方法级别的限流控制.
Author:
codeupsoft

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    int
    count
    时间窗口内允许的最大请求数.
    String
    key
    限流的key，支持SpEL表达式 例如: "#IP:#参数明".
    String
    limitType
    限流类型.
    String
    message
    触发限流时的提示信息.
    long
    period
    限流时间窗口（秒）.
    String
    prefix
    限流的key前缀.
    TimeUnit
    timeUnit
    时间单位.

  • Element Details

    • key

      String key
      限流的key，支持SpEL表达式 例如: "#IP:#参数明".
      Default:
      ""

    • prefix

      String prefix
      限流的key前缀.
      Default:
      "rate_limit:"

    • period

      long period
      限流时间窗口（秒）.
      Default:
      60L

    • count

      int count
      时间窗口内允许的最大请求数.
      Default:
      100

    • timeUnit

      TimeUnit timeUnit
      时间单位.
      Default:
      SECONDS

    • limitType

      String limitType
      限流类型.
      Default:
      "default"

    • message

      String message
      触发限流时的提示信息.
      Default:
      "\u8bbf\u95ee\u8fc7\u4e8e\u9891\u7e41\uff0c\u8bf7\u7a0d\u540e\u518d\u8bd5"