com.emily.infrastructure.rateLimiter.annotation.RateLimiter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of emily-spring-boot-rateLimiter Show documentation

The newest version!

package com.emily.infrastructure.rateLimiter.annotation;

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

/**
 * @author :  Emily
 * @since :  2024/8/30 上午9:37
 */
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface RateLimiter {
    /**
     * 缓存key前缀
     */
    String key();

    /**
     * 缓存过期时间，单位：秒
     */
    long timeout() default -1;

    /**
     * 超时时间 单位：秒
     */
    TimeUnit timeunit() default TimeUnit.SECONDS;

    /**
     * 最大限流次数，默认：10
     */
    int maxPermits() default 10;

    /**
     * 超过限流次数提醒消息
     */
    String message() default "您已触发访问限制，请等待几分钟后再试。";
}