SpringBoot实现限流注解

绝地灬酷狼 2024-03-17 20:31 91阅读 0赞

在高并发系统中，保护系统的三种方式分别为：缓存，降级和限流。

限流的目的是通过对并发访问请求进行限速或者一个时间窗口内的的请求数量进行限速来保护系统，一旦达到限制速率则可以拒绝服务、排队或等待

### 1、限流类型枚举类 ###

<table> 
 <tbody> 
  <tr> 
   <td></td> 
   <td><code>/**</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* 限流类型</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* @author ss_419</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>*/</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>public enum LimitType { </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>/**</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* 默认的限流策略，针对某一个接口进行限流</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>*/</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>DEFAULT,</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>/**</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* 针对某一个IP进行限流</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>*/</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>IP</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
 </tbody> 
</table>

### 2、自定义限流注解 ###

<table> 
 <tbody> 
  <tr> 
   <td></td> 
   <td><code>/**</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* @author ss_419</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>*/</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>@Retention(RetentionPolicy.RUNTIME)</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>@Target(ElementType.METHOD)</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>public @interface RateLimiter { </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>/**</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* 限流的 key，主要是指前缀</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* @return</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>*/</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>String key() default "rate_limit:";</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>/**</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* 在时间窗内的限流次数</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* @return</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>*/</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>int count() default 100;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>/**</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* 限流类型</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* @return</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>*/</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>LimitType limitType() default LimitType.DEFAULT;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>/**</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* 限流时间窗</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* @return</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>*/</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>int time() default 60;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
 </tbody> 
</table>

### 3、限流lua脚本 ###

1、由于我们使用 Redis 进行限流，我们需要引入 Redis 的 maven 依赖，同时需要引入 aop 的依赖

<table> 
 <tbody> 
  <tr> 
   <td></td> 
   <td><code>&lt;!-- aop依赖 --&gt;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>&lt;dependency&gt;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>&nbsp; &nbsp; &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>&nbsp; &nbsp; &lt;artifactId&gt;spring-boot-starter-aop&lt;/artifactId&gt;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>&lt;/dependency&gt;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>&lt;!-- redis依赖 --&gt;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>&lt;dependency&gt;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>&nbsp; &nbsp; &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>&nbsp; &nbsp; &lt;artifactId&gt;spring-boot-starter-data-redis&lt;/artifactId&gt;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>&lt;/dependency&gt;</code></td> 
  </tr> 
 </tbody> 
</table>

2、配置redis以及lua脚本

<table> 
 <tbody> 
  <tr> 
   <td></td> 
   <td><code>@Configuration</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>public class RedisConfig { </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>@Bean</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>RedisTemplate&lt;Object,Object&gt; redisTemplate(RedisConnectionFactory factory) { </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>RedisTemplate&lt;Object, Object&gt; template = new RedisTemplate&lt;&gt;();</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>template.setConnectionFactory(factory);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>template.setKeySerializer(jackson2JsonRedisSerializer);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>template.setValueSerializer(jackson2JsonRedisSerializer);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>template.setHashKeySerializer(jackson2JsonRedisSerializer);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>template.setHashValueSerializer(jackson2JsonRedisSerializer);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>return template;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>/**</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* 读取lua脚本</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* @return</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>*/</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>@Bean</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>DefaultRedisScript&lt;Long&gt; limitScript() { </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>DefaultRedisScript&lt;Long&gt; script = new DefaultRedisScript&lt;&gt;();</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>script.setResultType(Long.class);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>script.setScriptSource(new ResourceScriptSource(new ClassPathResource("lua/limit.lua")));</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>return script;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
 </tbody> 
</table>

通过 Lua 脚本，根据 Redis 中缓存的键值判断限流时间（也是 key 的过期时间）内，访问次数是否超出了限流次数，没超出则访问次数 +1，返回 true，超出了则返回 false。  
limit.lua:

<table> 
 <tbody> 
  <tr> 
   <td></td> 
   <td><code>local key = KEYS[1]</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>local time = tonumber(ARGV[1])</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>local count = tonumber(ARGV[2])</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>local current = redis.call('get', key)</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>if current and tonumber(current) &gt; count then</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>return tonumber(current)</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>end</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>current = redis.call('incr', key)</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>if tonumber(current) == 1 then</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>redis.call('expire', key, time)</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>end</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>return tonumber(current)</code></td> 
  </tr> 
 </tbody> 
</table>

### 4、限流切面处理类 ###

1、使用我们刚刚的 Lua 脚本判断是否超出了限流次数，超出了限流次数后返回一个自定义异常，然后在全局异常中去捕捉异常，返回 JSON 数据。

2、根据注解参数，判断限流类型，拼接缓存 key 值

<table> 
 <tbody> 
  <tr> 
   <td></td> 
   <td><code>package org.pp.ratelimiter.aspectj;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.aspectj.lang.JoinPoint;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.aspectj.lang.annotation.Aspect;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.aspectj.lang.annotation.Before;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.aspectj.lang.reflect.MethodSignature;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.pp.ratelimiter.annotation.RateLimiter;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.pp.ratelimiter.enums.LimitType;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.pp.ratelimiter.exception.RateLimitException;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.pp.ratelimiter.utils.IpUtils;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.slf4j.Logger;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.slf4j.LoggerFactory;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.springframework.beans.factory.annotation.Autowired;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.springframework.data.redis.core.RedisTemplate;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.springframework.data.redis.core.script.RedisScript;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.springframework.stereotype.Component;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.springframework.web.context.request.RequestContextHolder;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.springframework.web.context.request.ServletRequestAttributes;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import java.lang.reflect.Method;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import java.util.Collections;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>@Aspect</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>@Component</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>public class RateLimiterAspect { </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>private static final Logger logger = LoggerFactory.getLogger(RateLimiterAspect.class);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>@Autowired</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>RedisTemplate&lt;Object, Object&gt; redisTemplate;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>@Autowired</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>RedisScript&lt;Long&gt; redisScript;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>@Before("@annotation(rateLimiter)")</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>public void before(JoinPoint jp, RateLimiter rateLimiter) throws RateLimitException { </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>int time = rateLimiter.time();</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>int count = rateLimiter.count();</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>String combineKey = getCombineKey(rateLimiter, jp);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>try { </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>Long number = redisTemplate.execute(redisScript, Collections.singletonList(combineKey), time, count);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>if (number == null || number.intValue() &gt; count) { </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>//超过限流阈值</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>logger.info("当前接口以达到最大限流次数");</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>throw new RateLimitException("访问过于频繁，请稍后访问");</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>logger.info("一个时间窗内请求次数：{}，当前请求次数：{}，缓存的 key 为 {}", count, number, combineKey);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>} catch (Exception e) { </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>throw e;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>/**</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* 这个 key 其实就是接口调用次数缓存在 redis 的 key</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* rate_limit:11.11.11.11-org.javaboy.ratelimit.controller.HelloController-hello</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* rate_limit:org.javaboy.ratelimit.controller.HelloController-hello</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* @param rateLimiter</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* @param jp</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* @return</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>*/</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>private String getCombineKey(RateLimiter rateLimiter, JoinPoint jp) { </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>StringBuffer key = new StringBuffer(rateLimiter.key());</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>if (rateLimiter.limitType() == LimitType.IP) { </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>key.append(IpUtils.getIpAddr(((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest()))</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>.append("-");</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>MethodSignature signature = (MethodSignature) jp.getSignature();</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>Method method = signature.getMethod();</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>key.append(method.getDeclaringClass().getName())</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>.append("-")</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>.append(method.getName());</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>return key.toString();</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
 </tbody> 
</table>

### 5、使用与测试 ###

<table> 
 <tbody> 
  <tr> 
   <td></td> 
   <td><code>@RestController</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>public class HelloController { </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>/**</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* 限流 10 秒之内，这个接口可以访问3次</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* @return</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>*/</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>@GetMapping("/hello")</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>@RateLimiter(time = 10,count = 3)</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>public Map&lt;String, Object&gt; hello() { </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>Map&lt;String, Object&gt; map = new HashMap&lt;&gt;();</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>map.put("status", 200);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>map.put("message", "Hello RateLimiter");</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>return map;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
 </tbody> 
</table>

十秒之内访问次数超过3次就会报异常

![image][]

redis中的数据，每一次访问都加1

![image][image 1]

当访问次数超过3，则进行限流操作

![image][image 2]

[image]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/ac9735d12ec84c17889cd43fb2000f73.png
[image 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/34766cee14a14ce79f2fb6dc5d35ccc2.png
[image 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/16c1f0899d474d88b533e03ce2363886.png