15 springboot中使用自定义注解

一直不太明白自定义注解怎么运行的,今天正好试试,用于限制时间段内同一IP访问次数

import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import java.lang.annotation.*;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
//最高优先级
@Order(Ordered.HIGHEST_PRECEDENCE)
public @interface LijiaCheck {
    /**
     *
     * 允许访问的次数,默认值MAX_VALUE
     */
    int count() default Integer.MAX_VALUE;

    /**
     *
     * 时间段,单位为毫秒,默认值一分钟
     */
    long time() default 60000;
}

然后需要去写个AOP类去拦截访问

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.Map;
import java.util.Timer;
import java.util.TimerTask;
  
@Aspect  
@Component  
public class RequestLimitContract {
    private Logger logger = LoggerFactory.getLogger(getClass());
    private Map redisTemplate=new HashMap();

    @Before("within(@org.springframework.stereotype.Controller *) && @annotation(limit)")  
    public void requestLimit(final JoinPoint joinPoint, LijiaCheck limit) throws RequestLimitException {
        try {  
            Object[] args = joinPoint.getArgs();  
            HttpServletRequest request = null;  
            for (int i = 0; i < args.length; i++) {  
                if (args[i] instanceof HttpServletRequest) {  
                    request = (HttpServletRequest) args[i];  
                    break;  
                }  
            }  
            if (request == null) {  
                throw new RequestLimitException("方法中缺失HttpServletRequest参数");  
            }  
            String ip = request.getLocalAddr();  
            String url = request.getRequestURL().toString();  
            String key = "req_limit_".concat(url).concat(ip);  
            if(redisTemplate.get(key)==null || redisTemplate.get(key)==0){  
                redisTemplate.put(key,1);
                System.out.println(redisTemplate.get(key)+"========");
            }else{  
                redisTemplate.put(key,redisTemplate.get(key)+1);
                System.out.println(redisTemplate.get(key)+"========11111111");
            }  
            int count = redisTemplate.get(key);  
            if (count > 0) {
                Timer timer= new Timer();
                /**
                 * 创建一个新的计时器任务。
                 */
                TimerTask task  = new TimerTask(){
                    @Override
                    public void run() {
                        redisTemplate.remove(key);
                    }
                };
                timer.schedule(task, limit.time());
                //安排在指定延迟后执行指定的任务。task : 所要安排的任务。10000 : 执行任务前的延迟时间,单位是毫秒。
            }
            if (count > limit.count()) {  
                //logger.info("用户IP[" + ip + "]访问地址[" + url + "]超过了限定的次数[" + limit.count() + "]");  
                throw new RequestLimitException();  
            }  
        } catch (RequestLimitException e) {  
            throw e;  
        } catch (Exception e) {  
            logger.error("发生异常: ", e);  
        }  
    }  
}  

最后的异常类RequestLimitException

public class RequestLimitException extends Exception {
    private static final long serialVersionUID = 1364225358754654702L;  
  
    public RequestLimitException() {  
        super("HTTP请求超出设定的限制");  
    }  
  
    public RequestLimitException(String message) {  
        super(message);  
    }  
  
}  

最后写个Controller,把自定义注解放上去

@LijiaCheck(count=5,time=50000)
@RequestMapping("/urltest")
@ResponseBody
public String test(HttpServletRequest request, ModelMap modelMap) {
    return "aaa";
}

然后不断刷新通过访问url,超过5次,会出现自定义的异常


15 springboot中使用自定义注解_第1张图片

注解解释

@Target

@Target 说明了Annotation所修饰的对象范围,取值(ElementType)有:

  • 1.CONSTRUCTOR:用于描述构造器
  • 2.FIELD:用于描述域
  • 3.LOCAL_VARIABLE:用于描述局部变量
  • 4.METHOD:用于描述方法
  • 5.PACKAGE:用于描述包
  • 6.PARAMETER:用于描述参数
  • 7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

@Retention

@Retention定义了该Annotation被保留的时间长短:某些Annotation仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotationclass在使用上是被分离的)。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。取值(RetentionPoicy)有:

  • 1.SOURCE:在源文件中有效(即源文件保留)
  • 2.CLASS:在class文件中有效(即class保留)
  • 3.RUNTIME:在运行时有效(即运行时保留)

@Documented

@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。

@Aspect

@Aspect作用是把当前类标识为一个切面供容器读取

@Pointcut

@Pointcut定义一个切点

@Before

@Before标识一个前置增强方法,相当于BeforeAdvice的功能

@component

@component 把普通pojo实例化到spring容器中,相当于配置文件中的

总结:
自定义注解,通过在接口添加一个注解达到某些目的,主要还是运用反射的特性。最起码看到别人的注解时会去找他的切入点或者反射类在哪。

你可能感兴趣的:(15 springboot中使用自定义注解)