Spring Cloud Alibaba（4）Sentinel使用nacos对存储规则持久化带源码

红太狼 2022-01-29 00:39 301阅读 0赞

**目录**

背景

源码地址

博文参考：

持久化支持方式

整合nacos存储规则

sentinel规则修改

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

## 背景 ##

spring cloud微服务应用sentinel做限流，每次sentinel dashboard服务重启后，限流的规则丢失，这里就需要对限流规则作持久化处理。

## 源码地址 ##

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

## **博文参考：** ##

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

## 持久化支持方式 ##

> Sentinel自身就支持了多种不同的数据源来持久化规则配置，目前包括以下几种方式：
> 
>  *  文件配置
>  *  [Nacos配置][Nacos]
>  *  ZooKeeper配置
>  *  [Apollo配置][Apollo]

##  整合nacos存储规则 ##

1.启动[Nacos][]、[Sentinel Dashboard][]，对应访问地址如下：

>  *  Nacos：[http://localhost:8848/nacos/][http_localhost_8848_nacos]
>  *  Sentinel Dashboard：[http://localhost:8080/][http_localhost_8080]

2.新建一个spring boot项目acelee-alibaba-sentinel-nacos，在pom.xml文件里添加sentinel、nacos依赖

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.4.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.aceleeyy</groupId>
        <artifactId>acelee-alibaba-sentinel-nacos</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>acelee-alibaba-sentinel-nacos</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
                <version>0.9.0.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba.csp</groupId>
                <artifactId>sentinel-datasource-nacos</artifactId>
                <version>1.6.0</version>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

3.在application.properties里添加sentinel、nacos配置

>  *  `spring.cloud.sentinel.transport.dashboard`：sentinel dashboard的访问地址，根据上面准备工作中启动的实例配置
>  *  `spring.cloud.sentinel.datasource.ds.nacos.server-addr`：nacos的访问地址，，根据上面准备工作中启动的实例配置
>  *  `spring.cloud.sentinel.datasource.ds.nacos.groupId`：nacos中存储规则的groupId
>  *  `spring.cloud.sentinel.datasource.ds.nacos.dataId`：nacos中存储规则的dataId
>  *  `spring.cloud.sentinel.datasource.ds.nacos.rule-type`：该参数是spring cloud alibaba升级到0.2.2之后增加的配置，用来定义存储的规则类型。所有的规则类型可查看枚举类：`org.springframework.cloud.alibaba.sentinel.datasource.RuleType`，每种规则的定义格式可以通过各枚举值中定义的规则对象来查看，比如限流规则可查看：`com.alibaba.csp.sentinel.slots.block.flow.FlowRule`
> 
> 这里对于dataId使用了`${spring.application.name}`变量，这样可以根据应用名来区分不同的规则配置。
> 
> **注意**：由于版本迭代关系，Github Wiki中的文档信息不一定适用所有版本。比如：在这里适用的0.2.1版本中，并没有`spring.cloud.sentinel.datasource.ds2.nacos.rule-type`这个参数。所以，读者在使用的时候，可以通过查看`org.springframework.cloud.alibaba.sentinel.datasource.config.DataSourcePropertiesConfiguration`和`org.springframework.cloud.alibaba.sentinel.datasource.config.NacosDataSourceProperties`两个类来分析具体的配置内容，会更为准确。

spring.application.name=acelee-alibaba-sentinel-nacos
    server.port=8003
    
    # sentinel dashboard
    spring.cloud.sentinel.transport.dashboard=localhost:8080
    
    # sentinel datasource nacos ：http://blog.didispace.com/spring-cloud-alibaba-sentinel-2-1/
    spring.cloud.sentinel.datasource.ds.nacos.server-addr=localhost:8848
    spring.cloud.sentinel.datasource.ds.nacos.dataId=${spring.application.name}-sentinel
    spring.cloud.sentinel.datasource.ds.nacos.groupId=DEFAULT_GROUP
    spring.cloud.sentinel.datasource.ds.nacos.rule-type=flow

4.新建controller包，在包里新建HelloController.java类，增加hello接口

package com.aceleeyy.aceleealibabasentinelnacos.controller;
    
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class HelloController {
    
        @GetMapping("/hello")
        public String hello() {
            return "aceleeyy.com";
        }
    
    }

5.Nacos里配置列表页面新建配置，配置限流规则

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70][]

>  *  `1）Data ID`就是上面application.properties中配置对应的nacos.dataId
>  *  2）`Group`就是上面application.properties中配置对应的nacos.groupId
>  *  3）配置格式选择JSON
>  *  4）并在配置内容中填入下面的内容：

[
        {
            "resource": "/hello",
            "limitApp": "default",
            "grade": 1,
            "count": 5,
            "strategy": 0,
            "controlBehavior": 0,
            "clusterMode": false
        }
    ]

>  可以看到上面配置规则是一个数组类型，数组中的每个对象是针对每一个保护资源的配置对象，每个对象中的属性解释如下：
> 
>  *  resource：资源名，即限流规则的作用对象
>  *  limitApp：流控针对的调用来源，若为 default 则不区分调用来源
>  *  grade：限流阈值类型（QPS 或并发线程数）；`0`代表根据并发数量来限流，`1`代表根据QPS来进行流量控制
>  *  count：限流阈值
>  *  strategy：调用关系限流策略
>  *  controlBehavior：流量控制效果（直接拒绝、Warm Up、匀速排队）
>  *  clusterMode：是否为集群模式
> 
> 这里我们只做简单的配置解释，以便于理解这里的配置作用。实际上这里还有非常多可配置选项和规则，更复杂的配置后面我们一起来学习。

6.点击发布按钮，可以看到nacos配置列表多了一条记录

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 1][]

7.启动项目，如果一切顺利，可以看到控制台打印如下日志，证明sentinel的限流规则从nacos中获取，且对/hello接口作了qps为5的限流

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 2][]

8.访问[http://localhost:8003/hello][http_localhost_8003_hello] ，返回：aceleeyy.com

![20190520171420614.png][]

9.打开sentinel控制台，刷新页面，可以看到对/hello接口的实时监控，没有的话，刷新几次/hello接口

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 3][]

10。打开sentinel流控规则页面，可以看到新增了一条限流记录，配置值分别对应nacos里的json数据配置

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 4][]

11.验证限流规则，多次调用/hello接口，在快速刷新后返回：

Blocked by Sentinel (flow limiting)

证明sentinel使用nacos对限流规则持久化成功

![20190520172127339.png][]

## sentinel规则修改 ##

在完成了上面的整合之后，对于接口流控规则的修改就存在两个地方了：Sentinel控制台、Nacos控制台。

这个时候，需要注意当前版本的Sentinel控制台不具备同步修改Nacos配置的能力，而Nacos由于可以通过在客户端中使用Listener来实现自动更新。所以，在整合了Nacos做规则存储之后，需要知道在下面两个地方修改存在不同的效果：

>  *  Sentinel控制台中修改规则：仅存在于服务的内存中，不会修改Nacos中的配置值，重启后恢复原来的值。
>  *  Nacos控制台中修改规则：服务的内存中规则会更新，Nacos中持久化规则也会更新，重启后依然保持。

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

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

[https_gitee.com_acelee723_acelee-alibaba-sentinel-nacos]: https://gitee.com/acelee723/acelee-alibaba-sentinel-nacos
[http_blog.didispace.com_spring-cloud-alibaba-sentinel-2-1]: http://blog.didispace.com/spring-cloud-alibaba-sentinel-2-1/
[Nacos]: https://blog.csdn.net/las723/article/details/88552443
[Apollo]: https://blog.csdn.net/las723/article/details/90609699
[Sentinel Dashboard]: https://blog.csdn.net/las723/article/details/90296415
[http_localhost_8848_nacos]: http://localhost:8848/nacos/
[http_localhost_8080]: http://localhost:8080/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70]: /images/20220129/8645590191fc465d8bcd4577485f4bd2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 1]: /images/20220129/b09d7651ceae44dca9b0eeb69b0f7d07.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 2]: /images/20220129/0b539c20e1354155905a370565b9c0da.png
[http_localhost_8003_hello]: http://localhost:8003/hello
[20190520171420614.png]: /images/20220129/b621615427dd418b9bca48d0b35a80bb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 3]: /images/20220129/59c48696be084ba7b6edfdf52d929f0f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhczcyMw_size_16_color_FFFFFF_t_70 4]: /images/20220129/18ab1cdfd0c24ba99f35e778bb11266c.png
[20190520172127339.png]: /images/20220129/5a2ba200521d4ba18d32b17881661f0f.png
[spring cloud alibaba]: https://blog.csdn.net/las723/column/info/38747