@SentinelResource注解怎么用

這篇文章主要介紹了@SentinelResource注解怎么用，具有一定借鑒價(jià)值，感興趣的朋友可以參考下，希望大家閱讀完這篇文章之后大有收獲，下面讓小編帶著大家一起了解一下。

@SentinelResource 注解

注意：注解方式埋點(diǎn)不支持 private 方法。

注解介紹

@SentinelResource 用于定義資源，并提供可選的異常處理和 fallback 配置項(xiàng)。

@SentinelResource 注解包含以下屬性：

1.value：資源名稱，必需項(xiàng)(不能為空)

2.entryType：entry 類型，可選項(xiàng)(默認(rèn)為 EntryType.OUT)

3.blockHandler / blockHandlerClass: blockHandler 對(duì)應(yīng)處理 BlockException  的函數(shù)名稱，可選項(xiàng)。blockHandler 函數(shù)訪問范圍需要是  public，返回類型需要與原方法相匹配，參數(shù)類型需要和原方法相匹配并且最后加一個(gè)額外的參數(shù)，類型為 BlockException。blockHandler  函數(shù)默認(rèn)需要和原方法在同一個(gè)類中。若希望使用其他類的函數(shù)，則可以指定 blockHandlerClass 為對(duì)應(yīng)的類的 Class 對(duì)象，注意對(duì)應(yīng)的函數(shù)必需為  static 函數(shù)，否則無法解析。

4.fallback/fallbackClass：fallback 函數(shù)名稱，可選項(xiàng)，用于在拋出異常的時(shí)候提供 fallback 處理邏輯。fallback  函數(shù)可以針對(duì)所有類型的異常(除了exceptionsToIgnore里面排除掉的異常類型)進(jìn)行處理。fallback 函數(shù)簽名和位置要求：

• 返回值類型必須與原函數(shù)返回值類型一致;

• 方法參數(shù)列表需要和原函數(shù)一致，或者可以額外多一個(gè) Throwable 類型的參數(shù)用于接收對(duì)應(yīng)的異常。

• fallback 函數(shù)默認(rèn)需要和原方法在同一個(gè)類中。若希望使用其他類的函數(shù)，則可以指定 fallbackClass 為對(duì)應(yīng)的類的 Class  對(duì)象，注意對(duì)應(yīng)的函數(shù)必需為 static 函數(shù)，否則無法解析。

5.defaultFallback(since 1.6.0)：默認(rèn)的 fallback 函數(shù)名稱，可選項(xiàng)，通常用于通用的 fallback  邏輯(即可以用于很多服務(wù)或方法)。默認(rèn) fallback  函數(shù)可以針對(duì)所有類型的異常(除了exceptionsToIgnore里面排除掉的異常類型)進(jìn)行處理。若同時(shí)配置了 fallback 和  defaultFallback，則只有 fallback 會(huì)生效。defaultFallback 函數(shù)簽名要求：

• 返回值類型必須與原函數(shù)返回值類型一致;

• 方法參數(shù)列表需要為空，或者可以額外多一個(gè) Throwable 類型的參數(shù)用于接收對(duì)應(yīng)的異常。

• defaultFallback 函數(shù)默認(rèn)需要和原方法在同一個(gè)類中。若希望使用其他類的函數(shù)，則可以指定 fallbackClass 為對(duì)應(yīng)的類的 Class  對(duì)象，注意對(duì)應(yīng)的函數(shù)必需為 static 函數(shù)，否則無法解析。

5.exceptionsToIgnore(since 1.6.0)：用于指定哪些異常被排除掉，不會(huì)計(jì)入異常統(tǒng)計(jì)中，也不會(huì)進(jìn)入 fallback  邏輯中，而是會(huì)原樣拋出。

1.8.0 版本開始，defaultFallback 支持在類級(jí)別進(jìn)行配置。

注：1.6.0 之前的版本 fallback 函數(shù)只針對(duì)降級(jí)異常(DegradeException)進(jìn)行處理，不能針對(duì)業(yè)務(wù)異常進(jìn)行處理。

特別地，若 blockHandler 和 fallback 都進(jìn)行了配置，則被限流降級(jí)而拋出 BlockException 時(shí)只會(huì)進(jìn)入  blockHandler 處理邏輯。若未配置 blockHandler、fallback 和 defaultFallback，則被限流降級(jí)時(shí)會(huì)將  BlockException 直接拋出(若方法本身未定義 throws BlockException 則會(huì)被 JVM 包裝一層  UndeclaredThrowableException)。

注解使用

代碼編寫

代碼結(jié)構(gòu)

SentinelController

/**  * 注解 @SentinelResource學(xué)習(xí)  * @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：資源名稱，必需項(xiàng)（不能為空）     //blockHandler 對(duì)應(yīng)處理 BlockException 的函數(shù)名稱     //fallback  用于在拋出異常的時(shí)候提供 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 函數(shù)，函數(shù)簽名與原函數(shù)一致或加一個(gè) Throwable 類型的參數(shù).     public String helloFallback(long s) {         log.error("helloFallback:{}",s);         return String.format("Halooooo %d", s);     }      // Block 異常處理函數(shù)，參數(shù)最后多一個(gè) BlockException，其余與原函數(shù)一致.     public String exceptionHandler(long s, BlockException ex) {         // Do some log here.         log.error("exceptionHandler:{}",s);         ex.printStackTrace();         return "Oops, error occurred at " + s;     } }

啟動(dòng)我們的項(xiàng)目,訪問我們的測(cè)試方法(多刷新幾次,去看控制面板)

限流測(cè)試

現(xiàn)在我們?yōu)槲覀兊馁Y源:hello 配置一個(gè)流控規(guī)則,配置步驟如下圖

配置成功:

回到我們的頁面,快速刷新頁面,我們會(huì)發(fā)現(xiàn)偶爾有如下信息顯示,說明我們配置的流控規(guī)則成功進(jìn)行了攔截

控制臺(tái)日志:

根據(jù)我們上面的學(xué)習(xí),如果超過我們配置的QPS,代碼會(huì)拋出BlockException異常,為什么代碼里面是FlowException,通過查看源碼我們會(huì)發(fā)現(xiàn)FlowException其實(shí)是BlockException的子級(jí)

經(jīng)過上面的測(cè)試,我們發(fā)現(xiàn)成功實(shí)現(xiàn)注解開發(fā)實(shí)現(xiàn)了限流

降級(jí)測(cè)試

降級(jí)測(cè)試之前,我們需要修改下我們的代碼

前:

@SentinelResource(value = "hello", blockHandler = "exceptionHandler", fallback = "helloFallback")

后:

@SentinelResource(value = "hello",  fallback = "helloFallback")

配置流控規(guī)則

配置降級(jí)規(guī)則:

測(cè)試方法

根據(jù)我們配置的規(guī)則,如果qps>1,肯定會(huì)出發(fā)BlockException,這時(shí)候降級(jí)規(guī)則判斷異常比例超過請(qǐng)求次數(shù)的20%,就會(huì)自動(dòng)觸發(fā)降級(jí)?;

我的點(diǎn)擊速率: 勻速 ---到--- 快速?

大家觀察這里的日志,在我剛開始勻速點(diǎn)擊時(shí)候,并沒有進(jìn)入helloFallback方法,當(dāng)我快速點(diǎn)擊時(shí)候,進(jìn)入了helloFallback方法,說明這時(shí)候降級(jí)規(guī)則生效,觸發(fā)降級(jí),進(jìn)入回調(diào)函數(shù)helloFallback中;

感謝你能夠認(rèn)真閱讀完這篇文章，希望小編分享的“@SentinelResource注解怎么用”這篇文章對(duì)大家有幫助，同時(shí)也希望大家多多支持億速云，關(guān)注億速云行業(yè)資訊頻道，更多相關(guān)知識(shí)等著你來學(xué)習(xí)!