- 通过 API 直接修改 (loadRules)
- 通过DataSource适配不同数据源修改
通过 API 修改比较直观,可以通过以下三个 API 修改不同的规则:
上述 方法只接受内存态的规则对象,但更多时候规则存储在文件、数据库或者配置中心当中。DataSource
接口给我们提供了对接任意配置源的能力。相比直接通过 API 修改规则,实现 DataSource
接口是更加可靠的做法。我们推荐通过控制台设置规则后将规则推送到统一的规则中心,客户实现 DataSource
接口端监听规则中心实时获取变更。
拓展常见的实现方式有:
- 拉模式:客户端主动向某个规则管理中心定期轮询拉取规则,这个规则中心可以是 SQL、文件,甚至是 VCS 等。这样做的方式是简单,缺点是无法及时获取变更;
- 推模式:规则中心统一推送,客户端通过注册监听器的方式时刻监听变化,比如使用 、Zookeeper 等配置中心。这种方式有更好的实时性和一致性保证。
实现拉模式的数据源最简单的方式是继承 AutoRefreshDataSource
抽象类,然后实现 readSource()
方法,在该方法里从指定数据源读取字符串格式的配置数据。比如 。
推模式拓展
实现推模式的数据源最简单的方式是继承 抽象类,在其构造方法中添加监听器,并实现 从指定数据源读取字符串格式的配置数据。比如 基于 Nacos 的数据源。
注意: 要使客户端具备规则 API,需在客户端引入以下依赖:
- <groupId>com.alibaba.csp</groupId>
- <artifactId>sentienl-http-simple-transport</artifactId>
- <version>x.y.z</version>
- </dependency>
拉模式:使用文件配置规则
这个示例展示 Sentinel 是如何从文件获取规则信息的。 会周期性的读取文件以获取规则,当文件有更新时会及时发现,并将规则更新到内存中。使用时只需添加以下依赖:
- <dependency>
- <groupId>com.alibaba.csp</groupId>
- <artifactId>sentinel-datasource-extension</artifactId>
- <version>x.y.z</version>
- </dependency>
Nacos 是阿里中间件团队开源的服务发现和动态配置中心。Sentinel 针对 Nacos 作了适配,底层可以采用 Nacos 作为规则配置数据源。使用时只需添加以下依赖:
然后创建 NacosDataSource
并将其注册至对应的 RuleManager 上即可。比如:
- // remoteAddress 代表 Nacos 服务端的地址
- // groupId 和 dataId 对应 Nacos 中相应配置
- DataSource<String, List<FlowRule>> flowRuleDataSource = new NacosDataSource<>(remoteAddress, groupId, dataId,
- source -> JSON.parseObject(source, new TypeReference<List<FlowRule>>() {}));
详细示例可以参见 。
推模式:使用 ZooKeeper 配置规则
- <dependency>
- <groupId>com.alibaba.csp</groupId>
- <artifactId>sentinel-datasource-zookeeper</artifactId>
- <version>x.y.z</version>
- </dependency>
然后创建 ZookeeperDataSource
并将其注册至对应的 RuleManager 上即可。比如:
详细示例可以参见 。
Sentinel 针对 Apollo 作了相应适配,底层可以采用 Apollo 作为规则配置数据源。使用时只需添加以下依赖:
- <dependency>
- <groupId>com.alibaba.csp</groupId>
- <artifactId>sentinel-datasource-apollo</artifactId>
- <version>x.y.z</version>
- </dependency>
然后创建 并将其注册至对应的 RuleManager 上即可。比如:
- // namespaceName 对应 Apollo 的命名空间名称
- // ruleKey 对应规则存储的 key
- // defaultRules 对应连接不上 Apollo 时的默认规则
- FlowRuleManager.register2Property(flowRuleDataSource.getProperty());
详细示例可以参见 。