Sentinel-新手从零开始搭建限流框架

最新推荐文章于 2024-05-14 17:30:03 发布

龚厂长

最新推荐文章于 2024-05-14 17:30:03 发布

阅读量859

点赞数

分类专栏： sentinel 文章标签： sentinel 限流

本文链接：https://blog.csdn.net/weixin_38308374/article/details/112795795

版权

sentinel 专栏收录该内容

3 篇文章 1 订阅

订阅专栏

本文基于sentinel-1.8.0版本

Sentinel 是面向分布式服务架构的流量控制组件，主要以流量为切入点，从限流、流量整形、熔断降级、系统负载保护、热点防护等多个维度来帮助开发者保障微服务的稳定性，其具有以下特征:

丰富的应用场景：Sentinel 承接了阿里巴巴近 10 年的双十一大促流量的核心场景，例如秒杀、消息削峰填谷、集群流量控制、实时熔断下游不可用应用等。
完备的实时监控：Sentinel 同时提供实时的监控功能。您可以在控制台中看到接入应用的单台机器秒级数据，甚至 500 台以下规模的集群的汇总运行情况。
广泛的开源生态：Sentinel 提供开箱即用的与其它开源框架/库的整合模块，例如与Spring Cloud、Dubbo、gRPC的整合。您只需要引入相应的依赖并进行简单的配置即可快速地接入 Sentinel。
完善的 SPI 扩展点：Sentinel 提供简单易用、完善的 SPI 扩展接口。您可以通过实现扩展接口来快速地定制逻辑。例如定制规则管理、适配动态数据源等。

一、搭建sentinel

sentinel核心jar包不依赖任何框架/库，能够运行于Java 7及以上的版本的运行时环境。下面分四步运行起来一个sentinel。

1、引入依赖

sentinel的核心只依赖于sentinel-core，在pom文件里面配置如下依赖：

<dependency>
    <groupId>com.alibaba.csp</groupId>
    <artifactId>sentinel-core</artifactId>
    <version>1.8.0</version>
</dependency>

2、定义资源

在sentinel中，资源就是要被保护的部分，它可以是 Java 应用程序中的任何内容，例如，由应用程序提供的服务，或由应用程序调用的其它应用提供的服务，甚至可以是一段代码。一旦资源过载，sentinel就要启动保护措施，比如限流、拒绝请求等。
sentinel使用类SphU来定义资源，更准确的说，被SphU.entry()和SphU.exit()包围起来的内容就是资源。
下面来看一下代码：

	public static void main(String argv[]){
        Entry entry=null;
        while (true) {
            try{
            	//SphU.entry()的入参为资源名，这里的资源名为HelloWorld
                entry =SphU.entry("HelloWorld");
                // 被保护的资源
                System.out.println("hello world");
            } catch (BlockException ex) {
                // 如果被保护资源过载，会抛出异常BlockException，
                // catch异常后，可以打印日志，也可以返回失败，或者做其他处理
                System.out.println("blocked!");
            }finally {
                if(entry!=null) {
                    entry.exit();//关闭
                }
            }
        }
    }

3、定义规则

定义好了资源，下面要定义保护规则，也就是当发生资源过载了或者请求量超过了阈值，sentinel怎么处理，包括流量控制规则、熔断降级规则以及系统保护规则。

	//下面代码设置的规则是，如果请求每秒超过10次，就启动保护
	private static void initFlowRules(){
        List<FlowRule> rules = new ArrayList<>();
        FlowRule rule = new FlowRule();
        rule.setResource("HelloWorld");//资源名
        rule.setGrade(RuleConstant.FLOW_GRADE_QPS);//流控的阈值类型，这里用的是qps
        rule.setCount(10);//每秒最多10次请求
        rules.add(rule);
        FlowRuleManager.loadRules(rules);
    }

第2步和第3步代码合起来就是完整代码：

    public static void main(String argv[]){
        // 定义规则
        initFlowRules();
        Entry entry=null;
        while (true) {
            try{
            	//SphU.entry()的入参为资源名，这里的资源名为HelloWorld
                entry =SphU.entry("HelloWorld");
                // 被保护的资源
                System.out.println("hello world");
            } catch (BlockException ex) {
                // 处理被流控的逻辑
                System.out.println("blocked!");
            }finally {
                if(entry!=null) {
                    entry.exit();//关闭
                }
            }
        }
    }
    private static void initFlowRules(){
        List<FlowRule> rules = new ArrayList<>();
        FlowRule rule = new FlowRule();
        rule.setResource("HelloWorld");//资源名
        rule.setGrade(RuleConstant.FLOW_GRADE_QPS);//流控的阈值类型，这里用的是qps
        rule.setCount(10);//每秒最多10次请求
        rules.add(rule);
        FlowRuleManager.loadRules(rules);
    }

4、运行代码

下面开始运行main方法。
可以在控制台看到如下日志：

INFO: Sentinel log output type is: file
INFO: Sentinel log charset is: utf-8
INFO: Sentinel log base directory is: C:\Users\XX\logs\csp\
INFO: Sentinel log name use pid is: false
hello world
hello world
hello world
hello world
hello world
hello world
hello world
hello world
hello world
hello world
blocked!
blocked!
blocked!
blocked!
blocked!

“hello world”打印了10次之后，如果再访问资源就会抛出异常。
我们还可以看一下控制台输出的目录中的“Main-metrics.log.日期”文件，

|--timestamp-|------date time----|-resource-|p |block|s |e|rt
1610979251000|2021-01-18 22:14:11|HelloWorld|10|351  |10|0|10|0|0|0
1610979252000|2021-01-18 22:14:12|HelloWorld|10|6212 |10|0|0 |0|0|0

上面各个列的含义是 p 代表通过的请求, block 代表被阻止的请求, s 代表成功执行完成的请求个数, e 代表用户自定义的异常。
这样一个简单的sentinel就已经启动成功了。

二、Sentinel 控制台

Sentinel提供了一个控制台，可以帮忙我们管理推送流控规则，监控系统运行，机器发现等。
Sentinel 控制台目前仅支持单机部署。Sentinel 控制台项目提供 Sentinel 功能全集示例，不作为开箱即用的生产环境控制台。
运行控制台，不需要Tomcat，只需要从releases页面下载最新的jar包（本文写作时最新jar包是sentinel-dashboard-1.8.0.jar），使用如下命令运行即可（启动 Sentinel 控制台需要 JDK 版本为 1.8 及以上版本。）：

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

其中-Dserver.port=8080 指定了 Sentinel 控制台端口为 8080。
控制台启动成功后，在浏览器输入http://localhost:8080/，在登录页面输入用户名和密码，默认用户名和密码都是sentinel。
登录进去之后看到如下页面：
在这里插入图片描述

三、客户端接入控制台

控制台启动成功后，下面将第一小节写的代码接入到控制台。

1、引入依赖

在pom文件引入如下依赖：

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

2、修改启动参数

启动程序前，修改JVM参数 -Dcsp.sentinel.dashboard.server=localhost:8080 ，指定控制台地址和端口。

3、启动程序

前两步完成后，我修改了程序加了延迟，保证请求都是成功的：

			try{
                entry =SphU.entry("HelloWorld");
                // 被保护的资源
                System.out.println("hello world");
                Thread.sleep(100);//加入延迟
            } catch (BlockException ex) {

此时可以在实时监控页面看到：
在这里插入图片描述
关于控制台更多的介绍可以参见：

https://github.com/alibaba/Sentinel/wiki/%E6%8E%A7%E5%88%B6%E5%8F%B0

四、注解支持

如果使用第一小节的方法定义资源，会对业务代码造成侵入，开发的工作量也很大。
为了解决这个问题，sentinel为我们提供了注解支持@SentinelResource。只需要在方法上面添加该注解，sentinel就会将该方法作为资源对待。
使用注解，需要引入如下依赖：

        <dependency>
            <groupId>com.alibaba.csp</groupId>
            <artifactId>sentinel-annotation-aspectj</artifactId>
            <version>1.8.0</version>
        </dependency>

@SentinelResource有很多属性，下面介绍两个关键属性，其他的属性可以参见文章：

https://github.com/alibaba/Sentinel/wiki/%E6%B3%A8%E8%A7%A3%E6%94%AF%E6%8C%81

value：资源名称，必需项（不能为空）
blockHandler: blockHandler 对应处理 BlockException 的函数名称，可选项。blockHandler 函数访问范围需要是 public，返回类型需要与原方法相匹配，参数类型需要和原方法相匹配并且最后加一个额外的参数，类型为 BlockException。blockHandler 函数默认需要和原方法在同一个类中。若希望使用其他类的函数，则可以指定 blockHandlerClass 为对应的类的 Class 对象，注意对应的函数必需为 static 函数，否则无法解析。

下面我们将第一小节的代码改造成使用注解方式。
首先是启动类，下面的例子使用springboot启动：

package com.sentinel;
//import省略

@SpringBootApplication(scanBasePackages = "com.sentinel")
@Configuration
public class Main {
    public static void main(String argv[])throws Exception{
        // 创建spring容器
        ApplicationContext context =new SpringApplicationBuilder(Main.class)
                .web(WebApplicationType.NONE).bannerMode(Banner.Mode.OFF)
                .run(argv);
        // 定义规则
        initFlowRules();
        TestFrequentVisits visit=context.getBean(TestFrequentVisits.class);
        while(true) {
            System.out.println(visit.test());
        }
    }

    private static void initFlowRules(){
        List<FlowRule> rules = new ArrayList<>();
        FlowRule rule = new FlowRule();
        rule.setResource("HelloWorld");//资源名
        rule.setGrade(RuleConstant.FLOW_GRADE_QPS);//流控的阈值类型，这里用的是qps
        rule.setCount(10);//每秒最多10次请求
        rules.add(rule);
        FlowRuleManager.loadRules(rules);
    }

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

下面是资源方法所在的类：

package com.sentinel;
//import省略

@Component
public class TestFrequentVisits  {
    @SentinelResource(value="HelloWorld",blockHandler="exceptionHandler")
    public String test(){
        return "hello world";
    }
    // Block 异常处理函数，参数最后多一个 BlockException，其余与原函数一致.
    public String exceptionHandler(BlockException ex) {
        return "blocked!";
    }
}

启动起来之后，可以打印出与第一小节相同的日志。
注意：如果使用Spring Cloud Alibaba，上面示例代码无需注册SentinelResourceAspect对象，也就是不需要方法sentinelResourceAspect()。

五、总结

本文主要介绍了如何搭建sentinel，如何启动控制台监控应用，最后介绍了使用注解方式定义资源。

龚厂长

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
2
评论
Sentinel-新手从零开始搭建限流框架

本文基于sentinel-1.8.0版本一、搭建sentinelsentinel核心jar包不依赖任何框架/库，能够运行于Java 7及以上的版本的运行时环境。下面分四步运行起来一个sentinel。1、引入依赖sentinel的核心只依赖于sentinel-core，在pom文件里面配置如下依赖：<dependency> <groupId>com.alibaba.csp</groupId> <artifactId>sentine.
复制链接

扫一扫