io.github.dengchen2020.ratelimiter.annotation.RateLimit Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of dc-spring-boot-starter-ratelimiter Show documentation

限流

There is a newer version: 0.0.28

Show newest version

package io.github.dengchen2020.ratelimiter.annotation;

import java.lang.annotation.*;
import java.util.concurrent.TimeUnit;

/**
 * 限流注解
 *
 * @author dengchen
 * @since 2024/4/18
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface RateLimit {

    /**
     * 限制次数
     */
    int value() default 60;

    /**
     * 时间单位，仅支持秒级、分钟级
     */
    TimeUnit timeUnit() default TimeUnit.MINUTES;

    /**
     * 异常提示
     */
    String errorMsg() default "请求过于频繁，请稍后再试";

    /**
     * 目标方法执行异常时是否受限制，默认依旧限制
     */
    boolean errorLimit() default true;

    /**
     * 限流策略
     */
    RateLimitStrategy strategy() default RateLimitStrategy.userAndMethod;

}