27.|27. Spring Cloud Alibaba之服务容错组件 - Sentinel存储规则

通过之前的介绍,大家对Sentinel已经有了初步认识。在Spring Cloud Alibaba的整合封装下,接口限流这件事非常轻易的应用到我们的Spring Cloud应用中。但是这依然不能完美满足我们的日常生产需求。其中,非常重要的一点就是限流规则持久化的问题。默认情况下Dashboard中设置的限流规则在应用重启之后就会丢失。那么,接下来我们就Sentinel的规则持久化问题加以实现。
限流规则的持久化方式 Sentinel自身就支持了多种不同的数据源来持久化规则配置,目前包括以下几种方式:

  • 文件配置
  • Nacos配置
  • Zookeeper配置
  • Apollo配置
这里我们只针对 Nacos配置 和 Apollo配置做讲解,其它有兴趣的可以自行实现。
使用Nacos存储限流规则 【27.|27. Spring Cloud Alibaba之服务容错组件 - Sentinel存储规则】由于我们要使用到 Nacos 和 Sentinal Dashboard ,所以我们提前把这两个应用启动。
默认配置启动后,访问地址为:
  • Nacos: http://localhost:8848/
  • Sentinel Dashboard: http://localhost:8080/
详细配置参考之前文章。
应用配置 第一步:新建 Spring Cloud 应用alibaba-sentinel-datasource-nacos,在pom.xml中引入 Spring Cloud Alibaba的Sentinel和Nacos模块依赖:
org.springframework.boot spring-boot-starter-web org.springframework.cloud spring-cloud-starter-alibaba-sentinel com.alibaba.csp sentinel-datasource-nacos 1.5.2

第二步:在 application.properties 文件中添加配置:
spring.application.name=alibaba-sentinel-datasource-nacos server.port=8004# sentinel dashboard spring.cloud.sentinel.transport.dashboard=localhost:8080# sentinel datasource nacos :http://blog.didispace.com/spring-cloud-alibaba-sentinel-2-1/ spring.cloud.sentinel.datasource.ds.nacos.serverAddr=localhost:8848 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# nacos server spring.cloud.nacos.discovery.server-addr=localhost:8848

  • spring.cloud.sentinel.transport.dashboard:sentinel dashboard 的访问地址,和上面启动实例地址一致
  • spring.cloud.sentinel.datasource.ds.nacos.serverAddr:nacos的访问地址,和上面启动实例地址一致
  • spring.cloud.sentinel.datasource.ds.nacos.groupId :nacos中存储规则的groupId
  • spring.cloud.sentinel.datasource.ds.nacos.dataId:nacos中存储规则的dataId
  • spring.cloud.sentinel.datasource.ds.nacos.rule-type:该参数是 Spring Cloud Alibaba 升级到0.2.2之后增加的配置,用来定义存储规则类型。所有规则类型可以查看枚举类: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.DataSourcePropertiesConfigurationorg.springframework.cloud.alibaba.sentinel.datasource.config.NacosDataSourceProperties两个类来分析具体的配置内容,会更为准确。
比如: Nacos存储的具体配置类源码如下:
public class NacosDataSourceProperties extends AbstractDataSourceProperties {private String serverAddr; private String groupId; private String dataId; // commercialized usageprivate String endpoint; private String namespace; private String accessKey; private String secretKey; }

上面使用我们使用了前三个属性,后四个属性是阿里云的商业化产品使用的,这里就不介绍了。
第三步:创建应用主类和Rest服务接口:
@SpringBootApplication public class SentinelDatasourceNacosApplication { public static void main(String[] args) { SpringApplication.run(SentinelDatasourceNacosApplication.class, args); } }

@RestController public class TestController {@GetMapping("/hello") public String hello() { return "hello world"; } }

第四步:Nacos中创建限流规则的配置:
27.|27. Spring Cloud Alibaba之服务容错组件 - Sentinel存储规则
文章图片
image 其中,Data ID 、Group 就是上面第二步中配置的内容。配置格式选择 JSON,并在配置内容中填写下面内容:
[ { "resource": "/hello", "limitApp": "default", "grade": 1, "count": 5, "strategy": 0, "controlBehavior": 0, "clusterMode": false } ]

可以看到上面配置规则是一个数组类型,数组中的每个对象是针对每一个包含资源的配置对象,每个对象中的属性解释如下:
  • resource:资源名,即限流规则的作用对象
  • limitApp::流控针对的调用来源,若为 default 则不用区分来源
  • grade:限流阈值类型(QPS或并发线程数),0 代表根据并发数量来限流 , 1 代表根据QPS来进行流量控制
  • count:限流阈值
  • strategy:调用关系限流策略
  • controlBehavior:流量控制效果(直接拒绝、Warm Up、匀速排队)
  • clusterMode: 是否为集群模式
    这里只是对配置做了简单的解释,以便于理解这里配置的作用。实际上这里还有非常多的可配置选项和规则,更复杂的配置后面我们会单独讲解。
第五步:启动应用,如果顺利,可以看到类似下面日志,代表已经从Nacos加载了一条限流规则:
2019-07-16 11:21:37.356INFO 8036 --- [main] o.s.c.a.s.c.SentinelDataSourceHandler: [Sentinel Starter] DataSource ds-sentinel-nacos-datasource load 1 FlowRule

第六步:通过postman或者curl访问几下localhost:8003/hello接口:
此时,在Sentinel Dashboard中就可以看到当前我们启动的alibaba-sentinel-datasource-nacos服务。点击左侧菜单中的流控规则,可以看到已经存在一条记录了,具体如下:
27.|27. Spring Cloud Alibaba之服务容错组件 - Sentinel存储规则
文章图片
image 这条记录就是上面我们在Nacos中配置的限流规则。
思考 在完成上面的整合后,对于接口流控规则的修改就可以存在两个地方:Sentinel控制台Nacos控制台
这个时候,需要注意当前版本的 Sentinel 控制台不具备同步修改 Nacos 配置的能力,而Nacos 由于可以通过客户端中使用 Listener 来实现自动更新。所以,在整合了Nacos做规则存储之后,需要知道在下面两个地方修改存在不同的效果:
  • Sentinel控制台修改规则: 仅存与服务的内存中,不会修改Nacos中的配置值,重启后恢复原来值。
  • Nacos控制台中修改的值:服务的内存中规则会更新,Nacos中持久化规则也会更新,重启后不会丢失。
参考资料
  • Sentinel官方文档:动态规则
链接:https://www.jianshu.com/p/5562023cb2e8

    推荐阅读