啥也不說了，上代碼先：
- https://github.com/tangaiyun/redislimiter-spring-boot 或者
- https://gitee.com/aiyuntang/redislimiter-spring-boot
redislimiter-spring-boot
一個優秀的分布式spring boot/Spring Cloud API限流架構，特别适合微服務架構.
快速開始
1. git clone https://github.com/tangaiyun/redislimiter-spring-boot.git
2. cd redislimiter-spring-boot-starter
3. mvn clean install
4. 建立一個Spring boot API 項目，具體參考demo1項目，要在項目依賴中加入
<dependency>
<groupId>com.tay</groupId>
<artifactId>redislimiter-spring-boot-starter</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency> 5. 修改項目resources/application.yml檔案
server:
port: 8888 #端口
spring:
application:
name: demo1 #應用名稱必須要配置，不然無法啟動
redis-limiter: #限流器配置
redis-host: 127.0.0.1 #redis server ip
check-action-timeout: 100 #通路檢查動作最大執行時間(機關毫秒）
enable-dynamical-conf: true #開啟動态限流配置 spring.application.name必須配置
6. 建立一個RestController類
package com.tay.demo1;
import com.tay.redislimiter.RateLimiter;
import com.tay.redislimiter.dynamic.DynamicRateLimiter;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.concurrent.TimeUnit;
@RestController
@RequestMapping("/demo")
public class DemoController {
@GetMapping("/test")
//基于使用者限流，獨立使用者每分鐘最多2次通路，使用者id在header中，key為userid
//RateLimiter标簽為靜态配置，此類配置不可動态修改
@RateLimiter(base = "#Headers['userid']", permits = 2, timeUnit = TimeUnit.MINUTES)
public String test() {
return "test!";
}
@GetMapping("/dynamictest")
//基于來源ip限流，獨立ip每分鐘最多通路5次通路，來源ip位于header中，key為X-Real-IP
//DynamicRateLimiter标簽代表動态配置，此類配置可在運作時動态修改
@DynamicRateLimiter(base = "#Headers['X-Real-IP']", permits = 5, timeUnit = TimeUnit.MINUTES)
public String dynamicTest() {
return "dynamictest!";
}
} 7. 在本機安裝redis并啟動，強烈建議在本機安裝docker環境，然後執行
sudo docker run -d -p 6379:6379 redis 就是這麼爽氣！
8. 運作Demo1Application.java
9. 測試
通過postman或者restd通路url http://localhost:8888/demo/test 在header中指定userid=tom, 可以發現tom一分鐘最多隻能通路2次
通過postman或者restd通路url http://localhost:8888/demo/dynamictest 在header中指定X-Real-IP=127.0.0.1, 可以發現127.0.0.1一分鐘最多隻能通路5次 高階教程
1. 配置項大全
spring:
redis-limiter:
redis-host: 127.0.0.1 # redis server IP 預設值：127.0.0.1
redis-port: 6379 # redis service 端口 預設值：6379
redis-password: test # redis 通路密碼 預設值：null
redis-connection-timeout: 2000 # redis 連接配接逾時時間 預設值：2000
redis-pool-max-idle: 50 # redis 連接配接池最大空閑連接配接數 預設值：50
redis-pool-min-idle: 10 # redis 連接配接池最小空閑連接配接數 預設值： 10
redis-pool-max-wait-millis： -1 # 從連接配接池中擷取連接配接最大等待時間 預設值： -1
redis-pool-max-total: 200 # 連接配接池中最大連接配接數 預設值： 200
redis-key-prefix: #RL # 通路痕迹key值字首 預設值： #RL
check-action-timeout: 100 # 通路檢查動作最大執行時間(機關毫秒) 預設值： 100
enable-dynamical-conf: true # 是否開啟動态配置 預設值： false
channel： #RLConfigChannel # 配置變更事件發送channel名稱 預設值： #RLConfigChannel 2 标簽
@RateLimiter, @DynamicRateLimiter 是使用者最經常使用到的。
2.1 标簽說明 --整體說明
@RateLimiter @DynamicRateLimiter 這兩個标簽用法完全一緻,他們都有4個屬性base、path、timeUnit、permits.
@Retention(RUNTIME)
@Target({ TYPE, METHOD })
public @interface RateLimiter {
String base() default "";
String path() default "";
TimeUnit timeUnit() default TimeUnit.SECONDS;
int permits() default 10000;
}
@Retention(RUNTIME)
@Target({ TYPE, METHOD })
public @interface DynamicRateLimiter {
String base() default "";
String path() default "";
TimeUnit timeUnit() default TimeUnit.SECONDS;
int permits() default 10000;
} 2.2 标簽說明 -- base參數(Spel表達式)說明
标簽都有一個屬性base，含義就是限流是"基于what"來進行的，如果你不指定base,那麼所有的請求都會聚合在一起統計，base為一個Spel表達式。
@RateLimiter(base = "#Headers['userid']", permits = 2, timeUnit = TimeUnit.MINUTES)
@DynamicRateLimiter(base = "#Headers['X-Real-IP']", permits = 5, timeUnit = TimeUnit.MINUTES) 目前base表達式僅支援從header和cookie中取值，Headers和Cookies就是兩個Map, 下面兩種配置都是合法的。
"#Headers['X-Real-IP']"
"#Cookies['userid']" 2.3 标簽使用 -- path 參數說明
path 如果不設定預設值是"", 當path為"", 架構内部會把它改寫為request.getRequestURI(),一般情況下架構預設行為就OK了。但在一種情況下你可能需要設定path參數，就是RequestMapping的path裡面包含Path Parameters的情況，例如：
@GetMapping("/user/{userid}")
@DynamicRateLimiter(base = "#Headers['X-Real-IP']", path = "/user", permits = 5, timeUnit = TimeUnit.MINUTES)
public User get(@PathVariable String userid) {
User user ...
return user;
} 在這種情況下，我們一般不會基于"/user/001"這樣統計，所有通路"/user/001", "/user/002"的請求都會聚合到path "/user'上統計。
2.4 标簽使用 -- timeUnit 參數說明
通路統計時間機關，以下4種都是有效的：
TimeUnit.SECONDS, TimeUnit.MINUTES, TimeUnit.HOURS, TimeUnit.DAYS
2.5 标簽使用 -- permits 參數說明
機關時間内允許通路的次數
3. 動态配置
動态配置使用@DynamicRateLimiter标簽，動态配置含義就是在運作時可以動态修改限流配置，這個是通過提供内置配置通路Rest API來實作的。
RestController
@RequestMapping("/limiterconfig")
@RequiredArgsConstructor
public final class LimiterConfigResource implements InitializingBean, ApplicationContextAware {
...
@PutMapping
public void update(@RequestBody LimiterConfig limiterConfig, HttpServletResponse response) throws IOException {
if(applicationName.equals(limiterConfig.getApplicationName())) {
publish(limiterConfig);
}
else {
response.setStatus(HttpStatus.BAD_REQUEST.value());
response.getWriter().print("Bad request for updating limiter configuration!");
}
}
@GetMapping
public LimiterConfig get(@RequestParam("controller") String controller, @RequestParam("method")String method) {
String limiterConfigKey = controller + ":" + method;
return redisLimiterConfigProcessor.get(limiterConfigKey);
}
@DeleteMapping
public void delete(@RequestParam("controller") String controller, @RequestParam("method")String method) {
LimiterConfig limiterConfig = new LimiterConfig();
limiterConfig.setApplicationName(applicationName);
limiterConfig.setControllerName(controller);
limiterConfig.setMethodName(method);
limiterConfig.setDeleted(true);
publish(limiterConfig);
} 目前提供了修改(PUT), 查詢 (GET), 删除(DELETE)三種操作。
對于demo1項目
我們可以通過 GET
http://localhost:8888/limiterconfig?controller=DemoController&method=dynamicTest來擷取限流配置，傳回值為
{
"applicationName": "demo1",
"controllerName": "DemoController",
"methodName": "dynamicTest",
"baseExp": "#Headers['userid']",
"path": "",
"timeUnit": "MINUTES",
"permits": 5,
"deleted": false
} 通過指定Content-Type為application/json PUT
http://localhost:8888/limiterconfig來改動限流配置, 發送内容如
{
"applicationName": "demo1",
"controllerName": "DemoController",
"methodName": "dynamicTest",
"baseExp": "#Headers['userid']",
"path": "",
"timeUnit": "MINUTES",
"permits": 10,
"deleted": false
} 通過 DELETE
可删除限流配置
![Java String.format方法的簡單使用[圖]](data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=)