Sentinel：4.Sentinel的高级使用（一）流控规则持久化

男娘i 2023-01-13 04:16 214阅读 0赞

### 文章目录 ###

*  1.概述
 *   *  1.1 问题
     *  1.2 解决方法
 *  2.教程
 *   *  2.1 修改Sentinel Dashboard源码
     *  2.2 修改Nacos配置中心里的nacos-sample-provider.yml
     *  2.3 修改nacos-sample-provider项目中的bootstrap.yml
     *  2.4 在主pom.xml中添加Nacos数据依赖
     *  2.5 启动服务nacos-sample-provider，并在Sentinel Dashboard控制台为其添加两条条流控规则
     *  2.6 在Nacos配置中心查看一下对应的规则配置文件
     *  2.7 重启Sentinel Dashboard控制台和nacos-sample-provider服务，验证是否实现流控规则持久化
     *  2.8 注意事项
 *  3. 小练习
 *   *   *  本文示例源码：

# 1.概述 #

## 1.1 问题 ##

Sentinel Dashboard所配置的规则，都是保存在内存中的，不论是重启Sentinel Dashboard服务还是重启已注册的应用服务，都会导致这些规则被清除。

## 1.2 解决方法 ##

Sentinel提供了动态数据源支持，目前，Sentinel支持Consul、ZooKeeper、Redis、Nacos、Apollo、Etcd等数据源的扩展，本文就以Nacos为例进行规则持久化演示。

# 2.教程 #

在[Nacos：1.Nacos的基本使用（一）服务注册与发现][Nacos_1.Nacos]中，已经创建好了module：nacos-sample-provider，我们继续以它为例来演示Sentinel的高级使用。

## 2.1 修改Sentinel Dashboard源码 ##

1.  打开Sentinel源码中的sentinel-dashboard项目，找到该项目的pom.xml，注释掉部分

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

1.  然后修改sentinel-dashboard项目中sentinel-dashboard/src/main/webapp/resources/app/scripts/directives/sidebar/sidebar.html

<li ui-sref-active="active" ng-if="!entry.isGateway">
        
        <a ui-sref="dashboard.flow({app: entry.app})">
        <i class="glyphicon glyphicon-filter"></i>  流控规则</a>
    </li>

1.  在sentinel-dashboard/src/main/java/com/alibaba/csp/sentinel/dashboard/rule目录下，添加naocs包并新增以下代码

FlowRuleNacosProvider.java

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.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    
    import java.util.ArrayList;
    import java.util.List;
    
    /** * 从Nacos配置中心动态获取流控规则 */
    @Service
    public class FlowRuleNacosProvider implements DynamicRuleProvider<List<FlowRuleEntity>> { 
        private static Logger logger = LoggerFactory.getLogger(FlowRuleNacosProvider.class);
    
        @Autowired
        private NacosPropertiesConfiguration nacosPropertiesConfiguration;
    
        @Autowired
        private ConfigService configService;
    
        @Autowired
        private Converter<String, List<FlowRuleEntity>> converter;
    
        /** * 从Nacos配置中心拉取规则配置文件，并转换成正确的规则格式 * * @param appName 规则名/配置文件名 * @return * @throws Exception */
        @Override
        public List<FlowRuleEntity> getRules(String appName) throws Exception { 
            String dataId = new StringBuffer(appName).append(NacosConstants.DATA_ID_POSTFIX).toString();
            String rules = configService.getConfig(dataId, nacosPropertiesConfiguration.getGroupId(), 3000);
            logger.info("pull FlowRule from Nacos Config:{}", rules);
            if (StringUtil.isEmpty(rules)) { 
                return new ArrayList<>();
            }
            return converter.convert(rules);
        }
    }

FlowRuleNacosPublisher.java

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 java.util.List;
    
    /** * 动态上传流控规则到Nacos配置中心 */
    @Service
    public class FlowRuleNacosPublisher implements DynamicRulePublisher<List<FlowRuleEntity>> { 
    
        @Autowired
        private NacosPropertiesConfiguration nacosPropertiesConfiguration;
    
        @Autowired
        private ConfigService configService;
    
        @Autowired
        private Converter<List<FlowRuleEntity>, String> converter;
    
        /** * 将规则转换成配置文件格式，然后上传到Nacos配置中心 * * @param appName * @param rules list of rules to push * @throws Exception */
        @Override
        public void publish(String appName, List<FlowRuleEntity> rules) throws Exception { 
            AssertUtil.notEmpty(appName, "appName cannot be empty");
            if (rules == null) { 
                return;
            }
            String dataId = new StringBuffer(appName).append(NacosConstants.DATA_ID_POSTFIX).toString();
            configService.publishConfig(dataId, nacosPropertiesConfiguration.getGroupId(), converter.convert(rules));
        }
    }

NacosConfiguration.java

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 com.alibaba.nacos.api.exception.NacosException;
    import org.springframework.boot.context.properties.EnableConfigurationProperties;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    import java.util.List;
    import java.util.Properties;
    
    /** * Nacos配置类 */
    @EnableConfigurationProperties(NacosPropertiesConfiguration.class)
    @Configuration
    public class NacosConfiguration { 
    
        /** * Converter转换器，将FlowRuleEntity转换成FlowRule * * @return */
        @Bean
        public Converter<List<FlowRuleEntity>, String> flowRuleEntityEncoder() { 
            return JSON::toJSONString;
        }
    
        /** * Converter反向转换器，将FlowRule转换成FlowRuleEntity * * @return */
        @Bean
        public Converter<String, List<FlowRuleEntity>> flowRuleEntityDecoder() { 
            return s -> JSON.parseArray(s, FlowRuleEntity.class);
        }
    
        /** * Nacos配置服务 * * @param nacosPropertiesConfiguration * @return * @throws NacosException */
        @Bean
        public ConfigService nacosConfigService(NacosPropertiesConfiguration nacosPropertiesConfiguration) throws NacosException { 
            Properties properties = new Properties();
            properties.put(PropertyKeyConst.SERVER_ADDR, nacosPropertiesConfiguration.getServerAddr());
            properties.put(PropertyKeyConst.NAMESPACE, nacosPropertiesConfiguration.getNamespace());
            return ConfigFactory.createConfigService(properties);
        }
    }

NacosConstants.java

package com.alibaba.csp.sentinel.dashboard.rule.nacos;
    
    public class NacosConstants { 
    
        // 配置文件的后缀
        public static final String DATA_ID_POSTFIX = "-sentinel-flow";
        // 默认groupId
        public static final String GROUP_ID = "DEFAULT_GROUP";
    }

NacosPropertiesConfiguration.java

package com.alibaba.csp.sentinel.dashboard.rule.nacos;
    
    import org.springframework.boot.context.properties.ConfigurationProperties;
    
    @ConfigurationProperties(prefix = "sentinel.nacos")
    public class NacosPropertiesConfiguration { 
    
        // Nacos服务地址
        private String serverAddr;
        // 所需的配置id："Sentinel添加的规则转换成的配置文件"的id
        private String dataId;
        private String groupId = "DEFAULT_GROUP";
        private String namespace;
    
        public String getServerAddr() { 
            return serverAddr;
        }
    
        public void setServerAddr(String serverAddr) { 
            this.serverAddr = serverAddr;
        }
    
        public String getDataId() { 
            return dataId;
        }
    
        public void setDataId(String dataId) { 
            this.dataId = dataId;
        }
    
        public String getGroupId() { 
            return groupId;
        }
    
        public void setGroupId(String groupId) { 
            this.groupId = groupId;
        }
    
        public String getNamespace() { 
            return namespace;
        }
    
        public void setNamespace(String namespace) { 
            this.namespace = namespace;
        }
    }

1.  修改sentinel-dashboard/src/main/java/com/alibaba/csp/sentinel/dashboard/controller/v2/FlowControllerV2.java

NacosPropertiesConfiguration.java

@RestController
    @RequestMapping(value = "/v2/flow")
    public class FlowControllerV2 { 
    
        private final Logger logger = LoggerFactory.getLogger(FlowControllerV2.class);
    
        @Autowired
        private InMemoryRuleRepositoryAdapter<FlowRuleEntity> repository;
    
        @Autowired
    // @Qualifier("flowRuleDefaultProvider")
        @Qualifier("flowRuleNacosProvider")     // 修改为Nacos的Provider
        private DynamicRuleProvider<List<FlowRuleEntity>> ruleProvider;
        @Autowired
    // @Qualifier("flowRuleDefaultPublisher")
        @Qualifier("flowRuleNacosPublisher")    // 修改为Nacos的Publisher
        private DynamicRulePublisher<List<FlowRuleEntity>> rulePublisher;
        
        ... ...
    }

1.  修改sentinel-dashboard/src/main/resources/application.properties，在其中添加Nacos服务端的配置信息

# Nacos配置信息
    sentinel.nacos.serverAddr=localhost:8848
    sentinel.nacos.namespace=
    sentinel.nacos.group-id=DEFAULT_GROUP
    # serverAddr需要根据实际情况更改

1.  重新将sentinel-dashboard项目打包，然后启动服务

两种方式：

1.  官方文档教程：[README.md][]

【注意】

a. `官方教程中使用的端口是8080，用户可以自定义更改，本文中改成了8849。`

b. `官方教程中的mvan clean package指令，建议改成mvn clean package -Dmaven.test.skip=true，跳过test包的编译，以免编译失败`

1.  使用idea打开项目，等待所有maven依赖导入完成后，按下图设置，填入参数：`-Dserver.port=8849 -Dcsp.sentinel.dashboard.server=localhost:8849 -Dproject.name=sentinel-dashboard`，点击启动即可

## 2.2 修改Nacos配置中心里的nacos-sample-provider.yml ##

nacos-sample-provider.yml

# nacos配置中心信息参数
    nacos:
      instance:
        hostname: localhost
        port: 8848
    
    # sentinel信息参数
    sentinel:
      instance:
        hostname: localhost
        port: 8849
    
    spring:
      application:
        # 服务名，对应service-id（在这里配置的话，项目中的bootstrap.yml里的就可以删除了）
        name: nacos-sample-provider
      cloud:
        nacos:
          discovery:
            # 服务注册中心地址
            server-addr: ${ nacos.instance.hostname}:${ nacos.instance.port}
        sentinel:
          transport:
            # sentinel控制台地址
            dashboard: ${ sentinel.instance.hostname}:${ sentinel.instance.port}
          datasource:
            # 配置Nacos数据源，如果不配置话，尽管Sentinel创建的规则同步过来了，也不会生效
            - nacos:
                server-addr: ${ nacos.instance.hostname}:${ nacos.instance.port}
                data-id: ${ spring.application.name}-sentinel-flow
                group-id: DEFAULT_GROUP
                data-type: json
                rule-type: flow
    
    # 该服务启动后使用的端口
    server:
      port: 8001
      
    testValue: welcome!!!

## 2.3 修改nacos-sample-provider项目中的bootstrap.yml ##

bootstrap.yml

# nacos配置中心信息参数
    nacos:
      instance:
        hostname: localhost
        port: 8848
    
    spring:
      cloud:
        nacos:
          config:
            # 配置中心地址
            server-addr: ${ nacos.instance.hostname}:${ nacos.instance.port}
            # 配置文件扩展名（目前只支持 properties 和 yml 类型）
            file-extension: yml
            # 配置文件名前缀（默认为 spring.application.name 的值，也可以自己手动设置）
            prefix: nacos-sample-provider
      profiles:
        # 当 spring.profile.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 ${prefix}.${file-extension}
        active: dev
        # 当前设置对应的DataID是：nacos-sample-provider-dev.yml
        
    # 注释掉 application.name ，在Nacos配置中心里的nacos-sample-provider.yml中配置就好了
    # application:
    # # 服务名，对应service-id（在这里配置的话，项目中的bootstrap.yml里的就可以删除了）
    # name: nacos-sample-provider

## 2.4 在主pom.xml中添加Nacos数据依赖 ##

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

## 2.5 启动服务nacos-sample-provider，并在Sentinel Dashboard控制台为其添加两条条流控规则 ##

\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-LdeS0IGv-1618485979649)(https://note.youdao.com/yws/public/resource/fbce5e4f4122dcb2ed7f9bf7f715f161/xmlnote/BAAC9C6B65334F3D8A8C84BA6C46B24F/24763)\]

## 2.6 在Nacos配置中心查看一下对应的规则配置文件 ##

![image][]

![image][image 1]

## 2.7 重启Sentinel Dashboard控制台和nacos-sample-provider服务，验证是否实现流控规则持久化 ##

![image][image 2]

![image][image 3]

## 2.8 注意事项 ##

1.  `一定要在“流控规则Tab页”点击“新建流控规则”，否则不会同步到Nacos，即不会持久化`
2.  `如果创建规则后，在Nacos配置中心可以看到生成的规则配置文件，但是Sentinel Dashboard控制台看不到对应的规则，重启一下Nacos就好了`
3.  `在Sentinel Dashboard控制台“创建和修改规则”可以实时同步到Nacos，但是删除不会实时同步`
4.  `在Nacos配置中心“创建、修改和删除规则配置文件”都会实时同步到Sentinel`

# 3. 小练习 #

读者亲自尝试一下 “2.8 注意事项” 中的第3和第4点。

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

### 本文示例源码： ###

[GitHub：WangYe8613/scanacos][GitHub_WangYe8613_scanacos]

\[commit id：a34bbae1d17d73acf1a8ce19a043669324dcb767\]

[Nacos_1.Nacos]: https://blog.csdn.net/w_y_x_y/article/details/115558041?spm=1001.2014.3001.5501
[README.md]: https://github.com/alibaba/Sentinel/tree/master/sentinel-dashboard
[image]: /images/20221022/331d2db876d044b8beb0bffce9cf7ee7.png
[image 1]: /images/20221022/2eb1c1fde2af451687e62761fbbfbade.png
[image 2]: /images/20221022/17f042502320490c997dc192224148c8.png
[image 3]: /images/20221022/7b60c42bf978462d9c7a43d866accb9c.png
[GitHub_WangYe8613_scanacos]: https://github.com/WangYe8613/scanacos.git