分類
發燒車訊

Spring Cloud gateway 七 Sentinel 註解方式使用

Sentinel 註解支持

@SentinelResource 用於定義資源,並提供可選的異常處理和 fallback 配置項。 @SentinelResource 註解包含以下屬性:

  • value:資源名稱,必需項(不能為空)
  • entryType:entry 類型,可選項(默認為 EntryType.OUT)
  • blockHandler / blockHandlerClass: blockHandler 對應處理 BlockException 的函數名稱,可選項。blockHandler 函數訪問範圍需要是 public,返回類型需要與原方法相匹配,參數類型需要和原方法相匹配並且最後加一個額外的參數,類型為 BlockException。blockHandler 函數默認需要和原方法在同一個類中。若希望使用其他類的函數,則可以指定 blockHandlerClass 為對應的類的 Class 對象,注意對應的函數必需為 static 函數,否則無法解析。
  • fallback: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 邏輯中,而是會原樣拋出。

注:1.6.0 之前的版本 fallback 函數只針對降級異常(DegradeException)進行處理,不能針對業務異常進行處理。

特別地,若 blockHandler 和 fallback 都進行了配置,則被限流降級而拋出 BlockException 時只會進入 blockHandler 處理邏輯。若未配置 blockHandler、fallback 和 defaultFallback,則被限流降級時會將 BlockException 直接拋出。

使用注意點采坑日記

@SentinelResource 註解不單單用於controller的接口流控。同時也可以用於方法上面。如果看過實現方式代碼。可以知道他底層是基於cglib動態代理實現的。進行切面處理。注意點:

  • 不能修飾在接口上面。只能修飾在實現類的方法上
  • 不能修飾在靜態的方法上面。
  • 同一個bean方法A調用方法B,假設方法A和B都進行了註解。B方法註解失效,請參考@Transactional 失效。
    • @Transactional 加於private方法, 無效
    • @Transactional 加於未加入接口的public方法, 再通過普通接口方法調用, 無效
    • @Transactional 加於接口方法, 無論下面調用的是private或public方法, 都有效
    • @Transactional 加於接口方法后, 被本類普通接口方法直接調用, 無效
    • @Transactional 加於接口方法后, 被本類普通接口方法通過接口調用, 有效
    • @Transactional 加於接口方法后, 被它類的接口方法調用, 有效
    • @Transactional 加於接口方法后, 被它類的私有方法調用后, 有效

blockHandler 和 blockHandlerClass 的使用

blockHandler 是可選的。如果使用blockHandlerClass,必須搭配blockHandler使用, blockHandler指定blockHandlerClass類中對應的方法名稱。方法名稱、參數、返回值、static 必須按照上述文檔描述一樣。官方文檔沒有強調要必須要搭配使用。

同理 fallback 和 fallbackClass也是上面講述的注意點。

改造client 服務

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

bootstrap.yml 配置文件

spring:
    cloud:
        sentinel:
                filter:
                    # sentienl 默認生效,本地調試false
                    enabled: true
                transport:
                    dashboard: localhost:8890
                    port: 8719
                # 飢餓加載
                eager: true
                datasource:
                    # Sentinel基於nacos存儲獲取配置信息
                    na:
                        nacos:
                            server-addr: 47.99.209.72:8848
                            groupId: DEFAULT_GROUP
                            dataId: ${spring.application.name}-${spring.profiles.active}-sentinel
                            # 類型
    #            FLOW("flow", FlowRule.class),
    #            DEGRADE("degrade", DegradeRule.class),
    #            PARAM_FLOW("param-flow", ParamFlowRule.class),
    #            SYSTEM("system", SystemRule.class),
    #            AUTHORITY("authority", AuthorityRule.class),
    #            GW_FLOW("gw-flow", "com.alibaba.csp.sentinel.adapter.gateway.common.rule.GatewayFlowRule"),
    #            GW_API_GROUP("gw-api-group", "com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiDefinition");
                            rule-type: flow

nacos 創建 cloud-discovery-client-dev-sentinel 配置文件

[
    {
        "resource": "client:log:save",
        "limitApp": "default",
        "grade": 1,
        "count": 1,
        "strategy": 0,
        "controlBehavior": 0,
        "clusterMode": false
    },
    {
        "resource": "client:fegin:test",
        "limitApp": "default",
        "grade": 1,
        "count": 1,
        "strategy": 0,
        "controlBehavior": 0,
        "clusterMode": false
    },
     {
        "resource": "user:service:saveTx",
        "limitApp": "default",
        "grade": 1,
        "count": 1,
        "strategy": 0,
        "controlBehavior": 0,
        "clusterMode": false
    },
    {
        "resource": "user:service:save:test",
        "limitApp": "default",
        "grade": 1,
        "count": 1,
        "strategy": 0,
        "controlBehavior": 0,
        "clusterMode": false
    }
]

創建 BackHandlerClass DiscoveryClientControllerBackHandler

package com.xian.cloud.common.handler;

import com.alibaba.csp.sentinel.slots.block.BlockException;
import com.xian.cloud.entity.UserEntity;
import lombok.extern.slf4j.Slf4j;

/**
 *  對應處理 BlockException 的函數名稱 服務限流
 * @Author: xlr
 * @Date: Created in 9:08 PM 2019/11/16
 */
@Slf4j
public class DiscoveryClientControllerBackHandler {

    public static String defaultMessage(BlockException e){
        
        log.warn( "DiscoveryClientControllerBackHandler  defaultMessage BlockException : {}",e );
        return "defaultMessage 服務限流,請稍後嘗試";
    }

    public static String saveTx(UserEntity entity,BlockException e) {

        log.warn( "DiscoveryClientControllerBackHandler  saveTx BlockException : {}",e );
        return "saveTx 服務限流,請稍後嘗試";
    }
}

創建 FallBackHandlerClass

package com.xian.cloud.common.handler;

import com.xian.cloud.entity.UserEntity;
import lombok.extern.slf4j.Slf4j;

/**
 * 僅針對降級功能生效(DegradeException)
 * @Author: xlr
 * @Date: Created in 9:13 PM 2019/11/16
 */
@Slf4j
public class DiscoveryClientControllerFallBackHandler {

    public static String defaultMessage(Throwable t){
        
        log.warn( "DiscoveryClientControllerFallBackHandler defaultMessage Throwable : {}",t );
        return "defaultMessage 服務降級,請稍後嘗試";
    }

    public static String saveTx(UserEntity entity,Throwable t) {

        log.warn( "DiscoveryClientControllerFallBackHandler saveTx Throwable : {}",t );
        return "saveTx 服務降級,請稍後嘗試";
    }
}

對外接口DiscoveryClientController 添加接口


@SentinelResource(
            value = "client:fegin:test",
            blockHandler = "defaultMessage",
            fallback = "defaultMessage",
            blockHandlerClass = DiscoveryClientControllerBackHandler.class,
            fallbackClass = DiscoveryClientControllerFallBackHandler.class
    )
    @RequestMapping(value = "fegin/test",method = RequestMethod.GET)
    public String feginTest() {
        String result = serverService.hello( "fegin" );
        return  " 返回 : " + result;
    }
        
        
 @GetMapping("/log/save")
    @SentinelResource(
            value = "client/log/save",
            blockHandler = "defaultMessage",
            fallback = "defaultMessage",
            blockHandlerClass = DiscoveryClientControllerBackHandler.class,
            fallbackClass = DiscoveryClientControllerFallBackHandler.class
    )
    public String save(){
        UserEntity entity = new UserEntity();
        entity.setUsername("tom");
        entity.setPassWord("1232131");
        entity.setEmail("222@qq.com");
        userService.saveTx(entity);
        return "success";
    }
        
    @GetMapping("user/service/save")
    public String userServiceSaveTx(){
        UserEntity entity = new UserEntity();
        String result = userService.saveTx( entity );
        return result;
    }

UserServiceImpl 方法

  @Override
    @Transactional
    @SentinelResource(
            value = "user:service:saveTx",
            blockHandler = "saveTx",
            fallback = "saveTx",
            blockHandlerClass = DiscoveryClientControllerBackHandler.class,
            fallbackClass = DiscoveryClientControllerFallBackHandler.class
    )
    public String saveTx(UserEntity entity) {

        return "success";
    }

以上就配置完畢。然後進行測試在頁面瘋狂刷新

http://localhost:9011/client/user/service/save

http://localhost:9011/client/fegin/test

停止 server服務 再次調用 fegin、test

服務降級和服務限流來回切換提示在前端頁面。blockHandlerClass、fallbackClass。

如何喜歡可以關注分享本公眾號。

版權聲明:本文為博主原創文章,遵循 CC 4.0 BY-SA 版權協議,轉載請附上原文出處鏈接和本聲明。轉載請附帶公眾號二維碼

本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理
【其他文章推薦】

※為什麼 USB CONNECTOR 是電子產業重要的元件?

網頁設計一頭霧水??該從何著手呢? 找到專業技術的網頁設計公司,幫您輕鬆架站!

※想要讓你的商品成為最夯、最多人討論的話題?網頁設計公司讓你強力曝光

※想知道最厲害的台北網頁設計公司推薦台中網頁設計公司推薦專業設計師”嚨底家”!!

※專營大陸快遞台灣服務

台灣快遞大陸的貨運公司有哪些呢?