【Redis】SpringAOP+Redis的TTL实现接口规定时间内限流

我就是我 2023-10-10 18:46 60阅读 0赞

此处需求是有一个获取验证码的接口，我们需要规定一分钟内只能访问一次，此时我们可以通过redis中key的过期时间以及setnx命令来进行接口规定时间内的限流，需求不同可根据需求进行调整选择其他redis结构与命令如set key value。首先我们需要使用SpringAOP对该接口进行拦截，请求到访问该接口时被改拦截器拦截，我们可以定义一个拦截器类实现 HandlerInterceptor 这个类并重写prehandle方法，该方法如果返回true则会继续访问目标接口，如果返回false则不进行继续访问，在该方法里我们先需要先获取用户IP，获取到用户IP后构建redis的key，然后通过setnx命令存入这个key并设置过期时间，如果存入成功则返回true，存入失败则说明以及被存入了，说明接口在过期时间内被访问过，此时拒绝继续访问该接口。

封装Java操作setnx方法

/** @param key 请求的key
         * @param value 请求的value
         * @param time 时间
         * @param unit 时间的单位
         * @return 如果请求已经被处理过，返回false；否则返回true并将value值存入缓存中
         * @throws JsonProcessingException
         */
        public static boolean isRequest(String key, Object value, Long time, TimeUnit unit) throws JsonProcessingException {
            String jsonValue = objectMapper.writeValueAsString(value); // 将请求参数序列化成JSON字符串
            Boolean isAbsent = stringRedisTemplate.opsForValue().setIfAbsent(key, jsonValue, time, unit); // 将请求参数存入缓存
            return Boolean.TRUE.equals(isAbsent); // 如果返回值为true，说明请求未被处理过，否则返回false
        }

拦截器类：

package com.example.demo.interceptor;
    import com.example.demo.common.RedisUtil;
    import org.springframework.web.servlet.HandlerInterceptor;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import java.util.concurrent.TimeUnit;
    /**
     * 接口访问限制拦截器
     */
    public class APILimitInterceptor implements HandlerInterceptor {
        /**
         * 拦截请求，判断接口访问是否受限
         * @param request HttpServletRequest对象
         * @param response HttpServletResponse对象
         * @param handler 请求处理器对象
         * @return true表示接口访问未受限，false表示接口访问受限
         * @throws Exception
         */
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
            // 获取IP
            String ip = request.getRemoteAddr();
            System.out.println("IP:" + ip);
            // 使用Redis进行接口访问限制，设置1分钟内访问次数不能超过1次
            String key = "limit:IP:" + ip;
            return RedisUtil.isRequest(key, 1, 1L, TimeUnit.MINUTES);
        }
    }

此时我们需要创建配置类将拦截器注入Spring，创建一个配置类实现WebMvcConfigurer接口重写

addInterceptors方法在该方法中配置要拦截的接口

package com.example.demo.configur;
    
    import com.example.demo.interceptor.APILimitInterceptor;
    import com.example.demo.interceptor.LoginInterceptor;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
    
    /**
     * 将拦截器配置入spring
     */
    @Configuration
    public class InterceptorConfig implements WebMvcConfigurer {
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            /**
             * 添加拦截规则
             */  
    
            registry.addInterceptor(new APILimitInterceptor())
                    .addPathPatterns("/user/code");                     // 限流接口
        }
    }

也可以拦截所有接口然后排除一些接口，排除的这些接口请求时不用通过拦截器excludePathPatterns（接口）,也可以排除一些前端页面以及css等