Spring Cloud Alibaba（7）Sentinel Dashboard中修改规则同步到Nacos 带源码

系统管理员 2021-10-18 13:26 301阅读 0赞

**目录**

博文参考

源码地址

背景

代码实现

1.到alibab/Sentinel官网地址https://github.com/alibaba/Sentinel下载最新版源码到本地，用idea打开，这里主要用到Sentinel-dashboard。

2. 修改pom.xml中的sentinel-datasource-nacos的依赖，将test注释掉，这样才能在主程序中使用。

3. 找到webapp/resources/app/scripts/directives/sidebar/sidebar.html中的这段代码：

4.在com.alibaba.csp.sentinel.dashboard.rule包下新建一个nacos包，用来编写针对Nacos的扩展实现。

5. 创建Nacos的配置类，具体代码如下：

6. 实现Nacos的配置拉取。创建FlowRuleNacosProvider类，具体代码如下：

7. 实现Nacos的配置推送。创建FlowRuleNacosPublisher类，具体代码如下：

8.修改com.alibaba.csp.sentinel.dashboard.controller.v2.FlowControllerV2中DynamicRuleProvider和DynamicRulePublisher注入的Bean，改为上面我们编写的针对Apollo的实现：

9.启动DashboardApplication类的main方法，启动sentinel-dashboard应用，访问http://localhost:8080，登陆sentinel

10.限流测试参考Spring Cloud Alibaba（4）Sentinel使用nacos对存储规则持久化 带源码

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

## 博文参考 ##

[http://blog.didispace.com/spring-cloud-alibaba-sentinel-2-4/][http_blog.didispace.com_spring-cloud-alibaba-sentinel-2-4]

## 源码地址 ##

[https://gitee.com/acelee723/acelee-sentinel-dashboard-nacos][https_gitee.com_acelee723_acelee-sentinel-dashboard-nacos]

## 背景 ##

上一篇我们介绍了如何通过改造Sentinel Dashboard来实现修改规则之后自动同步到Apollo。下面通过这篇，详细介绍当使用Nacos作为配置中心之后，如何实现Sentinel Dashboard中修改规则同步到Nacos。关于下面改造的原理和分析可以见上一篇[《Sentinel Dashboard中修改规则同步到Apollo》][Sentinel Dashboard_Apollo]的头两节内容，这里不重复介绍了。

## 代码实现 ##

下面直接来看看如何实现的具体改造步骤，这里参考了`Sentinel Dashboard`源码中关于Nacos实现的测试用例。但是由于考虑到与Spring Cloud Alibaba的结合使用，略作修改。

### 1.到alibab/Sentinel官网地址[https://github.com/alibaba/Sentinel][https_github.com_alibaba_Sentinel]下载最新版源码到本地，用idea打开，这里主要用到Sentinel-dashboard。 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 1][]

### 2. 修改`pom.xml`中的sentinel-datasource-nacos的依赖，将`<scope>test</scope>`注释掉，这样才能在主程序中使用。 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 2][]

### 3. 找到`webapp`/`resources/app/scripts/directives/sidebar/sidebar.html`中的这段代码：  ###

**修改为：**

### 4.在`com.alibaba.csp.sentinel.dashboard.rule`包下新建一个nacos包，用来编写针对Nacos的扩展实现。 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 3][]

### 5. 创建Nacos的配置类，具体代码如下： ###

package com.alibaba.csp.sentinel.dashboard.rule.nacos;
    
    import com.alibaba.csp.sentinel.dashboard.datasource.entity.rule.FlowRuleEntity;
    import com.alibaba.csp.sentinel.datasource.Converter;
    import com.alibaba.fastjson.JSON;
    import com.alibaba.nacos.api.PropertyKeyConst;
    import com.alibaba.nacos.api.config.ConfigFactory;
    import com.alibaba.nacos.api.config.ConfigService;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    import java.util.List;
    import java.util.Properties;
    
    /**
     * TODO
     *
     * @Author Ace Lee
     * @Date 2019/8/12 12:00
     * @Version 1.0
     **/
    @Configuration
    public class NacosConfig {
    
        @Bean
        public Converter<List<FlowRuleEntity>, String> flowRuleEntityEncoder() {
            return JSON::toJSONString;
        }
    
        @Bean
        public Converter<String, List<FlowRuleEntity>> flowRuleEntityDecoder() {
            return s -> JSON.parseArray(s, FlowRuleEntity.class);
        }
    
        @Bean
        public ConfigService nacosConfigService() throws Exception {
            Properties properties = new Properties();
            properties.put(PropertyKeyConst.SERVER_ADDR, "localhost");
            //        properties.put(PropertyKeyConst.NAMESPACE, "130e71fa-97fe-467d-ad77-967456f2c16d");
            return ConfigFactory.createConfigService(properties);
        }
    }

**如果用到了namespace隔离环境，可以在`nacosConfigService`方法中再加入配置，比如：**

properties.put(PropertyKeyConst.NAMESPACE, "130e71fa-97fe-467d-ad77-967456f2c16d");

### 6. 实现Nacos的配置拉取。创建FlowRuleNacosProvider类，具体代码如下： ###

package com.alibaba.csp.sentinel.dashboard.rule.nacos;
    
    import com.alibaba.csp.sentinel.dashboard.datasource.entity.rule.FlowRuleEntity;
    import com.alibaba.csp.sentinel.dashboard.rule.DynamicRuleProvider;
    import com.alibaba.csp.sentinel.datasource.Converter;
    import com.alibaba.csp.sentinel.util.StringUtil;
    import com.alibaba.nacos.api.config.ConfigService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Component;
    
    import java.util.ArrayList;
    import java.util.List;
    
    /**
     * TODO
     *
     * @Author Ace Lee
     * @Date 2019/8/12 14:13
     * @Version 1.0
     **/
    @Component("flowRuleNacosProvider")
    public class FlowRuleNacosProvider implements DynamicRuleProvider<List<FlowRuleEntity>> {
    
        @Autowired
        private ConfigService configService;
        @Autowired
        private Converter<String, List<FlowRuleEntity>> converter;
    
        public static final String FLOW_DATA_ID_POSTFIX = "-sentinel";
        public static final String GROUP_ID = "DEFAULT_GROUP";
    
        @Override
        public List<FlowRuleEntity> getRules(String appName) throws Exception {
            String rules = configService.getConfig(appName + FLOW_DATA_ID_POSTFIX, GROUP_ID, 3000);
            if (StringUtil.isEmpty(rules)) {
                return new ArrayList<>();
            }
            return converter.convert(rules);
        }
    }

>  *  `getRules`方法中的`appName`参数是Sentinel中的服务名称。
>  *  `configService.getConfig`方法是从Nacos中获取配置信息的具体操作。其中，DataId和GroupId分别对应客户端使用时候的对应配置。比如这里的例子对应了之前我们在[《Sentinel使用Nacos存储规则》][Sentinel_Nacos]一文中的配置，具体如下：

spring.cloud.sentinel.datasource.ds.nacos.groupId=DEFAULT_GROUP
    spring.cloud.sentinel.datasource.ds.nacos.dataId=${spring.application.name}-sentinel

** 注意：两边的DataId和GroupId必须对应上。**

### **7. **实现Nacos的配置推送。创建FlowRuleNacosPublisher类，具体代码如下：  ###

package com.alibaba.csp.sentinel.dashboard.rule.nacos;
    
    import com.alibaba.csp.sentinel.dashboard.datasource.entity.rule.FlowRuleEntity;
    import com.alibaba.csp.sentinel.dashboard.rule.DynamicRulePublisher;
    import com.alibaba.csp.sentinel.datasource.Converter;
    import com.alibaba.csp.sentinel.util.AssertUtil;
    import com.alibaba.nacos.api.config.ConfigService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Component;
    
    import java.util.List;
    
    /**
     * TODO
     *
     * @Author Ace Lee
     * @Date 2019/8/12 14:20
     * @Version 1.0
     **/
    @Component("flowRuleNacosPublisher")
    public class FlowRuleNacosPublisher implements DynamicRulePublisher<List<FlowRuleEntity>> {
    
        @Autowired
        private ConfigService configService;
        @Autowired
        private Converter<List<FlowRuleEntity>, String> converter;
    
        public static final String FLOW_DATA_ID_POSTFIX = "-sentinel";
        public static final String GROUP_ID = "DEFAULT_GROUP";
    
        @Override
        public void publish(String app, List<FlowRuleEntity> rules) throws Exception {
            AssertUtil.notEmpty(app, "app name cannot be empty");
            if (rules == null) {
                return;
            }
            configService.publishConfig(app + FLOW_DATA_ID_POSTFIX, GROUP_ID, converter.convert(rules));
        }
    }

>  *  这里的大部分内容与上一步中的实现一致。主要就是Nacos中存储配置的DataId和GroupId不要弄错。

### 8.修改`com.alibaba.csp.sentinel.dashboard.controller.v2.FlowControllerV2`中`DynamicRuleProvider`和`DynamicRulePublisher`注入的Bean，改为上面我们编写的针对Apollo的实现： ###

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

### 9.启动DashboardApplication类的main方法，启动sentinel-dashboard应用，访问[http://localhost:8080][http_localhost_8080]，登陆[sentinel][] ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 4][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 5][]

### 10.限流测试参考[Spring Cloud Alibaba（4）Sentinel使用nacos对存储规则持久化 带源码][Sentinel_Nacos] ###

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

**欢迎关注博主博客，后期博主会持续更新[spring cloud alibaba][] 系列文章，敬请期待！ **

[http_blog.didispace.com_spring-cloud-alibaba-sentinel-2-4]: http://blog.didispace.com/spring-cloud-alibaba-sentinel-2-4/
[https_gitee.com_acelee723_acelee-sentinel-dashboard-nacos]: https://gitee.com/acelee723/acelee-sentinel-dashboard-nacos
[Sentinel Dashboard_Apollo]: https://blog.csdn.net/las723/article/details/95164570
[https_github.com_alibaba_Sentinel]: https://github.com/alibaba/Sentinel
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70]: /images/20211018/d92758edaa184bc68c3107ecb4fd7371.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 1]: /images/20211018/4e3e574a4dd24f26ac8f6489f3e17432.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 2]: /images/20211018/fee051e90a9442fc88a29e04b5ed5c9f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 3]: /images/20211018/a874a63b42ed4ffebe5ad2f51d6d1a54.png
[Sentinel_Nacos]: https://blog.csdn.net/las723/article/details/90375322
[http_localhost_8080]: http://localhost:8080/
[sentinel]: https://blog.csdn.net/las723/article/details/90296415
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 4]: /images/20211018/b66f5fab2372445a882e313971b6c4bc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 5]: /images/20211018/b45bbbcd4a514074b66f22e411211066.png
[spring cloud alibaba]: https://blog.csdn.net/las723/column/info/38747