Sentinel中的Entry

默認(rèn)情況下，Sentinel會(huì)將controller中的方法作為被保護(hù)資源，Sentinel中的資源用Entry來(lái)表示。

Sentinel中Entry可以理解為每次進(jìn)入資源的一個(gè)憑證，如果調(diào)用SphO.entry()或者SphU.entry()能獲取Entry對(duì)象，代表獲取了憑證，沒(méi)有被限流，否則拋出一個(gè)BlockException。

Entry是一個(gè)抽象的類，在Sentinel中真正創(chuàng)建的Entry是CtEntry。

Entry

• createTime：當(dāng)前entry的創(chuàng)建時(shí)間，毫秒值，用來(lái)計(jì)算響應(yīng)時(shí)間rt。
• curNode：當(dāng)前Entry所關(guān)聯(lián)的node，會(huì)在NodeSelectorSlot插槽中設(shè)置，主要是記錄了當(dāng)前Context下的統(tǒng)計(jì)信息。
• originNode：context的請(qǐng)求源節(jié)點(diǎn)，通常是服務(wù)的消費(fèi)端，如果存在的話，在ClusterBuilderSlot的entry方法中設(shè)置
• resourceWrapper：當(dāng)前Entry所關(guān)聯(lián)的資源包裝器

CtEntry

CtEntry 是 Entry的子類，主要保存了實(shí)體之間的關(guān)系、調(diào)用鏈、上下文信息。

• parent：entry的父entry，用于在同一個(gè)context上下文中，多次調(diào)用entry方法，保存entry之間的關(guān)系。
• child：entry的子entry，與parent相反
• chain：entry中的插槽鏈
• context：entry的上下文

Sentinel中的資源用Entry來(lái)表示。聲明Entry的API示例：

// 資源名可使用任意有業(yè)務(wù)語(yǔ)義的字符串，比如方法名、接口名或其它可唯一標(biāo)識(shí)的字符串。
try (Entry entry = SphU.entry("resourceName")) {
  // 被保護(hù)的業(yè)務(wù)邏輯
  // do something here...
} catch (BlockException ex) {
  // 資源訪問(wèn)阻止，被限流或被降級(jí)
  // 在此處進(jìn)行相應(yīng)的處理操作
}

Sentinel 提供了 @SentinelResource 注解用于定義資源，并提供了 AspectJ 的擴(kuò)展用于自動(dòng)定義資源、處理 BlockException 等 。

@SentinelResource屬性 

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

@SentinelResource 注解包含以下屬性：

value

資源名稱，必需項(xiàng)（不能為空）

entryType

entry 類型，資源調(diào)用方向，可選項(xiàng)（默認(rèn)為EntryType.OUT）

blockHandler / blockHandlerClass: blockHandler

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

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ù)，否則無(wú)法解析。

defaultFallback 

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

• 返回值類型必須與原函數(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ù)，否則無(wú)法解析。

exceptionsToIgnore 

用于指定哪些異常被排除掉，不會(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）。

public class TestService {
    // 原函數(shù)
    @SentinelResource(value = "hello", blockHandler = "exceptionHandler", fallback = "helloFallback")
    public String hello(long s) {
        return String.format("Hello at %d", s);
    }
    // Fallback 函數(shù)，函數(shù)簽名與原函數(shù)一致或加一個(gè) Throwable 類型的參數(shù).
    public String helloFallback(long s) {
        return String.format("Halooooo %d", s);
    }
    // Block 異常處理函數(shù)，參數(shù)最后多一個(gè) BlockException，其余與原函數(shù)一致.
    public String exceptionHandler(long s, BlockException ex) {
        // Do some log here.
        ex.printStackTrace();
        return "Oops, error occurred at " + s;
    }
    // 這里單獨(dú)演示 blockHandlerClass 的配置.
    // 對(duì)應(yīng)的 `handleException` 函數(shù)需要位于 `ExceptionUtil` 類中，并且必須為 public static 函數(shù).
    @SentinelResource(value = "test", blockHandler = "handleException", blockHandlerClass = {ExceptionUtil.class})
    public void test() {
        System.out.println("Test");
    }
}

到此這篇關(guān)于Sentinel核心類之Entry類解讀的文章就介紹到這了,更多相關(guān)Entry類解讀內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論