@SentinelResource注解

1、环境搭建(8401模块)

8401模块的pom增加以下依赖

<!--通用Commons-->
<dependency>
    <groupId>com.sw</groupId>
    <artifactId>cloud-api-commons</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

controller

@RestController
public class RateLimitController {

    @GetMapping(value = "/byResource", produces = {"application/json;charset=UTF-8"})
    @SentinelResource(value = "byResource", blockHandler = "handlerException")
    public CommonResult<JSONObject> byResource(){
        return new CommonResult(200, "按资源名称测试限流",new Payment(100L, "干脆面"));
    }

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

限流规则

注：配置了@SentinelResource注解后，资源名填byResource或者/byResource都可以

测试

2、自定义限流规则

单独创建一个handler类，用于处理限流

public class CustomerBlockHandler {

    public static CommonResult handlerException1(BlockException exception){
        return new CommonResult(444, "global handlerException01");
    }

    public static CommonResult handlerException2(BlockException exception){
        return new CommonResult(444, "global handlerException02");
    }
}

controller指定自定义的降级方法

@GetMapping(value = "/customerBlockHandler", produces = {"application/json;charset=UTF-8"})
@SentinelResource(value = "customerBlockHandler",
                  blockHandlerClass = CustomerBlockHandler.class,
                  blockHandler = "handlerException2"
                 )
public CommonResult<JSONObject> customerBlockHandler(){
    return new CommonResult(200, "按客户自定义测试限流",new Payment(100L, "干脆面"));
}

Sentinel自定义限流规则

测试

补充

3、其他属性

@SentinelResource不适用于private方法

• value：资源名称，必需项（不能为空）；
• entryType：entry类型，可选项（默认为 EntryType.OUT）；
• 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 逻辑中，而是会原样抛出。

图片来源：尚硅谷 - 周阳 - Spring Cloud Alibaba