Sentinel-（一）快速入门-搭建控制台、单机流量控制、定义受保护资源、定义规则、规则释义、动态数据源规则配置

前言：随着技术日新月异，技术选型成为了首要面对的问题，如何选择合适稳定的框架？

限流方面Sentinel承接了阿里巴巴近 10 年的双十一大促流量的核心场景，足以证明它的实力

目录

<一>Sentinel 是什么？分布式系统的流量防卫兵 

<二>控制台搭建，相关依赖配置快速关联服务与控制台

<三>如何定义资源？如何定义资源名？如何定义规则？动态数据源规则配置

---

引文sentinel官网内容 gitHub：https://github.com/alibaba/Sentinel 

 

一、Sentinel 是什么？分布式系统的流量防卫兵 

随着微服务的流行，服务和服务之间的稳定性变得越来越重要。Sentinel 以流量为切入点，从流量控制、熔断降级、系统负载保护等多个维度保护服务的稳定性。

Sentinel 具有以下特征:

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

sentinel可以保护我们所定义的所有资源，资源可以是方法也可以是一段甚至一行代码

概念性部分，不做补充，让我们快速入门

Sentinel 分为两个部分:

• 核心库（Java 客户端）不依赖任何框架/库，能够运行于所有 Java 运行时环境，同时对 Dubbo / Spring Cloud 等框架也有较好的支持。（补充说明：需要各个服务引入依赖）
• 控制台（Dashboard）基于 Spring Boot 开发，打包后可以直接运行，不需要额外的 Tomcat 等应用容器。（独立部署的服务，目的主要是方便管理应用资源以及实时监控流量）

 

二、控制台搭建，相关依赖配置快速关联服务与控制台

控制台下载：https://github.com/alibaba/Sentinel/releases  笔者使用的版本是1.7.1

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

其中 -Dserver.port=8080 用于指定 Sentinel 控制台端口为 8080 

注：笔者在windows使用Powershell启动的时候出现“找不到或无法加载主类 -prot=8080"  定位是powershell识别命令异常，可以直接用cmd启动

 本地启动完成后，浏览器打开127.0.0.1:8080即可登录（端口跟随上方你配置的 -Dserver.port），加载后如下，从 Sentinel 1.6.0 起，Sentinel 控制台引入基本的登录功能，默认用户名和密码都是 sentinel

先暂时不登录，为我们的服务配置一下依赖，版本最好与自己的springboot或者cloud版本对应上，否则可能出现版本不兼容或其他难以排查的问题 

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

依赖中的sentinel相关依赖都是1.7.1与上面我下载的控制台一致，避免出现其他问题，下面为服务中yml配置，如果使用的是properties自己修改一下层级

spring:
  cloud:
    sentinel:
      transport:
        #Sentinel api端口 提供接口访问等方式，默认8719
        port: 8720
        #你的控制台ip+端口
        dashboard: 127.0.0.1:8080

随后启动我们的服务，接下来登录控制台进入页面

机器列表  可以查看到服务已经和我们的控制台关联上了

 左侧流控规则，右上角新增流控规则，弹框如下，可以发现有个新概念：资源名  

 

三、如何定义资源？如何定义资源名？如何定义规则？动态数据源规则配置

一、定义资源与资源名的两种方式 ①硬编码 ②注解@SentinelResource

① 硬编码形式 代码侵入性高（不推荐）

使用SphU.entry("HelloWorld") 和 entry.exit() 包围起来业务代码即可 ，如下System.out.println("hello world")为我们要保护的资源，"HelloWorld"即为我们的资源名; 

//此代码示例 来源官方gitHub
public static void main(String[] args) {
    initFlowRules();
    while (true) {
        Entry entry = null;
        try {
	    entry = SphU.entry("HelloWorld");
            /*您的业务逻辑 - 开始*/
            System.out.println("hello world");
            /*您的业务逻辑 - 结束*/
	} catch (BlockException e1) {
            /*流控逻辑处理 - 开始*/
	    System.out.println("block!");
            /*流控逻辑处理 - 结束*/
	} finally {
	   if (entry != null) {
	       entry.exit();
	   }
	}
    }
}

 

② 注解@SentinelResource 代码侵入性低（推荐）

value是我们定义的资源名，用注解来定义的方法内容为需要保护的资源，注解代码侵入性低（推荐）

    @SentinelResource(value = "test")
    public String test(String name) {
        return "test, " + name;
    }

二、定义规则的三种方式 ① API形式 ②硬编码 ③ 动态数据源控制 

①API形式，基本上通过接口调用，可以在控制台进行操作

之前有yml中有提到8720是服务yml中配置的，进行api接口调用另起的，非服务器端口

②硬编码 （不推荐）一般在spring初始化完成容器后自己调用即可

//官方示例代码，以下为个人注释
private static void initFlowRules(){
    //可同时定义多条规则
    List<FlowRule> rules = new ArrayList<>();
    FlowRule rule = new FlowRule();
    //定义受该规则影响的资源名，如果没有找到就不会生效
    rule.setResource("HelloWorld");
    rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
    // 20次请求/s限制
    rule.setCount(20);
    rules.add(rule);
    //注册进管理器即可
    FlowRuleManager.loadRules(rules);
}

③动态数据源（推荐）笔者使用的是nacos作为动态数据源，以下为nacos作为数据源代码实现 （读者可以使用ZooKeeper Apollo Redis 来定义自己的规则，步骤大致一样）

首先需要额外引入nacos数据源相关依赖 

        <dependency>
            <groupId>com.alibaba.csp</groupId>
            <artifactId>sentinel-datasource-nacos</artifactId>
            <version>1.7.1</version>
            <scope>compile</scope>
        </dependency>

代码部分 以下属性内容可以通过依赖注入的方式进行动态配置

init方法需要自行调用一次进行初始化

    //不需要指定NAMESPACE
    public void init() throws Exception {
        final String remoteAddress = "localhost";//nacos的ip+端口
        final String groupId = "Sentinel:Demo";//nacos对应分组
        final String dataId = "com.alibaba.csp.sentinel.demo.flow.rule";//数据id

        ReadableDataSource<String, List<FlowRule>> flowRuleDataSource = new NacosDataSource<>(remoteAddress, groupId, dataId,
            source -> JSON.parseObject(source, new TypeReference<List<FlowRule>>() {}));
        FlowRuleManager.register2Property(flowRuleDataSource.getProperty());
    }

    //需要指定NAMESPACE
    public void init() throws Exception {
        final String remoteAddress = "localhost";
        final String namespace = "namespace";//工作空间
        final String groupId = "Sentinel:Demo";
        final String dataId = "com.alibaba.csp.sentinel.demo.flow.rule";
        Properties properties = new Properties();
        properties.put(PropertyKeyConst.SERVER_ADDR, remoteAddress);
        properties.put(PropertyKeyConst.NAMESPACE, namespace);
        ReadableDataSource<String, List<FlowRule>> flowRuleDataSource = new NacosDataSource<>(properties, groupId, dataId,
            source -> JSON.parseObject(source, new TypeReference<List<FlowRule>>() {}));
        FlowRuleManager.register2Property(flowRuleDataSource.getProperty());
    }

也可以借助 Sentinel 的 InitFunc SPI 扩展接口

package com.test.init;

public class DataSourceInitFunc implements InitFunc {

    @Override
    public void init() throws Exception {
        final String remoteAddress = "localhost";
        final String groupId = "Sentinel:Demo";
        final String dataId = "com.alibaba.csp.sentinel.demo.flow.rule";

        ReadableDataSource<String, List<FlowRule>> flowRuleDataSource = new NacosDataSource<>(remoteAddress, groupId, dataId,
            source -> JSON.parseObject(source, new TypeReference<List<FlowRule>>() {}));
        FlowRuleManager.register2Property(flowRuleDataSource.getProperty());
    }
}

接着将对应的类名添加到位于资源目录（通常是 resource 目录）下的 META-INF/services 目录下的（注：没有的话，自己安装以下目录格式创建即可）

文件内容 以上面的代码为例

//全限定名+类名
com.test.init.DataSourceInitFunc

接下来在dataId中写我们的配置

json数据内容如下： resource对标的"test"为我们之前所定义需要被保护的资源

[
    {
        "strategy": 0,
        "grade": 1,
        "controlBehavior": 3,
        "resource": "test",
        "limitApp": "default",
        "count": 100,
        "maxQueueingTimeMs": 1000,
        "clusterMode": false
    }
]

释义可以查阅 https://blog.csdn.net/qq_42709262/article/details/111106467

配置完成后，在控制台中展示为

每次重启都会读取nacos中的配置，且我们可以在运行阶段对nacos配置进行热修改，在nacos上的修改会同步至各个机器上

如上我们对nacos配置进行修改后，相关机器配置已同步修改

接下来可以尝试发起请求进行测试 ，流量控制效果如下 test： 为什么没有拒绝的请求？ 因为之前配置controlBehavior属性为3 即Warm Up+匀速排队 故不会拒绝请求，若修改为0后会出现拒绝请求的现象

controlBehavior修改为0（直接拒绝）后 可以发现test资源（我们原定义受保护资源）有大量拒绝请求

"/test/{name}"为控制器层上面这张图由于设置的是排队策略，故/test/{name}会被制约 仅50qps，而下图为直接拒绝策略，/test/{name}吞吐没有被制约住所以会通过许多请求

（其实/test/{name}不会存在拒绝请求，但此处/test/{name}拒绝请求1000+ 为什么？由于我配置了系统自适应限流才导致出现拒绝请求现象，后面文章会继续讲解）