GuavaRateLimiter实现API限流,这才是正确的姿势!

发布网友发布时间：2024-09-26 18:17

共1个回答

热心网友时间：2024-11-17 05:19

Guava提供的RateLimiter可以*物理或逻辑资源的被访问速率，咋一听有点像java并发包下的Samephore，但是又不相同，RateLimiter控制的是速率，Samephore控制的是并发量。

RateLimiter的原理类似于令牌桶，它主要由许可发出的速率来定义，如果没有额外的配置，许可证将按每秒许可证规定的固定速度分配，许可将被平滑地分发，若请求超过permitsPerSecond则RateLimiter按照每秒1/permitsPerSecond的速率释放许可。

<dependency><groupId>com.google.guava</groupId><artifactId>guava</artifactId><version>23.0</version></dependency>publicstaticvoidmain(String[]args){Stringstart=newSimpleDateFormat("yyyy-MM-ddHH:mm:ss").format(newDate());RateLimiterlimiter=RateLimiter.create(1.0);//这里的1表示每秒允许处理的量为1个for(inti=1;i<=10;i++){limiter.acquire();//请求RateLimiter,超过permits会被阻塞System.out.println("callexecute.."+i);}Stringend=newSimpleDateFormat("yyyy-MM-ddHH:mm:ss").format(newDate());System.out.println("starttime:"+start);System.out.println("endtime:"+end);}

可以看到，我假定了每秒处理请求的速率为1个，现在我有10个任务要处理，那么RateLimiter就很好的实现了控制速率，总共10个任务，需要9次获取许可，所以最后10个任务的消耗时间为9s左右。那么在实际的项目中是如何使用的呢？？

实际项目中使用@ServicepublicclassGuavaRateLimiterService{/*每秒控制5个许可*/RateLimiterrateLimiter=RateLimiter.create(5.0);/***获取令牌**@return*/publicbooleantryAcquire(){returnrateLimiter.tryAcquire();}}@AutowiredprivateGuavaRateLimiterServicerateLimiterService;@ResponseBody@RequestMapping("/ratelimiter")publicResulttestRateLimiter(){if(rateLimiterService.tryAcquire()){returnResultUtil.success1(1001,"成功获取许可");}returnResultUtil.success1(1002,"未获取到许可");}

jmeter起10个线程并发访问接口，测试结果如下：

可以发现，10个并发访问总是只有6个能获取到许可，结论就是能获取到RateLimiter.create(n)中n+1个许可，总体来看Guava的RateLimiter是比较优雅的。本文就是简单的提了下RateLimiter的使用。

翻阅发现使用上述方式使用RateLimiter的方式不够优雅，尽管我们可以把RateLimiter的逻辑包在service里面，controller直接调用即可，但是如果我们换成：自定义注解+切面的方式实现的话，会优雅的多，详细见下面代码：

自定义注解类

importjava.lang.annotation.*;/***自定义注解可以不包含属性，成为一个标识注解*/@Inherited@Documented@Target({ElementType.METHOD,ElementType.FIELD,ElementType.TYPE})@Retention(RetentionPolicy.RUNTIME)public@interfaceRateLimitAspect{}

自定义切面类

importcom.google.common.util.concurrent.RateLimiter;importcom.simons.cn.springbootdemo.util.ResultUtil;importnet.sf.json.JSONObject;importorg.aspectj.lang.ProceedingJoinPoint;importorg.aspectj.lang.annotation.Around;importorg.aspectj.lang.annotation.Aspect;importorg.aspectj.lang.annotation.Pointcut;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.context.annotation.Scope;importorg.springframework.stereotype.Component;importjavax.servlet.ServletOutputStream;importjavax.servlet.http.HttpServletResponse;importjava.io.IOException;@Component@Scope@AspectpublicclassRateLimitAop{@AutowiredprivateHttpServletResponseresponse;privateRateLimiterrateLimiter=RateLimiter.create(5.0);//比如说，我这里设置"并发数"为5@Pointcut("@annotation(com.simons.cn.springbootdemo.aspect.RateLimitAspect)")publicvoidserviceLimit(){}@Around("serviceLimit()")publicObjectaround(ProceedingJoinPointjoinPoint){Booleanflag=rateLimiter.tryAcquire();Objectobj=null;try{if(flag){obj=joinPoint.proceed();}else{Stringresult=JSONObject.fromObject(ResultUtil.success1(100,"failure")).toString();output(response,result);}}catch(Throwablee){e.printStackTrace();}System.out.println("flag="+flag+",obj="+obj);returnobj;}publicvoidoutput(HttpServletResponseresponse,Stringmsg)throwsIOException{response.setContentType("application/json;charset=UTF-8");ServletOutputStreamoutputStream=null;try{outputStream=response.getOutputStream();outputStream.write(msg.getBytes("UTF-8"));}catch(IOExceptione){e.printStackTrace();}finally{outputStream.flush();outputStream.close();}}}

推荐一个SpringBoot基础教程及实战示例：https://www.javastack.cn/categories/Spring-Boot/

测试controller类

importcom.simons.cn.springbootdemo.aspect.RateLimitAspect;importcom.simons.cn.springbootdemo.util.ResultUtil;importorg.springframework.stereotype.Controller;importorg.springframework.web.bind.annotation.RequestMapping;importorg.springframework.web.bind.annotation.ResponseBody;/***类描述：RateLimit限流测试（基于注解+切面方式）*创建人：simonsfan*/@ControllerpublicclassTestController{@ResponseBody@RateLimitAspect//可以非常方便的通过这个注解来实现限流@RequestMapping("/test")publicStringtest(){returnResultUtil.success1(1001,"success").toString();}

这样通过自定义注解@RateLimiterAspect来动态的加到需要限流的接口上，个人认为是比较优雅的实现吧。

压测结果：

可以看到，10个线程中无论压测多少次，并发数总是*在6，也就实现了限流。

作者：饭一碗