暂无图片
暂无图片
暂无图片
暂无图片
暂无图片

Spring Cloud集成Sentinel

Java收录阁 2020-05-31
320

本篇主要介绍Sentinel如何实现Spring Cloud应用的限流操作。

Sentinel接入Spring Cloud

1. 创建一个基于Spring Boot的项目,并集成Greenwich.SR2版本的Spring Cloud依赖。

2. 添加Sentinel依赖包

    <dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
    <version>2.1.1.RELEASE</version>
    </dependency>

    3. 创建一个REST接口,并通过@SentinelResource配置限流保护资源

      @RestController
      public class SentinelDemoController {


      @SentinelResource(value = "hello", blockHandler = "blockHandlerHello")
      @GetMapping("/hello")
      public String hello() {
      return "Hello Sentinel";
      }


      public String blockHandlerHello(BlockException e) {
      return "限流了";
      }
      }


      在上面代码中,配置限流资源有几种情况:

      • Sentinel starter在默认情况下会为所有HTTP服务提供限流埋点,所以如果只想对HTTP服务进行限流,只需要添加依赖即可。

      • 如果想要对特定的方法进行限流或者降级,则需要通过@SentinelResource注解来实现限流资源的定义

      • 可以通过SphU.entry()方法来配置资源。

      4. 手动配置流控规则,可以借助Sentinel的InitFunc SPI扩展接口来实现,只需要实现自己的InitFunc接口,并在init方法中编写规则加载的逻辑即可。

        public class FlowRuleInitFunc implements InitFunc {
        @Override
        public void init() throws Exception {
        List<FlowRule> rules = new ArrayList<>();
        FlowRule rule = new FlowRule();
        rule.setCount(1);
        rule.setResource("hello");
        rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
        rule.setLimitApp("default");
        rules.add(rule);
        FlowRuleManager.loadRules(rules);
        }
        }

        SPI是扩展点机制,如果需要被Sentinel加载,那么还要在resource目录下创建META-INF/services/com.alibaba.csp.sentinel.init.InitFunc文件,文件内容就是自定义扩展点的全路径

          com.sentinel.springcloud.demo.FlowRuleInitFunc

          按照上述配置好之后,在初次访问任意资源的时候,Sentinel就会自动加载hello资源的流控规则。


          5. 启动服务后,访问http://localhost:8080/hello方法,当访问频率超过设定阈值的时候,就会触发限流。

          上述配置过程是基于手动配置来加载流控规则的,还有一种方式就是通过Sentinel Dashboard来进行配置。

          基于Sentinel Dashboard来实现流控配置

          基于Sentinel Dashboard来配置流控规则,可以实现流控规则的动态配置,执行步骤如下:

          1. 启动Sentinel Dashboard


          2. 在application.yaml中增加如下配置:

            spring:
            application:
            name: sentinel-spring-cloud-demo
            cloud:
            sentinel:
            transport:
            dashboard: localhost:7777

            spring.cloud.sentinel.transport.dashboard指向的是Sentinel Dashboard的服务器地址,可以实现流控数据的监控和流控规则的分发。

            3. 提供一个REST接口:

              @RestController
              public class SentinelDashboardController {


              @GetMapping("/dash")
              public String dashboard() {
              return "Hello Sentinel Dashboard";
              }
              }

              此处不需要添加任何资源埋点,在默认情况下Sentinel Starter会对所有HTTP请求进行限流。

              4. 启动服务后,此时访问http://localhost:8080/dash,不存在任何限流行为。


              至此,Spring Cloud集成Sentinel的配置就完成了,接下来就可以进入Sentinel Dashboard去实现限流规则的配置。

              • 访问local host:7777进入Sentinel Dashboard。

              • 进入spring.application.name对应的菜单,访问“簇点链路”,如下图所示,在该列表下可以看到/dash这个REST接口的资源名称。

              • 针对/dash这个资源,点击最右边的操作栏中的“流控”按钮设置流控规则,如下图所示:

              新增规则中的所有配置信息,实际就是FlowRule中对应的属性配置。

              • 新增完成后,再次访问localhost:8080/dash,当超过设置的阈值的时候,就可以看到限流的效果,并获得如下输出:


              自定义URL限流异常

              在默认情况下,URL触发限流后会直接返回Blocked by Sentinel (flow limiting),但是在实际应用中,大都采用JSON格式的数据,所以如果希望修改触发限流之后的返回结果形式,则可以通过自定义限流异常来处理,实现UrlBlockHandler并重写blocked方法:

                @Service
                public class CustomUrlBlockHandler implements UrlBlockHandler {
                @Override
                public void blocked(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, BlockException e) throws IOException {
                httpServletResponse.setHeader("Content-Type", "application/json;charset=UTF-8");
                String message = "{\"code\":999,\"msg\":\"访问人数过多\"}";
                httpServletResponse.getWriter().write(message);
                }
                }

                还有一种场景是:当触发限流之后,我们希望直接跳转到一个降级页面,可以通过下面这个配置来实现:

                  spring.cloud.sentinel.servlet.block-page={url}


                  URL资源清洗

                  Sentinel中HTTP服务的限流默认由Sentinel-Web-Servlet包中的CommonFilter来实现,从代码中可以看到,这个Filter会把每个不同的URL都作为不同的资源来处理。

                  在下面这段代码中,提供一个携带{id}参数的REST风格的API,对于每一个不同的{id},URL也都不一样,所以在默认情况下Sentinel会把所有的URL当作资源来进行流控。

                    @RestController
                    public class UrlCleanController {


                    @GetMapping("/clean/{id}")
                    public String clean(@PathVariable("id") int id) {
                    return "Hello URL";
                    }


                    }

                    这会导致两个问题:

                    1. 限流统计不准确,实际需求是控制clean方法总的QPS,结果统计的是每个URL的QPS。

                    2. 导致Sentinel中资源数量过多,默认资源数量的阈值是6000, 对于多出的资源规则将不会生效。


                    针对这个问题,可以通过UrlCleaner接口来实现资源清洗,也就是对/clean/{id}这个URL,我们可以统一归集到/clean/*资源下,具体配置代码如下:

                      @Service
                      public class CustomUrlCleaner implements UrlCleaner {
                      @Override
                      public String clean(String s) {
                      if (StringUtils.isEmpty(s)) {
                      return s;
                      }
                      if (s.startsWith("/clean/")) {
                      return "/clean/*";
                      }
                      return s;
                      }
                      }




                      文章转载自Java收录阁,如果涉嫌侵权,请发送邮件至:contact@modb.pro进行举报,并提供相关证据,一经查实,墨天轮将立刻删除相关内容。

                      评论