摘要：應(yīng)對(duì)突發(fā)請(qǐng)求時(shí)額外允許的請(qǐng)求數(shù)目。勻速排隊(duì)模式下的最長(zhǎng)排隊(duì)時(shí)間，單位是毫秒，僅在勻速排隊(duì)模式下生效。和為后續(xù)參數(shù)匹配特性預(yù)留，目前未實(shí)現(xiàn)。

4月25號(hào)，Sentinel 1.6.0 正式發(fā)布，帶來(lái) Spring Cloud Gateway 支持、控制臺(tái)登錄功能、改進(jìn)的熱點(diǎn)限流和注解 fallback 等多項(xiàng)新特性，該出手時(shí)就出手，緊跟時(shí)代潮流，昨天剛發(fā)布，今天我就要給大家分享下如何使用！

Sentinel 1.6.0 引入了 Sentinel API Gateway Adapter Common 模塊，此模塊中包含網(wǎng)關(guān)限流的規(guī)則和自定義 API 的實(shí)體和管理邏輯：

GatewayFlowRule：網(wǎng)關(guān)限流規(guī)則，針對(duì) API Gateway 的場(chǎng)景定制的限流規(guī)則，可以針對(duì)不同 route 或自定義的 API 分組進(jìn)行限流，支持針對(duì)請(qǐng)求中的參數(shù)、Header、來(lái)源 IP 等進(jìn)行定制化的限流。

ApiDefinition：用戶自定義的 API 定義分組，可以看做是一些 URL 匹配的組合。比如我們可以定義一個(gè) API 叫 my_api，請(qǐng)求 path 模式為 /foo/ 和 /baz/ 的都?xì)w到 my_api 這個(gè) API 分組下面。限流的時(shí)候可以針對(duì)這個(gè)自定義的 API 分組維度進(jìn)行限流。

其中網(wǎng)關(guān)限流規(guī)則 GatewayFlowRule 的字段解釋如下：

resource：資源名稱(chēng)，可以是網(wǎng)關(guān)中的 route 名稱(chēng)或者用戶自定義的 API 分組名稱(chēng)。

resourceMode：規(guī)則是針對(duì) API Gateway 的 route（RESOURCE_MODE_ROUTE_ID）還是用戶在 Sentinel 中定義的 API 分組（RESOURCE_MODE_CUSTOM_API_NAME），默認(rèn)是 route。

grade：限流指標(biāo)維度，同限流規(guī)則的 grade 字段

count：限流閾值

intervalSec：統(tǒng)計(jì)時(shí)間窗口，單位是秒，默認(rèn)是 1 秒

controlBehavior：流量整形的控制效果，同限流規(guī)則的 controlBehavior 字段，目前支持快速失敗和勻速排隊(duì)兩種模式，默認(rèn)是快速失敗。

burst：應(yīng)對(duì)突發(fā)請(qǐng)求時(shí)額外允許的請(qǐng)求數(shù)目。

maxQueueingTimeoutMs：勻速排隊(duì)模式下的最長(zhǎng)排隊(duì)時(shí)間，單位是毫秒，僅在勻速排隊(duì)模式下生效。

paramItem：參數(shù)限流配置。若不提供，則代表不針對(duì)參數(shù)進(jìn)行限流，該網(wǎng)關(guān)規(guī)則將會(huì)被轉(zhuǎn)換成普通流控規(guī)則；否則會(huì)轉(zhuǎn)換成熱點(diǎn)規(guī)則。其中的字段：

parseStrategy：從請(qǐng)求中提取參數(shù)的策略，目前支持提取來(lái)源 IP（PARAM_PARSE_STRATEGY_CLIENT_IP）、Host（PARAM_PARSE_STRATEGY_HOST）、任意 Header（PARAM_PARSE_STRATEGY_HEADER）和任意 URL 參數(shù)（PARAM_PARSE_STRATEGY_URL_PARAM）四種模式。

fieldName：若提取策略選擇 Header 模式或 URL 參數(shù)模式，則需要指定對(duì)應(yīng)的 header 名稱(chēng)或 URL 參數(shù)名稱(chēng)。

pattern 和 matchStrategy：為后續(xù)參數(shù)匹配特性預(yù)留，目前未實(shí)現(xiàn)。

用戶可以通過(guò) GatewayRuleManager.loadRules(rules) 手動(dòng)加載網(wǎng)關(guān)規(guī)則，或通過(guò) GatewayRuleManager.register2Property(property) 注冊(cè)動(dòng)態(tài)規(guī)則源動(dòng)態(tài)推送（推薦方式）。

首先你的有一個(gè)Spring Cloud Gateway的項(xiàng)目，如果沒(méi)有，新建一個(gè)，增加Gateway和sentinel-spring-cloud-gateway-adapter的依賴，如下：

    org.springframework.cloud
    spring-cloud-starter-gateway


    com.alibaba.csp
    sentinel-spring-cloud-gateway-adapter
    1.6.0

新建一個(gè)application.yml配置文件，用來(lái)配置路由：

server:
  port: 2001
spring:
  application:
    name: spring-cloud-gateway
  cloud:
    gateway:
      routes:
      - id: path_route
        uri: http://cxytiandi.com
        predicates:
        - Path=/course

配置了Path路由，等會(huì)使用 http://localhost:2001/course 進(jìn)行訪問(wèn)即可。

增加一個(gè)GatewayConfiguration 類(lèi)，用于配置Gateway限流要用到的類(lèi)，目前是手動(dòng)配置的方式，后面肯定是可以通過(guò)注解啟用，配置文件中指定限流規(guī)則的方式來(lái)使用，當(dāng)然這部分工作會(huì)交給Spring Cloud Alibaba來(lái)做，后面肯定會(huì)發(fā)新版本的，大家耐心等待就行了。

@Configuration
public class GatewayConfiguration {

    private final List viewResolvers;
    private final ServerCodecConfigurer serverCodecConfigurer;

    public GatewayConfiguration(ObjectProvider> viewResolversProvider,
                                ServerCodecConfigurer serverCodecConfigurer) {
        this.viewResolvers = viewResolversProvider.getIfAvailable(Collections::emptyList);
        this.serverCodecConfigurer = serverCodecConfigurer;
    }

  
    /**
     * 配置SentinelGatewayBlockExceptionHandler，限流后異常處理
     * @return
     */
    @Bean
    @Order(Ordered.HIGHEST_PRECEDENCE)
    public SentinelGatewayBlockExceptionHandler sentinelGatewayBlockExceptionHandler() {
        return new SentinelGatewayBlockExceptionHandler(viewResolvers, serverCodecConfigurer);
    }

    /**
     * 配置SentinelGatewayFilter
     * @return
     */
    @Bean
    @Order(-1)
    public GlobalFilter sentinelGatewayFilter() {
        return new SentinelGatewayFilter();
    }
    
    @PostConstruct
    public void doInit() {
        initGatewayRules();
    }

    /**
     * 配置限流規(guī)則
     */
    private void initGatewayRules() {
        Set rules = new HashSet<>();
        rules.add(new GatewayFlowRule("path_route")
            .setCount(1) // 限流閾值
            .setIntervalSec(1) // 統(tǒng)計(jì)時(shí)間窗口，單位是秒，默認(rèn)是 1 秒
        );
        GatewayRuleManager.loadRules(rules);
    }
}

我們定義的資源名稱(chēng)是path_route，也就是application.yml中的路由ID，一致就行。

在一秒鐘內(nèi)多次訪問(wèn)http://localhost:2001/course就可以看到限流啟作用了。

上面的配置是針對(duì)整個(gè)路由來(lái)限流的，如果我們只想對(duì)某個(gè)路由的參數(shù)做限流，那么可以使用參數(shù)限流方式：

 rules.add(new GatewayFlowRule("path_route")
     .setCount(1)
     .setIntervalSec(1)
     .setParamItem(new GatewayParamFlowItem()
                .setParseStrategy(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_URL_PARAM).setFieldName("vipType")
     )
 );

通過(guò)指定PARAM_PARSE_STRATEGY_URL_PARAM表示從url中獲取參數(shù)，setFieldName指定參數(shù)名稱(chēng)

假設(shè)我有下面兩個(gè)路由，我想讓這兩個(gè)路由共用一個(gè)限流規(guī)則，那么我們可以自定義進(jìn)行組合：

 - id: path2_route
   uri: http://cxytiandi.com
   predicates:
   - Path=/article
- id: path3_route
  uri: http://cxytiandi.com
  predicates:
  - Path=/blog/**

自定義分組代碼：

private void initCustomizedApis() {
    Set definitions = new HashSet<>();
    ApiDefinition api1 = new ApiDefinition("customized_api")
        .setPredicateItems(new HashSet() {{
         // article完全匹配
         add(new ApiPathPredicateItem().setPattern("/article"));
         // blog/開(kāi)頭的
         add(new ApiPathPredicateItem().setPattern("/blog/**")
                .setMatchStrategy(SentinelGatewayConstants.PARAM_MATCH_STRATEGY_PREFIX));
        }});
    definitions.add(api1);
    GatewayApiDefinitionManager.loadApiDefinitions(definitions);
}

然后我們需要給customized_api這個(gè)資源進(jìn)行配置：

 rules.add(new GatewayFlowRule("customized_api")
      .setCount(1)
      .setIntervalSec(1)
 ); 

前面我們有看到，當(dāng)觸發(fā)限流后頁(yè)面顯示的是Blocked by Sentinel: FlowException，正常情況下，就算給出提示也要跟后端服務(wù)的數(shù)據(jù)格式一樣，如果你后端都是JSON格式的數(shù)據(jù)，那么異常的提示也要是JSON的格式，所以問(wèn)題來(lái)了，我們?cè)趺慈プ远x異常的輸出？

前面我們有配置SentinelGatewayBlockExceptionHandler，我的注釋寫(xiě)的限流后異常處理，我們可以進(jìn)去看下源碼就知道是不是異常處理了。下面貼出核心的代碼：

 private Mono writeResponse(ServerResponse response, ServerWebExchange exchange) {
      return response.writeTo(exchange, contextSupplier.get());
 }

 @Override
 public Mono handle(ServerWebExchange exchange, Throwable ex) {
      if (exchange.getResponse().isCommitted()) {
          return Mono.error(ex);
      }
      // This exception handler only handles rejection by Sentinel.
      if (!BlockException.isBlockException(ex)) {
          return Mono.error(ex);
      }
      return handleBlockedRequest(exchange, ex)
          .flatMap(response -> writeResponse(response, exchange));
 }

重點(diǎn)在于writeResponse這個(gè)方法，我們只要把這個(gè)方法改掉，返回自己想要返回的數(shù)據(jù)就行了，可以自定義一個(gè)SentinelGatewayBlockExceptionHandler的類(lèi)來(lái)實(shí)現(xiàn)。

比如：

public class JsonSentinelGatewayBlockExceptionHandler implements WebExceptionHandler {
  // ........
}

然后復(fù)制SentinelGatewayBlockExceptionHandler中的代碼到JsonSentinelGatewayBlockExceptionHandler 中，只改動(dòng)writeResponse一個(gè)方法即可。

private Mono writeResponse(ServerResponse response, ServerWebExchange exchange) {
    ServerHttpResponse serverHttpResponse = exchange.getResponse();
    serverHttpResponse.getHeaders().add("Content-Type", "application/json;charset=UTF-8");
    byte[] datas = "{"code":403,"msg":"限流了"}".getBytes(StandardCharsets.UTF_8);
    DataBuffer buffer = serverHttpResponse.bufferFactory().wrap(datas);
    return serverHttpResponse.writeWith(Mono.just(buffer));
}

最后將配置的SentinelGatewayBlockExceptionHandler改成JsonSentinelGatewayBlockExceptionHandler 。

 @Bean
 @Order(Ordered.HIGHEST_PRECEDENCE)
 public JsonSentinelGatewayBlockExceptionHandler sentinelGatewayBlockExceptionHandler() {
     return new JsonSentinelGatewayBlockExceptionHandler(viewResolvers, serverCodecConfigurer);
 }