首页 > 技术文章 > springcloud微服务-sentinel

hongzuiliyu 2020-09-08 05:18 原文

sentinel作用,流量防卫兵

 

 

 

sentinel官方文档地址:https://github.com/alibaba/Sentinel/wiki

 

sentine入门

1.引入pom依赖

 

 

 2.定义资源,注解模式为@SentinelResource

  

 

 

 

 

 

 

 

 3.定义规则

  

 

 

 4.检查效果,日志文件中会打印相应的流控效果数据

  

 

 

 5.启动控制台,在控制台进行流控效果可视化查看

  1.guthub下载源码

  2.启动sentinel-dashboard,并加上启动参数

  java -Dserver.port=8080 -Dcsp.sentinel.dashboard.server=localhost:8080 -Dproject.name=sentinel-dashboard -jar sentinel-dashboard.jar

  3.客户端接入控制台

    1)引入pom依赖 

      <dependency>
          <groupId>com.alibaba.csp</groupId>
          <artifactId>sentinel-transport-simple-http</artifactId>
          <version>x.y.z</version>
      </dependency>

    2)配置JVM启动参数

      -Dcsp.sentinel.dashboard.server=localhost:8080

      -Dcsp.sentinel.api.port=8719

 

 

sentinel流控规则默认存储在内存中,服务重启就会丢失,需要配合持久化组件使用,比如apollo,db,redis等

 

sentinel注解模式

  @SentinelResource(value="xxx",blockHandler="xxx", fallback="xxx",defaultFallback=“xxx”,exceptionsToIgnore={xxx.class},blockHandlerClass={xxx.class})

  1.引入pom依赖   

    <dependency>
        <groupId>com.alibaba.csp</groupId>
        <artifactId>sentinel-annotation-aspectj</artifactId>
        <version>x.y.z</version>
    </dependency>

  2.注入bean

    @Bean

      public SentinelResourceAspect sentinelResourceAspect() {
          return new SentinelResourceAspect(); 

      }  

 

  注意点:

  1)value定义资源名称,blockHandler处理block异常,fallback处理所有异常,defaultFallback指定默认公共异常处理逻辑

  2)如果同时配置blockHandler和fallback,对于block异常只会走blockHandler,如果blockHandler,fallback,defaultFallback三者都没有,则直接抛出异常

  3)1.6版本之后,fallback函数可以处理业务异常,之前只能处理degradeException

  4)blockHandler必须和原函数在同一个类,如果希望在另外一个类,则使用blockHandlerClass,且必须是static修饰

  

@SentinelResource 用于定义资源,并提供可选的异常处理和 fallback 配置项。 @SentinelResource 注解包含以下属性:

  • value:资源名称,必需项(不能为空)
  • entryType:entry 类型,可选项(默认为 EntryType.OUT
  • blockHandler / blockHandlerClassblockHandler 对应处理 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.6.0 之前的版本 fallback 函数只针对降级异常(DegradeException)进行处理,不能针对业务异常进行处理

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

示例:

public class TestService {

    // 对应的 `handleException` 函数需要位于 `ExceptionUtil` 类中,并且必须为 static 函数.
    @SentinelResource(value = "test", blockHandler = "handleException", blockHandlerClass = {ExceptionUtil.class})
    public void test() {
        System.out.println("Test");
    }

    // 原函数
    @SentinelResource(value = "hello", blockHandler = "exceptionHandler", fallback = "helloFallback")
    public String hello(long s) {
        return String.format("Hello at %d", s);
    }
    
    // Fallback 函数,函数签名与原函数一致或加一个 Throwable 类型的参数.
    public String helloFallback(long s) {
        return String.format("Halooooo %d", s);
    }

    // Block 异常处理函数,参数最后多一个 BlockException,其余与原函数一致.
    public String exceptionHandler(long s, BlockException ex) {
        // Do some log here.
        ex.printStackTrace();
        return "Oops, error occurred at " + s;
    }
}

从 1.4.0 版本开始,注解方式定义资源支持自动统计业务异常,无需手动调用 Tracer.trace(ex) 来记录业务异常。Sentinel 1.4.0 以前的版本需要自行调用 Tracer.trace(ex) 来记录业务异常。

配置

Spring Cloud Alibaba

若您是通过 Spring Cloud Alibaba 接入的 Sentinel,则无需额外进行配置即可使用 @SentinelResource 注解。

Spring AOP

若您的应用使用了 Spring AOP(无论是 Spring Boot 还是传统 Spring 应用),您需要通过配置的方式将 SentinelResourceAspect 注册为一个 Spring Bean:

@Configuration
public class SentinelAspectConfiguration {

    @Bean
    public SentinelResourceAspect sentinelResourceAspect() {
        return new SentinelResourceAspect();
    }
}

我们提供了 Spring AOP 的示例,可以参见 sentinel-demo-annotation-spring-aop

AspectJ

若您的应用直接使用了 AspectJ,那么您需要在 aop.xml 文件中引入对应的 Aspect:

<aspects>
    <aspect name="com.alibaba.csp.sentinel.annotation.aspectj.SentinelResourceAspect"/>
</aspects>

 

sentinel集成dubbo

  1.引入pom依赖:

 

 

sentinel集成rocketmq(没讲清楚)

 

sentinel集群流控

 不太成熟,无法解决高可用和server性能问题,生产环境不要使用,用gateway进行集群流控

 

生产环境下使用sentinel

  1)原始模式    基于内存,不支持持久化,严重不建议在生产环境使用,故需要结合持久化组件

  2)pull模式     客户端向规则管理中心主动拉取,缺点是不能保证实时性

  3)push模式,生产环境一般使用这种模式,需要引用第三方依赖

 

apollo入门:

  1.官方文档:https://github.com/ctripcorp/apollo/wiki

  2.使用步骤:

    1)jdk1.8以上

    2)mysql5.6.5以上,apollo持久化依赖于mysql

    3)下载quick start 安装包

    

 

 

     4)创建数据库

      

 

 

     5)修改数据库连接信息

      

 

 

     6)启动apollo配置中心 

        

 

 

 

 

      

 

 

     7)访问apollo,默认用户名密码都是apollo

      

 

 

 

 3.搭建apollo-client

  1)引入pom依赖

    

  2)启动类加上@EnableApolloConfig,开启apollo客户端

  3)配置文件

    

 

 

   4)控制台创建项目,app-id要与配置文件保持一致

    

 

 

     5)新增或配置

    6)发布

      

 

 

 

Apollo开放平台

  

 

 

 第三方应用接入开放平台的步骤

   

 

 

     

 

 

 

    创建第三方应用:    
    

    赋权:

       

 

   第三方应用调用open api进行配置项管理

    

 

       

 

   然后查阅官方api文档进行http请求即可

 

sentinel整合apollo进行规则持久化(看不懂)

  

 











































推荐阅读