Spring Cloud集成Sentinel

本篇主要介绍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>
  1. 创建一个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()方法来配置资源。
  1. 手动配置流控规则,可以借助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资源的流控规则。

  1. 启动服务后,访问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的服务器地址,可以实现流控数据的监控和流控规则的分发。

  1. 提供一个REST接口:
@RestController
public class SentinelDashboardController {

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

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

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

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

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


    在这里插入图片描述
  3. 针对/dash这个资源,点击最右边的操作栏中的“流控”按钮设置流控规则,如下图所示:


    在这里插入图片描述

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

  4. 新增完成后,再次访问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;
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,393评论 5 467
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,790评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,391评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,703评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,613评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,003评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,507评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,158评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,300评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,256评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,274评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,984评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,569评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,662评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,899评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,268评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,840评论 2 339