Sentinel使用Nacos持久化并动态更新配置

小鱼儿 2022-11-18 01:39 621阅读 0赞

### Sentinel使用Nacos持久化并动态更新配置 ###

*  Sentinel注解限流
 *  Sentinel Dashboard控制台限流
 *  Nacos存储Sentinel配置
 *  Nacos与Sentinel Dashboard动态更新配置
 *   *  推模式：使用 Nacos 配置规则

# Sentinel注解限流 #

*  引入pom

<dependency>
                <groupId>com.alibaba.csp</groupId>
                <artifactId>sentinel-annotation-aspectj</artifactId>
                <version>1.8.0</version>
            </dependency>

*  全局配置

@Configuration
    public class SentinelAutoConfiguration { 
        @Bean
        public SentinelResourceAspect sentinelResourceAspect() { 
            return new SentinelResourceAspect();
        }
    }

*  对某个接口加上`@SentinelResource`注解

@SentinelResource(value = "hello", blockHandler = "exceptionHandler", fallback = "helloFallback")
        @GetMapping("/sentinel")
        public String sentinel() { 
            int i = (int) (Math.random() * 10);
            if (i % 2 == 0) { 
                throw new RuntimeException("偶数异常");
            }
            return "hello world!!!";
        }
    
        // Fallback 函数，函数签名与原函数一致或加一个 Throwable 类型的参数.
        public String helloFallback(Throwable throwable) { 
            throwable.printStackTrace();
            return "helloFallback";
        }
    
        // Block 异常处理函数，参数最后多一个 BlockException，其余与原函数一致.
        public String exceptionHandler(BlockException ex) { 
            ex.printStackTrace();
            return "exceptionHandler";
        }
    }

*  `blockHandler`、`fallback`调用方法必须和限流方法同参数、同返回值，blockHandler最后一个参数可以是BlockException，fallback最后一个参数可以是Throwable。
 *  如果有`blockHandlerClass`、`fallbackClass`两个参数，且必须为静态方法，否则无效。

此时访问[localhost:8080/sentinel][localhost_8080_sentinel]页面会出去两种情况

*  hello world!!!
 *  helloFallback

此时发现没起到限流作用，且网上说都说频繁访问就会限流，且调用exceptionHandler方法，这个说法是错误的！！！

*  在启动类配置限流规则

@SpringBootApplication
    public class SentinelApplication { 
    
        public static void main(String[] args) { 
            initFlowRules();
            SpringApplication.run(SentinelApplication.class, args);
        }
    
        private static void initFlowRules() { 
        	// 一秒只能有一个请求
            List<FlowRule> rules = new ArrayList<>();
            FlowRule rule = new FlowRule();
            rule.setResource("hello");
            rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
            rule.setCount(1);
            rules.add(rule);
            FlowRuleManager.loadRules(rules);
        }
    }

<table> 
 <thead> 
  <tr> 
   <th>Field</th> 
   <th>说明</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>resource</td> 
   <td>资源名，资源名是限流规则的作用对象</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>count</td> 
   <td>限流阈值</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>grade</td> 
   <td>限流阈值类型，QPS 或线程数模式</td> 
   <td>QPS 模式</td> 
  </tr> 
  <tr> 
   <td>limitApp</td> 
   <td>流控针对的调用来源</td> 
   <td>default，代表不区分调用来源</td> 
  </tr> 
  <tr> 
   <td>strategy</td> 
   <td>调用关系限流策略：直接、链路、关联</td> 
   <td>根据资源本身（直接）</td> 
  </tr> 
  <tr> 
   <td>controlBehavior</td> 
   <td>流控效果（直接拒绝 / 排队等待 / 慢启动模式），不支持按调用关系限流</td> 
   <td>直接拒绝</td> 
  </tr> 
 </tbody> 
</table>

这次频繁访问就会出现：exceptionHandler

生产环境不会使用，且每次修改都需要发版！！！

# Sentinel Dashboard控制台限流 #

注解配置限流有一个弊端，当需要更改限流规则必须重启项目。可以通过控制台参数更改限流规则。

*  下载Sentinel Dashboard控制台  
    通过官网下载[Sentinel Dashboard控制台][Sentinel Dashboard]，以1.8.0为例。
 *  启动Sentinel Dashboard控制台

java -Dserver.port=8088 -Dcsp.sentinel.dashboard.server=localhost:8088 -Dproject.name=sentinel-dashboard -jar sentinel-dashboard.jar

*  Dserver.port=8088 用于指定 Sentinel 控制台端口为 8088
 *  Dcsp.sentinel.dashboard.server 用于控制台对外暴露的服务地址

访问：[localhost:8088][localhost_8088]，账号密码都是：sentinel

*  引入Pom文件

<dependency>
        <groupId>com.alibaba.csp</groupId>
        <artifactId>sentinel-transport-simple-http</artifactId>
    </dependency>
    
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
    </dependency>

*  配置文件

spring:
      cloud:
        sentinel:
          transport:
            dashboard: localhost:8088
            port: 8719
          # 心跳监测
          eager: true

这里的 `spring.cloud.sentinel.transport.port` 端口配置会在应用对应的机器上启动一个 Http Server，该 Server 会与 Sentinel 控制台做交互。比如 Sentinel 控制台添加了一个限流规则，会把规则数据 push 给这个 Http Server 接收，Http Server 再将规则注册到 Sentinel 中。

*  在控制台中配置流控规则  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70]  
    频繁刷新页面和之前效果一样。

生产环境不会使用，且每次重启Dashboard配置会丢失！！！

# Nacos存储Sentinel配置 #

但是注解配置、控制台配置都无法解决配置丢失问题，通过Nacos配置中心解决该问题。

*  引入Pom文件

<dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
            </dependency>
    
            <dependency>
                <groupId>com.alibaba.csp</groupId>
                <artifactId>sentinel-datasource-nacos</artifactId>
            </dependency>
    
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
            </dependency>

*  配置文件

server:
      port: 8080
    
    spring:
      application:
        name: sentinel
      cloud:
        nacos:
          config:
            server-addr: localhost:8848
    
        sentinel:
          transport:
            dashboard: localhost:8088
            port: 8719
          # 心跳监测
          eager: true
    
          datasource:
            db:  # 指定数据源名称
              # 指定nacos数据源
              nacos:
                server-addr: localhost:8848
                # 指定配置文件名称
                dataId: my_sentinel
                # 指定配置文件规则类型
                rule-type: flow
                # 指定配置文件数据格式
                data-type: json

*  新建nacos配置

[
        { 
            "resource":"/sentinel",
            "limitApp":"default",
            "grade":1,
            "count":2
        }
    ]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 1]

*  Sentinel Dashboard查看规则信息

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 2]

生产环境不会使用，只能通过Nacos修改规则配置，通过Dashboard修改规则配置不自动刷新Nacos配置，重启Dashboard后只保留Nacos中数据！！！

# Nacos与Sentinel Dashboard动态更新配置 #

<table> 
 <thead> 
  <tr> 
   <th>推送模式</th> 
   <th>说明</th> 
   <th>优点</th> 
   <th>缺点</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>原始模式</td> 
   <td>API 将规则推送至客户端并直接更新到内存中，扩展写数据源（WritableDataSource）</td> 
   <td>简单，无任何依赖</td> 
   <td>不保证一致性；规则保存在内存中，重启即消失。严重不建议用于生产环境</td> 
  </tr> 
  <tr> 
   <td>Pull 模式</td> 
   <td>扩展写数据源（WritableDataSource）， 客户端主动向某个规则管理中心定期轮询拉取规则，这个规则中心可以是 RDBMS、文件 等</td> 
   <td>简单，无任何依赖；</td> 
   <td>规则持久化 不保证一致性；实时性不保证，拉取过于频繁也可能会有性能问题。</td> 
  </tr> 
  <tr> 
   <td>Push 模式</td> 
   <td>扩展读数据源（ReadableDataSource），规则中心统一推送，客户端通过注册监听器的方式时刻监听变化，比如使用 Nacos、Zookeeper 等配置中心。这种方式有更好的实时性和一致性保证。生产环境下一般采用 push 模式的数据源。</td> 
   <td>规则持久化；一致性；快速</td> 
   <td>引入第三方依赖</td> 
  </tr> 
 </tbody> 
</table>

推模式流程：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 3]

## 推模式：使用 Nacos 配置规则 ##

*  下载[Sentinel源码][Sentinel]
 *  修改`sentinel-dashboard`的Pom文件  
    注释  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 4]
 *  将sentinel-dashboard项目的test目录下：`com.alibaba.csp.sentinel.dashboard.rule.nacos`文件复制到`com.alibaba.csp.sentinel.dashboard.rule`目录下  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 5]
 *  修改上一步复制后`NacosConfig`类

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 6]

*  修改`com.alibaba.csp.sentinel.dashboard.controller.v2`目录下`FlowControllerV2`文件，名称同上一步复制类中`FlowRuleNacosProvider`类和`FlowRuleNacosPublisher`的名称

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 7]

*  修改sentinel-dashboard项目的webapp中：`resources.app.scripts.directives.sidebar`目录下`sidebar.html`

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 8]

*  打包并发布`sentinel-dashboard`项目
 *  项目中引用Pom文件

<dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
            </dependency>
    
            <dependency>
                <groupId>com.alibaba.csp</groupId>
                <artifactId>sentinel-datasource-nacos</artifactId>
            </dependency>
    
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
            </dependency>

*  配置文件

server:
      port: 8080
    
    spring:
      application:
        name: sentinel
      cloud:
        nacos:
          config:
            server-addr: localhost:8848
            # 组名必须为：SENTINEL_GROUP 
            group: SENTINEL_GROUP
    
        sentinel:
          transport:
            dashboard: localhost:8088
            port: 8719
          # 心跳监测
          eager: true
    
          datasource:
            db:  # 指定数据源名称
              # 指定nacos数据源
              nacos:
                server-addr: localhost:8848
                # 指定配置文件名称必须为：${spring.application.name}-flow-rules
                dataId: ${ spring.application.name}-flow-rules
                # 指定分组必须为：SENTINEL_GROUP
                groupId: SENTINEL_GROUP
                # 指定配置文件规则类型
                rule-type: flow
                # 指定配置文件数据格式
                data-type: json

*  启动项目
 *  创建限流规则

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 9]

*  在`Nacos`中刷新配置文件，多一个`sentinel-flow-rules`配置文件且内容和`dashboard`控制台添加内容一样

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 10]

任意修改两边配置都会同步，可用于生产环境！！！

[localhost_8080_sentinel]: http://localhost:8080/sentinel
[Sentinel Dashboard]: https://github.com/alibaba/Sentinel/releases
[localhost_8088]: http://localhost:8088
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70]: /images/20221022/7f6e31458561403dbe225a672a551e7b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 1]: /images/20221022/dc3f7031ff5649668d5de6ca743a8430.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 2]: /images/20221022/09397b247f614ab4942100464dd00a89.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 3]: /images/20221022/46ea7bb91a9849c49a5d60372cc3f8ea.png
[Sentinel]: https://github.com/alibaba/Sentinel
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 4]: /images/20221022/1df56f5c5034428bac17b5ea347841e6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 5]: /images/20221022/3f7d0d623ecc4ef981a553d64495b0be.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 6]: /images/20221022/878e0e4c43e94d51a9273d99ac801fac.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 7]: /images/20221022/7475d3bca54d496baf0631aacdfd0a1d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 8]: /images/20221022/40a089663c0a4975bca0523e54df4b91.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 9]: /images/20221022/416a9a9c77524a638f51585214d42b7f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70 10]: /images/20221022/0f63a2f6bd114b268e539fc40e9b9d9c.png