Nacos存储限流规则
sentinel自身就支持了多种不同的数据源来持久化规则配置,目前包括以下几种方式:
文件
nacos
zookeeper
apollo
本文将使用Spring Cloud Alibaba的中整合的配置中心
Nacos
存储限流规则。
下面我们将同时使用到
Nacos
和
Sentinel Dashboard
,所以可以先把
Nacos
和
Sentinel Dashboard
启动起来。
默认配置下启动后,它们的访问地址(后续会用到)为:
- Nacos:http://localhost:8848/
- Sentinel Dashboard:http://localhost:8080/
应用配置
第一步:在Spring Cloud应用的
pom.xml
中引入Spring Cloud Alibaba的Sentinel模块和Nacos存储扩展:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
</dependency>
<dependency>
<groupId>com.alibaba.csp</groupId>
<artifactId>sentinel-datasource-nacos</artifactId>
<!--<scope>test</scope>-->
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Finchley.SR1</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-alibaba-dependencies</artifactId>
<version>0.2.2.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
第二步:在Spring Cloud应用中添加配置信息:
server.port=8001
# sentinel dashboard
spring.cloud.sentinel.transport.dashboard=localhost:8080
spring.application.name=sentinle-client
spring.cloud.sentinel.datasource.ds.nacos.server-addr=192.168.5.83
spring.cloud.sentinel.datasource.ds.nacos.dataId=${spring.application.name}-sentinel
spring.cloud.sentinel.datasource.ds.nacos.groupId=DEFAULT_GROUP
spring.cloud.sentinel.datasource.ds.nacos.ruleType=flow
-
:sentinel dashboard的访问地址,根据上面准备工作中启动的实例配置spring.cloud.sentinel.transport.dashboard
-
:nacos的访问地址,,根据上面准备工作中启动的实例配置spring.cloud.sentinel.datasource.ds.nacos.server-addr
-
:nacos中存储规则的groupIdspring.cloud.sentinel.datasource.ds.nacos.groupId
-
:nacos中存储规则的dataIdspring.cloud.sentinel.datasource.ds.nacos.dataId
-
:该参数是spring cloud alibaba升级到0.2.2之后增加的配置,用来定义存储的规则类型。所有的规则类型可查看枚举类:spring.cloud.sentinel.datasource.ds.nacos.rule-type
,每种规则的定义格式可以通过各枚举值中定义的规则对象来查看,比如限流规则可查看:org.springframework.cloud.alibaba.sentinel.datasource.RuleType
com.alibaba.csp.sentinel.slots.block.flow.FlowRule
这里对于dataId使用了
${spring.application.name}
变量,这样可以根据应用名来区分不同的规则配置。
注意:由于版本迭代关系,Github Wiki中的文档信息不一定适用所有版本。比如:在这里适用的0.2.1版本中,并没有
spring.cloud.sentinel.datasource.ds2.nacos.rule-type
这个参数。所以,读者在使用的时候,可以通过查看
org.springframework.cloud.alibaba.sentinel.datasource.config.DataSourcePropertiesConfiguration
和
org.springframework.cloud.alibaba.sentinel.datasource.config.NacosDataSourceProperties
两个类来分析具体的配置内容,会更为准确。
比如,
Nacos
存储的具体配置类源码如下:
public class NacosDataSourceProperties extends AbstractDataSourceProperties {
private String serverAddr;
private String groupId;
private String dataId;
// commercialized usage
private String endpoint;
private String namespace;
private String accessKey;
private String secretKey;
}
第三步:创建应用主类,并提供一个rest接口,比如:
@RestController
@SpringBootApplication
public class Client1Application {
public static void main(String[] args) {
SpringApplication.run(Client1Application.class, args);
}
@GetMapping("/test")
public String test(){
return "test";
}
}
第四步:Nacos中创建限流规则的配置,比如:
其中:
Data ID
、
Group
就是上面第二步中配置的内容。配置格式选择JSON,并在配置内容中填入下面的内容:
sentinle-client-sentinel
DEFAULT_GROUP
[{"clusterMode":false,"controlBehavior":0,"count":3.0,"grade":1,"limitApp":"default","resource":"/test","strategy":0}]
可以看到上面配置规则是一个数组类型,数组中的每个对象是针对每一个保护资源的配置对象,每个对象中的属性解释如下:
- resource:资源名,即限流规则的作用对象
- limitApp:流控针对的调用来源,若为 default 则不区分调用来源
- grade:限流阈值类型(QPS 或并发线程数); 代表根据并发数量来限流,
代表根据QPS来进行流量控制1
- count:限流阈值
- strategy:调用关系限流策略
- controlBehavior:流量控制效果(直接拒绝、Warm Up、匀速排队)
- clusterMode:是否为集群模式
第五步:启动应用。如果一些顺利,可以看到类似下面的日志,代表已经成功从Nacos加载了一条限流规则:
2019-10-14 18:12:42.077 INFO 7036 --- [ main] o.s.c.a.s.c.SentinelDataSourceHandler : [Sentinel Starter] DataSource ds-sentinel-nacos-datasource load 1 FlowRule
2019-10-14 18:12:42.155 INFO 7036 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8001 (http) with context path ''
2019-10-14 18:12:42.158 INFO 7036 --- [ main] c.l.sentinel.client1.Client1Application : Started Client1Application in 4.686 seconds (JVM running for 5.382)
通过postman或者curl访问几下
localhost:8001/test
接口就会看到效果啦