@SentinelResource注解如何使用?請你過目!
Hello,大家好,我是麥洛,今天帶大家來了解一下Sentinel中@SentinelResource注解的使用方法 ,這篇文章主要向大家介紹一下以下內容
- @SentinelResource 注解
- 注解介紹
- 注解使用
@SentinelResource 注解
注意：注解方式埋點不支持 private 方法。
注解介紹
@SentinelResource 用于定義資源，并提供可選的異常處理和 fallback 配置項。
@SentinelResource 注解包含以下屬性：
1.value：資源名稱，必需項(不能為空)
2.entryType：entry 類型，可選項(默認為 EntryType.OUT)
3.blockHandler / blockHandlerClass: blockHandler 對應處理 BlockException 的函數名稱，可選項。blockHandler 函數訪問范圍需要是 public，返回類型需要與原方法相匹配，參數類型需要和原方法相匹配并且最后加一個額外的參數，類型為 BlockException。blockHandler 函數默認需要和原方法在同一個類中。若希望使用其他類的函數，則可以指定 blockHandlerClass 為對應的類的 Class 對象，注意對應的函數必需為 static 函數，否則無法解析。
4.fallback/fallbackClass：fallback 函數名稱，可選項，用于在拋出異常的時候提供 fallback 處理邏輯。fallback 函數可以針對所有類型的異常(除了exceptionsToIgnore里面排除掉的異常類型)進行處理。fallback 函數簽名和位置要求：
- 返回值類型必須與原函數返回值類型一致;
- 方法參數列表需要和原函數一致，或者可以額外多一個 Throwable 類型的參數用于接收對應的異常。
- fallback 函數默認需要和原方法在同一個類中。若希望使用其他類的函數，則可以指定 fallbackClass 為對應的類的 Class 對象，注意對應的函數必需為 static 函數，否則無法解析。
5.defaultFallback(since 1.6.0)：默認的 fallback 函數名稱，可選項，通常用于通用的 fallback 邏輯(即可以用于很多服務或方法)。默認 fallback 函數可以針對所有類型的異常(除了exceptionsToIgnore里面排除掉的異常類型)進行處理。若同時配置了 fallback 和 defaultFallback，則只有 fallback 會生效。defaultFallback 函數簽名要求：
- 返回值類型必須與原函數返回值類型一致;
- 方法參數列表需要為空，或者可以額外多一個 Throwable 類型的參數用于接收對應的異常。
- defaultFallback 函數默認需要和原方法在同一個類中。若希望使用其他類的函數，則可以指定 fallbackClass 為對應的類的 Class 對象，注意對應的函數必需為 static 函數，否則無法解析。
5.exceptionsToIgnore(since 1.6.0)：用于指定哪些異常被排除掉，不會計入異常統計中，也不會進入 fallback 邏輯中，而是會原樣拋出。
1.8.0 版本開始，defaultFallback 支持在類級別進行配置。
注：1.6.0 之前的版本 fallback 函數只針對降級異常(DegradeException)進行處理，不能針對業務異常進行處理。
特別地，若 blockHandler 和 fallback 都進行了配置，則被限流降級而拋出 BlockException 時只會進入 blockHandler 處理邏輯。若未配置 blockHandler、fallback 和 defaultFallback，則被限流降級時會將 BlockException 直接拋出(若方法本身未定義 throws BlockException 則會被 JVM 包裝一層 UndeclaredThrowableException)。
注解使用
代碼編寫
代碼結構
SentinelController
- /**
- * 注解 @SentinelResource學習
- * @author Milo Lee
- * @date 2021-03-23 11:33
- */
- @RestController
- public class SentinelController {
- @Autowired
- private ISentinelService service;
- @GetMapping(value = "/hello/{s}")
- public String apiHello(@PathVariable long s) {
- return service.hello(s);
- }
- }
ISentinelService
- /**
- * @author Milo Lee
- * @date 2021-03-23 11:34
- */
- public interface ISentinelService {
- String hello (long s);
- }
SentinelServiceImpl
- /**
- * @author Milo Lee
- * @date 2021-03-23 11:34
- */
- @Service
- @Slf4j
- public class SentinelServiceImpl implements ISentinelService {
- /**
- *Sentinel 提供了 @SentinelResource 注解用于定義資源
- * @param s
- * @return
- */
- @Override
- //value：資源名稱，必需項（不能為空）
- //blockHandler 對應處理 BlockException 的函數名稱
- //fallback 用于在拋出異常的時候提供 fallback 處理邏輯
- @SentinelResource(value = "hello", blockHandler = "exceptionHandler", fallback = "helloFallback")
- public String hello(long s) {
- log.error("hello:{}",s);
- return String.format("Hello at %d", s);
- }
- // Fallback 函數，函數簽名與原函數一致或加一個 Throwable 類型的參數.
- public String helloFallback(long s) {
- log.error("helloFallback:{}",s);
- return String.format("Halooooo %d", s);
- }
- // Block 異常處理函數，參數最后多一個 BlockException，其余與原函數一致.
- public String exceptionHandler(long s, BlockException ex) {
- // Do some log here.
- log.error("exceptionHandler:{}",s);
- ex.printStackTrace();
- return "Oops, error occurred at " + s;
- }
- }
啟動我們的項目,訪問我們的測試方法(多刷新幾次,去看控制面板)
限流測試
現在我們為我們的資源:hello 配置一個流控規則,配置步驟如下圖
配置成功:
回到我們的頁面,快速刷新頁面,我們會發現偶爾有如下信息顯示,說明我們配置的流控規則成功進行了攔截
控制臺日志:
根據我們上面的學習,如果超過我們配置的QPS,代碼會拋出BlockException異常,為什么代碼里面是FlowException,通過查看源碼我們會發現FlowException其實是BlockException的子級
經過上面的測試,我們發現成功實現注解開發實現了限流
降級測試
降級測試之前,我們需要修改下我們的代碼
前:
- @SentinelResource(value = "hello", blockHandler = "exceptionHandler", fallback = "helloFallback")
后:
- @SentinelResource(value = "hello", fallback = "helloFallback")
配置流控規則
配置降級規則:
測試方法
根據我們配置的規則,如果qps>1,肯定會出發BlockException,這時候降級規則判斷異常比例超過請求次數的20%,就會自動觸發降級😛;
我的點擊速率: 勻速 ---到--- 快速😂
大家觀察這里的日志,在我剛開始勻速點擊時候,并沒有進入helloFallback方法,當我快速點擊時候,進入了helloFallback方法,說明這時候降級規則生效,觸發降級,進入回調函數helloFallback中;
今天的分享就到這里,謝謝大家
