采用分布式限流解决接口限流的实现方案

采用分布式限流解决接口限流的实现方案

为防止用户刷接口，给服务器造成不必要的压力，对客户端进行请求限制，对每个用户的IP进行了限制。接口限流的方式有多种。这里介绍分布式限流：自定义注解+拦截器+Redis实现限流 (单体和分布式均适用，全局限流)，确保一定时间内，每个用户的请求次数收到限制。

一、具体流程

1. 添加一个拦截器，来拦截所有的请求。先判断接口是否需要限流，不需要则放行，需要则记录用户IP和接口的URI，存入Redis，Redis的key为interface-limit:ip:URI,value为该用户请求该接口的次数。
2. 当用户第一次请求时，value设置为1，过期时间为具体设置的限流时间，后续请求先判断key是否存在，不存在，当第一次请求处理。存在则取出该key对应的value，与具体设置的限流次数进行对比，若<=限流次数，value+1，否则进行限流，拒绝请求。

如何判断接口是否需要限流？

使用自定义注解，拦截器通过handlerMethod.getMethodAnnotation(InterfaceLimit.class)判断方法上是否有指定注解（@InterfaceLimit）。

二、代码实现

1.自定义注解**@InterfaceLimit**

import java.lang.annotation.*;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface InterfaceLimit {
    // 限流时间
    int time() default 10;

    // 限流次数
    int count() default 1;
}

2.拦截器

import com.example.interfacelimitdemo.controller.InterfaceLimit;
import com.example.interfacelimitdemo.utils.IpUtils;
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.Serializable;
import java.util.concurrent.TimeUnit;

@Slf4j
@Component
public class RateLimitInterceptor implements HandlerInterceptor {
    @Autowired
    private RedisTemplate<String, Serializable> redisTemplate;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 如果请求的是方法，需要进行校验
        if (handler instanceof HandlerMethod) {
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            // 获取目标方法上是否有指定注解
            InterfaceLimit interfaceLimit = handlerMethod.getMethodAnnotation(InterfaceLimit.class);
            if (interfaceLimit == null) {
                return true;
            }
            String ip = IpUtils.getIpAddress(request);
            String uri = request.getRequestURI();
            String key = "InterfaceLimit:" + ip + ":" + uri;
            // 在限流时间内已经访问过该接口
            if (Boolean.TRUE.equals(redisTemplate.hasKey(key))) {
                redisTemplate.opsForValue().increment(key, 1);
                Integer count = (Integer) redisTemplate.opsForValue().get(key);
                // 超出限流次数
                if (count > interfaceLimit.count()) {
                    throw new RuntimeException("限流了");
                }
            } else {
                // 第一次访问,过期时间为限流时间
                redisTemplate.opsForValue().set(key, 1, interfaceLimit.time(), TimeUnit.SECONDS);
            }
            return true;
        }
        //直接放行
        return true;
    }
}

3.将拦截器添加到spring中

import com.example.interfacelimitdemo.common.RateLimitInterceptor;
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.WebMvcConfigurerAdapter;

@Configuration
public class WebMvcConfigurer extends WebMvcConfigurerAdapter {
    @Autowired
    private RateLimitInterceptor rateLimitInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(rateLimitInterceptor);
    }
}

这里为什么要使用@Autowired呢？为什么将拦截器交给spring容器管理呢？如果不这样做的话，Redis注入为null，会报空指针。

因为拦截器加载是在Spring Context创建之前，所以主动注入的对象为null。

这里就要提到@Autowired注入对象为空的几种原因了

@Autowired注入对象为空

1.该类没有交给spring容器管理

解决办法：添加@Component注解

2.该类有被new出来的实例的，new 过的对象不会交给Spring容器管理

一般是指引用某些框架，你是继承某个接口，但是这些框架默认new过这个方法，比如MVC拦截的HandlerInterceptor类。

解决办法：在拦截器配置中将拦截器提前暴露，交给spring容器管理

显然这里是第二种情况，所以这就是为什么要使用@Autowired将拦截器交给spring容器管理的原因。

4.controller

@RestController
@RequestMapping("/v1/api/")
public class TestController {

    @Autowired
    private TestService testService;
    
    @GetMapping("limit")
    @InterfaceLimit(time = 20)
    public String limit(HttpServletRequest request){
        testService.limit(request);
        return "hello";
    }
}

在controller方法上加入自定义的注解，设置参数（次数和时间）。注解设置的默认次数为1，就不设置了。表明该方法20秒内同一个IP只能访问一次。
点击第一下

第二下，服务器错误
控制台抛出我们定义的异常

IP解析用的是ip2region工具。