spring cloud alibaba系列(二)Sentinel應用的限流管理

限流元件Sentinel

• Sentinel是把流量作為切入點，從流量控制、熔斷降級、系統負載保護等多個維度保護服務的穩定性。
• 預設支援 Servlet、Feign、RestTemplate、Dubbo 和 RocketMQ 限流降級功能的接入，可以在執行時通過控制檯實時修改限流降級規則，還支援檢視限流降級 Metrics 監控。
• 自帶控臺動態修改限流策略。但是每次服務重啟後就丟失了。所以它也支援ReadableDataSource 目前支援file, nacos, zk, apollo 這4種型別

接入Sentinel

建立專案cloud-sentinel

• 1 引入 Sentinel starter

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
</dependency>

• 2 application.properties配置如下

server.port=18084
spring.application.name=service-sentinel

#Sentinel 控制檯地址
spring.cloud.sentinel.transport.dashboard=localhost:8080
#取消Sentinel控制檯懶載入
spring.cloud.sentinel.eager=true

接入限流埋點

Sentinel 預設為所有的 HTTP 服務提供了限流埋點。引入依賴後自動完成所有埋點。只需要在控制配置限流規則即可

• 註解埋點
  如果需要對某個特定的方法進行限流或降級，可以通過 @SentinelResource 註解來完成限流的埋點

@SentinelResource("resource")
@RequestMapping("/sentinel/hello")
public Map<String,Object> hello(){
        Map<String,Object> map=new HashMap<>(2);
        map.put("appName",appName);
        map.put("method","hello");
        return map;
}

部署Sentinel控制檯

安裝

Sentinel下載

啟動控制檯

執行 Java 命令 java -jar sentinel-dashboard.jar 預設的監聽埠為 8080

訪問

開啟http://localhost:8080 即可看到控制檯介面

說明cloud-sentinel已經成功和Sentinel完成率通訊

配置限流規則

如果控制檯沒有找到自己的應用，可以先呼叫一下進行了 Sentinel 埋點的 URL 或方法或著禁用Sentinel 的賴載入spring.cloud.sentinel.eager=true

配置 URL 限流規則

控制器隨便新增一個普通的http方法

  /**
     * 通過控制檯配置URL 限流
     * @return
     */
    @RequestMapping("/sentinel/test")
    public Map<String,Object> test(){
        Map<String,Object> map=new HashMap<>(2);
        map.put("appName",appName);
        map.put("method","test");
        return map;
    }

點選新增流控規則。為了方便測試閥值設為 1

瀏覽器重複請求 http://localhost:18084/sentinel/test 如果超過閥值就會出現如下介面

整個URL限流就完成了。但是返回的提示不夠友好。

配置自定義限流規則(@SentinelResource埋點)

自定義限流規則就不是新增方法的訪問路徑。 配置的是@SentinelResource註解中value的值。比如@SentinelResource("resource")就是配置路徑為resource

• 訪問：http://localhost:18084/sentinel/hello
• 通過@SentinelResource註解埋點配置的限流規則如果沒有自定義處理限流邏輯，當請求到達限流的閥值時就返回404頁面
  

自定義限流處理邏輯

@SentinelResource 註解包含以下屬性：

• value: 資源名稱，必需項（不能為空）
• entryType: 入口型別，可選項（預設為 EntryType.OUT）
• blockHandler:blockHandlerClass中對應的異常處理方法名。引數型別和返回值必須和原方法一致
• blockHandlerClass：自定義限流邏輯處理類

 //通過註解限流並自定義限流邏輯
 @SentinelResource(value = "resource2", blockHandler = "handleException", blockHandlerClass = {ExceptionUtil.class})
 @RequestMapping("/sentinel/test2")
    public Map<String,Object> test2() {
        Map<String,Object> map=new HashMap<>();
        map.put("method","test2");
        map.put("msg","自定義限流邏輯處理");
        return  map;
    }

public class ExceptionUtil {

    public static Map<String,Object> handleException(BlockException ex) {
        Map<String,Object> map=new HashMap<>();
        System.out.println("Oops: " + ex.getClass().getCanonicalName());
        map.put("Oops",ex.getClass().getCanonicalName());
        map.put("msg","通過@SentinelResource註解配置限流埋點並自定義處理限流後的邏輯");
        return  map;
    }
}

控制檯新增resource2的限流規則並設定閥值為1。訪問http://localhost:18084/sentinel/test2 請求到達閥值時機會返回自定義的異常訊息

基本的限流處理就完成了。 但是每次服務重啟後 之前配置的限流規則就會被清空因為是記憶體態的規則物件.所以下面就要用到Sentinel一個特性ReadableDataSource 獲取檔案、資料庫或者配置中心是限流規則

讀取檔案的實現限流規則

一條限流規則主要由下面幾個因素組成：

• resource：資源名，即限流規則的作用物件
• count: 限流閾值
• grade: 限流閾值型別（QPS 或併發執行緒數）
• limitApp: 流控針對的呼叫來源，若為 default 則不區分呼叫來源
• strategy: 呼叫關係限流策略
• controlBehavior: 流量控制效果（直接拒絕、Warm Up、勻速排隊）
  SpringCloud alibaba整合Sentinel後只需要在配置檔案中進行相關配置，即可在 Spring 容器中自動註冊 DataSource，這點很方便。配置檔案新增如下配置

#通過檔案讀取限流規則
spring.cloud.sentinel.datasource.ds1.file.file=classpath: flowrule.json
spring.cloud.sentinel.datasource.ds1.file.data-type=json
spring.cloud.sentinel.datasource.ds1.file.rule-type=flow

在resources新建一個檔案 比如flowrule.json 新增限流規則

[
  {
    "resource": "resource",
    "controlBehavior": 0,
    "count": 1,
    "grade": 1,
    "limitApp": "default",
    "strategy": 0
  },
  {
    "resource": "resource3",
    "controlBehavior": 0,
    "count": 1,
    "grade": 1,
    "limitApp": "default",
    "strategy": 0
  }
]

重新啟動專案。出現如下日誌說明檔案讀取成功

 [Sentinel Starter] DataSource ds1-sentinel-file-datasource start to loadConfig
 [Sentinel Starter] DataSource ds1-sentinel-file-datasource load 2 FlowRule

重新整理Sentinel 控制檯 限流規則就會自動新增進去

Sentinel的配置

spring.cloud.sentinel.enabled              #Sentinel自動化配置是否生效
spring.cloud.sentinel.eager               #取消Sentinel控制檯懶載入
spring.cloud.sentinel.transport.dashboard   #Sentinel 控制檯地址
spring.cloud.sentinel.transport.heartbeatIntervalMs        #應用與Sentinel控制檯的心跳間隔時間
spring.cloud.sentinel.log.dir            #Sentinel 日誌檔案所在的目錄

• 原始碼：https://github.com/a870439570/alibaba-cloud
• 個人部落格：https://blog.qinxuewu.club/