本文主要是介绍三万字详解SpringClould高可用流量防护组件Sentinel哨兵（含源码例子），对大家解决编程问题具有一定的参考价值，需要的程序猿们随着小编来一起学习吧！

文章目录

• 项目结构
• 一、断路器
• • 1.1.为什么使用断路器?
  • 1.2.断路器两大常用组件 Sentinel 和 Hystrix 对比
• 二、sentinel 主要特性
• 三、sentinel 两个部分、三步骤
• • 3.1.两部分
  • 3.2.三步骤
• 四、使用核心库（如果已经引入了 springcloudalibabajar 不需要单独选择版本，只需直接引用）
• 五、使用控制台
• 六、控制台各功能详情
• • 6.1.流控规则
  • 6.2.降级规则
  • 6.3.热点规则
  • 6.4.系统规则
  • 6.5.授权规则
• 七、sentinel 规则管理及三种模式
• • 7.1.结合 nacos 使用 push 模式实现 sentinel 流控规则持久化
  • 7.2.测试下
  • 7.3.结合 nacos 使用 push 模式改造其他规则持久化
  • 7.4.全部修改完成后需要在 pom.xml 中增加

项目结构

一、断路器

1.1.为什么使用断路器?

在微服务架构中，我们将系统拆分成了很多服务单元，各单元的应用间通过服务注册
与订阅的方式互相依赖。由于每个单元都在不同的进程中运行，依赖通过远程调用的方式
执行，这样就有可能因为网络原因或是依赖服务自身间题出现调用故障或延迟，而这些问
题会直接导致调用方的对外服务也出现延迟，若此时调用方的请求不断增加，最后就会因
等待出现故障的依赖方响应形成任务积压，最终导致自身服务的瘫痪。为了解决这样的问题，
产生了断路器等一系列的服务保护机制。

1.2.断路器两大常用组件 Sentinel 和 Hystrix 对比

二、sentinel 主要特性

三、sentinel 两个部分、三步骤

3.1.两部分

a) 核心库（Java 客户端）不依赖任何框架/库，能够运行于所有 Java 运行时环境，
同时对 Dubbo / Spring Cloud 等框架也有较好的支持。
b) 控制台（Dashboard）基于 Spring Boot 开发，打包后可以直接运行，不需要额外
的 Tomcat 等应用容器。

3.2.三步骤

a) 定义资源
b) 定义规则
c) 检验规则是否生效

四、使用核心库（如果已经引入了 springcloudalibabajar 不需要单独选择版本，只需直接引用）

项目中引入核心库

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

a) 定义资源：定义资源提供三种方式：1、使用@SentinelResource 注解提供使用 AspectJ
拓展用于自动定义资源 2、Sphu（抛出异常）3、Spho（返回布尔类值）
i. 使用注解并开启对应切面需要引入 SentinelResourceAspect

1.引入依赖

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

如果使用原生 spring 需要通过配置将 sentinelAspectConfiguration 注册为一个 springbean。如
果使用 springcloudalibaba 则不需要

@Configuration
public class SentinelAspectConfiguration {

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

查看 SentinelResourceAspect 方法

可以看到 SentinelResourceAspect 使用 aspect 的 around 拦截，拦截标注有 SentinelResource
的注解，进入方法之前调用 SphU.entry(resourceName, entryType)，结束之后调用 entry.exit()；
底层和另外两种方式是一样的

2.需要定义资源的地方使用@SentinelResource 注解并定义一个资源名

@SentinelResource 属性值

3.使用 Sphu（作用方式是抛出异常）

try (Entry entry = SphU.entry ("resourceName")) {
	// 被保护的业务逻辑
	// do something here...
	} catch (BlockException ex) {
	// 资源访问阻止，被限流或被降级
	// 在此处进行相应的处理操作
}

4.使用 Spho（作用方式是返回布尔类型的值）

// 资源名可使用任意有业务语义的字符串
if (SphO.entry ("自定义资源名")) {
	// 务必保证 finally 会被执行
	try {
	/**
		* 被保护的业务逻辑
	*/
	} finally {
		SphO.exit();
	}
} else {
	//资源访问阻止，被限流或被降级
	//进行相应的处理操作
}

5.定义规则 （使规则生效可以使用@PostConstruct 注解）

1.流量控制参数说明

private static void initFlowQpsRule() {
	List<FlowRule> rules = new ArrayList<>();
	FlowRule rule1 = new FlowRule();
	rule1.setResource("资源名");
	// set limit qps to 2
	rule1.setCount(2);
	rule1.setGrade(RuleConstant. FLOW_GRADE_QPS );
	rule1.setLimitApp("default");
	rules.add(rule1);
	FlowRuleManager.loadRules(rules);
}

2.熔断降级规则参数说明

private static void initDegradeRule() {
	List<DegradeRule> rules = new ArrayList<>();
	DegradeRule rule = new DegradeRule();
	rule.setResource("资源名");
	// set threshold rt, 10 ms
	rule.setCount(10);
	rule.setGrade(RuleConstant. DEGRADE_GRADE_RT );
	rule.setTimeWindow(10);
	rules.add(rule);
	DegradeRuleManager.loadRules(rules);
}

3.热点规则参数说明

private static void initParamFlowRule() {
	ParamFlowRule rule = new ParamFlowRule( “资源名” );
	rule.setParamIdx(0);
	rule.setCount(5);
	ParamFlowItem item = new ParamFlowItem();
	// 针对 int 类型的参数 PARAM_B，单独设置限流 QPS 阈值为 10，而不是全局的阈值 5.
	item.setObject(String. valueOf (10));
	item.setClassType(int.class.getName());
	item.setCount(10);
	rule.setParamFlowItemList(Collections. singletonList (item));
	ParamFlowRuleManager. loadRules (Collections.singletonList (rule));
}

4.系统保护规则参数说明

private void initSystemProtectionRule() {
	List<SystemRule> rules = new ArrayList<>();
	SystemRule rule = new SystemRule();
	rule.setHighestSystemLoad(10);
	rules.add(rule);
	SystemRuleManager.loadRules(rules);
}

5.授权规则参数说明

public void initAuthorityRule() {
	AuthorityRule authorityRule = new AuthorityRule();
	authorityRule.setResource("资源名");
	authorityRule.setStrategy(RuleConstant.AUTHORITY_WHITE );
	authorityRule.setLimitApp("白名单应用");
	AuthorityRuleManager.loadRules (Collections.singletonList(authorityRule));
}

6.检验规则是否生效

i. 接口其他接口可以查看 https://blog.csdn.net/tsuiearl/article/details/116492167
http://IP:对外通信端口/getRules?type={} 支持 4 种类型：flow、degrade、authority、system
ii. 实际操作测试

五、使用控制台

a) 从 github 上 https://github.com/alibaba/Sentinel/releases 下载 jar 包
b) 可以通过 jvm 配置参数启动 jar。java -Dserver.port=8849

-Dcsp.sentinel.dashboard.server=localhost:8849 -Dproject.name=sentinel-dashboard
-jar sentinel-dashboard.jar

默认账号密码均为 sentinel

1.实时监控：实时查看各个资源的 QPS

2.簇点链路：查看 http 请求

3.流控规则：控制 QPS、线程等

4.降级规则：服务降级

5.热点规则：经常访问的数据,很多时候我们希望统计某个热点数据中访问频次
最高的 Top K 数据,并对其访问进行限制,热点参数限流可以看做是一种特殊的
流量控制,仅对包含热点参数的资源调用生效

6.系统规则：系统规则自然对应所有入口的 rest 请求做处理，整体管控

7.授权规则：设置白名单及黑名单，来源访问控制

8. 集群流控：以上配置均为单机应用，假如你的应用有多个实例，那么你设置了
限流的规则之后，每一台应用的实例都会生效相同的流控规则

9.机器列表：链接到 sentinel 控制台的机器

六、控制台各功能详情

6.1.流控规则

1.简介
根据 QPS、线程控制资源

2.新增流控规则

3.参数

4.场景例子

每秒支持两次访问

6.2.降级规则

1.简介

Sentinel 熔断降级会在调用链路中某个资源出现不稳定状态时,例如调用超时
或异常比例升高,对这个资源的调用进行限制,让请求快速失败,避免影响到其他的
资源而导致级联错误
当资源被降级后,在接下来的降级时间窗口之内,对该资源的调用都自动熔断(默认
抛出 DegradeException)

2.新增慢调用比例降级规则

3.参数

4.场景例子

如图所示设置规则开启后，在统计时长 1 秒内，当请求数目大于 10，并且慢调用
的比例大于 80%的时候，则在接下来 5 秒的熔断时长内，请求都会快速失败。经过
5 秒后熔断器会进入探测恢复状态，若接下来的一个请求响应时间小于设置的 1000
ms 则结束熔断，若大于 1000 ms 则会再次被熔断。

5.新增异常比例降级规则

参数

场景例子:

规则开启后，在统计时长 1 秒内，当请求数目大于 10，并且异常的比例大于等于
80%的时候，则在接下来 5 秒的熔断时长内，请求都会快速失败。经过 5 秒后熔断
器会进入探测恢复状态，若接下来的一个请求没有异常则结束熔断，否则会再次熔
断

6.新增异常数降级规则

参数:

场景例子:

规则开启后，在统计时长 1 秒内，当请求数目大于 10，并且异常的数量大于等于 5
的时候，则在接下来 5 秒的熔断时长内，请求都会快速失败。经过 5 秒后熔断器会
进入探测恢复状态，若接下来的一个请求没有异常则结束熔断，否则会再次熔断

6.3.热点规则

1.简介
热点就是经常访问的数据，根据请求的参数来做限流，比如请求带的参数是热点参数，就对这个请求应用特殊的限流规则；对携带非热点参数的请求，走另一个限流规则

2.新增热点规则

场景例子:

规则开启后，在统计时长 1 秒内，如果传递参数为 2 则以 20 作为阈值，若不传递
参数则以 2 作为阈值

6.4.系统规则

1.简介
系统保护规则是从应用级别的入口流量进行控制，从单台机器的 load、CPU 使用率、平均 RT、入口 QPS 和并发线程数等几个维度监控应用指标，让系统尽可能跑在最大吞吐量的同时保证系统整体的稳定性。可以理解为系统规则是全局的限流配置，可以针对服务的全局 QPS、机器的 CPU 等参数进行限流

2.新增系统规则

场景例子:
当 CPU 的使用率大于 70%，就停止新的请求

6.5.授权规则

1.简介
当我们需要根据调用来源来判断该次请求是否允许放行，这时候可以使用Sentinel 的来源控制功能。表示控制功能基于请求标识信息，只要 Sentinel 保护的接口资源被访问，Sentinel 就会调用 RequestOriginParser 的实现类去解析调用者标识。若配置白名单，则只有请求来源位于白名单内时才可通过，若配置黑名单，则请求来源位于黑名单时不允许通过，其余的请求来源可以通过

2.访问控制的功能，加上相应的授权规则。新增

场景例子:

资源名为 getTest 的资源仅有服务叫 demo 的可以调用

代码配置:

@Component
public class RequestOriginParserDefinition implements RequestOriginParser {
	//基于 Spring 的 Interceptor 拦截资源
	// 获取调用方标识信息并返回
	@Override
	public String parseOrigin(HttpServletRequest request) {
		String serviceName = request.getParameter("serviceName");
		if (StringUtils.isEmpty(serviceName)) {
		throw new IllegalArgumentException("serviceName must not be null");
	}
	return serviceName;
	}
}

七、sentinel 规则管理及三种模式

7.1.结合 nacos 使用 push 模式实现 sentinel 流控规则持久化

1.推送规则：

i. 控制台增加的规则推送到 nacos
ii. sentinel 链接 nacos 客户端，获取规则配置。并监听 Nacos 配置变化，如发生
变化，更新本地缓存（从而让本地缓存和 Nacos 一致）

2.下载 sentinel 源码，对源码进行改造
i. (需要源码联系博主即可)

1). sentinel-core：Sentinel 核心模块，实现限流、熔断等基本能力。
2). sentinel-dashboard：Sentinel 可视化控制台，提供基本的管理界面，配置
限流、熔断规则等，展示监控数据等。
3). sentinel-adapter：Sentinel 适配，Sentinel-core 模块提供的是限流等基本
API，主要是提供给应用自己去显示调用，对代码有侵入性，故该模块对
主流框架进行了适配，目前已适配的模块：
a) sentinel-apache-dubbo-adapter：对 Apache Dubbo 版本进行适配，这样
应用只需引入 sentinel-apache-dubbo-adapter 包即可对 dubbo 服务进行流控
与熔断，大家可以思考会利用 Dubbo 的哪个功能特性。
b)sentinel-dubbo-adapter：对 Alibaba Dubbo 版本进行适配。
c)sentinel-grpc-adapter：对 GRPC 进行适配。
d)sentinel-spring-webflux-adapter：对响应式编程框架 webflux 进行适配。
e)sentinel-web-servlet：对 servlet 进行适配，例如 Spring MVC。
f)sentinel-zuul-adapter：对 zuul 网关进行适配。
4). sentinel-cluster：提供集群模式的限流与熔断支持，因为通常一个应用会
部署在多台机器上组成应用集群。
5). sentinel-transport：网络通讯模块，提供 Sentinel 节点与
sentinel-dashboard 的通讯支持，主要有如下两种实现。
a)sentinel-transport-netty-http：基于 Netty 实现的 http 通讯模式。
b)sentinel-transport-simple-http：简单的 http 实现方式。
6). sentinel-extension：Sentinel 扩展模式。主要提供了如下扩展(高级)功能：
a)sentinel-annotation-aspectj：提供基于注解的方式来定义资源等。
b)sentinel-parameter-flow-control：提供基于参数的限流(热点限流)。
c)sentinel-datasource-extension：限流规则、熔断规则的存储实现，默认是
存储在内存中。
d)sentinel-datasource-apollo：基于 apollo 配置中心实现限流规则、熔断
规则的存储，动态推送生效机制。
e)sentinel-datasource-consul：基于 consul 实现限流规则、熔断规则的存
储，动态推送生效机制。
f)sentinel-datasource-etcd：基于 etcd 实现限流规则、熔断规则的存储，
动态推送生效机制。
g)sentinel-datasource-nacos：基于 nacos 实现限流规则、熔断规则的存储，
动态推送生效机制。
h)entinel-datasource-redis：基于 redis 实现限流规则、熔断规则的存储，
动态推送生效机制。
i)sentinel-datasource-spring-cloud-config：基于 spring-cloud-config 实现限
流规则、熔断规则的存储，动态推送生效机制。
j)sentinel-datasource-zookeeper：基于 zookeeper 实现限流规则、熔断规
则的存储，动态推送生效机制。

3.改造 sentinel 中 sentinel-dashboard 模块 打开 pom 去掉中 nacos 的 test 注解

拓展 maven scope 标签
a) compile：默认的 scope，运行期有效，需要打入包中
b) provided：编译期有效，运行期不需要提供，不会打入包中
c) runtime：编译不需要，在运行期有效，需要导入包中。（接口与实
现分离）
d) test：测试需要，不会打入包中
e) system：非本地仓库引入、存在系统的某个路径下的 jar

4.把 src/test/java/com/alibaba/csp/sentinel/dashboard/rule/nacos 文件夹拷贝到
src/main/java/com/alibaba/csp/sentinel/dashboard/rule 目录下：

5.修改改模块下的 application.properties,根据实际需要修改 address、namespace。需要注意 GROUPID 默认值是 SENTINEL_GROUP，在 nacos 新建规则时候需要注意

6.修改 nacosconfig 文件，使得 nacos 链接可以通过配置文件实现

7.修改流控制器 FlowControllerV2 注入

注入的两个 bean：
flowRuleNacosProvider：就是实现 Nacos 的限流规则配置拉取。
flowRuleNacosPublisher：实现 Nacos 的配置推送

进入 flowruleNacosPublisher 默认的 GROUP_ID 为

8.打开 src/main/webapp/resources/app/scripts/directives/sidebar/sidebar.html，找
到 dashboard.flowV1({app: entry.app})修改为 dashboard.flow({app: entry.app})。

9. 打开 src/main/webapp/resources/app/scripts/controllers/identity.js，把
FlowServiceV1 改为 FlowServiceV2。

上述已经完成所有的配置操作

7.2.测试下

1.启动 DashboardApplication 模块进行测试默认端口为 8080，首先打开 nacos 中
sentinel 的 spacename 可以看到目前配置为空

2.项目 pom.xml 中新增相关依赖

<!-- sentinel 流量控制 -->
<dependency>
	<groupId>com.alibaba.cloud</groupId>
	<artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
</dependency>
<dependency>
	<groupId>com.alibaba.csp</groupId>
	<artifactId>sentinel-datasource-nacos</artifactId>
</dependency>

配置文件中增加

访问测试接口。为 getTest 新增一条流控规则

3.打开 nacos 可以看到命名空间内新增了一条配置，查看详情与 sentinel 的配置
相同

7.3.结合 nacos 使用 push 模式改造其他规则持久化

1.新增降级规则、热点规则、授权规则、系统规则的配置后缀以作区分

2.添加规则推送类

3.nacosConfig 中添加规则转化类

@Bean
public Converter<List<DegradeRuleEntity>, String> degradeRuleEntityEncoder() {
	return JSON::toJSONString ;
}
@Bean
public Converter<String, List<DegradeRuleEntity>> degradeRuleEntityDecoder() {
	return s -> JSON.parseArray(s, DegradeRuleEntity.class);
}
@Bean
public Converter<List<SystemRuleEntity>, String> systemRuleEntityEncoder() {
	return JSON:: toJSONString ;
}
@Bean
public Converter<String, List<SystemRuleEntity>> systemRuleEntityDecoder() {
	return s -> JSON. parseArray (s, SystemRuleEntity.class);
}
@Bean
public Converter<List<AuthorityRuleEntity>, String> authorityRuleEntityEncoder() {
	return JSON:: toJSONString ;
}
@Bean
public Converter<String, List<AuthorityRuleEntity>> authorityRuleEntityDecoder() {
	return s -> JSON.parseArray(s, AuthorityRuleEntity.class);
}
@Bean
public Converter<List<ParamFlowRuleEntity>, String> paramFlowRuleEntityEncoder() {
	return JSON::toJSONString ;
}
@Bean
public Converter<String, List<ParamFlowRuleEntity>> paramFlowRuleEntityDecoder() {
	return s -> JSON.parseArray(s, ParamFlowRuleEntity.class);
}

4.参照 FlowControllerV2 修改对应的降级规则、热点规则、授权规则、系统规则的控制器增加对 nacos 的推送支持
5.应用配置文件中增加相关配置

7.4.全部修改完成后需要在 pom.xml 中增加

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-surefire-plugin</artifactId>
	<version>2.22.1</version>
	<configuration>
		<skipTests>true</skipTests>
	</configuration>
</plugin>

跳过对 test 的打包运行 mvn clean package 打成一个 fat jar 启动 jar 包 sentinel 提供了 jvm 启动参数

补充：
配置内容说明：
resource：接口名，即限流规则的作用对象
limitApp：流控针对的调用来源，若为 default 则不区分调用来源
grade：限流阈值类型（QPS 或并发线程数）；0 代表根据并发数量来限流，1 代表根据 QPS
来进行流量控制
count：限流阈值
strategy：调用关系限流策略
controlBehavior：流量控制效果（直接拒绝、Warm Up、匀速排队）
clusterMode：是否为集群模式

这篇关于三万字详解SpringClould高可用流量防护组件Sentinel哨兵（含源码例子）的文章就介绍到这儿，希望我们推荐的文章对大家有所帮助，也希望大家多多支持为之网！