SpringCloud Alibaba之Sentinel的@SentinelResource简介之案例演示

所有代码都在github上：https://github.com/demonruin/cloud2020/tree/master

 

官网github地址：https://github.com/alibaba/Sentinel/wiki/%E4%BB%8B%E7%BB%8D

 

前面的文章中我们使用到了@SentinelResource，做了两个测试，

一个是@SentinelResource(value = "testHotKey", blockHandler = "deal_testHotKey"),有自己兜底的自定义处理方法

一个是@SentinelResource(value = "testHotKey")就会使用默认的兜底方法~

上面兜底方案面临的问题：

1. 系统默认的，没有体现我们自己的业务要求。
2. 依照现有条件,我们自定义的处理方法又和业务代码耦合在一块,不直观。
3. 每个业务方法都添加一个兜底的,那代码膨胀加剧。
4. 全局统的处理方法没有体现。

下面我们进行一个自定义的限流处理逻辑

1、创建customerBlockHandler类用于自定义限流处理逻辑

注意：此处必须是 static 修饰的~~blockHandler函数访问范围需要是public,返回类型需要与原方法相匹配,参数类型需要和原方法相匹配并且最后加一个额外的参数,类型为BlockException

package com.king.springcloud.myHandler;

import com.alibaba.csp.sentinel.slots.block.BlockException;
import com.king.springcloud.entities.CommonResult;

/**
 * created by king on 2020/5/28 5:56 下午
 */
public class CustomerBlockHandler {

    public static CommonResult dealLockHandlerException1(BlockException exception){
        return new CommonResult(1111,"自定义处理兜底方法-------1");
    }
   public static CommonResult dealLockHandlerException2(BlockException exception){
        return new CommonResult(2222,"自定义处理兜底方法-------2");
    }
}

2、创建自定义业务类，准备测试自定义限流处理逻辑

blockHandlerClass = CustomerBlockHandler.class：此处为第一步中自定义的限流处理逻辑类
blockHandler = "dealLockHandlerException2" ：此处为第一步中自定义的限流处理逻辑类中的静态处理方法

package com.king.springcloud.controller;

import com.alibaba.csp.sentinel.annotation.SentinelResource;
import com.king.springcloud.entities.CommonResult;
import com.king.springcloud.myHandler.CustomerBlockHandler;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * created by king on 2020/5/28 5:52 下午
 */
@RestController
@Slf4j
public class RateLimitController {

    @GetMapping("/rateLimit/myLockHandler")
    @SentinelResource(value = "myLockHandler",
            blockHandlerClass = CustomerBlockHandler.class,
            blockHandler = "dealLockHandlerException2")
    public CommonResult myLockHandler(){
        return new CommonResult(200,"myLockHandler方法进入成功");
    }
}

3、在sentinel-dashboard中设置流控规则，因为有对接口或者SentinelResource限流，这里我们选择对SentinelResource的value资源值做1QPS的限流

4、进行测试，查看结果是否走自定义的限流处理逻辑，单次访问的时候会正常响应，当进行多次快速刷新访问的时候，就会触发流控规则，进行服务降级，然后走我们自定义的限流处理逻辑，响应结果如下：

此时表明我们自定义的限流处理逻辑生效了~~简单演示成功

 

更多注解属性说明：

注意：注解方式埋点不支持private方法

@SentinelResource用于定义资源,并供可选的异常处理和 fall back配置项, @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函数,否则无法解析。
• default Fallback( since1.60):默认的 fallback函数名称,可选项,通常用于通用的 fallback逻辑(即可以用于很多服务或方法),默认 fallback函数可以针对所有类型的异常(除了exceptionsToIgnore里面排除掉的异常类型)进行处理。若同时配置了 fallback和
  default Fallback,则只有 fallback会生效 default Fallback函数签名要求:
  • 返回值类型必须与原函数返回值类型一致
  • 方法参数列表需要为空,或者可以额外多一个 Throwable类型的参数用于接收对应的异常。

 

• exceptions ToIgnore( Since1.60):用于指定哪些异常被排除掉,不会计入异常统计中,也不会进入 fallback逻中,而是会原样抛出

注:1.60之前的版本 fallback函数只针对降级异常( DegradeException)进行处理,不能针对业务异常进行处理
特别地,若 blockhandler和 fallback都进行了配置,则被限流降级而抛出B1 ockException时只会进入blockHandler处理逻辑

 

 

附加：一般不会使用，Sentinel主要有三个核心API：

• sphU定义资源
• Tracer定义统计
• Contextutil定义了上下文