SpringCloud-Sentinel的@SentinelResource注解(Day14)

@SentinelResource注解

@SentinelResource 用于定义资源，并提供可选的异常处理和 fallback 配置项。

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

@SentinelResource限流的自定义返回和默认返回

控制层代码

@GetMapping("/byResource")
@SentinelResource(value = "byResource",blockHandler = "handleException")
public CommonResult byResource() {
    return new CommonResult(200,"按资源名称限流测试OK",new Payment(2022L,"serial001"));
}

public CommonResult handleException(BlockException exception) {
    return new CommonResult(444,exception.getClass().getCanonicalName()+"\t 服务不可用");
}

@GetMapping("/rateLimit/byUrl")
@SentinelResource(value = "byUrl")
public CommonResult byUrl()
{
    return new CommonResult(200,"按url限流测试OK",new Payment(2022L,"serial002"));
}

限流设置

运行测试

案例分析

我们在控制层创建了两个接口，其中一个的注解参数中设定了blockhandler的限流返回函数和value资源名，另外一个则值设定了value资源名。我们之后设置了两个接口的QPS都为1，在之后我们分别对这两个接口进行了测试并侧也验证了我们的猜想，没有设定blockhandler的接口返回了Sentinel默认的提示，而我们设定了blockhandler的接口返回了我们自己定义的提示。

@SentinelResource限流的全局自定义返回设计

我们上边虽然也能设置为自定义返回，但是blockhandler和业务方法融合在一起。非常不利于整体的设计，这样设计会使代码臃肿也使后期维护变的麻烦起来。

控制层代码

package com.gcl.springcloud.blockhandler;

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

public class BlockHandler {

    public static CommonResult blockHandlerException1(BlockException exception){
        return new CommonResult(4444, "用户自定义，全局异常处理器1");
    }

    public static CommonResult blockHandlerException2(BlockException exception){
        return new CommonResult(4444, "用户自定义，全局异常处理器2");
    }

}

@GetMapping(value = "/consumerBlockHandler")
@SentinelResource( value = "consumerBlockHandler", blockHandlerClass = BlockHandler.class, blockHandler = "blockHandlerException2")
public CommonResult comsumerBlockHandler(){
    return new CommonResult(200, "按照用户自定义", new Payment(2022L , "serial003") );
}

限流设置

运行测试

案例分析

我们需要注意的是我们本次是对SentinelResource的资源进行限流的，所以我们需要注意，我们设置的blockhandler的自定义方法只是针对@SentinelResource