改造Sentinel源码，实现Nacos双向通信！

╰+攻爆jí腚メ 2024-02-21 09:41 41阅读 0赞

![9323031dc1231f9263f406fd7e594390.png][]

作者 | 磊哥

来源 | Java中文社群

作者微信：GG\_Stone

Sentinel Dashboard（控制台）默认情况下，只能将配置规则保存到内存中，这样就会导致 Sentinel Dashboard 重启后配置规则丢失的情况，因此我们需要将规则保存到某种数据源中，Sentinel 支持的数据源有以下这些：![2d409ccb3cff58182332b6335ca70ad8.png][]然而，默认情况下，Sentinel 和数据源之间的关系是单向数据通讯的，也就是只能先在数据源中配置规则，然后数据源会被规则推送至 Sentinel Dashboard 和 Sentinel 客户端，但是在 Sentinel Dashboard 中修改规则或新增规则是不能反向同步到数据源中的，这就是单向通讯。

所以，今天我们就该修改一下 Sentinel 的源码，让其可以同步规则至数据源，改造之后的交互流程如下图所示：![97d1a7c8925455dc84613dea11870f39.png][]Sentinel 同步规则至数据源，例如将 Sentinel 的规则，同步规则至 Nacos 数据源的改造步骤很多，但整体实现难度不大，下面我们一起来看吧。

### 1.下载Sentinel源码 ###

下载地址：https://github.com/alibaba/Sentinel

> “
> 
> PS：本文 Sentinel 使用的版本是 1.8.6。
> 
> ”

下载源码之后，使用 idea 打开里面的 sentinel-dashboard 项目，如下图所示：![cebd66c580b381793b0e1e5743f4467d.png][]

### 2.修改pom.xml ###

将 sentinel-datasource-nacos 底下的 scope 注释掉，如下图所示：![391c44d00f91c71c2a401b63c3011864.png][]

> “
> 
> PS：因为官方提供的 Nacos 持久化实例，是在 test 目录下进行单元测试的，而我们是用于生产环境，所以需要将 scope 中的 test 去掉。
> 
> ”

### 3.移动单元测试代码 ###

将 test/com.alibaba.csp.sentinel.dashboard.rule.nacos 下所有文件复制到 src/main/java/com.alibaba.csp.sentinel.dashboard.rule 目录下，如下图所示：![8c7dc415e0976f938fa1118d5686f0bd.png][]

### 4.新建NacosPropertiesConfiguration文件 ###

在 com.alibaba.csp.sentinel.dashboard.rule 下创建 Nacos 配置文件的读取类，实现代码如下：

package com.alibaba.csp.sentinel.dashboard.rule;
    
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.context.annotation.Configuration;
    
    @ConfigurationProperties(prefix = "sentinel.nacos")
    @Configuration
    public class NacosPropertiesConfiguration {
        private String serverAddr;
        private String dataId;
        private String groupId;
        private String namespace;
        private String username;
        private String password;
        // 省略 Getter/Setter 代码
    }

### 5.修改NacosConfig文件 ###

只修改 NacosConfig 中的 nacosConfigService 方法，修改后的代码如下：

@Bean
    public ConfigService nacosConfigService(NacosPropertiesConfiguration nacosPropertiesConfiguration) throws Exception {
        Properties properties = new Properties();
        properties.put(PropertyKeyConst.SERVER_ADDR, nacosPropertiesConfiguration.getServerAddr());
        properties.put(PropertyKeyConst.NAMESPACE, nacosPropertiesConfiguration.getNamespace());
        properties.put(PropertyKeyConst.USERNAME,nacosPropertiesConfiguration.getUsername());
        properties.put(PropertyKeyConst.PASSWORD,nacosPropertiesConfiguration.getPassword());
        return ConfigFactory.createConfigService(properties);
    //        return ConfigFactory.createConfigService("localhost"); // 原代码
    }

### 6.修改FlowControllerV2文件 ###

修改 com.alibaba.csp.sentinel.dashboard.controller.v2 目录下的 FlowControllerV2 文件：![97076a3dfd67f10c58babec6af7c65a2.png][]修改后代码：

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

> “
> 
> PS：此操作的目的是开启 Controller 层操作 Nacos 的开关。
> 
> ”

如下图所示：![058fe4211e178b4bf47d8e1340771e39.png][]

### 7.修改配置信息 ###

在 application.properties 中设置 Nacos 连接信息，配置如下：

sentinel.nacos.serverAddr=localhost:8848
    sentinel.nacos.username=nacos
    sentinel.nacos.password=nacos
    sentinel.nacos.namespace=
    sentinel.nacos.groupId=DEFAULT_GROUP
    sentinel.nacos.dataId=sentinel-dashboard-demo-sentinel

### 8.修改sidebar.html ###

修改 webapp/resources/app/scripts/directives/sidebar/sidebar.html 文件：![e35b023b7313239ca2a7c02e4665ff5d.png][]搜索“dashboard.flowV1”改为“dashboard.flow”，如下图所示：![efe5884b6f8715af5d7ff0c3c7556935.png][]

### 9.修改identity.js ###

identity.js 文件有两处修改，它位于 webapp/resources/app/scripts/controllers/identity.js 目录。

#### 9.1 第一处修改 ####

将“FlowServiceV1”修改为“FlowServiceV2”，如下图所示：![f1931584d62c88b67aa9200196700820.png][]

#### 9.2 第二处修改 ####

搜索“/dashboard/flow/”修改为“/dashboard/v2/flow/”，如下图所示：![fc96fc927c4b921cb9b5e616783ab2e8.png][]

> “
> 
> PS：修改 identity.js 文件主要是用于在 Sentinel 点击资源的“流控”按钮添加规则后将信息同步给 Nacos。
> 
> ”

### 小结 ###

Sentinel Dashboard 默认情况下，只能将配置规则保存到内存中，这样就会程序重启后配置规则丢失的情况，因此我们需要给 Sentinel 设置一个数据源，并且要和数据源之间实现双向通讯，所以我们需要修改 Sentinel 的源码。源码的改造步骤虽然很多，但只要逐一核对和修改就可以实现 Sentinel 生成环境的配置了。看完记得收藏哦，防止以后用的时候找不到。

--------------------

### 说件大事 ###

为了让大家更简单的学习微服务，有着 13 年工作经验的磊哥，开设了一门最新版的微服务实战课。**课程包学包会，提供无限期的技术答疑和远程指导服务。**

课程包含 7 大微服务组件 + 1 个综合性项目，目录如下：

![8f0439dcf45c9b56982106a7d0cb24e1.png][]

加我微信咨询吧：GG\_Stone【备注：微服务】

![90c8b35eb3b07e696264d00077b898d7.png][]

[9323031dc1231f9263f406fd7e594390.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/260a05fb5180416181f0e28e61bec157.png
[2d409ccb3cff58182332b6335ca70ad8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/7052a4672f75451e94680d6b7e1a5be8.png
[97d1a7c8925455dc84613dea11870f39.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/146f5b4759fa45b3944a086b6043e938.png
[cebd66c580b381793b0e1e5743f4467d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/13086fd12b004ff8a4c716094bd49685.png
[391c44d00f91c71c2a401b63c3011864.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/5fcbe257008e4efa954a05106b921937.png
[8c7dc415e0976f938fa1118d5686f0bd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/0e19a8a4a68844d68ffeaf3fa306ac79.png
[97076a3dfd67f10c58babec6af7c65a2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/ae9d5ef0ffbd45dc8baa5b3c6bf13530.png
[058fe4211e178b4bf47d8e1340771e39.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/a8a86d64a5cb4630bf94ede5c281b085.png
[e35b023b7313239ca2a7c02e4665ff5d.png]: https://img-blog.csdnimg.cn/img_convert/e35b023b7313239ca2a7c02e4665ff5d.png
[efe5884b6f8715af5d7ff0c3c7556935.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/108dc08f506544a4883205fa44b73eb8.png
[f1931584d62c88b67aa9200196700820.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/2a2b2d12467b4e4c8c4a4a6793f9c744.png
[fc96fc927c4b921cb9b5e616783ab2e8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/7843872853cd40c4b06c241f84c8531a.png
[8f0439dcf45c9b56982106a7d0cb24e1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/ed1126d50076482ea777b2975839fd43.png
[90c8b35eb3b07e696264d00077b898d7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/c5189da51cb1477893131f5db20f3839.png