Sentinel服务哨兵之定义资源

亦凉 2023-01-05 01:21 74阅读 0赞

## 根据Sentinel官网介绍，定义资源一共有5种方式： ##

方式一：主流框架的默认适配

方式二：抛出异常的方式定义资源

方式三：返回布尔值方式定义资源

方式四：注解方式定义资源

方式五：异步调用支持

每一种都有其应用的场景，这里只做注解方式定义资源的介绍

一般使用只需要value，blockHandler，fallback参数就够用了

blockHandler：触发限流调用的方法

fallback：触发熔断调用的方法

// 原本的业务方法.
    @SentinelResource(value="getUserById",
    					blockHandler = "blockHandlerForGetUser",
    					fallback="getUserByIdFallback")
    public User getUserById(String id) {
        throw new RuntimeException("getUserById command failed");
    }
    
    // blockHandler 函数，原方法调用被限流/降级/系统保护的时候调用
    public User blockHandlerForGetUser(String id, BlockException ex) {
        return new User("admin");
    }
    
    // fallback函数，原方法调用被熔断的时候调用
    public User getUserByIdFallback(String id) {
        return new User("admin");
    }

@SentinelResource 用于定义资源，并提供可选的异常处理和 fallback 配置项。 @SentinelResource 注解包含以下属性：

value：资源名称，必需项（不能为空）

entryType：entry 类型，可选项（默认为 EntryType.OUT）

blockHandler / blockHandlerClass: blockHandler 对应处理 BlockException 的函数名称，可选项。  
blockHandler 函数访问范围需要是 public，返回类型需要与原方法相匹配，参数类型需要和原方法相匹配并且最后加一个额外的参数，类型为 BlockException。blockHandler 函数默认需要和原方法在同一个类中。若希望使用其他类的函数，则可以指定 blockHandlerClass 为对应的类的 Class 对象，注意对应的函数必需为 static 函数，否则无法解析。

fallback / 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 逻辑中，而是会原样抛出。