详解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上找到本文的完整代码

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

您可能感兴趣的文章:

MyBatis 实现批量插入和删除中双层循环的写法案例
这篇文章主要介绍了MyBatis 实现批量插入和删除中双层循环的写法案例，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2021-01-01
基于SpringBoot+Avue实现短信通知功能
Avue是基于vue和element-ui的快速开发框架 ,它的核心是数据驱动UI的思想,让我们从繁琐的crud开发中解脱出来,本文将给大家介绍一下使用SpringBoot+Avue实现短信通知功能,文中有详细的代码示例,需要的朋友可以参考下
2023-09-09
Mockito mock Kotlin Object类方法报错解决方法
这篇文章主要介绍了Mockito mock Kotlin Object类方法报错解决方法,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
2021-09-09
Java中的原子类AtomicInteger使用详解
这篇文章主要介绍了Java中的原子类AtomicInteger使用详解,原子操作是指不会被线程调度机制打断的操作,这种操作一旦开始,就一直运行到结束,中间不会有任何线程上下文切换,需要的朋友可以参考下
2023-12-12
SpringMVC集成Swagger实例代码
本篇文章主要介绍了SpringMVC集成Swagger实例代码，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-04-04
Mybatis中自定义实例化SqlSessionFactoryBean问题
这篇文章主要介绍了Mybatis中自定义实例化SqlSessionFactoryBean问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-02-02
mybatis group by substr函数传参报错的解决
这篇文章主要介绍了mybatis group by substr函数传参报错的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-01-01
使用SpringMVC 重写、扩展HttpServletRequest请求参数
这篇文章主要介绍了使用SpringMVC 重写、扩展HttpServletRequest请求参数，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-08-08
Java用户登录验证代码
本文给大家使用java代码实现用户登录验证功能，当用户输入三次错误后，用户不可以再次登录的。具体实现代码，大家可以参考下本教程
2016-08-08
Spring的BeanUtils.copyProperties属性复制避坑指南
这篇文章主要介绍了Spring的BeanUtils.copyProperties属性复制避坑指南,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-08-08

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

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具