本文实现基于拉模式的 Alibaba Sentinel 规则持久化。

一、拉模式架构

Alibaba Sentinel 规则持久化-拉模式-基于文件 - 图1

TIPS 图片来自官方。 引用自 https://github.com/alibaba/Sentinel/wiki / 在生产环境中使用 - Sentinel

二、原理简述

  • FileRefreshableDataSource 定时从指定文件中读取规则 JSON 文件【图中的本地文件】，如果发现文件发生变化，就更新规则缓存。
  • FileWritableDataSource 接收控制台规则推送，并根据配置，修改规则 JSON 文件【图中的本地文件】。

三、编写

修改 Spring Cloud Alibaba 微服务。

3.1 加依赖

  1. <dependency>
  2.   <groupId>com.alibaba.csp</groupId>
  3.   <artifactId>sentinel-datasource-extension</artifactId>
  4. </dependency>

3.2 写代码

  1. /**
  2.  * 拉模式规则持久化
  3.  *
  4.  * @author itmuch.com
  5.  */
  6. public class FileDataSourceInit implements InitFunc {
  7.     @Override
  8.     public void init() throws Exception {
  9.         // TIPS: 如果你对这个路径不喜欢，可修改为你喜欢的路径
  10.         String ruleDir = System.getProperty("user.home") + "/sentinel/rules";
  11.         String flowRulePath = ruleDir + "/flow-rule.json";
  12.         String degradeRulePath = ruleDir + "/degrade-rule.json";
  13.         String systemRulePath = ruleDir + "/system-rule.json";
  14.         String authorityRulePath = ruleDir + "/authority-rule.json";
  15.         String paramFlowRulePath = ruleDir + "/param-flow-rule.json";
  17.         this.mkdirIfNotExits(ruleDir);
  18.         this.createFileIfNotExits(flowRulePath);
  19.         this.createFileIfNotExits(degradeRulePath);
  20.         this.createFileIfNotExits(systemRulePath);
  21.         this.createFileIfNotExits(authorityRulePath);
  22.         this.createFileIfNotExits(paramFlowRulePath);
  24.         // 流控规则
  25.         ReadableDataSource<String, List<FlowRule>> flowRuleRDS = new FileRefreshableDataSource<>(
  26.             flowRulePath,
  27.             flowRuleListParser
  28.         );
  29.         // 将可读数据源注册至FlowRuleManager
  30.         // 这样当规则文件发生变化时，就会更新规则到内存
  31.         FlowRuleManager.register2Property(flowRuleRDS.getProperty());
  32.         WritableDataSource<List<FlowRule>> flowRuleWDS = new FileWritableDataSource<>(
  33.             flowRulePath,
  34.             this::encodeJson
  35.         );
  36.         // 将可写数据源注册至transport模块的WritableDataSourceRegistry中
  37.         // 这样收到控制台推送的规则时，Sentinel会先更新到内存，然后将规则写入到文件中
  38.         WritableDataSourceRegistry.registerFlowDataSource(flowRuleWDS);
  40.         // 降级规则
  41.         ReadableDataSource<String, List<DegradeRule>> degradeRuleRDS = new FileRefreshableDataSource<>(
  42.             degradeRulePath,
  43.             degradeRuleListParser
  44.         );
  45.         DegradeRuleManager.register2Property(degradeRuleRDS.getProperty());
  46.         WritableDataSource<List<DegradeRule>> degradeRuleWDS = new FileWritableDataSource<>(
  47.             degradeRulePath,
  48.             this::encodeJson
  49.         );
  50.         WritableDataSourceRegistry.registerDegradeDataSource(degradeRuleWDS);
  52.         // 系统规则
  53.         ReadableDataSource<String, List<SystemRule>> systemRuleRDS = new FileRefreshableDataSource<>(
  54.             systemRulePath,
  55.             systemRuleListParser
  56.         );
  57.         SystemRuleManager.register2Property(systemRuleRDS.getProperty());
  58.         WritableDataSource<List<SystemRule>> systemRuleWDS = new FileWritableDataSource<>(
  59.             systemRulePath,
  60.             this::encodeJson
  61.         );
  62.         WritableDataSourceRegistry.registerSystemDataSource(systemRuleWDS);
  64.         // 授权规则
  65.         ReadableDataSource<String, List<AuthorityRule>> authorityRuleRDS = new FileRefreshableDataSource<>(
  66.             authorityRulePath,
  67.             authorityRuleListParser
  68.         );
  69.         AuthorityRuleManager.register2Property(authorityRuleRDS.getProperty());
  70.         WritableDataSource<List<AuthorityRule>> authorityRuleWDS = new FileWritableDataSource<>(
  71.             authorityRulePath,
  72.             this::encodeJson
  73.         );
  74.         WritableDataSourceRegistry.registerAuthorityDataSource(authorityRuleWDS);
  76.         // 热点参数规则
  77.         ReadableDataSource<String, List<ParamFlowRule>> paramFlowRuleRDS = new FileRefreshableDataSource<>(
  78.             paramFlowRulePath,
  79.             paramFlowRuleListParser
  80.         );
  81.         ParamFlowRuleManager.register2Property(paramFlowRuleRDS.getProperty());
  82.         WritableDataSource<List<ParamFlowRule>> paramFlowRuleWDS = new FileWritableDataSource<>(
  83.             paramFlowRulePath,
  84.             this::encodeJson
  85.         );
  86.         ModifyParamFlowRulesCommandHandler.setWritableDataSource(paramFlowRuleWDS);
  87.     }
  89.     private Converter<String, List<FlowRule>> flowRuleListParser = source -> JSON.parseObject(
  90.         source,
  91.         new TypeReference<List<FlowRule>>() {
  92.         }
  93.     );
  94.     private Converter<String, List<DegradeRule>> degradeRuleListParser = source -> JSON.parseObject(
  95.         source,
  96.         new TypeReference<List<DegradeRule>>() {
  97.         }
  98.     );
  99.     private Converter<String, List<SystemRule>> systemRuleListParser = source -> JSON.parseObject(
  100.         source,
  101.         new TypeReference<List<SystemRule>>() {
  102.         }
  103.     );
  105.     private Converter<String, List<AuthorityRule>> authorityRuleListParser = source -> JSON.parseObject(
  106.         source,
  107.         new TypeReference<List<AuthorityRule>>() {
  108.         }
  109.     );
  111.     private Converter<String, List<ParamFlowRule>> paramFlowRuleListParser = source -> JSON.parseObject(
  112.         source,
  113.         new TypeReference<List<ParamFlowRule>>() {
  114.         }
  115.     );
  117.     private void mkdirIfNotExits(String filePath) throws IOException {
  118.         File file = new File(filePath);
  119.         if (!file.exists()) {
  120.             file.mkdirs();
  121.         }
  122.     }
  124.     private void createFileIfNotExits(String filePath) throws IOException {
  125.         File file = new File(filePath);
  126.         if (!file.exists()) {
  127.             file.createNewFile();
  128.         }
  129.     }
  131.     private <T> String encodeJson(T t) {
  132.         return JSON.toJSONString(t);
  133.     }
  134. }

3.3 配置

在项目的 resources/META-INF/services 目录下创建文件，名为 com.alibaba.csp.sentinel.init.InitFunc ，内容为：

  1. # 改成上面FileDataSourceInit的包名类名全路径即可。
  2. com.itmuch.contentcenter.FileDataSourceInit

四、优缺点分析

  • 优点
    • 简单易懂
    • 没有多余依赖（比如配置中心、缓存等）
  • 缺点
    • 由于规则是用 FileRefreshableDataSource 定时更新的，所以规则更新会有延迟。如果 FileRefreshableDataSource 定时时间过大，可能长时间延迟；如果 FileRefreshableDataSource 过小，又会影响性能；
    • 规则存储在本地文件，如果有一天需要迁移微服务，那么需要把规则文件一起迁移，否则规则会丢失。

五、你可能会有的疑问

Spring Cloud Alibaba 不是提供了如下配置了吗？为什么要全部自己写呢？

  1. spring.cloud.sentinel.datasource.ds1.file.file=classpath: degraderule.json
  2. spring.cloud.sentinel.datasource.ds1.file.rule-type=flow
  4. #spring.cloud.sentinel.datasource.ds1.file.file=classpath: flowrule.json
  5. #spring.cloud.sentinel.datasource.ds1.file.data-type=custom
  6. #spring.cloud.sentinel.datasource.ds1.file.converter-class=com.alibaba.cloud.examples.JsonFlowRuleListConverter
  7. #spring.cloud.sentinel.datasource.ds1.file.rule-type=flow

关于这个问题，可以看我提的 Issue：https://github.com/alibaba/spring-cloud-alibaba/issues/756

六、参考文档

https://github.com/alibaba/Sentinel/wiki / 在生产环境中使用 - Sentinel#pull 模式

来源丨Alibaba Sentinel 规则持久化 - 拉模式 - 手把手教程【基于文件】
作者丨周立