ApiBoot RateLimiter 修改为AOP方式实现

Author: hengboy

api-boot-project/api-boot-plugins/api-boot-plugin-rate-limiter/pom.xml

@@ -22,7 +22,7 @@
     <parent>
         <artifactId>api-boot-plugins</artifactId>
         <groupId>org.minbox.framework</groupId>
-        <version>2.0.7.RELEASE</version>
+        <version>2.0.8.RC1</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>api-boot-plugin-rate-limiter</artifactId>
@@ -50,6 +50,11 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-web</artifactId>
         </dependency>
+        <!--SpringBoot Aop-->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-aop</artifactId>
+        </dependency>
         <!--SpringBoot Data Redis-->
         <dependency>
             <groupId>org.springframework.boot</groupId>

api-boot-project/api-boot-plugins/api-boot-plugin-rate-limiter/src/main/java/org/minbox/framework/api/boot/plugin/rate/limiter/ApiBootRateLimiter.java

@@ -33,8 +33,8 @@ public interface ApiBootRateLimiter {
      * Attempt to obtain a request current limit token
      *
      * @param QPS        queries per second
-     * @param requestUri request uri
+     * @param requestKey request key
      * @return true : allow access to
      */
-    boolean tryAcquire(Double QPS, String requestUri);
+    boolean tryAcquire(Double QPS, String requestKey);
 }

api-boot-project/api-boot-plugins/api-boot-plugin-rate-limiter/src/main/java/org/minbox/framework/api/boot/plugin/rate/limiter/ApiBootRateLimiterConfiguration.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright [2019] [恒宇少年 - 于起宇]
+ *
+ *      Licensed under the Apache License, Version 2.0 (the "License");
+ *      you may not use this file except in compliance with the License.
+ *      You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *      Unless required by applicable law or agreed to in writing, software
+ *      distributed under the License is distributed on an "AS IS" BASIS,
+ *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *      See the License for the specific language governing permissions and
+ *      limitations under the License.
+ *
+ */
+
+package org.minbox.framework.api.boot.plugin.rate.limiter.aop.advisor;
+
+import org.aopalliance.aop.Advice;
+import org.minbox.framework.api.boot.plugin.rate.limiter.annotation.RateLimiter;
+import org.minbox.framework.api.boot.plugin.rate.limiter.aop.interceptor.ApiBootRateLimiterMethodInterceptor;
+import org.springframework.aop.Pointcut;
+import org.springframework.aop.support.AbstractPointcutAdvisor;
+import org.springframework.aop.support.ComposablePointcut;
+import org.springframework.aop.support.annotation.AnnotationMatchingPointcut;
+import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.BeanFactory;
+import org.springframework.beans.factory.BeanFactoryAware;
+import org.springframework.util.Assert;
+
+/**
+ * ApiBoot RateLimiter Advisor
+ *
+ * @author：恒宇少年 - 于起宇
+ * <p>
+ * DateTime：2019-05-09 16:03
+ * Blog：http://blog.yuqiyu.com
+ * WebSite：http://www.jianshu.com/u/092df3f77bca
+ * Gitee：https://gitee.com/hengboy
+ * GitHub：https://github.com/hengboy
+ */
+public class ApiBootRateLimiterAdvisor extends AbstractPointcutAdvisor implements BeanFactoryAware {
+    private Advice advice;
+    private Pointcut pointcut;
+    private BeanFactory beanFactory;
+
+    public ApiBootRateLimiterAdvisor(ApiBootRateLimiterMethodInterceptor apiBootRateLimiterMethodInterceptor) {
+        // build pointcut instance
+        this.pointcut = buildPointcut();
+        // build advice instance
+        this.advice = apiBootRateLimiterMethodInterceptor;
+        if (this.advice instanceof BeanFactoryAware) {
+            ((BeanFactoryAware) this.advice).setBeanFactory(beanFactory);
+        }
+    }
+
+    @Override
+    public Pointcut getPointcut() {
+        Assert.notNull(this.pointcut, "pointcut is required.");
+        return this.pointcut;
+    }
+
+    @Override
+    public Advice getAdvice() {
+        Assert.notNull(this.advice, "advice is required.");
+        return this.advice;
+    }
+
+    @Override
+    public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
+        this.beanFactory = beanFactory;
+    }
+
+    /**
+     * build pointcut instance
+     */
+    private Pointcut buildPointcut() {
+        // method
+        Pointcut mpc = AnnotationMatchingPointcut.forMethodAnnotation(RateLimiter.class);
+        return new ComposablePointcut(mpc);
+    }
+}

api-boot-project/api-boot-plugins/api-boot-plugin-rate-limiter/src/main/java/org/minbox/framework/api/boot/plugin/rate/limiter/aop/advisor/ApiBootRateLimiterAdvisor.java

@@ -0,0 +1,98 @@
+/*
+ * Copyright [2019] [恒宇少年 - 于起宇]
+ *
+ *      Licensed under the Apache License, Version 2.0 (the "License");
+ *      you may not use this file except in compliance with the License.
+ *      You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *      Unless required by applicable law or agreed to in writing, software
+ *      distributed under the License is distributed on an "AS IS" BASIS,
+ *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *      See the License for the specific language governing permissions and
+ *      limitations under the License.
+ *
+ */
+
+package org.minbox.framework.api.boot.plugin.rate.limiter.aop.interceptor;
+
+import org.aopalliance.intercept.MethodInterceptor;
+import org.aopalliance.intercept.MethodInvocation;
+import org.minbox.framework.api.boot.plugin.rate.limiter.ApiBootRateLimiter;
+import org.minbox.framework.api.boot.plugin.rate.limiter.annotation.RateLimiter;
+import org.minbox.framework.api.boot.plugin.tools.AopTools;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.aop.support.AopUtils;
+import org.springframework.util.Assert;
+
+import java.lang.reflect.Method;
+
+/**
+ * ApiBoot RateLimiter MethodInterceptor
+ * Current Limitation Request
+ *
+ * @author：恒宇少年 - 于起宇
+ * <p>
+ * DateTime：2019-05-09 16:01
+ * Blog：http://blog.yuqiyu.com
+ * WebSite：http://www.jianshu.com/u/092df3f77bca
+ * Gitee：https://gitee.com/hengboy
+ * GitHub：https://github.com/hengboy
+ */
+public class ApiBootRateLimiterMethodInterceptor implements MethodInterceptor {
+    /**
+     * logger instance
+     */
+    static Logger logger = LoggerFactory.getLogger(ApiBootRateLimiterMethodInterceptor.class);
+    /**
+     * ApiBoot RateLimiter
+     */
+    private ApiBootRateLimiter apiBootRateLimiter;
+
+    public ApiBootRateLimiterMethodInterceptor(ApiBootRateLimiter apiBootRateLimiter) {
+        this.apiBootRateLimiter = apiBootRateLimiter;
+        Assert.notNull(apiBootRateLimiter, "No ApiBootRateLimiter implementation class instance.");
+        logger.info("ApiBootDefaultRateLimiterInterceptorHandler load complete.");
+    }
+
+    /**
+     * Processing Current Limited Business Logic
+     *
+     * @param invocation method invocation
+     * @return method result
+     * @throws Throwable error instance
+     */
+    @Override
+    public Object invoke(MethodInvocation invocation) throws Throwable {
+        try {
+            Class<?> targetClass = (invocation.getThis() != null ? AopUtils.getTargetClass(invocation.getThis()) : null);
+            Method executeMethod = invocation.getMethod();
+
+            RateLimiter rateLimiter = AopTools.getMethodAnnotation(targetClass, executeMethod, RateLimiter.class);
+
+            // request key
+            String requestKey = formatRequestKey(targetClass, executeMethod);
+            logger.debug("RateLimiter Request Key：{}", requestKey);
+            boolean acquire = apiBootRateLimiter.tryAcquire(rateLimiter.QPS(), requestKey);
+            if (acquire) {
+                return invocation.proceed();
+            }
+        } catch (Exception e) {
+            logger.error("Current Limiting Request Encountered Exception.", e);
+        }
+        return null;
+    }
+
+    /**
+     * format request key
+     *
+     * @param targetClass   target class
+     * @param executeMethod execute method
+     * @return request key
+     */
+    private String formatRequestKey(Class<?> targetClass, Method executeMethod) {
+        return String.format("%s#%s", targetClass.getName(), executeMethod.getName());
+    }
+}

api-boot-project/api-boot-plugins/api-boot-plugin-rate-limiter/src/main/java/org/minbox/framework/api/boot/plugin/rate/limiter/aop/interceptor/ApiBootRateLimiterMethodInterceptor.java

@@ -40,16 +40,16 @@ public GoogleGuavaRateLimiter(Long globalQPS, RateLimiterConfigCentre rateLimite
      * google guava away
      *
      * @param annotationQPS RateLimiter QPS value
-     * @param requestUri    request uri
+     * @param requestKey    request key
      * @return true : allow access to
      */
     @Override
-    public boolean tryAcquire(Double annotationQPS, String requestUri) {
-        Long QPS = getPriorityQPS(requestUri, annotationQPS);
+    public boolean tryAcquire(Double annotationQPS, String requestKey) {
+        Long QPS = getPriorityQPS(requestKey, annotationQPS);
         if (QPS <= 0) {
             return true;
         }
-        com.google.common.util.concurrent.RateLimiter rateLimiter = ApiBootRateLimiterContext.cacheRateLimiter(requestUri, QPS);
+        com.google.common.util.concurrent.RateLimiter rateLimiter = ApiBootRateLimiterContext.cacheRateLimiter(requestKey, QPS);
         return rateLimiter.tryAcquire();
     }
 }