# sentinel-develop-demo

**Repository Path**: openxgj/sentinel-develop-demo

## Basic Information

- **Project Name**: sentinel-develop-demo
- **Description**: sentinel限流demo实战
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 7
- **Forks**: 3
- **Created**: 2020-06-30
- **Last Updated**: 2024-10-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Sentinel
## 介绍
Sentinel是阿里开源的一款分布式流量控制、服务熔断、系统负载保护的轻量级框架，目的为了使得服务更加稳定。

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

Sentinel主要特性：
![image](7B48E646149C4F88ADC1E71886C67C78)

## 2个基本概念
### 1.资源
资源是 Sentinel 的关键概念。它可以是 Java 应用程序中的任何内容，例如，由应用程序提供的服务，或由应用程序调用的其它应用提供的服务，甚至可以是一段代码。

只要通过 Sentinel API 定义的代码，就是资源，能够被 Sentinel 保护起来。大部分情况下，可以使用方法签名，URL，甚至服务名称作为资源名来标示资源。
### 2.规则
围绕资源的实时状态设定的规则，可以包括流量控制规则、熔断降级规则以及系统保护规则。所有规则可以动态实时调整。


## Sentinel设计理念
### 流量控制
#### 什么是流量控制
流量控制在网络传输中是一个常用的概念，它用于调整网络包的发送数据。然而，从系统稳定性角度考虑，在处理请求的速度上，也有非常多的讲究。任意时间到来的请求往往是随机不可控的，而系统的处理能力是有限的。我们需要根据系统的处理能力对流量进行控制。Sentinel 作为一个调配器，可以根据需要把随机的请求调整成合适的形状。

![image](799400019B524E5691DAE03A5277BF63)

#### 流量控制的设计理念
流量控制有以下几个角度:

- 资源的调用关系，例如资源的调用链路，资源和资源之间的关系；
- 运行指标，例如 QPS、线程池、系统负载等；
- 控制的效果，例如直接限流、冷启动、排队等。

Sentinel 的设计理念是让您自由选择控制的角度，并进行灵活组合，从而达到想要的效果。

### 熔断降级
#### 什么是熔断降级
除了流量控制以外，及时对调用链路中的不稳定因素进行熔断也是 Sentinel 的使命之一。由于调用关系的复杂性，如果调用链路中的某个资源出现了不稳定，可能会导致请求发生堆积，进而导致级联错误。

![image](32D4C904BB4A41A2ADE30736AD6127A5)

Sentinel 和 Hystrix 的原则是一致的: 当检测到调用链路中某个资源出现不稳定的表现，例如请求响应时间长或异常比例升高的时候，则对这个资源的调用进行限制，让请求快速失败，避免影响到其它的资源而导致级联故障。

#### 熔断降级的设计理念
在限制的手段上，Sentinel 和 Hystrix 采取了完全不一样的方法。

Hystrix 通过 线程池隔离 的方式，来对依赖（在 Sentinel 的概念中对应 资源）进行了隔离。这样做的好处是资源和资源之间做到了最彻底的隔离。缺点是除了增加了线程切换的成本（过多的线程池导致线程数目过多），还需要预先给各个资源做线程池大小的分配。

Sentinel 对这个问题采取了两种手段:

通过并发线程数进行限制
和资源池隔离的方法不同，Sentinel 通过限制资源并发线程的数量，来减少不稳定资源对其它资源的影响。这样不但没有线程切换的损耗，也不需要预先分配线程池的大小。当某个资源出现不稳定的情况下，例如响应时间变长，对资源的直接影响就是会造成线程数的逐步堆积。当线程数在特定资源上堆积到一定的数量之后，对该资源的新请求就会被拒绝。堆积的线程完成任务后才开始继续接收请求。

通过响应时间对资源进行降级
除了对并发线程数进行控制以外，Sentinel 还可以通过响应时间来快速降级不稳定的资源。当依赖的资源出现响应时间过长后，所有对该资源的访问都会被直接拒绝，直到过了指定的时间窗口之后才重新恢复。

### 系统自适应保护
Sentinel 同时提供系统维度的自适应保护能力。防止雪崩，是系统防护中重要的一环。当系统负载较高的时候，如果还持续让请求进入，可能会导致系统崩溃，无法响应。在集群环境下，网络负载均衡会把本应这台机器承载的流量转发到其它的机器上去。如果这个时候其它的机器也处在一个边缘状态的时候，这个增加的流量就会导致这台机器也崩溃，最后导致整个集群不可用。

针对这个情况，Sentinel 提供了对应的保护机制，让系统的入口流量和系统的负载达到一个平衡，保证系统在能力范围之内处理最多的请求。

## 快速入门
主要包括以下几步:
> **在项目中引入依赖**

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


> **编写基本示例**

#### 代码块：
```
/**
 * 定义默认资源名
 */
private static final String DEFAULT_RESOURCE_KEY = "HelloWorld";
/**
 * 定义QPS模式下的阈值
 */
private static final int QPS_COUNT = 1;

public static void main(String[] args) throws InterruptedException {
    initFlowRules();
    // 死循环的原因是 直观看触发限流
    while (true) {
        // 1.5版本后 直接可 try-with-resource
        try (Entry entry = SphU.entry(DEFAULT_RESOURCE_KEY)) {
            // ====== 被保护的逻辑 ========
            System.out.println("Hello World");
        } catch (BlockException e) {
            System.out.println("触发限流");
        }
        // 因为阈值默认为1了 线程休眠 400MS
        Thread.sleep(400L);
    }
}

/**
 * 初始化加载规则
 */
private static void initFlowRules() {
    // 规则集合定义
    List<FlowRule> rules = new ArrayList<>();
    // 单个规则定义
    FlowRule rule = new FlowRule();
    // 设置资源名
    rule.setResource(DEFAULT_RESOURCE_KEY);
    // 设置限流模式
    rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
    // 设置限流阈值 - 吞吐量模式即每秒可访问次数
    rule.setCount(QPS_COUNT);
    rules.add(rule);
    // 规则管理器加载规则
    FlowRuleManager.loadRules(rules);
}
```
#### 注解：
注意：==启用注解需要导入spring-aop模块或者aspectj并且配置相关类信息==

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

```
public static void main(String[] args) throws InterruptedException {
    initFlowRules();
    // 死循环的原因是 直观看触发限流
    while (true) {
        // 1.5版本后 直接可 try-with-resource
        try (Entry entry = SphU.entry(DEFAULT_RESOURCE_KEY)) {
            // ====== 被保护的逻辑 ========
            sayHello();
        } catch (BlockException e) {
            System.out.println("触发限流");
        }
        // 因为阈值默认为1了 线程休眠 400MS
        Thread.sleep(400L);
    }
}

@SentinelResource(value = DEFAULT_RESOURCE_KEY)
private static void sayHello() {
    System.out.println("Hello World");
}
```



> **运行**

运行结果：

![image](708B550CB05F4743B2D3EB5E1CA45244)

> **检查效果**

Demo 运行之后，我们可以在日志 ~/logs/csp/${appName}-metrics.log.xxx 里看到下面的输出:
![image](94AD0B5937A140F19D7631CDC3224E3C)

    |--timestamp-|------date time----|--resource-|p|block |s|e|rt
    1593486101000|2020-06-30 11:01:41|HelloWorld |1|1     |1|0|8|
    1593486102000|2020-06-30 11:01:42|HelloWorld |1|2     |1|0|2|
    1593486103000|2020-06-30 11:01:43|HelloWorld |1|1     |1|0|0|
    1593486104000|2020-06-30 11:01:44|HelloWorld |1|2     |1|0|0|
    1593486105000|2020-06-30 11:01:45|HelloWorld |1|1     |1|0|2|
限流日志名词解释：

名词 | 解释 
---|--- 
timestamp | 时间戳 
date time | 具体时间 
resource | 具体时间
p | 通过的请求 
block | 被阻止的请求 
s | 成功执行完成的请求个数 
e | 用户自定义异常 
rt | 平均响应时长


***
### 参考资料
Sentinel新手指南：
https://github.com/alibaba/Sentinel/wiki/%E6%96%B0%E6%89%8B%E6%8C%87%E5%8D%97#%E5%85%AC%E7%BD%91-demo

Sentinel介绍：https://github.com/alibaba/Sentinel/wiki/%E4%B8%BB%E9%A1%B5

gitee地址：https://gitee.com/javaeexgj/sentinel-develop-demo

<div style="text-align: right"> 2020年6月30日 </div>

***