当前位置 博文首页 > 龚厂长的博客：Sentinel-新手从零开始搭建限流框架
本文基于sentinel-1.8.0版本
Sentinel 是面向分布式服务架构的流量控制组件，主要以流量为切入点，从限流、流量整形、熔断降级、系统负载保护、热点防护等多个维度来帮助开发者保障微服务的稳定性，其具有以下特征:
sentinel核心jar包不依赖任何框架/库，能够运行于Java 7及以上的版本的运行时环境。下面分四步运行起来一个sentinel。
sentinel的核心只依赖于sentinel-core，在pom文件里面配置如下依赖：
<dependency>
<groupId>com.alibaba.csp</groupId>
<artifactId>sentinel-core</artifactId>
<version>1.8.0</version>
</dependency>
在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();//关闭
}
}
}
}
定义好了资源，下面要定义保护规则，也就是当发生资源过载了或者请求量超过了阈值，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);
}
下面开始运行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 功能全集示例，不作为开箱即用的生产环境控制台。
运行控制台，不需要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。
登录进去之后看到如下页面：
控制台启动成功后，下面将第一小节写的代码接入到控制台。
在pom文件引入如下依赖：
<dependency>
<groupId>com.alibaba.csp</groupId>
<artifactId>sentinel-transport-simple-http</artifactId>
<version>1.8.0</version>
</dependency>
启动程序前，修改JVM参数 -Dcsp.sentinel.dashboard.server=localhost:8080 ，指定控制台地址和端口。
前两步完成后，我修改了程序加了延迟，保证请求都是成功的：
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
下面我们将第一小节的代码改造成使用注解方式。
首先是启动类，下面的例子使用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) {
