自定义注解实现限流

最新推荐文章于 2025-10-08 22:15:28 发布

原创最新推荐文章于 2025-10-08 22:15:28 发布 · 542 阅读

CC 4.0 BY-SA版权

本文介绍了一种基于Java的限流实现方法，通过自定义注解和AOP技术完成请求频率限制。具体步骤包括创建限流注解RateLimiter、实现限流逻辑的RateLimiterAspect切面类、在Controller中应用注解以及最终的测试验证。

一、创建注解RateLimiter

package com.niwodai.mobile.bi.web.controller.limit;

import java.lang.annotation.*;

//专门用来限定某个自定义注解能够被应用在哪些Java元素上面的
@Target(value = {ElementType.METHOD})
//如果一个注解被定义为RetentionPolicy.RUNTIME，那么这个注解可以在运行期的加载阶段被加载到Class对象中。那么在程序运行阶段，我们可以通过反射得到这个注解，并通过判断是否有这个注解或这个注解中属性的值，从而执行不同的程序代码段。我们实际开发中的自定义注解几乎都是使用的RetentionPolicy.RUNTIME；
@Retention(RetentionPolicy.RUNTIME)
//用来指定自定义注解是否能随着被定义的java文件生成到JavaDoc文档当中。
@Documented
//指定某个自定义注解如果写在了父类的声明部分，那么子类的声明部分也能自动拥有该注解。    使用：例如 @BIRateLimiter(rate = 1.0, timeout = 500)
@Inherited
public @interface RateLimiter {

    //向令牌桶放入令牌的速率
    double rate() default 1.0;

    //从令牌桶获取令牌的超时时间
    long timeout() default 1000;
}

二、创建RateLimiterAspect 实现限流逻辑

package com.niwodai.mobile.bi.web.controller.limit;

import com.google.common.util.concurrent.RateLimiter;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.concurrent.TimeUnit;

/**
 * @Auther: layne
 * @Date: 2021/5/1 15:31
 */
@Aspect
@Component
@Slf4j
public class RateLimiterAspect {

    @Autowired
    private HttpServletResponse response;

    //创建限流类，每秒释放的令牌数为2
    private RateLimiter rateLimiter = RateLimiter.create(2);

    //
    @Pointcut("execution(public * com.niwodai.mobile.bi.web.controller.report.*.*(..))")
    public void pointcut1() {
    }

    @Pointcut("execution(public * com.niwodai.mobile.bi.web.controller.oversea.*.*(..))")
    public void pointcut2() {
    }

    /*** 核心切面方法 */
//    @Around("pointcut1()||pointcut2()")
    public Object process(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        MethodSignature signature = (MethodSignature) proceedingJoinPoint.getSignature();
        //使用反射获取方法上是否存在@MyRateLimiter注解
        BIRateLimiter biRateLimiter = signature.getMethod().getDeclaredAnnotation(BIRateLimiter.class);
        if (biRateLimiter == null) {
            //程序正常执行，执行目标方法
            return proceedingJoinPoint.proceed();
        }
        //获取注解上的参数 //获取配置的速率
        double rate = biRateLimiter.rate();
        //获取客户端等待令牌的时间
        long timeout = biRateLimiter.timeout();
        //设置限流速率
        this.rateLimiter.setRate(rate);
        //判断客户端获取令牌是否超时
        boolean tryAcquire = this.rateLimiter.tryAcquire(timeout, TimeUnit.MILLISECONDS);
        if (!tryAcquire) {
            //服务降级
            fullback();
            return null;
        }
        //获取到令牌，直接执行
        return proceedingJoinPoint.proceed();
    }


    //服务降级方法
    private void fullback() {
        response.setHeader("Content-type", "text/html;charset=UTF-8");
        PrintWriter writer = null;
        try {
            writer = response.getWriter();
            writer.println("当前请求次数过多，请稍后再试....");
            writer.flush();
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (writer != null) {
                writer.close();
            }
        }
    }
}

三、在相应的controller的method加上自定义的注解

@PostMapping("/achievement")
@BIRateLimiter(rate = 1.0, timeout = 500)
public Object queryAchievement(@RequestBody Map<String, Object> queryParam) {
     return new ActionResult(mexicoService.queryAchievement(queryParam));
}

四、测试结果