阿里Sentinel支持Spring Cloud Gateway的實現(xiàn)
1. 前言
4月25號，Sentinel 1.6.0 正式發(fā)布，帶來 Spring Cloud Gateway 支持、控制臺登錄功能、改進的熱點限流和注解 fallback 等多項新特性，該出手時就出手，緊跟時代潮流，昨天剛發(fā)布，今天我就要給大家分享下如何使用！
2. 介紹（本段來自Sentinel文檔）
Sentinel 1.6.0 引入了 Sentinel API Gateway Adapter Common 模塊，此模塊中包含網(wǎng)關限流的規(guī)則和自定義 API 的實體和管理邏輯：
GatewayFlowRule：網(wǎng)關限流規(guī)則，針對 API Gateway 的場景定制的限流規(guī)則，可以針對不同 route 或自定義的 API 分組進行限流，支持針對請求中的參數(shù)、Header、來源 IP 等進行定制化的限流。
ApiDefinition：用戶自定義的 API 定義分組，可以看做是一些 URL 匹配的組合。比如我們可以定義一個 API 叫 my_api，請求 path 模式為 /foo/ 和 /baz/ 的都歸到 my_api 這個 API 分組下面。限流的時候可以針對這個自定義的 API 分組維度進行限流。
其中網(wǎng)關限流規(guī)則 GatewayFlowRule 的字段解釋如下：
- resource：資源名稱，可以是網(wǎng)關中的 route 名稱或者用戶自定義的 API 分組名稱。
- resourceMode：規(guī)則是針對 API Gateway 的 route（RESOURCE_MODE_ROUTE_ID）還是用戶在 Sentinel 中定義的 API 分組（RESOURCE_MODE_CUSTOM_API_NAME），默認是 route。
- grade：限流指標維度，同限流規(guī)則的 grade 字段
- count：限流閾值
- intervalSec：統(tǒng)計時間窗口，單位是秒，默認是 1 秒
- controlBehavior：流量整形的控制效果，同限流規(guī)則的 controlBehavior 字段，目前支持快速失敗和勻速排隊兩種模式，默認是快速失敗。
- burst：應對突發(fā)請求時額外允許的請求數(shù)目。
- maxQueueingTimeoutMs：勻速排隊模式下的最長排隊時間，單位是毫秒，僅在勻速排隊模式下生效。
- paramItem：參數(shù)限流配置。若不提供，則代表不針對參數(shù)進行限流，該網(wǎng)關規(guī)則將會被轉換成普通流控規(guī)則；否則會轉換成熱點規(guī)則。其中的字段：
- parseStrategy：從請求中提取參數(shù)的策略，目前支持提取來源 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ù)模式，則需要指定對應的 header 名稱或 URL 參數(shù)名稱。
- pattern 和 matchStrategy：為后續(xù)參數(shù)匹配特性預留，目前未實現(xiàn)。
用戶可以通過 GatewayRuleManager.loadRules(rules) 手動加載網(wǎng)關規(guī)則，或通過 GatewayRuleManager.register2Property(property) 注冊動態(tài)規(guī)則源動態(tài)推送（推薦方式）。
3. 使用
3.1 快速體驗
首先你的有一個Spring Cloud Gateway的項目，如果沒有，新建一個，增加Gateway和sentinel-spring-cloud-gateway-adapter的依賴，如下：
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> </dependency> <dependency> <groupId>com.alibaba.csp</groupId> <artifactId>sentinel-spring-cloud-gateway-adapter</artifactId> <version>1.6.0</version> </dependency>
新建一個application.yml配置文件，用來配置路由：
server:
port: 2001
spring:
application:
name: spring-cloud-gateway
cloud:
gateway:
routes:
- id: path_route
uri: http://cxytiandi.com
predicates:
- Path=/course
配置了Path路由，等會使用 http://localhost:2001/course 進行訪問即可。
增加一個GatewayConfiguration 類，用于配置Gateway限流要用到的類，目前是手動配置的方式，后面肯定是可以通過注解啟用，配置文件中指定限流規(guī)則的方式來使用，當然這部分工作會交給Spring Cloud Alibaba來做，后面肯定會發(fā)新版本的，大家耐心等待就行了。
@Configuration
public class GatewayConfiguration {
private final List<ViewResolver> viewResolvers;
private final ServerCodecConfigurer serverCodecConfigurer;
public GatewayConfiguration(ObjectProvider<List<ViewResolver>> 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<GatewayFlowRule> rules = new HashSet<>();
rules.add(new GatewayFlowRule("path_route")
.setCount(1) // 限流閾值
.setIntervalSec(1) // 統(tǒng)計時間窗口，單位是秒，默認是 1 秒
);
GatewayRuleManager.loadRules(rules);
}
}
我們定義的資源名稱是path_route，也就是application.yml中的路由ID，一致就行。
在一秒鐘內多次訪問http://localhost:2001/course就可以看到限流啟作用了。
3.2 指定參數(shù)限流
上面的配置是針對整個路由來限流的，如果我們只想對某個路由的參數(shù)做限流，那么可以使用參數(shù)限流方式：
rules.add(new GatewayFlowRule("path_route")
.setCount(1)
.setIntervalSec(1)
.setParamItem(new GatewayParamFlowItem()
.setParseStrategy(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_URL_PARAM).setFieldName("vipType")
)
);
通過指定PARAM_PARSE_STRATEGY_URL_PARAM表示從url中獲取參數(shù)，setFieldName指定參數(shù)名稱
3.3 自定義API分組
假設我有下面兩個路由，我想讓這兩個路由共用一個限流規(guī)則，那么我們可以自定義進行組合：
- id: path2_route uri: http://cxytiandi.com predicates: - Path=/article - id: path3_route uri: http://cxytiandi.com predicates: - Path=/blog/**
自定義分組代碼：
private void initCustomizedApis() {
Set<ApiDefinition> definitions = new HashSet<>();
ApiDefinition api1 = new ApiDefinition("customized_api")
.setPredicateItems(new HashSet<ApiPredicateItem>() {{
// article完全匹配
add(new ApiPathPredicateItem().setPattern("/article"));
// blog/開頭的
add(new ApiPathPredicateItem().setPattern("/blog/**")
.setMatchStrategy(SentinelGatewayConstants.PARAM_MATCH_STRATEGY_PREFIX));
}});
definitions.add(api1);
GatewayApiDefinitionManager.loadApiDefinitions(definitions);
}
然后我們需要給customized_api這個資源進行配置：
rules.add(new GatewayFlowRule("customized_api")
.setCount(1)
.setIntervalSec(1)
);
3.4 自定義異常提示
前面我們有看到，當觸發(fā)限流后頁面顯示的是Blocked by Sentinel: FlowException，正常情況下，就算給出提示也要跟后端服務的數(shù)據(jù)格式一樣，如果你后端都是JSON格式的數(shù)據(jù)，那么異常的提示也要是JSON的格式，所以問題來了，我們怎么去自定義異常的輸出？
前面我們有配置SentinelGatewayBlockExceptionHandler，我的注釋寫的限流后異常處理，我們可以進去看下源碼就知道是不是異常處理了。下面貼出核心的代碼：
private Mono<Void> writeResponse(ServerResponse response, ServerWebExchange exchange) {
return response.writeTo(exchange, contextSupplier.get());
}
@Override
public Mono<Void> 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));
}
重點在于writeResponse這個方法，我們只要把這個方法改掉，返回自己想要返回的數(shù)據(jù)就行了，可以自定義一個SentinelGatewayBlockExceptionHandler的類來實現(xiàn)。
比如：
public class JsonSentinelGatewayBlockExceptionHandler implements WebExceptionHandler {
// ........
}
然后復制SentinelGatewayBlockExceptionHandler中的代碼到JsonSentinelGatewayBlockExceptionHandler 中，只改動writeResponse一個方法即可。
private Mono<Void> 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);
}
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。
相關文章
這篇文章主要介紹了java實現(xiàn)圖片寫入高清字體及帶邊框的方法,涉及java針對圖片及文字的相關操作技巧,具有一定參考借鑒價值,需要的朋友可以參考下2015-07-07
解決配置Feign時報錯PathVariable annotation was empty
在配置Feign客戶端時,如果遇到`@PathVariable`注解為空的問題,是因為在聲明接口方法時沒有為`@PathVariable`注解提供`value`屬性,解決方法是為`@PathVariable`注解添加`value`屬性,這樣就可以避免報錯,并成功啟動Feign客戶端2024-11-11
本文主要介紹了Java實現(xiàn)threadLocal線程池獲取，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2023-07-07
MQTT是一種輕量級的消息傳輸協(xié)議,特別適用于物聯(lián)網(wǎng)（IoT）場景,具有低帶寬、高延遲網(wǎng)絡環(huán)境下的優(yōu)勢,SpringBoot作為流行的 Java開發(fā)框架,能夠方便地與MQTT集成,實現(xiàn)高效的消息通信,本文將詳細介紹如何在SpringBoot項目中接入MQTT,需要的朋友可以參考下2025-03-03
這篇文章主要介紹了java語言注解基礎概念詳解，具有一定借鑒價值，需要的朋友可以參考下。2017-12-12
這篇文章介紹了java 讀取excel內容具體代碼，有需要的朋友可以參考一下2013-10-10
java微信企業(yè)號開發(fā)之發(fā)送消息（文本、圖片、語音）
這篇文章主要為大家詳細介紹了java微信企業(yè)號開發(fā)之發(fā)送消息，發(fā)送類型包括文本、圖片、語音，感興趣的小伙伴們可以參考一下2016-06-06
在開發(fā)的過程中，很多業(yè)務場景需要一個樹形結構的結果集進行前端展示，也可以理解為是一個無限父子結構，常見的有報表指標結構、菜單結構等，這篇文章主要介紹了Java遞歸實現(xiàn)樹形結構的兩種方式,需要的朋友可以參考下2022-10-10
鏈表是一種物理存儲單元上非連續(xù)、非順序的存儲結構,java代碼實現(xiàn)單鏈表,插入,刪除和遍歷等功能,這篇文章主要給大家介紹了關于Java數(shù)據(jù)結構和算法之鏈表的相關資料,需要的朋友可以參考下2024-01-01
下面小編就為大家?guī)硪黄狫ava基礎的幾道練習題(分享)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧，希望可以幫到你2021-07-07