Sentinel 如何持久化數據到 Nacos?

默認情況下 Sentinel 只能接收到 Nacos 推送的消息,但不能將自己控制檯修改的信息同步給 Nacos,如下圖所示:但是在生成環境下,我們爲了更方便的操作,是需要將 Sentinel 控制檯修改的規則也同步到 Nacos 的,所以在這種情況下我們就需要修改 Sentinel 的源碼,讓其可以實現和 Nacos 的雙向通訊,如下圖所示:改造之後的交互流程如下圖所示:Sentinel 同步規則至數據源,例如將 Sentinel 的規則,同步規則至 Nacos 數據源的改造步驟很多,但整體實現難度不大,下面我們一起來看吧。

  1. 下載 Sentinel 源碼

下載地址:https://github.com/alibaba/Sentinel

PS:本文 Sentinel 使用的版本是 1.8.6。

下載源碼之後,使用 idea 打開裏面的 sentinel-dashboard 項目,如下圖所示:

  1. 修改 pom.xml

將 sentinel-datasource-nacos 底下的 scope 註釋掉,如下圖所示:

PS:因爲官方提供的 Nacos 持久化實例,是在 test 目錄下進行單元測試的,而我們是用於生產環境,所以需要將 scope 中的 test 去掉。

  1. 移動單元測試代碼

將 test/com.alibaba.csp.sentinel.dashboard.rule.nacos 下所有文件複製到 src/main/java/com.alibaba.csp.sentinel.dashboard.rule 目錄下,如下圖所示:

  1. 新建 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 代碼
}
  1. 修改 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"); // 原代碼
}
  1. 修改 FlowControllerV2 文件

修改 com.alibaba.csp.sentinel.dashboard.controller.v2 目錄下的 FlowControllerV2 文件:修改後代碼:

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

PS:此操作的目的是開啓 Controller 層操作 Nacos 的開關。

如下圖所示:

  1. 修改配置信息

在 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
  1. 修改 sidebar.html

修改 webapp/resources/app/scripts/directives/sidebar/sidebar.html 文件:搜索 “dashboard.flowV1” 改爲“dashboard.flow”,如下圖所示:

  1. 修改 identity.js

identity.js 文件有兩處修改,它位於 webapp/resources/app/scripts/controllers/identity.js 目錄。

9.1 第一處修改

將 “FlowServiceV1” 修改爲“FlowServiceV2”,如下圖所示:

9.2 第二處修改

搜索 “/dashboard/flow/” 修改爲“/dashboard/v2/flow/”,如下圖所示:

PS:修改 identity.js 文件主要是用於在 Sentinel 點擊資源的 “流控” 按鈕添加規則後將信息同步給 Nacos。

小結

Sentinel Dashboard 默認情況下,只能將配置規則保存到內存中,這樣就會程序重啓後配置規則丟失的情況,因此我們需要給 Sentinel 設置一個數據源,並且要和數據源之間實現雙向通訊,所以我們需要修改 Sentinel 的源碼。源碼的改造步驟雖然很多,但只要逐一覈對和修改就可以實現 Sentinel 生成環境的配置了。

本文由 Readfog 進行 AMP 轉碼,版權歸原作者所有。
來源https://mp.weixin.qq.com/s/1qawNuXWWj_QSzChFruFTA