使用Redis完成接口限流的過程
更新時間：2024年05月30日 16:21:27 作者：Mr丶呂
在一個高并發(fā)系統(tǒng)中對流量的把控是非常重要的,當巨大的流量直接請求到我們的服務器上沒多久就可能造成接口不可用,為了避免這種情況的發(fā)生我們就需要在請求接口時對接口進行限流的操作,這篇文章主要介紹了使用Redis完成接口限流的過程,需要的朋友可以參考下
接口限流
在一個高并發(fā)系統(tǒng)中對流量的把控是非常重要的，當巨大的流量直接請求到我們的服務器上沒多久就可能造成接口不可用，不處理的話甚至會造成整個應用不可用。為了避免這種情況的發(fā)生我們就需要在請求接口時對接口進行限流的操作。
怎么做？
基于springboot而言，我們想到的是通過redis的自加：incr來實現(xiàn)。我們可以通過用戶的唯一標識來設計成redis的key,值為單位時間內用戶的請求次數(shù)。
一、準備工作
創(chuàng)建Spring Boot 工程，引入 Web 和 Redis 依賴，同時考慮到接口限流一般是通過注解來標記，而注解是通過 AOP 來解析的，所以我們還需要加上 AOP 的依賴：
<!-- 需要的依賴 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<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>提前準備好一個redis示例，并在項目中進行配置。
#具體配置以實際為主這里只是演示 spring: redis: host: localhost port: 6379 password: 123
二、創(chuàng)建限流注解
限流我們一般分為兩種情況：
1、針對某一個接口單位時間內指定允許訪問次數(shù)，例如：A接口1分鐘內允許訪問100次；
2、針對ip地址進行限流，例如：ip地址A可以在1分鐘內訪問接口50次；
針對這兩種情況我們定義一個枚舉類：
public enum LimitType {
/**
* 默認策略
*/
DEFAULT,
/**
* 根據(jù)IP進行限流
*/
IP
}接下來定義限流注解：
@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface RateLimiter {
/**
* 限流key
*/
String key() default "rate_limit:";
/**
* 限流時間,單位秒
*/
int time() default 60;
/**
* 限流次數(shù)
*/
int count() default 50;
/**
* 限流類型
*/
LimitType limitType() default LimitType.DEFAULT;
}第一個參數(shù) key 是一個前綴，實際使用過程中是這個前綴加上接口方法的完整路徑共同來組成一個 key 來存到redis中。使用時在需要進行限流的接口中加上注解并配置詳細的參數(shù)即可。
三、定制RedisTemplate
在實際使用過程中我們通常是通過RedisTemplate來操作redis的，所以這里就需要定制我們需要的RedisTemplate，默認的RedisTemplate中是有一下小問題的，就是直接使用JdkSerializationRedisSerializer這個工具進行序列化時存放到redis中的key和value是會多一些前綴的，這樣就會導致我們在讀取數(shù)據(jù)時可能會出現(xiàn)錯誤。
修改 RedisTemplate 序列化方案，代碼如下：
@Bean
public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
RedisTemplate<String, Object> template = new RedisTemplate<>();
// 配置連接工廠
template.setConnectionFactory(factory);
//使用Jackson2JsonRedisSerializer來序列化和反序列化redis的value值（默認使用JDK的序列化方式）
Jackson2JsonRedisSerializer<Object> jacksonSeial = new Jackson2JsonRedisSerializer<>(Object.class);
ObjectMapper om = new ObjectMapper();
// 指定要序列化的域，field,get和set,以及修飾符范圍，ANY是都有包括private和public
om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
// 指定序列化輸入的類型，類必須是非final修飾的，final修飾的類，比如String,Integer等會跑出異常
om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
jacksonSeial.setObjectMapper(om);
// 值采用json序列化
template.setValueSerializer(jacksonSeial);
//使用StringRedisSerializer來序列化和反序列化redis的key值
template.setKeySerializer(new StringRedisSerializer());
// 設置hash key 和value序列化模式
template.setHashKeySerializer(new StringRedisSerializer());
template.setHashValueSerializer(jacksonSeial);
template.afterPropertiesSet();
return template;
}四、開發(fā)lua腳本
我們在java 代碼中將 Lua 腳本定義好，然后發(fā)送到 Redis 服務端去執(zhí)行。我們在 resources 目錄下新建 lua 文件夾專門用來存放 lua 腳本，腳本內容如下：
local key = KEYS[1]
local count = tonumber(ARGV[1])
local time = tonumber(ARGV[2])
local current = redis.call('get', key)
if current and tonumber(current) > count then
return tonumber(current)
end
current = redis.call('incr', key)
if tonumber(current) == 1 then
redis.call('expire', key, time)
end
return tonumber(current)KEYS 和 ARGV 都是一會調用時候傳進來的參數(shù)，tonumber 就是把字符串轉為數(shù)字，redis.call 就是執(zhí)行具體的 redis 指令。具體的流程：
- 首先獲取到傳進來的 key 以及 限流的 count 和時間 time。
- 通過 get 獲取到這個 key 對應的值，這個值就是當前時間段內這個接口訪問了多少次。
- 如果是第一次訪問，此時拿到的結果為 nil，否則拿到的結果應該是一個數(shù)字，所以接下來就判斷，如果拿到的結果是一個數(shù)字，并且這個數(shù)字還大于 count，那就說明已經超過流量限制了，那么直接返回查詢的結果即可。
- 如果拿到的結果為 nil，說明是第一次訪問，此時就給當前 key 自增 1，然后設置一個過期時間。
- 最后把自增 1 后的值返回就可以了。
接下來寫一個Bean來加載這個腳本：
@Bean
public DefaultRedisScript<Long> limitScript() {
DefaultRedisScript<Long> redisScript = new DefaultRedisScript<>();
redisScript.setScriptSource(new ResourceScriptSource(new ClassPathResource("lua/limit.lua")));
redisScript.setResultType(Long.class);
return redisScript;
}五、解析注解
自定義切面解析注解：
@Slf4j
@Aspect
@Component
public class RateLimiterAspect {
private final RedisTemplate redisTemplate;
private final RedisScript<Long> limitScript;
public RateLimiterAspect(RedisTemplate redisTemplate, RedisScript<Long> limitScript) {
this.redisTemplate = redisTemplate;
this.limitScript = limitScript;
}
@Around("@annotation(com.example.demo.annotation.RateLimiter)")
public Object doBefore(ProceedingJoinPoint joinPoint) throws Throwable{
MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
RateLimiter rateLimiter = methodSignature.getMethod().getAnnotation(RateLimiter.class);
//判斷該方法是否存在限流的注解
if (null != rateLimiter){
//獲得注解中的配置信息
int count = rateLimiter.count();
int time = rateLimiter.time();
String key = rateLimiter.key();
//調用getCombineKey()獲得存入redis中的key key -> 注解中配置的key前綴-ip地址-方法路徑-方法名
String combineKey = getCombineKey(rateLimiter, methodSignature);
log.info("combineKey->,{}",combineKey);
//將combineKey放入集合
List<Object> keys = Collections.singletonList(combineKey);
log.info("keys->",keys);
try {
//執(zhí)行l(wèi)ua腳本獲得返回值
Long number = (Long) redisTemplate.execute(limitScript, keys, count, time);
//如果返回null或者返回次數(shù)大于配置次數(shù)，則限制訪問
if (number==null || number.intValue() > count) {
throw new ServiceException("訪問過于頻繁，請稍候再試");
}
log.info("限制請求'{}',當前請求'{}',緩存key'{}'", count, number.intValue(), combineKey);
} catch (ServiceException e) {
throw e;
} catch (Exception e) {
throw new RuntimeException("服務器限流異常，請稍候再試");
}
}
return joinPoint.proceed();
}
/**
* Gets combine key.
*
* @param rateLimiter the rate limiter
* @param signature the signature
* @return the combine key
*/
public String getCombineKey(RateLimiter rateLimiter, MethodSignature signature) {
StringBuilder stringBuffer = new StringBuilder(rateLimiter.key());
if (rateLimiter.limitType() == LimitType.IP) {
stringBuffer.append(RequestUtil.getIpAddr(((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest())).append("-");
}
Method method = signature.getMethod();
Class<?> targetClass = method.getDeclaringClass();
stringBuffer.append(targetClass.getName()).append("-").append(method.getName());
return stringBuffer.toString();
}
}六、自定義異常處理
由于訪問次數(shù)達到限制時是拋異常出來，所以我們還需要寫一個全局異常捕獲：
/**
* 自定義ServiceException
*/
public class ServiceException extends Exception{
public ServiceException(){
super();
}
public ServiceException(String msg){
super(msg);
}
}
/**
* 異常捕獲處理
*/
@RestControllerAdvice
public class GlobalExceptionAdvice {
@ExceptionHandler(ServiceException.class)
public Result<Object> serviceException(ServiceException e) {
//Result.failure()是我們在些項目是自定義的統(tǒng)一返回
return Result.failure(e.getMessage());
}
}七、測試結果
測試代碼：
@GetMapping("/strategy")
@RateLimiter(time = 3,count = 1,limitType = LimitType.IP)
public String strategyTest(){
return "test";
}當訪問次數(shù)大于配置的限制時限制接口調用 ↓
正常結果 ↓
到此這篇關于使用Redis完成接口限流的過程的文章就介紹到這了,更多相關Redis接口限流內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要介紹了關于redis是如何實現(xiàn)隊列消息的ack的相關資料，文中介紹的非常詳細，需要的朋友可以參考借鑒，下面來一起看看吧。2017-04-04
這篇文章主要給大家介紹了關于Redis和Lua實現(xiàn)分布式限流器的相關資料，文中通過示例代碼介紹的非常詳細，對大家學習或者使用Redis和Lua具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧2019-06-06
Redis+Caffeine多級緩存數(shù)據(jù)一致性解決方案
兩級緩存Redis+Caffeine可以解決緩存雪等問題也可以提高接口的性能,但是可能會出現(xiàn)緩存一致性問題,如果數(shù)據(jù)頻繁的變更,可能會導致Redis和Caffeine數(shù)據(jù)不一致的問題,所以本文給大家介紹了Redis+Caffeine多級緩存數(shù)據(jù)一致性解決方案,需要的朋友可以參考下2024-12-12
這篇文章主要用趣味性的方法講解了redis是什么？并且和MYSQL的區(qū)別是什么，有對redis不太懂的小伙伴可以來看一下吧2020-12-12
緩存可以比喻為防彈衣，但如果沒有使用好這個防彈衣效果就會適得其反，所以要更好的使用緩存才能發(fā)揮出它的作用。本文詳細講解了緩存穿透/擊穿/雪崩以及其解決方法，感興趣的小伙伴可以學習一下這篇文章2021-09-09
這篇文章主要介紹了Redis如何統(tǒng)計用戶訪問量問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-07-07
這篇文章主要介紹了Redis中的動態(tài)字符串學習教程,以sds模塊的使用為主進行講解,需要的朋友可以參考下2015-08-08
這篇文章主要介紹了Redis在windows環(huán)境下如何啟動的實現(xiàn)方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2025-04-04
Redis increment 函數(shù)處理并發(fā)序列號案例
這篇文章主要介紹了Redis increment 函數(shù)處理并發(fā)序列號案例,本文通過實例代碼給大家介紹的非常詳細,感興趣的朋友跟隨小編一起看看吧2024-08-08
這篇文章主要介紹了Redis上實現(xiàn)分布式鎖以提高性能的方案研究,其中重點需要理解異步算法與鎖的自動釋放,需要的朋友可以參考下2015-12-12