Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/weasley-j/http-rate-limiter-spring-parent
一个用于支持springboot项目http请求限制的starter，通过识别客户端传来token值(具有唯一标志性)来实现：同一个用户在一定的时间频次内最多只能点击N次特定接口的功能，使用redisson内置非公平锁实现
https://github.com/weasley-j/http-rate-limiter-spring-parent
api-limit http-request-restrict java redis spring spring-boot
Last synced: 18 days ago
JSON representation
一个用于支持springboot项目http请求限制的starter，通过识别客户端传来token值(具有唯一标志性)来实现：同一个用户在一定的时间频次内最多只能点击N次特定接口的功能，使用redisson内置非公平锁实现
- Host: GitHub
- URL: https://github.com/weasley-j/http-rate-limiter-spring-parent
- Owner: Weasley-J
- License: gpl-3.0
- Created: 2022-11-15T16:23:08.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-27T10:41:38.000Z (over 1 year ago)
- Last Synced: 2023-06-27T17:31:02.164Z (over 1 year ago)
- Topics: api-limit, http-request-restrict, java, redis, spring, spring-boot
- Language: Java
- Homepage:
- Size: 127 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# http-rate-limiter-spring-boot-starter
[](https://search.maven.org/artifact/io.github.weasley-j/http-rate-limiter-spring-boot-starter)
一个用于支持`springboot`项目`http`请求限制的`starter`，通过识别客户端传来`token`值(具有唯一标志性)
来实现：同一个用户在一定的时间频次内最多只能点击`N`次特定接口的功能
## 1 映入pom坐标
版本号在`maven`仓库获取
```xml
io.github.weasley-j
http-rate-limiter-spring-boot-starter
${latest.version}
```
## 2 应用yaml配置元数据
**这里以`Sa-Token`作为`token`逻辑演示**
### 2.1 [Github示例链接](https://github.com/Weasley-J/http-rate-limiter-spring-parent/blob/main/http-rate-limiter-spring-boot-tests/src/main/resources/application-demo.yml)
```yaml
spring:
redis:
host: 127.0.0.1
port: 6379
password: 123456
database: 0
# Config（组件主体配置）
request:
restrict:
enable: on
# 指定要解析的请求头名称列表, 多个满足一个即可作为key, @RateLimit注解里面的'headName'和'cookieName'
# 优先级: headName > cookieName > header-keys
header-keys:
- x-auth-token
redis:
enable-ssl: off
host: ${spring.redis.host}
port: ${spring.redis.port}
password: ${spring.redis.password}
database: ${spring.redis.database}
# Sa Token
sa-token:
enable: true
# token名称 (同时也是cookie名称)
token-name: x-auth-token
# token有效期，单位s 默认30天, -1代表永不过期
timeout: 2592000
# token临时有效期 (指定时间内无操作就视为token过期) 单位: 秒
activity-timeout: -1
# 是否允许同一账号并发登录 (为true时允许一起登录, 为false时新登录挤掉旧登录)
is-concurrent: true
# 在多人登录同一账号时，是否共用一个token (为true时所有登录共用一个token, 为false时每次登录新建一个token)
is-share: true
# token风格
token-style: simple-uuid
# 是否输出操作日志
is-log: false
plugins:
redis:
show-banner: true
redis-base-prefix: 'uc:'
independent-session: true
independent-redis:
host: ${spring.redis.host}
port: ${spring.redis.port}
password: ${spring.redis.password}
database: ${spring.redis.database}
```
**补充：**`Sa-Token`的`pom`坐标（版本号在`maven`仓库获取）
```xml
cn.dev33
sa-token-spring-boot-starter
${sa-token.version}
cn.dev33
sa-token-dao-redis-jackson
${sa-token.version}
io.github.weasley-j
sa-plugin-redis-spring-boot-starter
1.0.5
org.springframework.boot
spring-boot-starter-data-redis
```
### 2.2 注解`@RateLimit`使用示例
一下接口调用前先要调用**登录接口**获取指定的`token`
```java
/**
* Rate Limit Demo Controller
*
* @author weasley
* @version 1.0.0
*/
@Slf4j
@RestController
@RequestMapping("/api/public/demo")
public class RateLimitDemoController {
@PostMapping("/clickOnce5Seconds")
@RateLimit(value = 5, maxCount = 1, timeUnit = TimeUnit.SECONDS) //5秒内点仅能点击1次
public void clickOnce5Seconds() {
log.info("5秒内点仅能点击1次");
}
@PostMapping("/click2Times10Seconds")
@RateLimit(value = 10, maxCount = 2, timeUnit = TimeUnit.SECONDS) //10秒内仅能点击2次
public void click2Times10Seconds() {
log.info("10秒内仅能点击2次");
}
@PostMapping("/click5Times5Minutes")
@RateLimit(value = 5, maxCount = 5, timeUnit = TimeUnit.MINUTES) //5分钟只能内只能点5次
public void click5Times5Minutes() {
log.info("5分钟只能内只能点5次");
}
@PostMapping("/click2Times10SecondsByHeaderName")
@RateLimit(value = 5, maxCount = 1, timeUnit = TimeUnit.SECONDS, headName = "x-auth-token") //5秒内仅能点击1次, 解析请求头
public void click2Times10SecondsByHeaderName() {
log.info("指定headerName: 5秒内仅能点击1次");
}
@PostMapping("/click2Times10SecondsByCookieName")
@RateLimit(value = 10, maxCount = 1, timeUnit = TimeUnit.SECONDS, cookieName = "x-auth-token")
//10秒内仅能点击2次,解析cookie
public void click2Times10SecondsByCookieName() {
log.info("指定cookieName: 10秒内仅能点击2次");
}
}
```
## 3 通过注解装配bean开启功能
```java
import annotation.io.github.weasleyj.http.rate.limit.EnableHttpRateLimit;
import io.github.weasleyj.satoken.session.annotation.EnableSaIndependentRedisSession;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* DEMO APP
*/
@SpringBootApplication
@EnableRateLimit //主体注解
@EnableSaIndependentRedisSession
public class HttpRequestRestrictDemoApp {
public static void main(String[] args) {
SpringApplication.run(HttpRequestRestrictDemoApp.class, args);
}
}
```
## 4 启动应用访问接口观察异常
- 访问登录接口获取`token`
[源码](https://github.com/Weasley-J/http-rate-limiter-spring-parent/blob/main/http-rate-limiter-spring-boot-tests/src/main/java/com/example/request/controller/AuthenticationController.java)
http://localhost:8080/api/public/auth/login/token
接口返回：
```json
{
"tokenName": "x-auth-token",
"tokenValue": "d0d4821c21404465895199be8203222c",
"isLogin": true,
"loginId": "10086"
}
```
- 使用`API`工具调用限流接口
[源码](https://github.com/Weasley-J/http-rate-limiter-spring-parent/blob/main/http-rate-limiter-spring-boot-tests/src/main/java/com/example/request/controller/RateLimitDemoController.java)
10秒内仅能点击2次: http://localhost:8080/api/public/demo/click2Times10Seconds
**触发限流抛出异常方便开发者进行捕获处理，给前端发返回提示。**
```java
exception.io.github.weasleyj.http.rate.limit.FrequentRequestException: 操作太过频繁，请稍后再试（接口URI: /api/public/demo/click2Times10Seconds, 10(SECONDS)内仅能请求2次）
at interceptor.io.github.weasleyj.http.rate.limit.DefaultRequestRestrictInterceptor.preHandle(DefaultRequestRestrictInterceptor.java:106) ~[classes/:na]
at org.springframework.web.servlet.HandlerExecutionChain.applyPreHandle(HandlerExecutionChain.java:148) ~[spring-webmvc-5.3.23.jar:5.3.23]
at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1066) ~[spring-webmvc-5.3.23.jar:5.3.23]
at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:964) ~[spring-webmvc-5.3.23.jar:5.3.23]
at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006) ~[spring-webmvc-5.3.23.jar:5.3.23]
at org.springframework.web.servlet.FrameworkServlet.doPost(FrameworkServlet.java:909) ~[spring-webmvc-5.3.23.jar:5.3.23]
```