Spring Cloud Alibaba基礎教程：Sentinel Dashboard中修改規則同步到Nacos

上一篇咱們介紹瞭如何經過改造Sentinel Dashboard來實現修改規則以後自動同步到Apollo。下面經過這篇，詳細介紹當使用Nacos做爲配置中心以後，如何實現Sentinel Dashboard中修改規則同步到Nacos。關於下面改造的原理和分析能夠見上一篇《Sentinel Dashboard中修改規則同步到Apollo》的頭兩節內容，這裏不重複介紹了。

代碼實現

下面直接來看看如何實現的具體改造步驟，這裏參考了Sentinel Dashboard源碼中關於Nacos實現的測試用例。可是因爲考慮到與Spring Cloud Alibaba的結合使用，略做修改。

第一步：修改pom.xml中的sentinel-datasource-nacos的依賴，將<scope>test</scope>註釋掉，這樣才能在主程序中使用。

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

第二步：找到resources/app/scripts/directives/sidebar/sidebar.html中的這段代碼：

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

修改成：

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

第三步：在com.alibaba.csp.sentinel.dashboard.rule包下新建一個nacos包，用來編寫針對Nacos的擴展實現。

第四步：建立Nacos的配置類，具體代碼以下：

@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");
        return ConfigFactory.createConfigService(properties);
    }
}

若是用到了namespace隔離環境，能夠在nacosConfigService方法中再加入配置，好比：properties.put(PropertyKeyConst.NAMESPACE, "130e71fa-97fe-467d-ad77-967456f2c16d");

第五步：實現Nacos的配置拉取。

@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存儲規則》一文中的配置，具體以下：

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

注意：兩邊的DataId和GroupId必須對應上。

第六步：實現Nacos的配置推送。

@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不要弄錯。

第七步：修改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;

最後，讀者能夠使用本文改造後的sentinel-dashboard聯合以前《Sentinel使用Nacos存儲規則》一文的例子來驗證本文內容。

代碼示例

本文介紹內容的客戶端代碼，示例讀者能夠經過查看下面倉庫中的alibaba-sentinel-dashboard-nacos項目：

• Github：https://github.com/dyc87112/SpringCloud-Learning/
• Gitee：https://gitee.com/didispace/SpringCloud-Learning/

若是您對這些感興趣，歡迎star、follow、收藏、轉發給予支持！