Springboot+Redis實現API接口限流的示例代碼

更新時間：2021年07月28日 08:46:35 作者：· Coisini

本文主要介紹了Springboot+Redis實現API接口限流的示例代碼，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下

添加Redis的jar包.

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

在application.yml中配置redis

spring:
  ## Redis
    redis:
      database: 0
      host: 127.0.0.1
      port: 6379
      password:
      jedis:
        pool:
          max-active: 8
          max-wait: -1ms
          max-idle: 8
          min-idle: 0
      timeout: 2000ms

添加自定義注解

@Inherited
@Documented
@Target({ElementType.FIELD,ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface AccessLimit {

    //指定second 時間內 API請求次數
    int times() default 4;

    // 請求次數的指定時間范圍  秒數(redis數據過期時間)
    int second() default 10;
}

編寫攔截器

import com.ys.xlb.annotation.AccessLimit;
import com.ys.xlb.bean.Code;
import com.ys.xlb.exception.GlobalException;
import com.ys.xlb.utils.IpUtils;
import com.ys.xlb.utils.RequestUtils;
import com.ys.xlb.utils.ResultUtils;
import lombok.extern.slf4j.Slf4j;
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 org.springframework.web.servlet.ModelAndView;

import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Method;
import java.util.concurrent.TimeUnit;

/**
 * @ClassName AccessLimitInterceptor
 * @description: API請求限流攔截器
 * @time 2019-04-20 11:08
 **/
@Slf4j
@Component
public class AccessLimitInterceptor implements HandlerInterceptor {

    @Resource
    private RedisTemplate<String, Integer> redisTemplate;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        try{
            // Handler 是否為 HandlerMethod 實例
            if(handler instanceof HandlerMethod){
                // 強轉
                HandlerMethod handlerMethod = (HandlerMethod) handler;
                // 獲取方法
                Method method = handlerMethod.getMethod();
                // 是否有AccessLimit注解
                if(!method.isAnnotationPresent(AccessLimit.class)){
                    return true;
                }
                // 獲取注解內容信息
                AccessLimit accessLimit = method.getAnnotation(AccessLimit.class);
                if(accessLimit == null){
                    return true;
                }
                int times = accessLimit.times();//請求次數
                int second = accessLimit.second();//請求時間范圍
                //根據 IP + API 限流
                String key = IpUtils.getIpAddr(request) + request.getRequestURI();
                //根據key獲取已請求次數
                Integer maxTimes = redisTemplate.opsForValue().get(key);
                if(maxTimes == null){
                    //set時一定要加過期時間
                    redisTemplate.opsForValue().set(key, 1, second, TimeUnit.SECONDS);
                }else if(maxTimes < times){
                    redisTemplate.opsForValue().set(key, maxTimes+1, second, TimeUnit.SECONDS);
                }else{
                    // 30405 API_REQUEST_TOO_MUCH  請求過于頻繁
                    RequestUtils.out(response, ResultUtils.error(Code.API_REQUEST_TOO_MUCH));
                    return false;
                }
            }
        }catch (Exception e){
            log.error("API請求限流攔截異常,請檢查Redis是否開啟!",e);
            throw new GlobalException(Code.BAD_REQUEST,e.getMessage());
        }
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }
}

方法中的IP工具類方法

 /**
     * IpUtils工具類方法
     * 獲取真實的ip地址
     * @param request
     * @return
     */
    public static String getIpAddr(HttpServletRequest request) {
        String ip = request.getHeader("X-Forwarded-For");
        if(org.apache.commons.lang.StringUtils.isNotEmpty(ip) && !"unKnown".equalsIgnoreCase(ip)){
            //多次反向代理后會有多個ip值，第一個ip才是真實ip
            int index = ip.indexOf(",");
            if(index != -1){
                return ip.substring(0,index);
            }else{
                return ip;
            }
        }
        ip = request.getHeader("X-Real-IP");
        if(org.apache.commons.lang.StringUtils.isNotEmpty(ip) && !"unKnown".equalsIgnoreCase(ip)){
            return ip;
        }
        return request.getRemoteAddr();
    }

RequestUtils.out()方法

 /**
     * @Title: out
     * @Description:  response輸出JSON數據
     * @param response : 響應請求
     * @param object: object
     * @return void
     **/
    public static void out(ServletResponse response, Object object){
        PrintWriter out = null;
        try {
            response.setContentType("application/json;charset=UTF-8");
            response.setCharacterEncoding("UTF-8");
            out = response.getWriter();
            out.println(JSONObject.fromObject(resultMap).toString());
        } catch (Exception e) {
            log.error("輸出JSON報錯!"+e);
        }finally{
            if(null != out){
                out.flush();
                out.close();
            }
        }
    }

配置攔截器

@Configuration
public class ApplicationConfig implements WebMvcConfigurer {

 //這里需要注入攔截器 否則無法獲取到攔截器注入的RedisTemplate<String, Integer> redisTemplate; 
 @Bean
    public AccessLimitInterceptor accessLimitInterceptor(){
        return new AccessLimitInterceptor();
    }

 /**
     * 配置攔截器
     * @author lance
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/**").excludePathPatterns("/static/**","/login.html","/user/login");
        //API限流攔截
        registry.addInterceptor(accessLimitInterceptor()).addPathPatterns("/**").excludePathPatterns("/static/**","/login.html");
    }
}

配置攔截器的類中必須先注入這個攔截器否則無法獲取到攔截器注入的RedisTemplate<String, Integer> redisTemplate

使用注解

/**
     * @Title: selectAll
     * @Description: 查詢文章信息
     **/
    @AccessLimit(times = 5)
    @RequestMapping(value = "selectAll" , method = {RequestMethod.GET,RequestMethod.POST})
    //GetMapping(value = "selectAll")
    public ResultBody selectAll(Article article) {
        return articleService.selectAll(article);
    }

請求測試

時間間隔為默認的10s, 10s內請求第6次出現此返回值,完成.

參考博客:
https://blog.csdn.net/zrg523/article/details/82185088

到此這篇關于Springboot+Redis實現API接口限流的示例代碼的文章就介紹到這了,更多相關Springboot+Redis接口API限流內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

Java中為何要使用ArrayList
這篇文章主要介紹了Java中為何要使用ArrayList，幫助大家更好的理解和學習Java，感興趣的朋友可以了解下
2020-09-09
spring?cloud中Feign導入jar失敗的問題及解決方案
這篇文章主要介紹了spring?cloud中Feign導入jar失敗的問題及解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
2022-03-03
Java線程的生命周期的詳解
這篇文章主要介紹了Java線程的生命周期的詳解的相關資料,希望通過本文能幫助到大家，讓大家理解掌握這部分內容，需要的朋友可以參考下
2017-10-10
Spring Boot實戰(zhàn)之模板引擎
這篇文章主要介紹了Spring Boot實戰(zhàn)之模板引擎，小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2018-05-05
java使用EasyExcel導入導出excel
導入導出excel數據是常見的需求，今天就來看一下Java基于EasyExcel實現這個功能，感興趣的朋友可以了解下
2021-05-05
Java代碼性能優(yōu)化的35個方法總結
本篇文章主要介紹了Java代碼性能優(yōu)化的35個方法，具有很好的參考價值，下面跟著小編一起來看下吧
2017-02-02
Spring Bean的線程安全問題
Spring容器中的Bean是否線程安全，本文主要介紹了Spring Bean的線程安全問題，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2022-06-06
SpringMVC高級開發(fā)功能實現過程解析
這篇文章主要介紹了SpringMVC高級開發(fā)功能實現過程解析,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下
2020-06-06
Java中上傳圖片壓縮處理的方法示例
本篇文章主要介紹了Java中圖片壓縮處理的方法示例，小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2017-02-02
動態(tài)代理模擬實現aop的示例
下面小編就為大家?guī)硪黄獎討B(tài)代理模擬實現aop的示例。小編覺得挺不錯的，現在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧，希望對大家有所幫助
2017-11-11