ApiBoot RateLimiter 示例 & 文档

Author: hengboy

api-boot-samples/api-boot-sample-rate-limiter/README.md

@@ -0,0 +1,61 @@
+​    
+
+## ApiBoot RateLimiter
+
+`ApiBoot RateLimiter`基于拦截器的实现，封装了`Google`的`令牌桶方式`的限流实现，可通过注解配置每个接口的流量`QPS`（每秒允许的流量请求）。
+
+> 注意：目前不支持分布式系统的流量限制，会在下个版本进行更新添加。
+
+### 添加依赖
+
+```xml
+<dependencies>
+  <!--ApiBoot RateLimiter-->
+  <dependency>
+    <groupId>org.minbox.framework</groupId>
+    <artifactId>api-boot-starter-rate-limiter</artifactId>
+  </dependency>
+  <!--省略其他依赖-->
+</dependencies>
+<dependencyManagement>
+  <dependencies>
+    <!--ApiBoot 版本依赖-->
+    <dependency>
+      <groupId>org.minbox.framework</groupId>
+      <artifactId>api-boot-dependencies</artifactId>
+      <version>2.0.6.RELEASE</version>
+      <type>pom</type>
+      <scope>import</scope>
+    </dependency>
+  </dependencies>
+</dependencyManagement>
+```
+
+### 相关配置
+
+| 配置名称                                | 默认值 | 描述                               |
+| --------------------------------------- | ------ | ---------------------------------- |
+| `api.boot.rate-limiter.interceptor-url` | /**    | 数组类型，可配置多个限流的路径地址 |
+
+### QPS定义
+
+限流注解`RateLimiter`配置使用如下所示：
+
+```java
+@RestController
+@RequestMapping(value = "/resource")
+public class ResourceSampleController {
+    /**
+     * QPS = 10
+     * 配置该接口每秒只允许访问10次
+     *
+     * @return
+     */
+    @RequestMapping(value = "/")
+    @RateLimiter(QPS = 10)
+    public UserInfo user() {
+        return new UserInfo("admin");
+    }
+}
+```
+

api-boot-samples/api-boot-sample-rate-limiter/src/main/java/org/minbox/framework/api/boot/sample/ApiBootRateLimiterApplication.java

@@ -0,0 +1,40 @@
+/*
+ * 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.sample;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+/**
+ * ApiBoot Rate Limiter Application
+ *
+ * @author：恒宇少年 - 于起宇
+ * <p>
+ * DateTime：2019-04-26 16:09
+ * Blog：http://blog.yuqiyu.com
+ * WebSite：http://www.jianshu.com/u/092df3f77bca
+ * Gitee：https://gitee.com/hengboy
+ * GitHub：https://github.com/hengboy
+ */
+@SpringBootApplication
+public class ApiBootRateLimiterApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(ApiBootRateLimiterApplication.class, args);
+    }
+}

api-boot-samples/api-boot-sample-rate-limiter/src/main/java/org/minbox/framework/api/boot/sample/RateLimiterSampleController.java

@@ -36,6 +36,7 @@
 public class RateLimiterSampleController {
     /**
      * QPS默认为1
+     * 每秒限制该接口访问10次
      *
      * @return
      */