Sentinel.04.Sentinel之熱點規則

Sentinel之熱點規則

• • 概念
  • @SentinelResource
  • 小試牛刀
  • • TestController.java
    • defaultFallback
    • fallback
    • 流量控制
    • 熔斷降級
    • 熱點參數限流
    • • 進階選項

概念

何為熱點？熱點即經常通路的資料。很多時候我們希望統計某個熱點資料中通路頻次最高的 Top K 資料，并對其通路進行限制。比如：

• 商品 ID 為參數，統計一段時間内最常購買的商品 ID 并進行限制
• 使用者 ID 為參數，針對一段時間内頻繁通路的使用者 ID 進行限制

熱點參數限流會統計傳入參數中的熱點參數，并根據配置的限流門檻值與模式，對包含熱點參數的資源調用進行限流。熱點參數限流可以看做是一種特殊的流量控制，僅對包含熱點參數的資源調用生效。

Sentinel 利用 LRU 政策統計最近最常通路的熱點參數，結合令牌桶算法來進行參數級别的流控。

使用熱單參數限流式不能使用資源路徑，必須要使用資源名的方式。Sentinel提供了@SentinelResource 注解用于定義資源

@SentinelResource

@SentinelResource

用于定義資源，并提供可選的異常處理和 fallback 配置項。

@SentinelResource

注解包含以下屬性：

• value

  ：資源名稱，必需項（不能為空）

• entryType

  ：entry 類型，可選項（預設為

  EntryType.OUT

  ）

• blockHandler

  /

  blockHandlerClass

  :

  blockHandler

  對應處理

  BlockException

  的函數名稱，可選項。blockHandler 函數通路範圍需要是

  public

  ，傳回類型需要與原方法相比對，參數類型需要和原方法相比對并且最後加一個額外的參數，類型為

  BlockException

  。blockHandler 函數預設需要和原方法在同一個類中。若希望使用其他類的函數，則可以指定

  blockHandlerClass

  為對應的類的

  Class

  對象，注意對應的函數必需為 static 函數，否則無法解析。

• fallbac

  /

  fallbackClass

  ：fallback 函數名稱，可選項，用于在抛出異常的時候提供 fallback 處理邏輯。fallback 函數可以針對所有類型的異常（除了

  exceptionsToIgnore

  裡面排除掉的異常類型）進行處理。fallback 函數簽名和位置要求：
  • 傳回值類型必須與原函數傳回值類型一緻；
  • 方法參數清單需要和原函數一緻，或者可以額外多一個

    Throwable

    類型的參數用于接收對應的異常。
  • fallback 函數預設需要和原方法在同一個類中。若希望使用其他類的函數，則可以指定

    fallbackClass

    為對應的類的

    Class

    對象，注意對應的函數必需為 static 函數，否則無法解析。

• defaultFallback

  （since 1.6.0）：預設的 fallback 函數名稱，可選項，通常用于通用的 fallback 邏輯（即可以用于很多服務或方法）。預設 fallback 函數可以針對所有類型的異常（除了

  exceptionsToIgnore

  裡面排除掉的異常類型）進行處理。若同時配置了 fallback 和 defaultFallback，則隻有 fallback 會生效。defaultFallback 函數簽名要求：
  • 傳回值類型必須與原函數傳回值類型一緻；
  • 方法參數清單需要為空，或者可以額外多一個

    Throwable

    類型的參數用于接收對應的異常。
  • defaultFallback 函數預設需要和原方法在同一個類中。若希望使用其他類的函數，則可以指定

    fallbackClass

    為對應的類的

    Class

    對象，注意對應的函數必需為 static 函數，否則無法解析。

• exceptionsToIgnore

  （since 1.6.0）：用于指定哪些異常被排除掉，不會計入異常統計中，也不會進入 fallback 邏輯中，而是會原樣抛出。

注意：注解方式埋點不支援 private 方法。

特别地，若 blockHandler 和 fallback 都進行了配置，則被限流降級而抛出 BlockException 時隻會進入 blockHandler 處理邏輯。若未配置 blockHandler、fallback 和 defaultFallback，則被限流降級時會将 BlockException 直接抛出（若方法本身未定義 throws BlockException 則會被 JVM 包裝一層 UndeclaredThrowableException）。

小試牛刀

TestController.java

我們将之前的TestController中的

/test/hello

方法做以下處理：

import com.alibaba.csp.sentinel.annotation.SentinelResource;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import com.alibaba.csp.sentinel.slots.block.degrade.DegradeException;
import com.alibaba.csp.sentinel.slots.block.flow.FlowException;
import com.alibaba.csp.sentinel.slots.block.flow.param.ParamFlowException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @Author Christy
 * @Date 2021/8/6 10:17
 **/
@RestController
@RequestMapping("/test")
public class TestController {
    private static final Logger log = LoggerFactory.getLogger(TestController.class);

    /**
     * @SentinelResource: 代表這是一個sentinel資源
     * value: 資源名稱
     * blockHandler: 使用sentinel進行不同規則控制時的預設處理方案
     * fallback: 自定義業務出錯時預設處理方案
     * defaultFallback: 業務錯誤時的預設處理方案
     */
    @RequestMapping("/hello")
    @SentinelResource(value = "hello",blockHandler = "blockHandler",fallback = "fallback",defaultFallback = "defaultFallback")
    public String sayHello(Integer id){
        log.info("Hello, Sentinel!");
        if(id < 0){
            throw new RuntimeException();
        }
        return "Hello, Sentinel!";
    }

    public String blockHandler(Integer id, BlockException e){
        if(e instanceof FlowException){
            return  "目前請求被流控！";
        }
        if(e instanceof DegradeException){
            return  "目前請求被降級！";
        }
        if(e instanceof ParamFlowException){
            return  "目前請求被熱點參數限流!";
        }
        return "目前通路人數太多，請稍後再試！";
    }

    public String fallback(Integer id){
        return "fallback函數處理的異常!";
    }

    public String defaultFallback(){
        return "預設的fallback函數處理的異常！";
    }

    @RequestMapping("/bye")
    public String sayBye(){
        log.info("Bye, Sentinel!");
        return "Bye, Sentinel!";
    }
}
           

defaultFallback

首先我們來試下沒有自定義fallback的情況，我們将TestControler中的

/test/hello

修改如下：

@RequestMapping("/hello")
@SentinelResource(value = "hello",blockHandler = "blockHandler",defaultFallback = "defaultFallback")
public String sayHello(Integer id){
  log.info("Hello, Sentinel!");
  if(id < 0){
    throw new RuntimeException();
  }
  return "Hello, Sentinel!";
}
           

然後我們啟動項目，在浏覽器中通路

http://localhost:8990/test/hello?id=-1

，界面會傳回

預設的fallback函數處理的異常！

如下圖所示：

fallback

同樣的方式我們将TestControler中的

/test/hello

修改如下

@RequestMapping("/hello")
@SentinelResource(value = "hello",blockHandler = "blockHandler",fallback = "fallback",defaultFallback = "defaultFallback")
public String sayHello(Integer id){
  log.info("Hello, Sentinel!");
  if(id < 0){
    throw new RuntimeException();
  }
  return "Hello, Sentinel!";
}
           

我們再次啟動項目，在浏覽器中通路

http://localhost:8990/test/hello?id=-1

，界面會傳回

預設的fallback函數處理的異常！

如下圖所示：

流量控制

我們在Sentinel中的流控規則中新增一個規則，如下所示：

然後我們在浏覽器中通路

http://localhost:8990/test/hello

，發現結果被流控

熔斷降級

我們删除上面的流控規則，按照下圖所示新增一個熔斷規則，如圖所示：

然後我們在浏覽器中通路

http://localhost:8990/test/hello?id=-1

，發現結果被降級

熱點參數限流

同樣的我們删除上面的熔斷規則，按照下圖所示新增一個熱點參數規則。如圖所示：

然後我們在浏覽器中通路

http://localhost:8990/test/hello?id=-1

，發現結果被熱點參數限流

進階選項

在熱點規則的底部有

進階選項

功能，點開它如下圖所示：

• 參數類型

  ：是上述參數索引對應參數的類型。比如我們通路：

  http://localhost:8990/test/hello?id=?

  值得就是id的類型

• 參數值

  ：我們上面寫的是2，意思是隻對id=2這個進行熱點參數限流，其餘的放過；

• 限流門檻值

  ：在統計時長内超過設定的門檻值就會被限流

我們在浏覽器通路

http://localhost:8990/test/hello?id=1

可以發現是沒有問題的，沒有被限流。但是當通路

http://localhost:8990/test/hello?id=2

時就會被限流。如圖所示

熱點限流的進階選項中可以添加多個參數例外項