springboot和redis控制单位时间内同个ip访问同个接口的次数

注：本文中的修改于网上一个错误的例子，不知道为什么一个错误的例子还被人疯狂转载，还都标着原创。。。具体是那个这里就不指出了！

第一步：自定义一个注解

注：其实完全没必要（这样做的唯一好处就是每个接口与的访问限制次数都可以不一样）。。但是注解这个东西自从培训结束后没有在用到过，决定还是再复习下

package com.mzd.redis_springboot_mybatis_mysql.limit;

import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;

import java.lang.annotation.*;

/**
 * @Retention：注解的保留位置
 * @Retention(RetentionPolicy.SOURCE) //注解仅存在于源码中，在class字节码文件中不包含
 * @Retention(RetentionPolicy.CLASS) // 默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得，
 * @Retention(RetentionPolicy.RUNTIME) // 注解会在class字节码文件中存在，在运行时可以通过反射获取到
 */
@Retention(RetentionPolicy.RUNTIME)
/**
 * @Target:注解的作用目标
 * @Target(ElementType.TYPE)   //接口、类、枚举、注解
 * @Target(ElementType.FIELD) //字段、枚举的常量
 * @Target(ElementType.METHOD) //方法
 * @Target(ElementType.PARAMETER) //方法参数
 * @Target(ElementType.CONSTRUCTOR)  //构造函数
 * @Target(ElementType.LOCAL_VARIABLE)  //局部变量
 * @Target(ElementType.ANNOTATION_TYPE)  //注解
 * @Target(ElementType.PACKAGE) ///包
 */
@Target(ElementType.METHOD)
/**
 * @Document 说明该注解将被包含在javadoc中
 */
@Documented
/**
 * Ordered接口是由spring提供的，为了解决相同接口实现类的优先级问题
 */
//最高优先级- - - 个人觉得这个在这里没必要加
//@order，使用注解方式使类的加载顺序得到控制
@Order(Ordered.HIGHEST_PRECEDENCE)
public @interface RequestTimes {
    //单位时间允许访问次数 - - -默认值是2
    int count() default 2;

    //设置单位时间为1分钟 - - - 默认值是1分钟
    long time() default 60 * 1000;

}

Ordered:

1、接口内容：我们可以打开这个接口查看它的源码

这里写图片描述

我们可以看到这个接口中只有一个方法两个属性，一个是int的最小值，另一个是int的最大值

2、OrderComparator接口： PriorityOrdered是个接口，是Ordered接口的子类，并没有实现任何方法

这里写图片描述

这个Comparator方法的逻辑大致是：

PriorityOrdered的优先级高于Ordered
如果两个都是Ordered或者PriorityOrdered就比较他们的order值，order值越大，优先级越小

第二步：定义一个aop

package com.mzd.redis_springboot_mybatis_mysql.limit;

import com.mzd.redis_springboot_mybatis_mysql.bean.generator.Student;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util.concurrent.TimeUnit;

//使用@Aspect注解将一个java类定义为切面类
@Aspect
@Component
public class RequestTimesAop {
    @Autowired
    private RedisTemplate<String, String> redisTemplate;
    //切面范围
    @Pointcut("execution(public * com.mzd.redis_springboot_mybatis_mysql.controller.*.*(..))")
    public void WebPointCut() {
    }

    @Before("WebPointCut() && @annotation(times)")
    /**
     * JoinPoint对象封装了SpringAop中切面方法的信息,在切面方法中添加JoinPoint参数,就可以获取到封装了该方法信息的JoinPoint对象.
     */
    public void ifovertimes(final JoinPoint joinPoint, RequestTimes times) {
        try {
            //java.lang.Object[] getArgs()：获取连接点方法运行时的入参列表；
            //Signature getSignature() ：获取连接点的方法签名对象；
            //java.lang.Object getTarget() ：获取连接点所在的目标对象；
            //java.lang.Object getThis() ：获取代理对象本身；
            //####################################################################
            /**
             * 比如：获取连接点方法运行时的入参列表
             *  不足：如果连接点方法中没有request参数的话，就没法获取request，如果不做处理的话，会报空指针异常的
             *  但是所有请求怎么可能没有request
             */
//            Object[] objects = joinPoint.getArgs();
//            HttpServletRequest request = null;
//            for (int i = 0; i < objects.length; i++) {
//                if (objects[i] instanceof HttpServletRequest) {
//                    request = (HttpServletRequest) objects[i];
//                    break;
//                }
//            }
            //####################################################################
            /**
             * 另一种获取request
             */
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = attributes.getRequest();
            String ip = request.getRemoteAddr();
            String url = request.getRequestURL().toString();
            String key = "ifovertimes".concat(url).concat(ip);
            //访问次数加一
            long count = redisTemplate.opsForValue().increment(key, 1);
            //如果是第一次，则设置过期时间
            if (count == 1) {
                redisTemplate.expire(key, times.time(), TimeUnit.MILLISECONDS);
            }
            if (count > times.count()) {
                request.setAttribute("ifovertimes", "true");
            } else {
                request.setAttribute("ifovertimes", "false");
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

提问：就是在aop方法中返回的值在controller层值如何才能获得，比如：ifovertimes这个方法返回的String类型的值，那我在controller层如何获得这个值。我现在是将这个值放在了request域里面，不知道有没有别的更好的值。。。求大神帮助啊。。。

第三步：写一个测试接口

    @RequestTimes(count = 3, time = 60000)
    @RequestMapping("hello.do")
    public String hello(String username, HttpServletRequest request) {
        System.out.println(request.getAttribute("ifovertimes"));
        if (request.getAttribute("ifovertimes").equals("false")) {
            System.out.println(username);
            return "hello redis_springboot_mybatis_mysql";
        }
        return "HTTP请求超出设定的限制";
    }

总结：这是一个完全可以跑的例子，当然，springboot集成redis这里就不讲了。。。

springboot和redis控制单位时间内同个ip访问同个接口的次数

猜你喜欢