Sentinel 1.6.0 引入了 Sentinel API Gateway Adapter Common 模塊，此模塊中包含網關限流的規則和自定義 API 的實體和管理邏輯：
GatewayFlowRule：網關限流規則，針對 API Gateway 的場景定制的限流規則，可以針對不同 route 或自定義的 API 分組進行限流，支持針對請求中的參數、Header、來源 IP 等進行定制化的限流。ApiDefinition：用戶自定義的 API 定義分組，可以看做是一些 URL 匹配的組合。比如我們可以定義一個 API 叫my_api，請求 path 模式為/foo/**和/baz/**的都歸到my_api這個 API 分組下面。限流的時候可以針對這個自定義的 API 分組維度進行限流。
其中網關限流規則 GatewayFlowRule 的字段解釋如下：
resource：資源名稱，可以是網關中的 route 名稱或者用戶自定義的 API 分組名稱。resourceMode：規則是針對 API Gateway 的 route（RESOURCE_MODE_ROUTE_ID）還是用戶在 Sentinel 中定義的 API 分組（RESOURCE_MODE_CUSTOM_API_NAME），默認是 route。grade：限流指標維度，同限流規則的grade字段。count：限流閾值intervalSec：統計時間窗口，單位是秒，默認是 1 秒。controlBehavior：流量整形的控制效果，同限流規則的controlBehavior字段，目前支持快速失敗和勻速排隊兩種模式，默認是快速失敗。burst：應對突發請求時額外允許的請求數目。maxQueueingTimeoutMs：勻速排隊模式下的最長排隊時間，單位是毫秒，僅在勻速排隊模式下生效。paramItem：參數限流配置。若不提供，則代表不針對參數進行限流，該網關規則將會被轉換成普通流控規則；否則會轉換成熱點規則。其中的字段：parseStrategy：從請求中提取參數的策略，目前支持提取來源 IP（PARAM_PARSE_STRATEGY_CLIENT_IP）、Host（PARAM_PARSE_STRATEGY_HOST）、任意 Header（PARAM_PARSE_STRATEGY_HEADER）和任意 URL 參數（PARAM_PARSE_STRATEGY_URL_PARAM）四種模式。fieldName：若提取策略選擇 Header 模式或 URL 參數模式，則需要指定對應的 header 名稱或 URL 參數名稱。pattern：參數值的匹配模式，只有匹配該模式的請求屬性值會納入統計和流控；若為空則統計該請求屬性的所有值。（1.6.2 版本開始支持）matchStrategy：參數值的匹配策略，目前支持精確匹配（PARAM_MATCH_STRATEGY_EXACT）、子串匹配（PARAM_MATCH_STRATEGY_CONTAINS）和正則匹配（PARAM_MATCH_STRATEGY_REGEX）。（1.6.2 版本開始支持）
用戶可以通過 GatewayRuleManager.loadRules(rules) 手動加載網關規則，或通過 GatewayRuleManager.register2Property(property) 注冊動態規則源動態推送（推薦方式）。
Spring Cloud Gateway
從 1.6.0 版本開始，Sentinel 提供了 Spring Cloud Gateway 的適配模塊，可以提供兩種資源維度的限流：
- route 維度：即在 Spring 配置文件中配置的路由條目，資源名為對應的 routeId
- 自定義 API 維度：用戶可以利用 Sentinel 提供的 API 來自定義一些 API 分組
使用時需引入以下模塊（以 Maven 為例）：
<dependency> <groupId>com.alibaba.csp</groupId> <artifactId>sentinel-core</artifactId> <version>1.7.2</version> </dependency> <dependency> <groupId>com.alibaba.csp</groupId> <artifactId>sentinel-spring-cloud-gateway-adapter</artifactId> <version>1.7.2</version> </dependency> <dependency> <groupId>com.alibaba.csp</groupId> <artifactId>sentinel-transport-simple-http</artifactId> <version>1.7.2</version> </dependency>
使用時只需注入對應的 SentinelGatewayFilter 實例以及 SentinelGatewayBlockExceptionHandler 實例即可。
網關設置：
import org.springframework.cloud.gateway.route.RouteLocator; import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration public class SpringCloudConfig { @Bean public RouteLocator gatewayRoutes(RouteLocatorBuilder builder) { return builder.routes() .route(r -> r.path("/employee/**") .uri("http://localhost:8081/") .id("employeeModule")) .route(r -> r.path("/consumer/**") .uri("http://localhost:8082/") .id("consumerModule")) .build(); } }
Sentinel限流設置
Set<GatewayFlowRule> rules = new HashSet<>(); //規則是針對 API Gateway 的 route（RESOURCE_MODE_ROUTE_ID），默認是 route。 rules.add(new GatewayFlowRule("employeeModule") .setCount(2) .setIntervalSec(1) ); //規則是針對在 Sentinel 中定義的 API 分組（RESOURCE_MODE_CUSTOM_API_NAME） rules.add(new GatewayFlowRule("account_api") .setResourceMode(SentinelGatewayConstants.RESOURCE_MODE_CUSTOM_API_NAME) .setCount(30) .setIntervalSec(1) );
我們對employeeModule為id的網關設置2個qps的限流閾值，當大於2時出現：
Blocked by Sentinel: ParamFlowException
控制流程：
上圖的整體流程如下：
1、外部請求進入API Gateway時會經過Sentinel實現的filter，其中會依次進行 路由/API 分組匹配、請求屬性解析和參數組裝。
2、Sentinel 會根據配置的網關流控規則來解析請求屬性，並依照參數索引順序組裝參數數組，最終傳入SphU.entry(res, args) 中。
3、Sentinel API Gateway Adapter Common 模塊向 Slot Chain 中添加了一個 GatewayFlowSlot，專門用來做網關規則的檢查。
4、GatewayFlowSlot會從GatewayRuleManager中提取生成的熱點參數規則，根據傳入的參數依次進行規則檢查。若某條規則不針對請求屬性，則會在參數最后一個位置置入預設的常量，達到普通流控的效果。注意：
當通過 GatewayRuleManager 加載網關流控規則GatewayFlowRule時，無論是否針對請求屬性進行限流，Sentinel底層都會將網關流控規則轉化為熱點參數規則ParamFlowRule，存儲在GatewayRuleManager 中，與正常的熱點參數規則相隔離。轉換時Sentinel會根據請求屬性配置，為網關流控規則設置參數索引idx，並同步到生成的熱點參數規則中
完整Demo工程下載：