SpringCloud+Redis實現Api接口限流防止惡意刷接口
一、API接口防刷
顧名思義,想讓某個接口某個人在某段時間內只能請求N次。
二、原理
在請求的時候,服務器通過Redis記錄你請求的次數,如果次數超過限制就不給訪問。
在redis保存的key是有失效的,過期就會刪除。
三、api限流的場景
限流的需求出現在許多常見的場景中:
- 秒殺活動,有人使用軟件惡意刷單搶貨,需要限流防止機器參與活動
- 某api被各式各樣系統(tǒng)廣泛調用,嚴重消耗網絡、內存等資源,需要合理限流
- 淘寶獲取ip所在城市接口、微信公眾號識別微信用戶等開發(fā)接口,免費提供給用戶時需要限流,更具有實時性和準確性的接口需要付費。
四、api限流代碼實現
使用自定義注解的方式實現
1.添加依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bootstrap</artifactId>
<version>3.1.5</version>
</dependency>
<!--nacos 服務注冊中心-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
<version>2021.1</version>
</dependency>
<!--nacos 配置中心-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
<version>2021.1</version>
</dependency>
<!--redis 依賴-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
2.添加自定義AccessLimit注解
package com.example.demo.aop;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 自定義接口:api接口限流
* @author qzz
* @date 2024/1/11
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface AccessLimit {
/**
* 時間間隔(單位秒)
* @return
*/
int seconds() default 60;
/**
* 最大訪問次數
* @return
*/
int maxCount() default 60;
/**
* 是否需要登錄
* @return
*/
boolean needLogin() default true;
}
3.添加AccessLimitIntercepter攔截器
自定義一個攔截器,請求之前,進行請求次數校驗
package com.example.demo.intercepter;
import com.alibaba.fastjson.JSON;
import com.example.demo.aop.AccessLimit;
import com.example.demo.enums.CodeMsg;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.OutputStream;
import java.lang.reflect.Method;
import java.nio.charset.StandardCharsets;
import java.util.concurrent.TimeUnit;
/**
* 限制訪問攔截器
* @author qzz
* @date 2024/1/12
*/
@Slf4j
@Component
public class AccessLimitIntercepter implements HandlerInterceptor {
private RedisTemplate<String,Object> redisTemplate;
@Autowired
public AccessLimitIntercepter(RedisTemplate<String,Object> redisTemplate){
this.redisTemplate = redisTemplate;
}
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
//方法請求攔截 Handler 是否為 HandlerMethod 實例
if(handler instanceof HandlerMethod){
HandlerMethod hm = (HandlerMethod) handler;
// 獲取方法
Method method = hm.getMethod();
// 是否有AccessLimit注解
if (!method.isAnnotationPresent(AccessLimit.class)) {
return true;
}
//獲取方法中的AccessLimit注解
AccessLimit accessLimit = hm.getMethodAnnotation(AccessLimit.class);
if(accessLimit == null){
return true;
}
int seconds = accessLimit.seconds();
int maxCount = accessLimit.maxCount();
boolean needLogin = accessLimit.needLogin();
String key=request.getRequestURI();
//判斷是否登錄
if(needLogin){
//獲取登錄的session進行判斷
//...
//獲取用戶id
Long userId = 1L;
key+=userId;
}
//從redis中獲取用戶訪問的次數
Object count = redisTemplate.opsForValue().get(key);
log.info("count:{}",count);
if(count == null){
//第一次訪問
redisTemplate.opsForValue().set(key,1, Long.valueOf(String.valueOf(seconds)), TimeUnit.SECONDS);
log.info("--------------------------第一次訪問--------------------------");
}else if(count!=null && Integer.valueOf(String.valueOf(count)) < maxCount){
//次數自增
redisTemplate.opsForValue().increment(key,1);
log.info("--------------------------次數自增--------------------------");
}else{
//超出訪問次數
render(response, CodeMsg.ACCESS_LIMIT_REACHED);
return false;
}
}
return true;
}
private void render(HttpServletResponse response, CodeMsg codeMsg) throws IOException {
response.setContentType("application/json;charset=UTF-8");
OutputStream outputStream = response.getOutputStream();
String str = JSON.toJSONString(codeMsg);
outputStream.write(str.getBytes(StandardCharsets.UTF_8));
outputStream.flush();
outputStream.close();
}
}
攔截器寫好了,但是還得添加注冊
4.WebConfig配置類
如果是Springboot的版本是2.*,只需要實現WebMvcConfigurer,然后重寫addInterceptors()方法,添加自定義攔截器即可。
如果是Springboot的版本是1.*,只需要實現WebMvcConfigurerAdapter,然后重寫addInterceptors()方法,添加自定義攔截器即可。
我的版本是2.4.6,所以代碼如下:
package com.example.demo.config;
import com.example.demo.intercepter.AccessLimitIntercepter;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
/**
* @author qzz
* @date 2024/1/12
*/
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Autowired
private AccessLimitIntercepter accessLimitIntercepter;
@Override
public void addInterceptors(InterceptorRegistry registry) {
//添加攔截器
registry.addInterceptor(accessLimitIntercepter);
}
}
5.controller控制層測試接口
使用方式:在方法上使用注解@AccessLimit(seconds = 5, maxCount = 5, needLogin = true)
默認5秒內,每個接口只能請求5次
package com.example.demo.controller;
import com.example.demo.aop.AccessLimit;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* 攔截器注冊
* @author qzz
* @date 2024/1/11
*/
@RestController
public class TestController {
@AccessLimit(seconds = 5, maxCount = 5, needLogin = true)
@RequestMapping("test/api/limit")
public String testApiLimit(){
return "test api limit";
}
}
五、完整代碼
代碼點擊此處下載
到此這篇關于SpringCloud+Redis實現Api接口限流防止惡意刷接口的文章就介紹到這了,更多相關SpringCloud Redis Api接口限流內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
Spring Bean Scope 有狀態(tài)的Bean與無狀態(tài)的Bean
這篇文章主要介紹了Spring Bean Scope 有狀態(tài)的Bean與無狀態(tài)的Bean,每個用戶有自己特有的一個實例,在用戶的生存期內,bean保持了用戶的信息,下面來了解有狀態(tài)和無狀態(tài)的區(qū)別吧2022-01-01
Spring Boot 整合 Shiro+Thymeleaf過程解析
這篇文章主要介紹了Spring Boot 整合 Shiro+Thymeleaf過程解析,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2019-10-10
mybatis-xml映射文件及mybatis動態(tài)sql詳解
XML映射文件的名稱與Mapper接口名稱一致,并且將XML映射文件和Mapper接口放置在相同包下(同包同名),這篇文章主要介紹了mybatis-xml映射文件及mybatis動態(tài)sql的相關知識,感興趣的朋友跟隨小編一起看看吧2024-12-12
Plugin ‘org.springframework.boot:spring-boot-maven-plug
這篇文章給大家介紹了Plugin ‘org.springframework.boot:spring-boot-maven-plugin:‘ not found的解決方案,親測可用,文中給出了兩種解決方法,需要的朋友可以參考下2024-01-01

