目的

使用spring的AOP完成应用限流操作,此处是一个demo

1、创建限流注解Limit,在需要对某个服务限流的时候加上注解即可

package com.site.blog.my.core.config;

import java.lang.annotation.*;
import java.util.concurrent.TimeUnit;

/**
 * Retention的参数说明:
 * RetentionPolicy.SOURCE  : 注解只保留在源文件中
 * RetentionPolicy.CLASS  : 注解保留在class文件中,在加载到JVM虚拟机时丢弃
 * RetentionPolicy.RUNTIME  : 注解保留在程序运行期间,此时可以通过反射获得定义在某个类上的所有注解。
 *
 * Target的参数说明:
 * ElementType.TYPE:说明该注解只能被声明在一个 类 前
 * ElementType.FIELD:类的字段前
 * ElementType.METHOD:类的方法前
 * ElementType.PARAMETER:方法参数前
 * ElementType.CONSTRUCTOR:类的构造方法前
 * ElementType.LOCAL_VARIABLE:局部变量前
 * ElementType.ANNOTATION_TYPE:注解类型前
 * ElementType.PACKAGE:包名前
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface Limit {
    /**
     * 资源的key,唯一
     * 作用:不同的接口,不同的流量控制
     */
    String key() default "";

    /**
     * 最多的访问限制次数
     */
    double permitsPerSecond () ;

    /**
     * 获取令牌最大等待时间
     */
    long timeout();

    /**
     * 获取令牌最大等待时间,单位(例:分钟/秒/毫秒) 默认:毫秒
     */
    TimeUnit timeunit() default TimeUnit.MILLISECONDS;

    /**
     * 得不到令牌的提示语
     */
    String msg() default "系统繁忙,请稍后再试.";
}

2、构建使用AOP进行限流逻辑

package com.site.blog.my.core.config;

import com.google.common.collect.Maps;
import com.google.common.util.concurrent.RateLimiter;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.lang.reflect.Method;
import java.util.Map;

@Slf4j
@Aspect
@Component
public class LimitAop {
    /**
     * 不同的接口,不同的流量控制
     * map的key为 Limiter.key
     */
    private final Map<String, RateLimiter> limitMap = Maps.newConcurrentMap();

    @Around("@annotation(com.site.blog.my.core.config.Limit)")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable{
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        //拿limit的注解
        Limit limit = method.getAnnotation(Limit.class);
        if (limit != null) {
            //key作用:不同的接口,不同的流量控制
            String key=limit.key();
            RateLimiter rateLimiter = null;
            //验证缓存是否有命中key
            if (!limitMap.containsKey(key)) {
                // 创建令牌桶
                rateLimiter = RateLimiter.create(limit.permitsPerSecond());
                limitMap.put(key, rateLimiter);
                log.info("新建了令牌桶={},容量={}",key,limit.permitsPerSecond());
            }
            rateLimiter = limitMap.get(key);
            // 拿令牌
            boolean acquire = rateLimiter.tryAcquire(limit.timeout(), limit.timeunit());
            // 拿不到命令,直接返回异常提示
            if (!acquire) {
                System.out.printf("令牌桶={},获取令牌失败",key);
                this.responseFail(limit.msg());
                return null;
            }
        }
        return joinPoint.proceed();
    }

    /**
     * 直接向前端抛出异常,在生产环境此处应该修改为业务具体提示
     * @param msg 提示信息
     */
    private void responseFail(String msg)  {
        HttpServletResponse response=((ServletRequestAttributes)         RequestContextHolder.getRequestAttributes()).getResponse();
        response.setCharacterEncoding("UTF-8");
        response.setHeader("Content-type", "text/html;charset=UTF-8");
        PrintWriter pr= null;
        try {
            pr = response.getWriter();
        } catch (IOException e) {
            e.printStackTrace();
        }
        pr.write(msg);
     }
}

3、应用限流注解,新建一个测试方法

package com.site.blog.my.core.controller;

import com.site.blog.my.core.config.Limit;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.time.format.DateTimeFormatter;
import java.util.concurrent.TimeUnit;

@Slf4j
@RestController
@RequestMapping("/limit")
public class LimitController  {

        /**
         * 限流策略 : 1秒钟2个请求
         */
        private final RateLimiter limiter = RateLimiter.create(2.0);

        private DateTimeFormatter dtf = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");

        @GetMapping("/test1")
        @Limit(key = "limit2", permitsPerSecond = 1, timeout = 500, timeunit = TimeUnit.MILLISECONDS,msg = "当前排队人数较多,请稍后再试!")
        public String testLimiter() {
            //500毫秒内,没拿到令牌,就直接进入服务降级
            boolean tryAcquire = limiter.tryAcquire(500, TimeUnit.MILLISECONDS);

            if (!tryAcquire) {
                log.warn("进入服务降级,时间{}", LocalDateTime.now().format(dtf));
                return "当前排队人数较多,请稍后再试!";
            }

            log.info("获取令牌成功,时间{}", LocalDateTime.now().format(dtf));
            return "请求成功";
        }
    }