SentinelResource配置-Toy模板网

这篇具有很好参考价值的文章主要介绍了SentinelResource配置。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

1.SentinelResource配置（上）

1.1.按资源名称限流 + 后续处理

1.1.1.启动Nacos成功

1.1.2.启动Sentinel成功

1.1.3.添加控制器

import com.alibaba.csp.sentinel.annotation.SentinelResource;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import com.tianxia.alibaba.entity.CommonResult;
import com.tianxia.alibaba.entity.Payment;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 按资源名称限流 + 后续处理
 * @author liqb
 * @date 2023-05-26 15:06
 */
@RestController
public class RateLimitController {

    /**
     * SentinelResource配置(上)
     * @author liqb
     * @date 2023-05-26 22:06
     * @return
     */
    @GetMapping("/byResource")
    @SentinelResource(value = "byResource", blockHandler = "handleException")
    public CommonResult byResource() {
        return new CommonResult(200, "按资源名称限流测试OK", new Payment(2020L,"serial001"));
    }
    public CommonResult handleException(BlockException exception) {
        return new CommonResult(444, exception.getClass().getCanonicalName()+"\t 服务不可用");
    }
}

1.1.4.配置流控规则

配置步骤

SentinelResource配置

图形配置和代码关系

表示1秒钟内查询次数大于1，就跑到我们自定义的处流，限流

1.1.5.测试

1秒钟点击1下，OK http://localhost:8401/byResource

超过上述，疯狂点击，返回了自己定义的限流处理信息，限流发生

{"code":444, "message":"com.alibaba.csp.sentinel.slots.block.flow.FlowException\t 服务不可用", "data":null}

额外问题

此时关闭问服务8401 -> Sentinel控制台，流控规则消失了

1.2.按照Url地址限流 + 后续处理

1.2.1.启动Nacos成功

1.2.2.启动Sentinel成功

通过访问的URL来限流，会返回Sentinel自带默认的限流处理信息

1.2.3.添加控制器

@RestController
public class RateLimitController {
	...

    /**
     * 按照Url地址限流 + 后续处理
     * @author liqb
     * @date 2023-05-26 22:25
     * @return
     */
    @GetMapping("/rateLimit/byUrl")
    @SentinelResource(value = "byUrl")
    public CommonResult byUrl() {
        return new CommonResult(200,"按url限流测试OK",new Payment(2020L,"serial002"));
    }
}

1.2.4.Sentinel控制台配置

SentinelResource配置

1.2.5.测试

快速点击http://localhost:8401/rateLimit/byUrl
结果 - 会返回Sentinel自带的限流处理结果 Blocked by Sentinel (flow limiting)

上面兜底方案面临的问题

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

2.SentinelResource配置(中)

2.1.客户自定义限流处理逻辑

2.1.1.自定义限流处理类 - 创建CustomerBlockHandler类用于自定义限流处理逻辑

package com.tianxia.springcloud.myhandler;

import com.alibaba.csp.sentinel.slots.block.BlockException;
import com.tianxia.alibaba.entity.CommonResult;

/**
 * @author: liqb
 * @date: 2023-05-26 2:41
 */
public class CustomerBlockHandler {

    public static CommonResult handlerException01(BlockException exception) {
        return new CommonResult(4444,"按客戶自定义,global handlerException----1");
    }

    public static CommonResult handlerException02(BlockException exception) {
        return new CommonResult(4444,"按客戶自定义,global handlerException----2");
    }
}

2.2.2.RateLimitController

@RestController
public class RateLimitController {
	...
  /**
   * 客户自定义限流处理逻辑
   * @author liqb
   * @date 2023-05-26 22:42
   * @return
   */
  @GetMapping("/rateLimit/customerBlockHandler")
  @SentinelResource(value = "customerBlockHandler",
          blockHandlerClass = CustomerBlockHandler.class, // <-------- 自定义限流处理类
          blockHandler = "handlerException02") // <-----------
  public CommonResult customerBlockHandler() {
      return new CommonResult(200,"按客戶自定义",new Payment(2020L,"serial003"));
  }
}

2.2.3.Sentinel控制台配置

SentinelResource配置

启动微服务后先调用一次 - http://localhost:8401/rateLimit/customerBlockHandler。

然后，多次快速刷新http://localhost:8401/rateLimit/customerBlockHandler。

刷新后，我们自定义兜底方法的字符串信息就返回到前端。

3.SentinelResource配置(下)

3.1.@SentinelResource 注解

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

@SentinelResource 用于定义资源，并提供可选的异常处理和 fallback 配置项。** @SentinelResource** 注解包含以下属性：文章来源地址https://www.toymoban.com/news/detail-466811.html

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