Soul源码阅读 - Sentinel插件

Sentinel插件功能

Sentinel是面向分布式服务架构的高可用流量控制组件,为Soul网关提供流量控制和熔断降级功能。Sentinel插件使Soul网关与Sentinel组件进行整合。通过上篇介绍,使用者只需要少量配置即可使用。并且支持动态修改Sentinel的配置信息,不需要重启Soul网关应用。

Sentinel插件源码阅读

当客户端调用网关请求时,SentinelPlugin类会执行,它的功能是判断该请求是否启动规则配置,如符合则调用Sentinel的流控或熔断功能。

SentinelPlugin.java

public class SentinelPlugin extends AbstractSoulPlugin {
    @Override
    protected Mono<Void> doExecute(final ServerWebExchange exchange, final SoulPluginChain chain, final SelectorData selector, final RuleData rule) {
        // 通过HTTP Request,获取到SoulContext信息
        final SoulContext soulContext = exchange.getAttribute(Constants.CONTEXT);
        assert soulContext != null;
        // 根据规则配置信息,生成资源名(选择ID + 规则名称)。 资源名是Sentinel的核心概念
        String resourceName = SentinelRuleHandle.getResourceName(rule);
        // 解析Sentinel的相关配置信息,如流控类型、流控策略、流控限值等等
        SentinelHandle sentinelHandle = GsonUtils.getInstance().fromJson(rule.getHandle(), SentinelHandle.class);
        // 处理一下plugin,SentinelReactorTransformer执行流控或熔断监控
        return chain.execute(exchange).transform(new SentinelReactorTransformer<>(resourceName)).doOnSuccess(v -> {
            if (exchange.getResponse().getStatusCode() != HttpStatus.OK) {
                HttpStatus status = exchange.getResponse().getStatusCode();
                exchange.getResponse().setStatusCode(null);
                throw new SentinelFallbackException(status);
            }
        }).onErrorResume(throwable -> sentinelFallbackHandler.fallback(exchange, UriUtils.createUri(sentinelHandle.getFallbackUri()), throwable));
    }
}

当Soul控制台更新流控或熔断的配置信息时,会将该信息同步给Soul网关,此时会调用SentinelRuleHandle类,如下代码:

SentinelRuleHandle.java

public class SentinelRuleHandle implements PluginDataHandler {
    // 当Soul控制台更新Sentinel相关配置信息时会调用此方法
    @Override
    public void handlerRule(final RuleData ruleData) {
        SentinelHandle sentinelHandle = GsonUtils.getInstance().fromJson(ruleData.getHandle(), SentinelHandle.class);
        // 获取Sentinel所有流控资源配置信息
        List<FlowRule> flowRules = FlowRuleManager.getRules()
                .stream()
                // 如果要更新配置在List中,则过滤掉,以便添加最新的配置信息
                .filter(r -> !r.getResource().equals(getResourceName(ruleData)))
                .collect(Collectors.toList());
                // 如果开启流控
        if (sentinelHandle.getFlowRuleEnable() == Constants.SENTINEL_ENABLE_FLOW_RULE) {
            // 创建Sentinel的流控规则
            FlowRule rule = new FlowRule(getResourceName(ruleData));
            // 流控限流阀值
            rule.setCount(sentinelHandle.getFlowRuleCount());
            // 流控类型,QPS或线程数
            rule.setGrade(sentinelHandle.getFlowRuleGrade());
            // 流控策略,直接拒绝、冷启动或匀速器
    rule.setControlBehavior(sentinelHandle.getFlowRuleControlBehavior());
            flowRules.add(rule);
        }
        // 创建资源规则
        FlowRuleManager.loadRules(flowRules);
        // 获取Sentinel所有熔断资源配置信息,
        List<DegradeRule> degradeRules = DegradeRuleManager.getRules()
                .stream()
                // 如果要更新配置在List中,则过滤掉,以便添加最新的配置信息
                .filter(r -> !r.getResource().equals(getResourceName(ruleData)))
                .collect(Collectors.toList());
                // 是否开启熔断
        if (sentinelHandle.getDegradeRuleEnable() == Constants.SENTINEL_ENABLE_DEGRADE_RULE) {
            // 创建熔断规则
            DegradeRule rule = new DegradeRule(getResourceName(ruleData));
            // 熔断阀值
            rule.setCount(sentinelHandle.getDegradeRuleCount());
            // 熔断策略 慢调用比例、异常比例或异常数
            rule.setGrade(sentinelHandle.getDegradeRuleGrade());
            // 熔断时长
            rule.setTimeWindow(sentinelHandle.getDegradeRuleTimeWindow());
            degradeRules.add(rule);
        }
        // 创建资源规则
        DegradeRuleManager.loadRules(degradeRules);
    }

    // 删除流控和熔断
    @Override
    public void removeRule(final RuleData ruleData) {
        FlowRuleManager.loadRules(FlowRuleManager.getRules()
                .stream()
                .filter(r -> !r.getResource().equals(getResourceName(ruleData)))
                .collect(Collectors.toList()));
        DegradeRuleManager.loadRules(DegradeRuleManager.getRules()
                .stream()
                .filter(r -> !r.getResource().equals(getResourceName(ruleData)))
                .collect(Collectors.toList()));
    }
}

总结

流量控制和熔断功能为系统提供了更高的稳定性。尤其是在微服务的体系下,避免了系统之间产生雪崩效应。做为网关,流量控制和熔断机制是必不可少的功能之一。

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

推荐阅读更多精彩内容