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

蔚落 2023-01-17 08:45 106阅读 0赞

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

### 文章目录 ###

*   *   *   *   *  一、推模式架构图
                 *  二、原理简述
                 *  三、微服务改造
                 *   *  3.1. 加依赖
                     *  3.2. 添加配置
                 *  四、Sentinel控制台改造
                 *  五、编译 & 启动
                 *  六、测试
                 *   *  测试1：
                     *  测试2：
                     *  测试3：
                 *  七、万里长征才进行了第一步…
                 *  八、懒人包
                 *  九、推模式优缺点分析
                 *  十、参考文档
                 *  十一、案例测试
                 *   *  11.1. 下载
                     *  11.2. 启动
                     *  11.3. 清空浏览器缓存
                     *  11.4. 访问口控制台
                     *  11.5. 接口请求
                     *  11.6. 登陆nacos
                     *  11.7. 添加降级规则
                     *  11.8. nacos查看降级规则
                     *  11.9. 内容中心和 Sentinel控制台服务关闭
                     *  11.10. 重新启动服务
                     *  11.11. 登陆Sentinel控制台查看降级规则

##### 一、推模式架构图 #####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70]

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

##### 二、原理简述 #####

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

##### 三、微服务改造 #####

###### 3.1. 加依赖 ######

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

###### 3.2. 添加配置 ######

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，找到：

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

将 test 这一行注释掉，即改为如下：

<dependency>
      <groupId>com.alibaba.csp</groupId>
      <artifactId>sentinel-datasource-nacos</artifactId>
      
    </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`，如图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 1]  
修改 `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`，找到：

把注释解开，即改为：

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

##### 五、编译 & 启动 #####

执行 `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][https_github.com_eacdy_Sentinel-Dashboard-Nacos] ，  
    使用1.6.2-NACOS分支即可。

使用说明：[https://github.com/eacdy/Sentinel-Dashboard-Nacos/releases][https_github.com_eacdy_Sentinel-Dashboard-Nacos_releases]

修改的文件：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 2]

##### 九、推模式优缺点分析 #####

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

##### 十、参考文档 #####

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

##### 十一、案例测试 #####

> 如果需要二次开发，请切换到使用1.6.2-NACOS分支下载源码开发即可

###### 11.1. 下载 ######

GitHub地址：[https://github.com/eacdy/Sentinel-Dashboard-Nacos/releases][https_github.com_eacdy_Sentinel-Dashboard-Nacos_releases]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 3]

###### 11.2. 启动 ######

java -jar sentinel-dashboard-1.6.2-NACOS.jar

###### 11.3. 清空浏览器缓存 ######

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 4]

###### 11.4. 访问口控制台 ######

[http://localhost:8080/][http_localhost_8080]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 5]

###### 11.5. 接口请求 ######

> Sentine控制台采用懒加载，因此，需要请求一下服务接口，后期可以修改懒加载策略关闭  
> ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 6]

###### 11.6. 登陆nacos ######

[http://localhost:8848/nacos][http_localhost_8848_nacos]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 7]

###### 11.7. 添加降级规则 ######

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 8]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 9]

###### 11.8. nacos查看降级规则 ######

刷新nacos，查看降级规则  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 10]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 11]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 12]

###### 11.9. 内容中心和 Sentinel控制台服务关闭 ######

略

###### 11.10. 重新启动服务 ######

重新启动 Sentinel控制台和内容中心

###### 11.11. 登陆Sentinel控制台查看降级规则 ######

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 13]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 14]  
从上图可以看出，测试通过！

[Link 1]: https://blog.csdn.net/weixin_40816738/article/details/116226766
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70]: /images/20221021/4bdcf3655bf04f29b8cf018966dd9322.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 1]: /images/20221021/c5fbfb21953243b3a44ef1d6bc3e0ffa.png
[https_github.com_eacdy_Sentinel-Dashboard-Nacos]: https://github.com/eacdy/Sentinel-Dashboard-Nacos
[https_github.com_eacdy_Sentinel-Dashboard-Nacos_releases]: https://github.com/eacdy/Sentinel-Dashboard-Nacos/releases
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 2]: /images/20221021/2a342b9d6ff0450dbfb8c6f86e8e3f27.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 3]: /images/20221021/1fe95f7c422a49338fa0cbb1b4ba2197.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 4]: /images/20221021/fe7b66f8ca724c77888e4fdf85596852.png
[http_localhost_8080]: http://localhost:8080/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 5]: /images/20221021/8b25f5ec8ece46c191c4de6696508fca.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 6]: /images/20221021/6c46f6742eaf43b4a4bafdbb01ef2507.png
[http_localhost_8848_nacos]: http://localhost:8848/nacos
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 7]: /images/20221021/016209c29b044f109365ddc98138610e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 8]: /images/20221021/ccfcac09183d403d8557bbccc796156a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 9]: /images/20221021/226b3b1acc0e4337b017139dcbc3ecd8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 10]: /images/20221021/77e17e195ea047b1b0e58a859f8f4ae2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 11]: /images/20221021/fa1d5269343d48a1bf2b4e173031fe68.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 12]: /images/20221021/ef4e832e83f34e6d8992d67496840f25.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 13]: /images/20221021/6f133432b81e4bad8a04ec41e19a0a9a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgxNjczOA_size_16_color_FFFFFF_t_70 14]: /images/20221021/e03c621b93b84123bc56494a3a6b7f44.png