SpringCloud+Redis实现Api接口限流防止恶意刷接口

 更新时间:2024年03月07日 15:19:38   作者:12程序猿  
接口限流是为了保护系统和服务,防止因为过多的请求而崩溃,本文主要介绍了SpringCloud+Redis实现Api接口限流防止恶意刷接口,具有一定的参考价值,感兴趣的可以了解一下

一、API接口防刷

顾名思义,想让某个接口某个人在某段时间内只能请求N次。

二、原理

在请求的时候,服务器通过Redis记录你请求的次数,如果次数超过限制就不给访问。
在redis保存的key是有失效的,过期就会删除。

三、api限流的场景

限流的需求出现在许多常见的场景中:

  • 秒杀活动,有人使用软件恶意刷单抢货,需要限流防止机器参与活动
  • 某api被各式各样系统广泛调用,严重消耗网络、内存等资源,需要合理限流
  • 淘宝获取ip所在城市接口、微信公众号识别微信用户等开发接口,免费提供给用户时需要限流,更具有实时性和准确性的接口需要付费。

四、api限流代码实现

使用自定义注解的方式实现

1.添加依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
   <groupId>org.springframework.cloud</groupId>
   <artifactId>spring-cloud-starter-bootstrap</artifactId>
   <version>3.1.5</version>
</dependency>
<!--nacos 服务注册中心-->
<dependency>
   <groupId>com.alibaba.cloud</groupId>
   <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
   <version>2021.1</version>
</dependency>
<!--nacos 配置中心-->
<dependency>
   <groupId>com.alibaba.cloud</groupId>
   <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
   <version>2021.1</version>
</dependency>
<!--redis 依赖-->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

2.添加自定义AccessLimit注解

package com.example.demo.aop;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 自定义接口:api接口限流
 * @author qzz
 * @date 2024/1/11
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface AccessLimit {
    /**
     * 时间间隔(单位秒)
     * @return
     */
    int seconds() default 60;

    /**
     * 最大访问次数
     * @return
     */
    int maxCount() default 60;

    /**
     * 是否需要登录
     * @return
     */
    boolean needLogin() default true;
}

3.添加AccessLimitIntercepter拦截器

自定义一个拦截器,请求之前,进行请求次数校验

package com.example.demo.intercepter;

import com.alibaba.fastjson.JSON;
import com.example.demo.aop.AccessLimit;
import com.example.demo.enums.CodeMsg;
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.IOException;
import java.io.OutputStream;
import java.lang.reflect.Method;
import java.nio.charset.StandardCharsets;
import java.util.concurrent.TimeUnit;

/**
 * 限制访问拦截器
 * @author qzz
 * @date 2024/1/12
 */
@Slf4j
@Component
public class AccessLimitIntercepter implements HandlerInterceptor {
    private RedisTemplate<String,Object> redisTemplate;

    @Autowired
    public AccessLimitIntercepter(RedisTemplate<String,Object> redisTemplate){
        this.redisTemplate = redisTemplate;
    }

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //方法请求拦截    Handler 是否为 HandlerMethod 实例
        if(handler instanceof HandlerMethod){
            HandlerMethod hm = (HandlerMethod) handler;

            // 获取方法
            Method method = hm.getMethod();
            // 是否有AccessLimit注解
            if (!method.isAnnotationPresent(AccessLimit.class)) {
                return true;
            }
            //获取方法中的AccessLimit注解
            AccessLimit accessLimit = hm.getMethodAnnotation(AccessLimit.class);
            if(accessLimit == null){
                return true;
            }
            int seconds = accessLimit.seconds();
            int maxCount = accessLimit.maxCount();
            boolean needLogin = accessLimit.needLogin();
            String key=request.getRequestURI();
            //判断是否登录
            if(needLogin){
                //获取登录的session进行判断
                //...
                //获取用户id
                Long userId = 1L;
                key+=userId;
            }
            //从redis中获取用户访问的次数
            Object count = redisTemplate.opsForValue().get(key);
            log.info("count:{}",count);
            if(count == null){
                //第一次访问
                redisTemplate.opsForValue().set(key,1, Long.valueOf(String.valueOf(seconds)), TimeUnit.SECONDS);
                log.info("--------------------------第一次访问--------------------------");
            }else if(count!=null && Integer.valueOf(String.valueOf(count)) < maxCount){
                //次数自增
                redisTemplate.opsForValue().increment(key,1);
                log.info("--------------------------次数自增--------------------------");
            }else{
                //超出访问次数
                render(response, CodeMsg.ACCESS_LIMIT_REACHED);
                return false;
            }
        }
        return true;
    }

    private void render(HttpServletResponse response, CodeMsg codeMsg) throws IOException {
        response.setContentType("application/json;charset=UTF-8");
        OutputStream outputStream = response.getOutputStream();
        String str = JSON.toJSONString(codeMsg);
        outputStream.write(str.getBytes(StandardCharsets.UTF_8));
        outputStream.flush();
        outputStream.close();
    }
}

拦截器写好了,但是还得添加注册

4.WebConfig配置类

如果是Springboot的版本是2.*,只需要实现WebMvcConfigurer,然后重写addInterceptors()方法,添加自定义拦截器即可。

如果是Springboot的版本是1.*,只需要实现WebMvcConfigurerAdapter,然后重写addInterceptors()方法,添加自定义拦截器即可。

我的版本是2.4.6,所以代码如下:

package com.example.demo.config;

import com.example.demo.intercepter.AccessLimitIntercepter;
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.WebMvcConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

/**
 * @author qzz
 * @date 2024/1/12
 */
@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private AccessLimitIntercepter accessLimitIntercepter;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //添加拦截器
        registry.addInterceptor(accessLimitIntercepter);
    }
}

5.controller控制层测试接口

使用方式:在方法上使用注解@AccessLimit(seconds = 5, maxCount = 5, needLogin = true)

默认5秒内,每个接口只能请求5次

package com.example.demo.controller;

import com.example.demo.aop.AccessLimit;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 拦截器注册
 * @author qzz
 * @date 2024/1/11
 */
@RestController
public class TestController {

    @AccessLimit(seconds = 5, maxCount = 5, needLogin = true)
    @RequestMapping("test/api/limit")
    public String testApiLimit(){
        return "test api limit";
    }
}

五、完整代码

代码点击此处下载

到此这篇关于SpringCloud+Redis实现Api接口限流防止恶意刷接口的文章就介绍到这了,更多相关SpringCloud Redis Api接口限流内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • spring NamedContextFactory在Fegin配置及使用详解

    spring NamedContextFactory在Fegin配置及使用详解

    在我们日常项目中,使用FeignClient实现各系统接口调用变得更加简单, 在各个系统集成过程中,难免会遇到某些系统的Client需要特殊的配置、返回读取等需求。Feign使用NamedContextFactory来为每个Client模块构造单独的上下文(ApplicationContext)
    2023-11-11
  • MyBatis无缝对接Spring的方法

    MyBatis无缝对接Spring的方法

    Spring框架与MyBatis框架是Java互联网技术的主流框架。那么mybatis如何无缝对接spring呢?下面通过本文给大家介绍,需要的的朋友参考下吧
    2017-09-09
  • 基于MapperXML扫描的问题

    基于MapperXML扫描的问题

    这篇文章主要介绍了MapperXML扫描的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10
  • java环境中的JDK、JVM、JRE详细介绍

    java环境中的JDK、JVM、JRE详细介绍

    这篇文章主要介绍了java环境中的JDK、JVM、JRE详细介绍的相关资料,对于初学者还是有必要了解下,细致说明他们是什么,需要的朋友可以参考下
    2016-11-11
  • mybatis-plus复合主键的使用

    mybatis-plus复合主键的使用

    本文主要介绍了mybatis-plus复合主键的使用,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-03-03
  • Java使用位运算实现加减乘除详解

    Java使用位运算实现加减乘除详解

    这篇文章主要为大家详细介绍了Java如何使用位运算实现加减乘除,文中的示例代码讲解详细,对我们深入了解Java有一定的帮助,感兴趣的可以了解一下
    2023-05-05
  • mybatis-plus报错Not Found TableInfoCache异常问题

    mybatis-plus报错Not Found TableInfoCache异常问题

    在集成百度uid-generator过程中,MyBatis-Plus报错NotFoundTableInfoCache异常,解决方法:检查实体类是否继承了官方model,确保实体类对应的mapper已正确注入,在使用@Component注解时,应保证相关依赖已注入
    2024-09-09
  • SpringMVC中RequestBody注解的List参数传递方式

    SpringMVC中RequestBody注解的List参数传递方式

    这篇文章主要介绍了SpringMVC中RequestBody注解的List参数传递方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-10-10
  • Intellij IDEA命令行执行java无法加载主类解决方案

    Intellij IDEA命令行执行java无法加载主类解决方案

    这篇文章主要介绍了Intellij IDEA命令行执行java无法加载主类解决方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-09-09
  • Java日期工具类操作字符串Date和LocalDate互转

    Java日期工具类操作字符串Date和LocalDate互转

    这篇文章主要介绍了Java日期工具类操作字符串Date和LocalDate互转,文章首先通过需要先引入坐标展开主题的相关内容介绍,需要的朋友可以参一下
    2022-06-06

最新评论