Sentinel使用及原理

依赖

implementation 'com.alibaba.cloud:spring-cloud-starter-alibaba-sentinel'

Demo

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(ServiceApplication.class, args);
    }
}

@Service
public class TestService {

    @SentinelResource(value = "sayHello")
    public String sayHello(String name) {
        return "Hello, " + name;
    }
}

@RestController
public class TestController {

    @Autowired
    private TestService service;

    @GetMapping(value = "/hello/{name}")
    public String apiHello(@PathVariable String name) {
        return service.sayHello(name);
    }
}

@SentinelResource 注解用来标识资源是否被限流、降级。

@SentinelResource 注解

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

@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 逻辑中，而是会原样抛出。1.8.0 版本开始，defaultFallback 支持在类级别进行配置。

注：1.6.0 之前的版本 fallback 函数只针对降级异常（DegradeException）进行处理，不能针对业务异常进行处理。

若 blockHandler 和 fallback 都进行了配置，则被限流降级而抛出 BlockException 时只会进入 blockHandler 处理逻辑。若未配置 blockHandler、fallback 和 defaultFallback，则被限流降级时会将 BlockException 直接抛出（若方法本身未定义 throws BlockException 则会被 JVM 包装一层 UndeclaredThrowableException）。

当 Spring WebFlux 应用接入 Sentinel starter 后，所有的 URL 就自动成为 Sentinel 中的埋点资源，可以针对某个 URL 进行流控。

springBoot 集成 Sentinel

server:
  port: 8090
  
spring:
  application:
    name: service-name
  cloud:
    sentinel:
      transport:
        dashboard: localhost:9999 #sentinel控制台访问路径
        port: 9999
      eager: true # 关闭懒加载

@RestController
public class TestController {

    @GetMapping(value = "/hello")
    @SentinelResource(value = "hello",fallback = "fallbackMethod")
    public String apiHello() {
        return "Sentinel";
    }

    public String fallbackMethod(){
        return "服务降级！";
    }
}

当我们访问：http://localhost:8090/hello/sentinel 时，面板如下

流控处理：hello接口QPS为1，超过1直接快速失败。

继续快速访问，直接失败！

降级处理：

Feign 支持

implementation 'org.springframework.cloud:spring-cloud-starter-openfeign'

@FeignClient(name = "service-provider", fallback = EchoServiceFallback.class, configuration = FeignConfiguration.class)
public interface EchoService {
    @RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
    String echo(@PathVariable("str") String str);
}

class FeignConfiguration {
    @Bean
    public EchoServiceFallback echoServiceFallback() {
        return new EchoServiceFallback();
    }
}

class EchoServiceFallback implements EchoService {
    @Override
    public String echo(@PathVariable("str") String str) {
        return "echo fallback";
    }
}

Gateway 支持

implementation 'org.springframework.cloud:spring-cloud-starter-gateway'
implementation 'com.alibaba.cloud:spring-cloud-starter-alibaba-sentinel'
implementation 'com.alibaba.cloud:spring-cloud-alibaba-sentinel-gateway'

spring:
  application:
    name: gateway
  cloud:
    sentinel:
      transport:
        dashboard: localhost:9999 #sentinel控制台访问路径
        port: 9999
      eager: true #懒加载
      filter:
        enabled: false #屏蔽URL 资源
    gateway:
      discovery:
        locator:
          enabled: true # 启用自动根据服务ID生成路由
          lower-case-service-id: true # 设置路由的路径为小写的服务ID
      routes:
        - id: test-service # 路由ID（一个路由配置一个ID）
          uri: lb://test # 通过注册中心来查找服务（lb代表从注册中心获取服务，并且负载均衡）
          predicates:
            - Path=/test/** # 匹配到的以/test开头的路径都转发到test的服务
          filters:
            - StripPrefix=1 # 去掉匹配到的路径的第一段

Dashboard控制台面板

下载地址：https://github.com/alibaba/Sentinel/releases

启动命令：启动 Sentinel 控制台需要 JDK 版本为 1.8 及以上版本

java -Dserver.port=9999 -Dcsp.sentinel.dashboard.server=localhost:9999 -Dproject.name=sentinel-dashboard -jar D:/Sentinel/sentinel-dashboard-1.8.1.jar

浏览器访问：http://localhost:9999/ ，账号密码均为：sentinel

posted @ 2021-04-10 00:05 柒月丶阅读(515) 评论(0) 编辑收藏举报

刷新页面返回顶部

柒月丶