详解Spring Cloud Netflix Zuul中的速率限制

更新时间：2018年11月12日 09:15:19 作者：banq

这篇文章主要介绍了详解Spring Cloud Netflix Zuul中的速率限制，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧

Spring Cloud Netflix Zuul是一个包含Netflix Zuul的开源网关。它为Spring Boot应用程序添加了一些特定功能。不幸的是，开箱即用不提供速率限制。

除了Spring Cloud Netflix Zuul依赖项之外，我们还需要将Spring Cloud Zuul RateLimit 添加到我们的应用程序的pom.xml中：

<dependency>
 <groupId>org.springframework.cloud</groupId>
 <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
</dependency>
<dependency>
 <groupId>com.marcosbarbero.cloud</groupId>
 <artifactId>spring-cloud-zuul-ratelimit</artifactId>
 <version>2.2.0.RELEASE</version>
</dependency>

首先，让我们创建几个REST端点，我们将在其上应用速率限制。

下面是一个简单的Spring Controller类，有两个端点：

@Controller
@RequestMapping("/greeting")
public class GreetingController {
 
 @GetMapping("/simple")
 public ResponseEntity<String> getSimple() {
  return ResponseEntity.ok("Hi!");
 }
 
 @GetMapping("/advanced")
 public ResponseEntity<String> getAdvanced() {
  return ResponseEntity.ok("Hello, how you doing?");
 }
}

让我们在application.yml文件中添加以下Zuul属性：

zuul:
 routes:
 serviceSimple:
  path: /greeting/simple
  url: forward:/
 serviceAdvanced:
  path: /greeting/advanced
  url: forward:/
 ratelimit:
 enabled: true
 repository: JPA
 policy-list:
  serviceSimple:
  - limit: 5
   refresh-interval: 60
   type:
   - origin
  serviceAdvanced:
  - limit: 1
   refresh-interval: 2
   type:
   - origin
 strip-prefix: true

在zuul.routes下，我们提供端点详细信息。在zuul.ratelimit.policy-list下，我们为端点提供速率限制配置。该限属性指定的时间端点可以在内部被称为数字刷新间隔。

我们可以看到，我们为serviceSimple 端点添加了每60秒5个请求的速率限制。相比之下， serviceAdvanced的速率限制为每2秒1个请求。

该类型配置指定其速率限制的方法,以下是可能的值：

origin - 基于用户原始请求的速率限制
url - 基于下游服务的请求路径的速率限制
user - 基于经过身份验证的用户名或“匿名”的速率限制
No value - 充当每项服务的全局配置。要使用这种方法，请不要设置参数'type'

接下来，让我们测试一下速率限制：

@Test
public void whenRequestNotExceedingCapacity_thenReturnOkResponse() {
 ResponseEntity<String> response = restTemplate.getForEntity(SIMPLE_GREETING, String.class);
 assertEquals(OK, response.getStatusCode());
 
 HttpHeaders headers = response.getHeaders();
 String key = "rate-limit-application_serviceSimple_127.0.0.1";
 
 assertEquals("5", headers.getFirst(HEADER_LIMIT + key));
 assertEquals("4", headers.getFirst(HEADER_REMAINING + key));
 assertEquals("60000", headers.getFirst(HEADER_RESET + key)); 
}

在这里，我们只对一个端点/ greeting / simple进行一次调用。请求成功，因为它在速率限制内。

另一个关键点是，对于每个响应，我们返回标头Header，为我们提供有关速率限制的更多信息。对于上述请求，我们将获得以下标头：

X-RateLimit-Limit-rate-limit-application_serviceSimple_127.0.0.1: 5

X-RateLimit-Remaining-rate-limit-application_serviceSimple_127.0.0.1: 4

X-RateLimit-Reset-rate-limit-application_serviceSimple_127.0.0.1: 60000

解释：

X-RateLimit-Limit- [key]：为端点配置的限制
X-RateLimit-Remaining- [key]：调用端点的剩余尝试次数
X-RateLimit-Reset- [key]：为端点配置的刷新间隔的剩余毫秒数

另外，如果我们再次立即触发相同的端点，我们可以得到：

X-RateLimit-Limit-rate-limit-application_serviceSimple_127.0.0.1: 5

X-RateLimit-Remaining-rate-limit-application_serviceSimple_127.0.0.1: 3

X-RateLimit-Reset-rate-limit-application_serviceSimple_127.0.0.1: 57031

请注意减少的剩余尝试次数和剩余的毫秒数。

让我们看看当我们超过速率限制时会发生什么：

@Test
public void whenRequestExceedingCapacity_thenReturnTooManyRequestsResponse() throws InterruptedException {
 ResponseEntity<String> response = this.restTemplate.getForEntity(ADVANCED_GREETING, String.class);
 assertEquals(OK, response.getStatusCode());
  
 for (int i = 0; i < 2; i++) {
  response = this.restTemplate.getForEntity(ADVANCED_GREETING, String.class);
 }
 
 assertEquals(TOO_MANY_REQUESTS, response.getStatusCode());
 
 HttpHeaders headers = response.getHeaders();
 String key = "rate-limit-application_serviceAdvanced_127.0.0.1";
 
 assertEquals("1", headers.getFirst(HEADER_LIMIT + key));
 assertEquals("0", headers.getFirst(HEADER_REMAINING + key));
 assertNotEquals("2000", headers.getFirst(HEADER_RESET + key));
 
 TimeUnit.SECONDS.sleep(2);
 
 response = this.restTemplate.getForEntity(ADVANCED_GREETING, String.class);
 assertEquals(OK, response.getStatusCode());
}

在这里，我们快速连续两次调用，由于我们已将速率限制配置为每2秒一个请求，因此第二个调用将失败。结果，错误代码429（Too Many Requests）返回给客户端。以下是达到速率限制时返回的标头：

X-RateLimit-Limit-rate-limit-application_serviceAdvanced_127.0.0.1: 1

X-RateLimit-Remaining-rate-limit-application_serviceAdvanced_127.0.0.1: 0

X-RateLimit-Reset-rate-limit-application_serviceAdvanced_127.0.0.1: 268

之后，我们休息了2秒钟。这是为端点配置的刷新间隔。最后，我们再次触发端点并获得成功的响应。

自定义密钥生成器

我们可以使用自定义密钥生成器自定义响应头中发送的密钥。这很有用，因为应用程序可能需要控制除type属性提供的选项之外的密钥策略。

例如，这可以通过创建自定义的RateLimitKeyGenerator实现类来完成。我们可以添加更多的限定符或完全不同的东西：

@Bean
public RateLimitKeyGenerator rateLimitKeyGenerator(RateLimitProperties properties,
 RateLimitUtils rateLimitUtils) {
 return new DefaultRateLimitKeyGenerator(properties, rateLimitUtils) {
  @Override
  public String key(HttpServletRequest request, Route route,
   RateLimitProperties.Policy policy) {
   return super.key(request, route, policy) + "_" + request.getMethod();
  }
 };
}

上面的代码将REST方法名称附加到键。例如：

X-RateLimit-Limit-rate-limit-application_serviceSimple_127.0.0.1_GET: 5

另一个关键点是 RateLimitKeyGenerator bean将由spring-cloud-zuul-ratelimit自动配置。

自定义错误处理

该框架支持速率限制数据存储的各种实现。例如，提供了Spring Data JPA和Redis。默认情况下，使用DefaultRateLimiterErrorHandler 类将故障记录为错误。

当我们需要以不同方式处理错误时，我们可以定义一个自定义的RateLimiterErrorHandler bean：

@Bean
public RateLimiterErrorHandler rateLimitErrorHandler() {
 return new DefaultRateLimiterErrorHandler() {
  @Override
  public void handleSaveError(String key, Exception e) {
   <i>// implementation</i>
  }
 
  @Override
  public void handleFetchError(String key, Exception e) {
   <i>// implementation</i>
  }
 
  @Override
  public void handleError(String msg, Exception e) {
   <i>// implementation</i>
  }
 };
}

与RateLimitKeyGenerator bean 类似，也将自动配置RateLimiterErrorHandler bean。

在GitHub上找到本文的完整代码

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

Java绘制迷宫动画并显示的示例代码
这篇文章主要为大家详细介绍了如何利用Java语言实现绘制迷宫动画并显示，文中的示例代码讲解详细，对我们学习Java有一定帮助，需要的可以参考一下
2022-08-08
Java重写(Override)与重载(Overload)区别原理解析
这篇文章主要介绍了Java重写(Override)与重载(Overload)区别原理解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-02-02
springboot+camunda实现工作流的流程分析
Camunda是基于Java语言，支持BPMN标准的工作流和流程自动化框架，并且还支持CMMN规范，DMN规范，本文给大家介绍springboot+camunda实现工作流的流程分析，感兴趣的朋友一起看看吧
2021-12-12
SpringBoot使用@SpringBootTest注解开发单元测试教程
这篇文章主要介绍了SpringBoot使用@SpringBootTest注解开发单元测试教程,本文通过详细的案例过程来说明如何使用该项技术,需要的朋友可以参考下
2021-06-06
Spring-boot结合Shrio实现JWT的方法
这篇文章主要介绍了Spring-boot结合Shrio实现JWT的方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-05-05
Spring中SmartLifecycle和Lifecycle的作用和区别
这篇文章主要介绍了Spring中SmartLifecycle和Lifecycle的作用和区别,本文通过实例代码给大家介绍的非常详细对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-03-03
SpringBoot中集成Swagger2及简单实用
使用Swagger你只需要按照它的规范去定义接口及接口相关的信息，再通过Swagger衍生出来的一系列项目和工具，就可以做到生成各种格式的接口文档，以及在线接口调试页面等等，这篇文章主要介绍了SpringBoot中集成Swagger2,需要的朋友可以参考下
2023-06-06
Zookeeper实现分布式锁代码实例
这篇文章主要介绍了Zookeeper实现分布式锁代码实例,Zookeeper 分布式锁应用了其临时顺序节点的特性,在Zookeeper中创建一个持久节点ParentLock,当第一个客户端要获取锁时,在ParentLock节点下创建一个临时顺序节点,需要的朋友可以参考下
2023-12-12
浅谈SpringBoot之事务处理机制
这篇文章主要介绍了浅谈SpringBoot之事务处理机制，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-01-01
java中transient关键字用法分析
这篇文章主要介绍了java中transient关键字用法,以实例形式分析了java中transient关键字的功能及使用技巧,具有一定参考借鉴价值,需要的朋友可以参考下
2015-02-02