Alibaba Sentinel规则持久化-推模式-手把手教程【基于Nacos】

前面，已经为Sentinel实现了 基于拉模式的规则持久化 ，本文来实现基于 推模式的规则持久化。

一、推模式架构图

TIPS

图片来自官方。

引用自 https://github.com/alibaba/Sentinel/wiki/在生产环境中使用-Sentinel

二、原理简述

• 控制台推送规则：
  • 将规则推送到Nacos或其他远程配置中心
  • Sentinel客户端链接Nacos，获取规则配置；并监听Nacos配置变化，如发生变化，就更新本地缓存（从而让本地缓存总是和Nacos一致）
• 控制台监听Nacos配置变化，如发生变化就更新本地缓存（从而让控制台本地缓存总是和Nacos一致）

三、微服务改造

• 加依赖

  <dependency>
      <groupId>com.alibaba.csp</groupId>
      <artifactId>sentinel-datasource-nacos</artifactId>
  </dependency>
  

• 添加配置

  spring:
    cloud:
      sentinel:
        datasource:
          # 名称随意
          flow:
            nacos:
              server-addr: localhost:8848
              dataId: ${spring.application.name}-flow-rules
              groupId: SENTINEL_GROUP
              # 规则类型，取值见：
              # org.springframework.cloud.alibaba.sentinel.datasource.RuleType
              rule-type: flow
          degrade:
            nacos:
              server-addr: localhost:8848
              dataId: ${spring.application.name}-degrade-rules
              groupId: SENTINEL_GROUP
              rule-type: degrade
          system:
            nacos:
              server-addr: localhost:8848
              dataId: ${spring.application.name}-system-rules
              groupId: SENTINEL_GROUP
              rule-type: system
          authority:
            nacos:
              server-addr: localhost:8848
              dataId: ${spring.application.name}-authority-rules
              groupId: SENTINEL_GROUP
              rule-type: authority
          param-flow:
            nacos:
              server-addr: localhost:8848
              dataId: ${spring.application.name}-param-flow-rules
              groupId: SENTINEL_GROUP
              rule-type: param-flow
  

四、Sentinel控制台改造

控制台改造主要是为规则实现

• DynamicRuleProvider：从Nacos上读取配置
• DynamicRulePublisher：将规则推送到Nacos上

• 修改pom.xml，找到：

  <!-- for Nacos rule publisher sample -->
    <dependency>
      <groupId>com.alibaba.csp</groupId>
      <artifactId>sentinel-datasource-nacos</artifactId>
      <scope>test</scope>
    </dependency>
  

  将 <scope>test</scope> 这一行注释掉，即改为如下：

  <!-- for Nacos rule publisher sample -->
  <dependency>
    <groupId>com.alibaba.csp</groupId>
    <artifactId>sentinel-datasource-nacos</artifactId>
    <!--<scope>test</scope>-->
  </dependency>
  

• 找到 sentinel-dashboard/src/test/java/com/alibaba/csp/sentinel/dashboard/rule/nacos目录，将整个目录拷贝到 sentinel-dashboard/src/main/java/com/alibaba/csp/sentinel/dashboard/rule/nacos，如图：

  

• 修改 com.alibaba.csp.sentinel.dashboard.controller.v2.FlowControllerV2 ，找到

  @Autowired
  @Qualifier("flowRuleDefaultProvider")
  private DynamicRuleProvider<List<FlowRuleEntity>> ruleProvider;
  @Autowired
  @Qualifier("flowRuleDefaultPublisher")
  private DynamicRulePublisher<List<FlowRuleEntity>> rulePublisher;
  

  修改为：

  @Autowired
  @Qualifier("flowRuleNacosProvider")
  private DynamicRuleProvider<List<FlowRuleEntity>> ruleProvider;
  @Autowired
  @Qualifier("flowRuleNacosPublisher")
  private DynamicRulePublisher<List<FlowRuleEntity>> rulePublisher;
  

• 修改 sentinel-dashboard/src/main/webapp/resources/app/scripts/directives/sidebar/sidebar.html，找到：

  <!--<li ui-sref-active="active">-->
    <!--<a ui-sref="dashboard.flow({app: entry.app})">-->
      <!--<i class="glyphicon glyphicon-filter"></i>&nbsp;&nbsp;流控规则 V1</a>-->
  <!--</li>-->
  

  把注释解开，即改为：

  <li ui-sref-active="active">
    <a ui-sref="dashboard.flow({app: entry.app})">
      <i class="glyphicon glyphicon-filter"></i>&nbsp;&nbsp;流控规则 V1</a>
  </li>
  

  齐活儿啦！终于把流控规则改造成推模式持久化啦！

五、编译 & 启动

• 执行 mvn clean package -DskipTests
• 在项目的 target 目录找到sentinel-dashboard.jar ，执行 java -jar sentinel-dashboard.jar 启动控制台。

六、测试

• 测试1：用Sentinel控制台【菜单栏的 流控规则 V1 】推送流控规则，规则会存储到Nacos；
• 测试2：直接在Nacos上修改流控规则，然后刷新Sentinel控制台，控制台上的显示也会被修改；
• 测试3：重启Sentinel控制台，并重启微服务；刷新控制台，可以发现规则依然存在。

七、万里长征才进行了第一步…

以上，其实只实现了流控规则的持久化。Sentinel有若干种规则，例如降级规则、系统规则、授权规则、热点规则等，都需要使用类似的方式，修改 com.alibaba.csp.sentinel.dashboard.controller 包中对应的Controller，才能实现持久化。

八、懒人包

笔者已经基于Sentinel Dashboard 1.6.2做了修改，为如下规则提供了持久化：

• 流控规则
• 降级规则
• 系统规则
• 授权规则
• 参数热点规则

GitHub地址：https://github.com/eacdy/Sentinel-Dashboard-Nacos ，使用1.6.2-NACOS分支即可。

使用说明：https://github.com/eacdy/Sentinel-Dashboard-Nacos/releases

修改的文件：

九、推模式优缺点分析

• 优点
  • 规则持久化
  • 一致性好
  • 性能优秀
• 改动多、并且麻烦
• 引入额外的依赖（Nacos）

十、参考文档

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

十一、本文首发

http://www.itmuch.com/spring-cloud-alibaba/sentinel-rules-persistence-push-mode-using-nacos/