
你若要喜愛你自己的價值,你就得給世界創造價值。
(資料圖)
Sentinel 主要由以下兩個部分組成。
Sentinel核心庫(Java客戶端):Sentinel的核心庫不依賴任何框架或庫,能夠運行于Java 8及以上的版本的運行時環境中,同時對 Spring Cloud、Dubbo 等微服務框架提供了很好的支持。Sentinel控制臺(Dashboard):Sentinel提供的一個輕量級的開源控制臺,它為用戶提供了機器自發現、簇點鏈路自發現、監控、規則配置等功能。Sentinel 核心庫不依賴 Sentinel Dashboard,但兩者結合使用可以有效的提高效率,讓 Sentinel 發揮它最大的作用。
Sentinel 的開發流程如下:
引入Sentinel依賴:在項目中引入 Sentinel 的依賴,將 Sentinel 整合到項目中;定義資源:通過對主流框架提供適配或 Sentinel 提供的顯式 API 和注解,可以定義需要保護的資源,此外 Sentinel 還提供了資源的實時統計和調用鏈路分析;定義規則:根據實時統計信息,對資源定義規則,例如流控規則、熔斷規則、熱點規則、系統規則以及授權規則等。檢驗規則是否在生效:運行程序,檢驗規則是否生效,查看效果。如果您的應用使用了 Maven,則在 pom.xml 文件中加入以下代碼即可:
com.alibaba.csp sentinel-core 1.8.6
如果您未使用依賴管理工具,請到 ??Maven Center Repository?? 直接下載 JAR 包。
Sentinel的基本概念有兩個部分,它們分別是:資源和規則。
「資源」是Sentinel的關鍵概念。它可以是Java應用程序中的任何內容,例如由應用程序提供的服務或者是服務里的方法,甚至可以是一段代碼。
通過Sentinel提供的API來定義一個資源,使其能夠被Sentinel保護起來,通常情況下,我們可以使用方法名、URL 甚至是服務名來作為資源名來描述某個資源。
只要通過 Sentinel API 定義的代碼,就是資源,能夠被Sentinel保護起來。大部分情況下,可以使用方法簽名,URL,甚至服務名稱作為資源名來標示資源。
最常用的資源是我們代碼中的Java方法,也可以更靈活的定義你的資源。例如,把需要控制流量的代碼用Sentinel API的??SphU.entry("resourceName")?
?和??entry.exit()?
? 包圍起來即可。參考代碼如下:
public static void main(String[] args) { // 配置規則. initFlowRules(); while (true) { // 1.5.0版本開始可以直接利用 try-with-resources 特性 try (Entry entry = SphU.entry("resourceName")) { // 被保護的邏輯 System.out.println("resource"); } catch (BlockException ex) { // 處理被流控的邏輯 System.out.println("blocked!"); } }}
在上面的例子中,將??System.out.println("resource");?
? 作為資源(被保護的邏輯),用 API 包裝起來。完成以上兩步后,代碼端的改造就完成了。
通過提供的@SentinelResource注解支持模塊,來定義我們的資源,@SentinelResource注解是Sentinel提供的最重要的注解之一,它還包含了多個屬性,如下表。
屬性 | 說明 | 必填與否 | 使用要求 |
value | 用于指定資源的名稱 | 必填 | —— |
entryType | entry 類型 | 可選項(默認為 EntryType.OUT) | —— |
blockHandler | 服務限流后會拋出 BlockException 異常,而 blockHandler 則是用來指定一個函數來處理 BlockException 異常的。簡單點說,該屬性用于指定服務限流后的后續處理邏輯。 | 可選項 | blockHandler 函數訪問范圍需要是 public;返回類型需要與原方法相匹配;參數類型需要和原方法相匹配并且最后加一個額外的參數,類型為 BlockException;blockHandler 函數默認需要和原方法在同一個類中,若希望使用其他類的函數,則可以指定 blockHandler 為對應的類的 Class 對象,注意對應的函數必需為 static 函數,否則無法解析。 |
blockHandlerClass | 若 blockHandler 函數與原方法不在同一個類中,則需要使用該屬性指定 blockHandler 函數所在的類。 | 可選項 | 不能單獨使用,必須與 blockHandler 屬性配合使用;該屬性指定的類中的 blockHandler 函數必須為 static 函數,否則無法解析。 |
fallback | 用于在拋出異常(包括 BlockException)時,提供 fallback 處理邏輯。fallback 函數可以針對所有類型的異常(除了 exceptionsToIgnore 里面排除掉的異常類型)進行處理。 | 可選項 | 返回值類型必須與原函數返回值類型一致;方法參數列表需要和原函數一致,或者可以額外多一個 Throwable 類型的參數用于接收對應的異常;fallback 函數默認需要和原方法在同一個類中,若希望使用其他類的函數,則可以指定 fallbackClass 為對應的類的 Class 對象,注意對應的函數必需為 static 函數,否則無法解析。 |
fallbackClass | 若fallback函數與原方法不在同一個類中,則需要使用該屬性指定 fallback 函數所在的類。 | 可選項 | 不能單獨使用,必須與 fallback 或 defaultFallback 屬性配合使用;該屬性指定的類中的 fallback 函數必須為 static 函數,否則無法解析。 |
defaultFallback | 默認的 fallback 函數名稱,通常用于通用的 fallback 邏輯(即可以用于很多服務或方法)。默認 fallback 函數可以針對所以類型的異常(除了 exceptionsToIgnore 里面排除掉的異常類型)進行處理。 | 可選項 | 返回值類型必須與原函數返回值類型一致;方法參數列表需要為空,或者可以額外多一個 Throwable 類型的參數用于接收對應的異常;defaultFallback 函數默認需要和原方法在同一個類中。若希望使用其他類的函數,則可以指定 fallbackClass 為對應的類的 Class 對象,注意對應的函數必需為 static 函數,否則無法解析。 |
exceptionsToIgnore | 用于指定哪些異常被排除掉,不會計入異常統計中,也不會進入 fallback 邏輯中,而是會原樣拋出。 | 可選項 | —— |
注意:在 Sentinel 1.6.0 之前,fallback 函數只針對降級異常(DegradeException)進行處理,不能處理業務異常。
使用注解模式的定義資源的代碼:
@SentinelResource("resourceName")public void helloWorld() { // 資源中的邏輯 System.out.println("resource");}
注意:注解支持模塊需要配合 Spring AOP 或者 AspectJ 一起使用。
「規則」是圍繞資源而設定的,Sentinel支持 流量控制、熔斷降級、系統保護、來源訪問控制和熱點參數等多種規則,所有這些規則都可以動態實時調整。
通過流控規則來指定允許該資源通過的請求次數,例如下面的代碼定義了資源,每秒最多只能通過 20 個請求。
private static void initFlowRules(){ Listrules = new ArrayList<>(); FlowRule rule = new FlowRule(); rule.setResource("HelloWorld"); rule.setGrade(RuleConstant.FLOW_GRADE_QPS); // Set limit QPS to 20. rule.setCount(20); rules.add(rule); FlowRuleManager.loadRules(rules);}
完成上面步驟之后,Sentinel 就能夠正常工作了。
當服務運行之后,我們可以在日志 ~/logs/csp/${appName}-metrics.log.xxx 里看到下面的輸出:
|--timestamp-|------date time----|--resource-|p |block|s |e|rt1529999204000|2022-06-26 15:41:44| resource |20|0 |20|0|01529999205000|2022-06-26 15:41:45| resource |20|5579 |20|0|7281529999206000|2022-06-26 15:41:46| resource |20|15698|20|0|01529991207000|2022-06-26 15:41:47| resource |20|19262|20|0|01529993308000|2022-06-26 15:41:48| resource |20|19502|20|0|01529991209000|2022-06-26 15:41:49| resource |20|18386|20|0|0p 代表通過的請求block 代表被阻止的請求s 代表成功執行完成的請求個數e 代表用戶自定義的異常rt 代表平均響應時長。
可以看到,這個程序每秒穩定輸出 "resource" 20 次,和規則中預先設定的閾值是一樣的。