JAVA自定义注解实现接口/ip限流的示例代码

 更新时间:2023年07月28日 15:18:53   作者:二月二_  
本文主要介绍了JAVA自定义注解实现接口/ip限流的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

基本步骤:

1.自定义注解 @RateLimiter,添加属性:key(redis中key前缀)、time(redis中key过期时间,单位秒)、count(time中定义时间段内可以访问的次数),limitType(限流类型:1.限制接口;2.限制ip)

2.创建AOP,定义前置通知,获取@RateLimiter注解上的各项值,客户端每访问一次接口,redis中存储的current(当前时间段内已访问的次数)值+1,若current值大于count规定的值,抛出异常,提示到达允许访问的次数;

具体代码如下:

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- redis json序列化 -->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.datatype</groupId>
            <artifactId>jackson-datatype-jsr310</artifactId>
        </dependency>
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.8.9</version>
        </dependency>

1.创建枚举类,定义限流类型

public enum LimitType {
    /**
     * 默认限流策略,针对某一个接口进行限流
     */
    DEFAULT,
    /**
     * 根据IP地址进行限流
     */
    IP;
}

2.自定义注解@RateLimiter

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface RateLimiter {
    /**
     * 定义redis中限流key前缀 rate_limit:com.xxx.controller.HelloController-hello //HelloController中的hello方法
     */
    String key() default "rate_limit:";
    /**
     * 限流时间,单位秒
     * @return
     */
    int time() default 60;
    /**
     * 限流时间内限流次数
     * @return
     */
    int count() default 100;
    /**
     * 限流类型:1.限制接口访问次数 2.限制ip访问次数
     * @return
     */
    LimitType limitType() default LimitType.DEFAULT;
}

3.创建lua脚本,保证redis中操作原子性(在resources/lua目录下创建rateLimit.lua文件)

---定义变量:redis中key值,redis中过期时间,规定的时间段内访问次数,当前访问次数
local key = KEYS[1]
local time = tonumber(ARGV[1])
local count = tonumber(ARGV[2])
local current = redis.call('get',key)
if current and tonumber(current) > count then ---如果current不为空当前访问次数大于规定时间段内的访问次数
    return tonumber(current)  ---返回当前访问的次数
end
    current = redis.call('incr',key)    --- 若没超过限制次数,当前次数+1(自增)
if tonumber(current)==1 then
    redis.call('expire',key,time)       --- 如果当前访问次数=1,表示第一次访问,设置当前key的过期时间
end
    return tonumber(current)        --返回tonumber(current)

4.创建配置类,解决redis序列化与读取lua脚本

@Configuration
public class RedisConfig {
    //Redis序列化
    @Bean
    public RedisTemplate<String, Object> redisTemplate(LettuceConnectionFactory redisConnectionFactory) {
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory);
        //首先解决key的序列化方式
        StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
        redisTemplate.setKeySerializer(stringRedisSerializer);
        //解决value的序列化方式
        Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<>(Object.class);
        //序列化时将类的数据类型存入json,以便反序列化的时候转换成正确的类型
        ObjectMapper objectMapper = new ObjectMapper();
        //objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        objectMapper.activateDefaultTyping(LaissezFaireSubTypeValidator.instance, ObjectMapper.DefaultTyping.NON_FINAL);
        // 解决jackson2无法反序列化LocalDateTime的问题
        objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
        objectMapper.registerModule(new JavaTimeModule());
        jackson2JsonRedisSerializer.setObjectMapper(objectMapper);
        redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);
        return redisTemplate;
    }
    /**
     * 定义lua脚本
     */
    @Bean
    public DefaultRedisScript<Long> limitScript(){
        DefaultRedisScript<Long> script = new DefaultRedisScript<>();
        script.setResultType(Long.class);//设置lua脚本返回值类型 需要同lua脚本中返回值一致
        script.setScriptSource(new ResourceScriptSource(new ClassPathResource("lua\\rateLimit.lua")));//读取lua文件
        return script;
    }
}

5.自定义限流异常与全局异常

//自定义限流异常
public class RateLimitException extends RuntimeException{
    private Integer code;
    private String msg;
    public RateLimitException(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }
    public Integer getCode() {
        return code;
    }
    public void setCode(Integer code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
}
//全局异常
@RestControllerAdvice
public class GlobalException {
    @ExceptionHandler(RateLimitException.class)
    public Map rateLimit(RateLimitException e){
        Map<String, Object> map = new HashMap<>();
        map.put("code",e.getCode());
        map.put("msg",e.getMsg());
        return map;
    }
}

6.创建切面,进行限流操作

@Aspect
@Component
public class RateLimitAspect {
    private static final Logger logger= LoggerFactory.getLogger(RateLimitAspect.class);
    @Autowired
    RedisTemplate<String,Object> redisTemplate;
    @Autowired
    RedisScript<Long> redisScript; //实现类为DefaultRedisScript<Long> limitScript()
    @Pointcut("@annotation(com.xxx.annotation.RateLimiter)")
    public void pointCut(){}
    @Before("pointCut()")
    public void beforeRateLimit(JoinPoint jp){
        //获取RateLimiter注解上的值
        MethodSignature methodSignature = (MethodSignature) jp.getSignature();
        RateLimiter rateLimiter = AnnotationUtils.findAnnotation(methodSignature.getMethod(), RateLimiter.class);
        int time = rateLimiter.time();
        int count = rateLimiter.count();
        //构建redis中的key值
        String rateKey=getRateLimitKey(rateLimiter,methodSignature);
        System.out.println("redis中key值:"+rateKey);
        try {
            Long current = redisTemplate.execute(redisScript, Collections.singletonList(rateKey), time, count);
            if(current==null||current.intValue()>count){
                logger.info("当前接口达到最大限流次数");
                throw new RateLimitException(500,"当前接口达到最大限流次数");
            }
            logger.info("一段时间内允许的请求次数:{},当前请求次数:{},缓存的key为:{}",count,current,rateKey);
        } catch (Exception e) {
            throw e;
        }
    }
    /**
     * redis中key两种类型格式为:
     * 1.  rate_limit:com.xxx.controller.HelloController-hello
     * 2.  rate_limit:127.0.0.1-com.xxx.controller.HelloController-hello
     * @param rateLimiter
     * @param methodSignature
     * @return
     */
    private String getRateLimitKey(RateLimiter rateLimiter, MethodSignature methodSignature) {
        StringBuffer key = new StringBuffer(rateLimiter.key());
        if(rateLimiter.limitType()== LimitType.IP){//如果参数类型为IP
            //获取客户端ip
            String clientIP = ServletUtil.getClientIP(((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest());
            key.append(clientIP+"-");
        }
        Method method = methodSignature.getMethod();
        //获取全类名
        String className = method.getDeclaringClass().getName();
        //获取方法名
        String methodName = method.getName();
        key.append(className)
                .append("-")
                .append(methodName);
        System.out.println("全类名+方法名 "+className+"-"+methodName);
        return key.toString();
    }
}

7.创建接口,进行验证

@RestController
public class HelloController {
    @GetMapping("/hello")
    @RateLimiter(time = 10,count = 3,limitType = LimitType.DEFAULT) //10秒内允许访问三次
    public String hello(){
        return "hello";
    }
}

gitee开源地址:

RateLimiter: JAVA自定义注解实现接口/ip限流

到此这篇关于JAVA自定义注解实现接口/ip限流的示例代码的文章就介绍到这了,更多相关JAVA 接口/ip限流内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java简单实现SpringMVC+MyBatis分页插件

    Java简单实现SpringMVC+MyBatis分页插件

    自己最近搭建的一个SpringMVC+Mybatis的框架 属于无实体类的框架 并实现了Myabtis的自动分页和总数查询 只要传入分页参数便能自动查询总数和分页 总数封装在参数里面执行查询后可以直接从参数中获取
    2015-09-09
  • springboot读取resources下文件的方式详解

    springboot读取resources下文件的方式详解

    最近写读取模板文件做一些后续的处理,将文件放在了项目的resources下,发现了一个好用的读取方法,下面这篇文章主要给大家介绍了关于springboot读取resources下文件的相关资料,需要的朋友可以参考下
    2022-06-06
  • 使用Java实现串口通信

    使用Java实现串口通信

    这篇文章主要为大家详细介绍了使用Java实现串口通信的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-12-12
  • jar包打包成exe安装包的实现

    jar包打包成exe安装包的实现

    本文主要介绍了jar包打包成exe安装包的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-07-07
  • SpringBoot打印启动时异常堆栈信息详解

    SpringBoot打印启动时异常堆栈信息详解

    在本篇文章里小编给大家整理的是关于SpringBoot打印启动时异常堆栈信息,有需要的朋友们可以学习下。
    2019-11-11
  • Java实现前端jsencrypt.js加密后端解密的示例代码

    Java实现前端jsencrypt.js加密后端解密的示例代码

    这篇文章主要为大家详细介绍了如何利用jsencrypt.js实现前端加密,利用Java实现后端解密的功能,文中的示例代码讲解详细,需要的可以参考一下
    2022-09-09
  • Java之BigDecimal的坑及解决

    Java之BigDecimal的坑及解决

    这篇文章主要介绍了Java之BigDecimal的坑及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • SpringBoot调用第三方接口的几种方式小结

    SpringBoot调用第三方接口的几种方式小结

    在项目中调用第三方接口时,确实需要根据项目的技术栈、架构规范以及具体的业务需求来选择最适合的调用方式,下面我们就介绍几种调用第三方接口的实现方式以及代码示例,需要的朋友可以参考下
    2024-07-07
  • Struts2实现文件下载功能代码分享(文件名中文转码)

    Struts2实现文件下载功能代码分享(文件名中文转码)

    这篇文章主要介绍了Struts2实现文件下载功能代码分享(文件名中文转码)的相关资料,需要的朋友可以参考下
    2016-06-06
  • 使用Mybatis遇到的坑之Integer类型参数的解读

    使用Mybatis遇到的坑之Integer类型参数的解读

    这篇文章主要介绍了使用Mybatis遇到的坑之Integer类型参数的解读,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03

最新评论