Springboot使用redis實現(xiàn)接口Api限流的實例
前言

該篇介紹的內(nèi)容如題,就是利用redis實現(xiàn)接口的限流( 某時間范圍內(nèi) 最大的訪問次數(shù) ) 。
正文
慣例,先看下我們的實戰(zhàn)目錄結(jié)構(gòu):

首先是pom.xml 核心依賴:
<!--用于redis數(shù)據(jù)庫連接-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!--用于redis lettuce 連接池pool使用-->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
然后是application.yml里面的redis接入配置:
spring:
redis:
lettuce:
pool:
#連接池最大連接數(shù) 使用負(fù)值代表無限制 默認(rèn)為8
max-active: 10
#最大空閑連接 默認(rèn)8
max-idle: 10
#最小空閑連接 默認(rèn)0
min-idle: 1
host: 127.0.0.1
password: 123456
port: 6379
database: 0
timeout: 2000ms
server:
port: 8710
redis的配置類, RedisConfig.java:
ps:可以看到日期是18年的,因為這些redis的整合教程,在這個系列里面一共有快10篇,不了解的看客如果感興趣可以去看一看。
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheConfiguration;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.RedisSerializationContext;
import org.springframework.data.redis.serializer.StringRedisSerializer;
import static org.springframework.data.redis.cache.RedisCacheConfiguration.defaultCacheConfig;
/**
* @Author: JCccc
* @CreateTime: 2018-09-11
* @Description:
*/
@Configuration
@EnableCaching
public class RedisConfig {
@Bean
public CacheManager cacheManager(RedisConnectionFactory connectionFactory) {
RedisCacheConfiguration cacheConfiguration =
defaultCacheConfig()
.disableCachingNullValues()
.serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(new Jackson2JsonRedisSerializer(Object.class)));
return RedisCacheManager.builder(connectionFactory).cacheDefaults(cacheConfiguration).build();
}
@Bean
public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
redisTemplate.setConnectionFactory(factory);
Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
ObjectMapper om = new ObjectMapper();
om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
jackson2JsonRedisSerializer.setObjectMapper(om);
//序列化設(shè)置 ,這樣為了存儲操作對象時正常顯示的數(shù)據(jù),也能正常存儲和獲取
redisTemplate.setKeySerializer(new StringRedisSerializer());
redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);
redisTemplate.setHashKeySerializer(new StringRedisSerializer());
redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer);
return redisTemplate;
}
@Bean
public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory factory) {
StringRedisTemplate stringRedisTemplate = new StringRedisTemplate();
stringRedisTemplate.setConnectionFactory(factory);
return stringRedisTemplate;
}
}
自定義注解:
import java.lang.annotation.*;
/**
* @Author JCccc
* @Description
* @Date 2021/7/23 11:46
*/
@Inherited
@Documented
@Target({ElementType.FIELD, ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface RequestLimit {
/**
* 時間內(nèi) 秒為單位
*/
int second() default 10;
/**
* 允許訪問次數(shù)
*/
int maxCount() default 5;
//默認(rèn)效果 : 10秒內(nèi) 對于使用該注解的接口,只能總請求訪問數(shù) 不能大于 5次
}
接下來是攔截器 RequestLimitInterceptor.java:
攔截接口的方式 是通過 ip地址+接口url ,做時間內(nèi)的訪問計數(shù)
import com.elegant.testdemo.annotation.RequestLimit;
import com.elegant.testdemo.utils.IpUtil;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
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.util.concurrent.TimeUnit;
/**
* @Author JCccc
* @Description
* @Date 2021/7/23 11:49
*/
@Component
public class RequestLimitInterceptor implements HandlerInterceptor {
private final Logger log = LoggerFactory.getLogger(this.getClass());
@Autowired
private RedisTemplate<String, Object> redisTemplate;
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
try {
if (handler instanceof HandlerMethod) {
HandlerMethod handlerMethod = (HandlerMethod) handler;
// 獲取RequestLimit注解
RequestLimit requestLimit = handlerMethod.getMethodAnnotation(RequestLimit.class);
if (null==requestLimit) {
return true;
}
//限制的時間范圍
int seconds = requestLimit.second();
//時間內(nèi)的 最大次數(shù)
int maxCount = requestLimit.maxCount();
String ipAddr = IpUtil.getIpAddr(request);
// 存儲key
String key = ipAddr+":"+request.getContextPath() + ":" + request.getServletPath();
// 已經(jīng)訪問的次數(shù)
Integer count = (Integer) redisTemplate.opsForValue().get(key);
log.info("檢測到目前ip對接口={}已經(jīng)訪問的次數(shù)", request.getServletPath() , count);
if (null == count || -1 == count) {
redisTemplate.opsForValue().set(key, 1, seconds, TimeUnit.SECONDS);
return true;
}
if (count < maxCount) {
redisTemplate.opsForValue().increment(key);
return true;
}
log.warn("請求過于頻繁請稍后再試");
returnData(response);
return false;
}
return true;
} catch (Exception e) {
log.warn("請求過于頻繁請稍后再試");
e.printStackTrace();
}
return true;
}
public void returnData(HttpServletResponse response) throws IOException {
response.setCharacterEncoding("UTF-8");
response.setContentType("application/json; charset=utf-8");
ObjectMapper objectMapper = new ObjectMapper();
//這里傳提示語可以改成自己項目的返回數(shù)據(jù)封裝的類
response.getWriter().println(objectMapper.writeValueAsString("請求過于頻繁請稍后再試"));
return;
}
}
接下來是 攔截器的配置 WebConfig.java:
import com.elegant.testdemo.interceptor.RequestLimitInterceptor;
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;
/**
* @Author JCccc
* @Description
* @Date 2021/7/23 11:52
*/
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Autowired
private RequestLimitInterceptor requestLimitInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(requestLimitInterceptor)
//攔截所有請求路徑
.addPathPatterns("/**")
//再設(shè)置 放開哪些路徑
.excludePathPatterns("/static/**","/auth/login");
}
}
最后還有兩個工具類
IpUtil:
http://www.dbjr.com.cn/article/218249.htm
RedisUtil :
http://www.dbjr.com.cn/article/218246.htm
最后寫個測試接口
TestController.java
import com.elegant.testdemo.annotation.RequestLimit;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @Author JCccc
* @Description
* @Date 2021/7/23 11:55
*/
@RestController
public class TestController {
@GetMapping("/test")
@RequestLimit(maxCount = 3,second = 60)
public String test() {
return "你好,如果對你有幫助,請點贊加關(guān)注。";
}
}
這個/test接口的注解,我們設(shè)置的是 60秒內(nèi) 最大訪問次數(shù)為 3次 (實際應(yīng)用應(yīng)該是根據(jù)具體接口做相關(guān)的次數(shù)限制。)
然后使用postman測試一下接口:
前面三次都是請求通過的:

第四次:

到此這篇關(guān)于Springboot使用redis實現(xiàn)接口Api限流的實例的文章就介紹到這了,更多相關(guān)Springboot redis接口Api限流內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- springboot+redis 實現(xiàn)分布式限流令牌桶的示例代碼
- 使用SpringBoot?+?Redis?實現(xiàn)接口限流的方式
- SpringBoot整合Redis并且用Redis實現(xiàn)限流的方法 附Redis解壓包
- SpringBoot中使用Redis對接口進(jìn)行限流的實現(xiàn)
- 基于SpringBoot+Redis實現(xiàn)一個簡單的限流器
- SpringBoot使用Redis對用戶IP進(jìn)行接口限流的示例詳解
- SpringBoot使用Redis對用戶IP進(jìn)行接口限流的項目實踐
- Springboot+Redis實現(xiàn)API接口限流的示例代碼
- Springboot使用redis實現(xiàn)接口Api限流的示例代碼
- SpringBoot使用Redis進(jìn)行限流功能實現(xiàn)
相關(guān)文章
微信公眾號 網(wǎng)頁授權(quán)登錄及code been used解決詳解
這篇文章主要介紹了微信公眾號 網(wǎng)頁授權(quán)登錄及code been used解決詳解,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2019-07-07
mybatis中查詢結(jié)果為空時不同返回類型對應(yīng)返回值問題
這篇文章主要介紹了mybatis中查詢結(jié)果為空時不同返回類型對應(yīng)返回值問題,本文分幾種方法給大家介紹的非常詳細(xì),需要的朋友可以參考下2019-10-10
java swing標(biāo)準(zhǔn)對話框具體實現(xiàn)
這篇文章介紹了swing標(biāo)準(zhǔn)對話框的具體實現(xiàn)方法,有需要的朋友可以參考一下2013-06-06
如何解決EasyExcel導(dǎo)出文件LocalDateTime報錯問題
這篇文章主要介紹了如何解決EasyExcel導(dǎo)出文件LocalDateTime報錯問題,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2023-06-06
Mybatis?TypeHandler接口及繼承關(guān)系示例解析
這篇文章主要為大家介紹了Mybatis?TypeHandler接口及繼承關(guān)系示例解析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-02-02
Java下利用Jackson進(jìn)行JSON解析和序列化示例
本篇文章主要介紹了Java下利用Jackson進(jìn)行JSON解析和序列化示例,具有一定的參考價值,感興趣的小伙伴們可以參考一下。2017-02-02

