Spring Cloud学习笔记7-服务限流 or API限流(Zuul+RateLimiter)

叁歲伎倆 2022-04-04 11:18 287阅读 0赞

--------------------

title: “Spring Cloud学习笔记7-服务限流 or API限流(Zuul+RateLimiter)”

url: “[https://wsk1103.github.io/][https_wsk1103.github.io]”

tags:

*  Spring Cloud
 *  学习笔记

--------------------

#### 备注： ####

**官网**：[http://spring.io/projects/spring-cloud][http_spring.io_projects_spring-cloud]

**总纲**：[https://cloud.spring.io/spring-cloud-static/Finchley.SR2/single/spring-cloud.html][https_cloud.spring.io_spring-cloud-static_Finchley.SR2_single_spring-cloud.html]

**JAVA**： 1.8 +

**MAVEN**： 3.5.0 +

**Spring Boot**：2.0.7.RELEASE

**Spring Cloud**：Finchley

说明：  
**RateLimiter** ：RateLimiter是Google开源的实现了令牌桶算法的限流工具（速率限制器）。[http://ifeve.com/guava-ratelimiter/][http_ifeve.com_guava-ratelimiter]

**[Spring Cloud Zuul RateLimiter][http_spring.io_projects_spring-cloud]** ：结合了Zuul对RateLimiter进行了封装，通过实现ZuulFilter提供了服务限流功能

<table> 
 <thead> 
  <tr> 
   <th>限流粒度/类型</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Authenticated User</td> 
   <td>针对请求的用户进行限流</td> 
  </tr> 
  <tr> 
   <td>Request Origin</td> 
   <td>针对请求的Origin进行限流</td> 
  </tr> 
  <tr> 
   <td>URL</td> 
   <td>针对URL/接口进行限流</td> 
  </tr> 
  <tr> 
   <td>Service</td> 
   <td>针对服务进行限流，如果没有配置限流类型，则此类型生效</td> 
  </tr> 
 </tbody> 
</table>

--------------------

本项目地址：[https://github.com/wsk1103/my-spring-cloud][https_github.com_wsk1103_my-spring-cloud]

--------------------

## 服务限流 ##

延用zuul项目

#### 1. 修改pom.xml，加入新的依赖 ####

<dependency>
        <groupId>com.marcosbarbero.cloud</groupId>
        <artifactId>spring-cloud-zuul-ratelimit</artifactId>
        <version>2.2.1.RELEASE</version>
    </dependency>
    //增加redis，配合redis使用
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-redis</artifactId>
    </dependency>

#### 2. 修改application.yml ####

增加了redis配置和rate limit配置

eureka:
      client:
        service-url:
          defaultZone: http://localhost:8761/eureka/
    
    server:
      port: 8769
    
    spring:
      application:
        name: service-zuul
      redis:
        host: localhost
        port: 6379
    
    zuul:
      routes:
        a:
          path: /a/**
          serviceId: service-client
        b:
          path: /b/**
          serviceId: service-feign
      ratelimit:
        key-prefix: wsk
        enabled: true
        repository: REDIS
        behind-proxy: true
        default-policy-list: #optional - will apply unless specific policy exists
          - limit: 1 #optional - request number limit per refresh interval window
            quota: 1 #optional - request time limit per refresh interval window (in seconds)
            refresh-interval: 3 #default value (in seconds)
    #        type: #optional
    #          - user
    #          - origin
    #          - url
        policy-list:
          a: #需要和服务同名
            - limit: 10 #optional - request number limit per refresh interval window
              quota: 100 #optional - request time limit per refresh interval window (in seconds)
              refresh-interval: 30 #default value (in seconds)
          b:
            - limit: 1 #optional - request number limit per refresh interval window
              quota: 1 #optional - request time limit per refresh interval window (in seconds)
              refresh-interval: 3 #default value (in seconds)
    #          type: #optional
    #            - user
    #            - origin
    #            - url
    #          type: #optional value for each type
    #            - user=anonymous
    #            - origin=somemachine.com
    #            - url=/api #url prefix
    #            - role=user

#### 结果实例 ####

![image][]

## 参数说明 ##

Property namespace: zuul.ratelimit

<table> 
 <thead> 
  <tr> 
   <th>Property name</th> 
   <th>Values</th> 
   <th>Default Value</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>enabled</td> 
   <td>true/false</td> 
   <td>false</td> 
   <td>是否启用限流</td> 
  </tr> 
  <tr> 
   <td>behind-proxy</td> 
   <td>true/false</td> 
   <td>false</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>key-prefix</td> 
   <td>String</td> 
   <td>${ <a href="http://spring.application.name" rel="nofollow">spring.application.name</a>:rate-limit-application}</td> 
   <td>限流key前缀</td> 
  </tr> 
  <tr> 
   <td>repository</td> 
   <td>CONSUL, REDIS, JPA, BUCKET4J_JCACHE, BUCKET4J_HAZELCAST, BUCKET4J_INFINISPAN, BUCKET4J_IGNITE</td> 
   <td>-</td> 
   <td>必填，使用redis即可</td> 
  </tr> 
  <tr> 
   <td>default-policy-list</td> 
   <td>List of Policy</td> 
   <td>-</td> 
   <td>默认策略</td> 
  </tr> 
  <tr> 
   <td>policy-list</td> 
   <td>Map of Lists of Policy</td> 
   <td>-</td> 
   <td>自定义策略</td> 
  </tr> 
  <tr> 
   <td>postFilterOrder</td> 
   <td>int</td> 
   <td>FilterConstants.SEND_RESPONSE_FILTER_ORDER - 10</td> 
   <td>postFilter过滤顺序</td> 
  </tr> 
  <tr> 
   <td>preFilterOrder</td> 
   <td>int</td> 
   <td>FilterConstants.FORM_BODY_WRAPPER_FILTER_ORDER</td> 
   <td>preFilter过滤顺序</td> 
  </tr> 
 </tbody> 
</table>

Policy properties:

<table> 
 <thead> 
  <tr> 
   <th>Property name</th> 
   <th>Values</th> 
   <th>Default Value</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>limit</td> 
   <td>number of calls</td> 
   <td>-</td> 
   <td>单位时间内请求次数限制</td> 
  </tr> 
  <tr> 
   <td>quota</td> 
   <td>time of calls</td> 
   <td>-</td> 
   <td>单位时间内累计请求时间限制（秒），非必要参数</td> 
  </tr> 
  <tr> 
   <td>refresh-interval</td> 
   <td>seconds</td> 
   <td>60</td> 
   <td>单位时间（秒），默认60秒</td> 
  </tr> 
  <tr> 
   <td>type</td> 
   <td>[ORIGIN, USER, URL, ROLE]</td> 
   <td>[]</td> 
   <td>限流方式：ORIGIN, USER, URL（每个Url 在z秒内访问次数不得超过x次且总计访问时间这不得超过y秒）</td> 
  </tr> 
 </tbody> 
</table>

[https_wsk1103.github.io]: https://wsk1103.github.io/
[http_spring.io_projects_spring-cloud]: https://github.com/marcosbarbero/spring-cloud-zuul-ratelimit
[https_cloud.spring.io_spring-cloud-static_Finchley.SR2_single_spring-cloud.html]: https://cloud.spring.io/spring-cloud-static/Finchley.SR2/single/spring-cloud.html
[http_ifeve.com_guava-ratelimiter]: http://ifeve.com/guava-ratelimiter/
[https_github.com_wsk1103_my-spring-cloud]: https://github.com/wsk1103/my-spring-cloud
[image]: /images/20220404/dfa01f10040648afaeb42156b92b6668.png