跟我學SpringCloud | 第十四篇：Spring Cloud Gateway高階應用

極客挖掘機發表於2019-07-14
SpringGCCloudGateway

SpringCloud系列教程 | 第十四篇：Spring Cloud Gateway高階應用

Springboot: 2.1.6.RELEASE

SpringCloud: Greenwich.SR1

如無特殊說明，本系列教程全採用以上版本

上一篇我們聊了Gateway和註冊中心的使用，以及 Gataway 中 Filter 的基本使用，這篇文章我們將繼續介紹 Filter 的一些高階功能。

  • 熔斷
  • 限流
  • 重試

1. 限速路由器

限速在高併發場景中比較常用的手段之一，可以有效的保障服務的整體穩定性，Spring Cloud Gateway 提供了基於 Redis 的限流方案。所以我們首先需要新增對應的依賴包spring-boot-starter-data-redis-reactive

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-redis-reactive</artifactId>
</dependency>

配置檔案中需要新增 Redis 地址和限流的相關配置

server:
  port: 8080
spring:
  application:
    name: spring-cloud-gateway
  redis:
    host: localhost
    password: password
    port: 6379
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true
      routes:
        - id: requestratelimiter_route
          uri: http://example.org
          filters:
            - name: RequestRateLimiter
              args:
                redis-rate-limiter.replenishRate: 10
                redis-rate-limiter.burstCapacity: 20
                key-resolver: "#{@userKeyResolver}"
          predicates:
            - Method=GET
  • filter 名稱必須是 RequestRateLimiter
  • redis-rate-limiter.replenishRate：允許使用者每秒處理多少個請求
  • redis-rate-limiter.burstCapacity：令牌桶的容量，允許在一秒鐘內完成的最大請求數
  • key-resolver：使用 SpEL 按名稱引用 bean

專案中設定限流的策略，建立 Config 類。

package com.springcloud.gateway.config;

import org.springframework.cloud.gateway.filter.ratelimit.KeyResolver;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import reactor.core.publisher.Mono;

/**
 * Created with IntelliJ IDEA.
 *
 * @Date: 2019/7/11
 * @Time: 23:45
 * @email: inwsy@hotmail.com
 * Description:
 */
@Configuration
public class Config {
    @Bean
    KeyResolver userKeyResolver() {
        return exchange -> Mono.just(exchange.getRequest().getQueryParams().getFirst("user"));
    }
}

Config類需要加@Configuration註解。

根據請求引數中的 user 欄位來限流，也可以設定根據請求 IP 地址來限流，設定如下:

@Bean
public KeyResolver ipKeyResolver() {
    return exchange -> Mono.just(exchange.getRequest().getRemoteAddress().getHostName());
}

這樣閘道器就可以根據不同策略來對請求進行限流了。

2. 熔斷路由器

在之前的 Spring Cloud 系列文章中，大家對熔斷應該有了一定的瞭解，如過不了解可以先讀這篇文章：《跟我學SpringCloud | 第四篇：熔斷器Hystrix》

Spring Cloud Gateway 也可以利用 Hystrix 的熔斷特性，在流量過大時進行服務降級，同樣我們還是首先給專案新增上依賴。

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
</dependency>

配置示例

spring:
  cloud:
    gateway:
      routes:
      - id: hystrix_route
        uri: http://example.org
        filters:
        - Hystrix=myCommandName

配置後，gateway 將使用 myCommandName 作為名稱生成 HystrixCommand 物件來進行熔斷管理。如果想新增熔斷後的回撥內容，需要在新增一些配置。

spring:
  cloud:
    gateway:
      routes:
      - id: hystrix_route
        uri: lb://spring-cloud-producer
        predicates:
        - Path=/consumingserviceendpoint
        filters:
        - name: Hystrix
          args:
            name: fallbackcmd
            fallbackUri: forward:/incaseoffailureusethis

fallbackUri: forward:/incaseoffailureusethis配置了 fallback 時要會調的路徑，當呼叫 Hystrix 的 fallback 被呼叫時，請求將轉發到/incaseoffailureuset這個 URI。

3. 重試路由器

RetryGatewayFilter 是 Spring Cloud Gateway 對請求重試提供的一個 GatewayFilter Factory。

配置示例

spring:
  cloud:
    gateway:
      routes:
      - id: retry_test
        uri: lb://spring-cloud-producer
        predicates:
        - Path=/retry
        filters:
        - name: Retry
          args:
            retries: 3
            statuses: BAD_GATEWAY

Retry GatewayFilter 通過這四個引數來控制重試機制： retries, statuses, methods, 和 series。

  • retries：重試次數，預設值是 3 次
  • statuses：HTTP 的狀態返回碼，取值請參考：org.springframework.http.HttpStatus
  • methods：指定哪些方法的請求需要進行重試邏輯，預設值是 GET 方法，取值參考：org.springframework.http.HttpMethod
  • series：一些列的狀態碼配置，取值參考：org.springframework.http.HttpStatus.Series。符合的某段狀態碼才會進行重試邏輯，預設值是 SERVER_ERROR，值是 5，也就是 5XX(5 開頭的狀態碼)，共有5 個值。

以上便是專案中常用的一些閘道器操作，更多關於 Spring Cloud GateWay 的使用請參考官網。

spring-cloud-gateway官網

示例程式碼-Github

參考：

https://cloud.spring.io/spring-cloud-gateway/single/spring-cloud-gateway.html
https://windmt.com/2018/05/11/spring-cloud-16-spring-cloud-gateway-others/

相關文章