SpringBoot利用限速器RateLimiter實現單機限流的示例代碼
一. 概述
參考開源項目https://github.com/xkcoding/spring-boot-demo
在系統運維中, 有時候為瞭避免用戶的惡意刷接口, 會加入一定規則的限流, 本Demo使用速率限制器com.xkcoding.ratelimit.guava.annotation.RateLimiter實現單機版的限流
二. SpringBootDemo
2.1 依賴
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> <dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> </dependency> <dependency> <groupId>com.google.guava</groupId> <artifactId>guava</artifactId> </dependency>
2.2 application.yml
server: port: 8080 servlet: context-path: /demo
2.3 啟動類
@SpringBootApplication public class SpringBootDemoRatelimitGuavaApplication { public static void main(String[] args) { SpringApplication.run(SpringBootDemoRatelimitGuavaApplication.class, args); } }
2.4 定義一個限流註解 RateLimiter.java
註意代碼裡使用瞭 AliasFor 設置一組屬性的別名,所以獲取註解的時候,需要通過 Spring 提供的註解工具類 AnnotationUtils 獲取,不可以通過 AOP 參數註入的方式獲取,否則有些屬性的值將會設置不進去。
@Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface RateLimiter { int NOT_LIMITED = 0; /** * qps (每秒並發量) */ @AliasFor("qps") double value() default NOT_LIMITED; /** * qps (每秒並發量) */ @AliasFor("value") double qps() default NOT_LIMITED; /** * 超時時長,默認不等待 */ int timeout() default 0; /** * 超時時間單位,默認毫秒 */ TimeUnit timeUnit() default TimeUnit.MICROSECONDS; }
2.5 代理: RateLimiterAspect.java
@Slf4j @Aspect @Component public class RateLimiterAspect { /** * 單機緩存 */ private static final ConcurrentMap<String, com.google.common.util.concurrent.RateLimiter> RATE_LIMITER_CACHE = new ConcurrentHashMap<>(); @Pointcut("@annotation(com.xkcoding.ratelimit.guava.annotation.RateLimiter)") public void rateLimit() { } @Around("rateLimit()") public Object pointcut(ProceedingJoinPoint point) throws Throwable { MethodSignature signature = (MethodSignature) point.getSignature(); Method method = signature.getMethod(); // 通過 AnnotationUtils.findAnnotation 獲取 RateLimiter 註解 RateLimiter rateLimiter = AnnotationUtils.findAnnotation(method, RateLimiter.class); if (rateLimiter != null && rateLimiter.qps() > RateLimiter.NOT_LIMITED) { double qps = rateLimiter.qps(); // TODO 這個key可以根據具體需求配置,例如根據ip限制,或用戶 String key = method.getDeclaringClass().getName() + StrUtil.DOT + method.getName(); if (RATE_LIMITER_CACHE.get(key) == null) { // 初始化 QPS RATE_LIMITER_CACHE.put(key, com.google.common.util.concurrent.RateLimiter.create(qps)); } // 嘗試獲取令牌 if (RATE_LIMITER_CACHE.get(key) != null && !RATE_LIMITER_CACHE.get(key).tryAcquire(rateLimiter.timeout(), rateLimiter.timeUnit())) { throw new RuntimeException("手速太快瞭,慢點兒吧~"); } } return point.proceed(); } }
2.6 使用
@Slf4j @RestController public class TestController { /** * 接口每秒隻能請求一次,不等待 * @return */ @RateLimiter(value = 1.0) @GetMapping("/test1") public Dict test1() { log.info("【test1】被執行瞭。。。。。"); return Dict.create().set("msg", "hello,world!").set("description", "別想一直看到我,不信你快速刷新看看~"); } /** * 接口每秒隻能請求一次,等待一秒 * @return */ @RateLimiter(value = 1.0, timeout = 1,timeUnit = TimeUnit.SECONDS) @GetMapping("/test3") public Dict test3() { log.info("【test3】被執行瞭。。。。。"); return Dict.create().set("msg", "hello,world!").set("description", "別想一直看到我,不信你快速刷新看看~"); } }
到此這篇關於SpringBoot利用限速器RateLimiter實現單機限流的示例代碼的文章就介紹到這瞭,更多相關SpringBoot 單機限流 內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!
推薦閱讀:
- 使用springboot整合RateLimiter限流過程
- SpringBoot 進行限流的操作方法
- SpringBoot如何使用RateLimiter通過AOP方式進行限流
- Java實現接口限流方案
- java實現單機限流